Difference between revisions of "Help:How to make a Tool page"

Latest revision as of 14:04, 2 March 2023

This wiki offers a couple of templates that help maintain a consistent style, categorization and automatic linking through semantic information. If you want a new page to be a Tool page, the minimum information you need to add is the categorization as a tool. All other templates are optional, though we strongly encourage using them to improve findability.

Elements of a Tool page[edit | edit source]

The category tag: A tag that assigns your page to the "Tools" category.
An infobox: A template in which you can add titles of related topic pages. These will become semantic properties of the page and will make the tool show up in the list of linked pages in the infobox of the respective topic. The part "Linked pages on this wiki" shows pages that have this tool as semantic property.

Using the visual editor to add tool templates to a page[edit | edit source]

Depending on how you ended up on the page creation form the visual editor should already be the default. Otherwise, the visual editor can be found under the "Create" tab on the top right/middle of the page. A step-by-step guide of how to add all the right templates and information can be seen in the galleries below.

Adding the category[edit | edit source]

Click on the hamburger menu on the top right of the editor and choose "Categories".
Type "Tools" into the search bar and click "enter". The category tag should appear in the autocomplete option. If the category title is red, please check the spelling.Click "Apply changes". Now the category tag should appear on the bottom of your page.

Adding the infobox[edit | edit source]

Adding the infobox: Click on the "Insert" tab on top of the editor, then pick "Template". Type "Tool Infobox" into the search bar. The template should appear in the autocomplete list.
Once you selected the infobox template, click on "Related topics" under "Add more information".
Now you can add a list of related topic pages, separated by commas. As of now, there is no autocomplete option for that. If you are not sure about the title of the pages you want to link to, you can verify it on the Topic category overview page. Click "Insert". The infobox should now appear on the right of your page.

Adding further content[edit | edit source]

All other content can now be added and formatted as you wish. See the Cheatsheet from MediaWiki for formatting help.

Using the source code editor to add tool templates to a page[edit | edit source]

Adding the tool category: [[Category:Tools]]
- We recommend adding this at the bottom of the page,
- This makes the page show up on the Tools overview page
Adding the infobox: {{Tool Infobox|Related topics= }}
- You can enter a list of related topic pages after "Related topics=", separated by commas (e.g. "Related topics=Sleep,Metabolism")
- We recommend putting this at the top of your page article

See Semantic properties in Personal Science Wiki for more information.

How to turn a page a tool page if it already in a different category?[edit | edit source]

You can change the categorization of a page by removing any existing infobox/footer templates and category tags from a page and instead replace with (at least) the tool tag as specified above. This will put the page in the tool category and remove it from the other categories.

@@ Line 1: / Line 1: @@
-While you are free to add content to pages as you wish, this wiki uses some structural elements for different page categories for semantic structuring.
+This wiki offers a couple of templates that help maintain a consistent style, categorization and automatic linking through semantic information. If you want a new page to be a ''Tool'' page, the minimum information you need to add is the categorization as a tool. All other templates are optional, though we strongly encourage using them to improve findability.
 ==Elements of a Tool page==
-===Tool Infobox===
-A template in which you can add titles of related topic pages as semantic properties.
-[[File:Tool-infobox-example.png]]
+<gallery widths=300px>
+File:Category-tools-tag.png|Category-tools-tag.png|The category tag: A tag that assigns your page to the "Tools" category.
+File:Tool-infobox-example.png|An infobox: A template in which you can add titles of related topic pages. These will become semantic properties of the page and will make the tool show up in the list of linked pages in the infobox of the respective topic. The part "Linked pages on this wiki" shows pages that have this tool as semantic property.
+</gallery>
-===Tool Queries===
+== Using the visual editor to add tool templates to a page ==
-A template which automatically displays all pages that link to your tool page in their infobox.
+Depending on how you ended up on the page creation form the visual editor should already be the default. Otherwise, the visual editor can be found under the ''"Create"'' tab on the top right/middle of the page. A step-by-step guide of how to add all the right templates and information can be seen in the galleries below.
-[[File:Tool-queries-example-narrow.png]]
+===Adding the category===
+<gallery>
+File:Set-page-category.png|Click on the hamburger menu on the top right of the editor and choose ''"Categories"''.
+File:Set-tools-category.png|Type ''"Tools"'' into the search bar and click "enter". The category tag should appear in the autocomplete option. If the category title is red, please check the spelling.Click ''"Apply changes"''. Now the category tag should appear on the bottom of your page.
+</gallery>
+=== Adding the infobox ===
+<gallery>
+File:Insert-template.png|Adding the infobox: Click on the ''"Insert"'' tab on top of the editor, then pick ''"Template"''. Type ''"Tool Infobox"'' into the search bar. The template should appear in the autocomplete list.
+File:Tool-infobox-properties.png|Once you selected the infobox template, click on ''"Related topics"'' under ''"Add more information"''.
+File:Tool-infobox-add-topics.png|Now you can add a list of related topic pages, separated by commas. As of now, there is no autocomplete option for that. If you are not sure about the title of the pages you want to link to, you can verify it on the [[:Category:Topics|Topic category overview page]]. Click "Insert". The infobox should now appear on the right of your page.
+</gallery>
-===Tool Category===
+===Adding further content===
-A tag that assigns your page to the "Tools" category.
+All other content can now be added and formatted as you wish. See the [https://www.mediawiki.org/wiki/Cheatsheet Cheatsheet] from MediaWiki for formatting help.
-[[File:Category-tools-tag.png|Category-tools-tag.png]]
+==Using the source code editor to add tool templates to a page==
-==How to add these elements to a page==
+* Adding the '''tool category''': <code><nowiki>[[Category:Tools]]</nowiki></code>
-===Using the source code editor===
+** We recommend adding this at the bottom of the page,
-* <nowiki>{{Tool Infobox|Related topics= }}</nowiki>
+** This makes the page show up on the [[:Category:Tools|Tools overview page]]
-** Add this to the top of the page, after the leading text.
+* Adding the '''infobox''': <code><nowiki>{{Tool Infobox|Related topics= }}</nowiki></code>
-** You can enter a list of related topic pages after "Related topics=", separated by commas.
+** You can enter a list of related topic pages after "Related topics=", separated by commas (e.g. "Related topics=Sleep,Metabolism")
-** [[Template:Tool Infobox|Link to the Tool Infobox template]]
+** We recommend putting this at the top of your page article
-* <nowiki>{{Tool Queries}}</nowiki>
-** Add this to the bottom of the page.
-** [[Template:Tool Queries|Link to the Tool Queries template]]
-* <nowiki>[[Category:Tools]]</nowiki>
-** Add this to the bottom of the page, below the Tool Queries.
-** This tag makes the page show up on the [[:Category:Tools|Tools overview page]]
-===Using the visual editor===
+See [[Help:Semantic properties in Personal Science Wiki|Semantic properties in Personal Science Wiki]] for more information.
-The visual editor can be found under the "Create" tab on the top right/middle of the page.
-====Adding the Tool Infobox====
-# Click on the "Insert" tab on top of the editor, then pick "Template".
-[[File:Insert-template.png]]
+==How to turn a page a tool page if it already in a different category?==
+You can change the categorization of a page by removing any existing infobox/footer templates and category tags from a page and instead replace with (at least) the tool tag as specified above. This will put the page in the tool category and remove it from the other categories.
-# Type "Tool Infobox" into the search bar. The template should appear in the autocomplete list.
-# Once you selected the infobox template, click on "Related topics" under "Add more information".
-[[File:Tool-infobox-properties.png|400px]]
-# Now you can add a list of related topic pages, separated by commas. As of now, there is no autocomplete option for that. If you are not sure about the title of the pages you want to link to, please verify on the [[:Category:Topics|Topic category overview page]].
-[[File:Tool-infobox-add-topics.png|400px]]
-# Click "Insert". The infobox should now appear on the right of your page.
-====Adding the Tool Queries====
-# Click on the "Insert" tab on top of the editor, then pick "Template".
-[[File:Insert-template.png]]
-# Type "Tool Queries" into the search bar. The template should appear in the autocomplete list.
-# Choose the template and click "Insert". Do not add anything under "add more information". The queries will be automatically filled when another page refers to your page in their infobox.
-[[File:Tool-queries-properties.png|400px]]
-# The Tool Queries template should not appear on the bottom of your page.
-====Adding the Tool Category====
-# Click on the hamburger menu on the top right of the editor and choose "Categories"
-[[File:Set-page-category.png|300px]]
-# Type "Tools" into the search bar and click "enter". The category tag should appear in the autocomplete option. If the category title is red, please check the spelling.
-[[File:Set-tools-category.png]]
-# Click "Apply changes". Now the category tag should appear on the bottom of your page.
-====Adding further content====
-All other content can be added and formatted as you wish. See the [https://www.mediawiki.org/wiki/Cheatsheet Cheatsheet] from MediaWiki for formatting help.
-===Using the Tool form===
-There is a [[Form:Tool|form]] that automatically adds the aforementioned elements to the page. However, there is a bug that makes the queries and category tag disappear after saving, so you have to update them manually. We encourage you create a Tool page using one of the other two methods.
-==How to make a page a tool page if it already has elements of a different category?==
-Remove any templates and category tags of other categories and add the Tool page elements specified above