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

From Personal Science Wiki
Jump to navigation Jump to search
(Added a colon before category:tools so the page does not get classified as a tool)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
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.  
 
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==
 +
 +
<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>
  
 
== Using the visual editor to add tool templates to a page ==
 
== Using the visual editor to add tool templates to a page ==
Depending on how you ended up on the page creation form the default 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.  
+
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===
 
===Adding the category===
Line 11: Line 18:
 
=== Adding the infobox ===
 
=== Adding the infobox ===
 
<gallery>
 
<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. Once you selected the infobox template, click on ''"Related topics"'' under ''"Add more information"''.
+
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|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]].  
+
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|Click "Insert". The infobox should now appear on the right of your page.
+
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>
 
 
 
===Adding the Tool Queries===
 
 
 
<gallery>
 
File:Insert-template.png|Click on the ''"Insert"'' tab on top of the editor, then pick ''"Template"''.
 
File:Tool-queries-properties.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. The Tool Queries template should now appear on the bottom of your page.  
 
 
</gallery>
 
</gallery>
  
Line 32: Line 32:
 
** This makes the page show up on the [[:Category:Tools|Tools overview page]]
 
** This makes the page show up on the [[:Category:Tools|Tools overview page]]
 
* Adding the '''infobox''': <code><nowiki>{{Tool Infobox|Related topics= }}</nowiki></code>
 
* 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")
 
** We recommend putting this at the top of your page article
 
** We recommend putting this at the top of your page article
* Adding the '''footer queries''': <code><nowiki>{{Tool Queries}}</nowiki></code>
 
** We recommend adding this at the bottom of the page
 
 
==Elements of a Tool page==
 
  
<gallery>
+
See [[Help:Semantic properties in Personal Science Wiki|Semantic properties in Personal Science Wiki]] for more information.
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 as semantic properties.
 
File:Tool-queries-example-narrow.png|The queries: A template which automatically displays all pages that link to your tool page in their infobox.  
 
</gallery>
 
  
 
==How to turn a page a tool page if it already in a different category?==
 
==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.
 
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.

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]

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]

Adding the infobox[edit | edit source]

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.