Template:ToolInfoBox: Difference between revisions
something's wrong, line breaks are not taken... |
new optional parameter "made by" for self-made tools or jigs where "tutor" is a bit much but readers might appreciate a contact for questions |
||
(22 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
<noinclude>{{ToolInfoBox | <noinclude>{{ToolInfoBox | ||
|tool name=Example: | |tool name=Example: Woodturning Tools | ||
|image= | |image=cheap woodturning tools.JPG | ||
|synonyms=DE: | |synonyms=DE: Drechseleisen, Drechselmesser | ||
|type= | |type= | ||
|status= | |||
|used with=[[ | |material=[[wood]] | ||
|location=[[workshop]] | |used with=[[Wood Lathe|wood lathe]] | ||
| | |location=[[Wood Workshop|wood workshop]]<br>(wall above wood lathe) | ||
|tutors=[[ | |access=[[Woodturning Introduction|woodturning introduction]] | ||
|tutors=[[Lukas]] | |||
|manual= | |manual= | ||
|similar= | |donation= | ||
|similar= | |||
}} | }} | ||
Pretty much everything that does not qualify as a [[Template:MachineInfoBox|machine]] and is (usually) not a consumable is a "tool" and should get its own page eventually. Dangerous or complicated tools first, of course! | Pretty much everything that does not qualify as a [[Template:MachineInfoBox|machine/power tool]] and is (usually) not a consumable [[material]] is called a "[[tool]]" in this wiki and should get its own page eventually. Dangerous or complicated tools first, of course! | ||
== Documentation == | == Documentation == | ||
Line 20: | Line 22: | ||
{{ToolInfoBox | {{ToolInfoBox | ||
|tool name= | |tool name= | ||
|german= | |||
|image= | |image= | ||
|synonyms= | |synonyms= | ||
|type= | |type= | ||
|status= | |||
|material= | |material= | ||
|used with= | |used with= | ||
|location= | |location= | ||
|access= | |access= | ||
|made by= | |||
|tutors= | |tutors= | ||
|manual= | |manual= | ||
Line 33: | Line 38: | ||
}} | }} | ||
</pre> | </pre> | ||
Most fields will only be shown when used, i.e. you can create more or less detailed boxes. Make frequent use of the "Show preview" button and it should be clear. | Most fields will only be shown when they are actually used, i.e. you can easily create more or less detailed boxes (at least name and image). Make frequent use of the "Show preview" button and it should be clear. | ||
For example, entering the following leads to the '''box on the right''': | For example, entering the following leads to the '''box on the right''': | ||
<pre> | <pre> | ||
{{ToolInfoBox | {{ToolInfoBox | ||
|tool name=Example: | |tool name=Example: Woodturning Tools | ||
|image= | |german= | ||
|synonyms=DE: | |image=cheap woodturning tools.JPG | ||
|type= | |synonyms=DE: Drechseleisen, Drechselmesser | ||
|type= | |||
|used with=[[ | |status= | ||
|location=[[workshop]] | |material=[[wood]] | ||
| | |used with=[[Wood Lathe|wood lathe]] | ||
|tutors=[[ | |location=[[Location::Wood Workshop|wood workshop]]<br>(wall above wood lathe) | ||
|access=[[Woodturning Introduction|woodturning introduction]] | |||
|tutors=[[Lukas]] | |||
|manual= | |manual= | ||
|similar= | |donation= | ||
|similar= | |||
}} | }} | ||
</pre> | </pre> | ||
There are a few tool categories such as [[ | There are a few tool categories such as [[woodworking]] or [[saws]] that might be nice to link from "type" - please also [[Help:Wiki Basics#Categories & Namespaces|categorize]] your page to make it easier to find! | ||
== Advanced Users (SMW) == | |||
There is a "hidden" parameter in this template that's not in the copy template: <code>extrabox</code>. To enable <code>extrabox</code>, just give it any value (e.g. "true", "blablabla") and it should cause the box to behave as an extra without "Has image::" and "Has German::". | |||
You can use it when you '''don't''' want the InfoBox to set a "Has image::" and "Has German::" value (as it automatically does for "image" and "german"). That's useful on pretty much every page with multiple InfoBoxes so there is just one "main" image to represent the page in galleries. | |||
Questions, feedback and further improvements are welcome! | |||
</noinclude> | |||
{| class="wikitable" style="float:right; margin-left: 10px; border-style: solid; border-width: 5px; border-color: black" | {| class="wikitable" style="float:right; margin-left: 10px; border-style: solid; border-width: 5px; border-color: black" | ||
!colspan="2"|<small style="float:right">[[Template:ToolInfoBox|ToolInfoBox]]</small><br> | !colspan="2"|<small style="float:right">[[Template:ToolInfoBox|ToolInfoBox]]</small><br> | ||
<big>'''{{{tool name|Unnamed Tool}}}'''</big> | <big>'''{{{tool name|Unnamed Tool}}}'''</big> | ||
|- | |- | ||
!colspan="2"| [[File:{{#if: {{{image|}}} | {{{image}}} |tool-default.png}}|frameless|300px]] | !colspan="2"| [[{{#if: {{{extrabox|}}} |File: | Has image::File:}}{{#if: {{{image|}}} |{{{image}}} |tool-default.png}}|frameless|300px]] | ||
|- | |- | ||
{{#if: {{{synonyms|}}} | | {{#if: {{{synonyms|}}} | | ||
Line 72: | Line 85: | ||
{{!}}- | {{!}}- | ||
{{!}} Type: | {{!}} Type: | ||
{{!}} {{{type| | {{!}} {{{type|tool classification?}}} | ||
|}} | |||
|- | |||
{{#if: {{{status|}}} | | |||
{{!}}- | |||
{{!}} Status: | |||
{{!}} {{{status|}}} | |||
|}} | |}} | ||
|- | |- | ||
Line 95: | Line 114: | ||
{{#if: {{{access|}}} | | {{#if: {{{access|}}} | | ||
{{!}}- | {{!}}- | ||
{{!}} Access: | {{!}} Access Requirements: | ||
{{!}} {{{access| | {{!}} {{{access}}} | ||
|}} | |||
|- | |||
{{#if: {{{made by|}}} | | |||
{{!}}- | |||
{{!}} Made by: | |||
{{!}} {{{made by}}} | |||
|}} | |}} | ||
|- | |- | ||
{{#if: {{{tutors|}}} | | {{#if: {{{tutors|}}} | | ||
{{!}}- | {{!}}- | ||
{{!}} | {{!}} [[Tutors]]: | ||
{{!}} {{{tutors | {{!}} {{{tutors}}} | ||
|}} | |}} | ||
|- | |- | ||
Line 122: | Line 147: | ||
{{!}} {{{similar}}} | {{!}} {{{similar}}} | ||
|}} | |}} | ||
|} | |}[[Category:Tools]] [[Has caption::{{#if: {{{extrabox|}}} | |{{PAGENAME}}}}| ]] {{#if:{{{german|}}} | [[Has German::{{{german}}}|]] | }}<noinclude> | ||
[[ | |||
== Template Parameters == | |||
<templatedata> | |||
{ | |||
"params": { | |||
"tool name": { | |||
"label": "The name of your tool", | |||
"description": "The name of your tool", | |||
"type": "string", | |||
"default": "Unnamed Tool", | |||
"required": true | |||
}, | |||
"german": { | |||
"label": "The (best) German name of your tool (invisible)", | |||
"description": "The (best) German name of your tool (not visible, but usable for advanced pages like automatic galleries)", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"extrabox": { | |||
"label": "Extrabox? (advanced - if in doubt, ignore this)", | |||
"description": "Apply this parameter if you use the template as an additional InfoBox on a tool page with an existing \"main\" box. This will remove the \"Has Image\" parameter from this infobox so its image is NOT included as an SMW property of the page.", | |||
"type": "boolean" | |||
}, | |||
"image": { | |||
"label": "An image of the tool (example.jpg)", | |||
"description": "The file name of the image which represents the tool the best. If you do not fill the parameter \"extrabox\", this will be added to the page as a Semantic MediaWiki property. Do not include 'File:' or '[[', just the file name.", | |||
"type": "wiki-file-name", | |||
"default": "tool-default.png", | |||
"suggested": true | |||
}, | |||
"synonyms": { | |||
"label": "Synonyms for the tool's name", | |||
"description": "Existing synonyms for the name of the tool. You might include translations here.", | |||
"example": "DE: Schraubendreher", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"type": { | |||
"label": "Which type of tool is it?", | |||
"description": "Which type of tool is this InfoBox referring to? ", | |||
"example": "[[saw]]", | |||
"type": "string" | |||
}, | |||
"status": { | |||
"label": "The status of the tool", | |||
"description": "The status of the tool", | |||
"example": "available / broken", | |||
"type": "string" | |||
}, | |||
"material": { | |||
"label": "Material the tool can be used with", | |||
"description": "Links to materials the tool can be used with. Links should ideally be within our wiki.", | |||
"example": "[[wood]]", | |||
"type": "wiki-page-name", | |||
"suggested": true | |||
}, | |||
"used with": { | |||
"label": "Machines to use the tool with", | |||
"description": "Links to machines the tool can be used with. Links should ideally be within our wiki", | |||
"example": "[[Wood Lathe|wood lathe]]", | |||
"type": "wiki-page-name" | |||
}, | |||
"location": { | |||
"label": "The location of the tool", | |||
"description": "The location of the tool within the CoMakingSpace", | |||
"example": "[[Location::Wood Workshop|wood workshop]]", | |||
"type": "wiki-page-name", | |||
"suggested": true | |||
}, | |||
"access": { | |||
"label": "Access requirements (if applicable)", | |||
"description": "If applicable, use this to indicate the access requirements to use the tool", | |||
"example": "ask nicely", | |||
"type": "string" | |||
}, | |||
"made by": { | |||
"label": "Maker of the tool (if applicable)", | |||
"description": "For self-made tools or jigs: who may be able to answer questions (and gets the bragging rights)?", | |||
"example": "[[User:Lukas|Lukas]]", | |||
"type": "string" | |||
}, | |||
"tutors": { | |||
"label": "Tutors for the tool (if applicable)", | |||
"description": "List of tutors who can give introductions to the tool", | |||
"example": "[[Tutor::User:Lukas|Lukas]]", | |||
"type": "string" | |||
}, | |||
"manual": { | |||
"label": "Link to the manual", | |||
"description": "Link to the manual of the tool. This should be a public source. If there is no link, indicate where the manual is located in the CoMakingSpace. Leave empty if not applicable", | |||
"type": "url" | |||
}, | |||
"donation": { | |||
"label": "Donation", | |||
"description": "Indicate a suggested donation for the use of this tool. This is used mainly for expensive tools which generate maintenance costs based on their usage.", | |||
"example": "5ct", | |||
"type": "string" | |||
}, | |||
"similar": { | |||
"label": "Links to similar tools", | |||
"description": "Provide links to similar tools in our wiki.", | |||
"type": "wiki-page-name" | |||
} | |||
}, | |||
"description": "Pretty much everything that does not qualify as a machine/power tool and is (usually) not a consumable material is called a \"tool\" in this wiki and should get its own page eventually. Dangerous or complicated tools first, of course!", | |||
"paramOrder": [ | |||
"tool name", | |||
"german", | |||
"image", | |||
"synonyms", | |||
"type", | |||
"status", | |||
"material", | |||
"used with", | |||
"location", | |||
"access", | |||
"made by", | |||
"tutors", | |||
"manual", | |||
"donation", | |||
"similar", | |||
"extrabox" | |||
] | |||
} | |||
</templatedata> | |||
</noinclude> |
Revision as of 13:44, 1 April 2025
ToolInfoBox Example: Woodturning Tools | |
---|---|
Synonyms: | DE: Drechseleisen, Drechselmesser |
Material: | wood |
Used with: | wood lathe |
Location: | wood workshop (wall above wood lathe) |
Access Requirements: | woodturning introduction |
Tutors: | Lukas |
Pretty much everything that does not qualify as a machine/power tool and is (usually) not a consumable material is called a "tool" in this wiki and should get its own page eventually. Dangerous or complicated tools first, of course!
Documentation
To use this template, simply copy this code into your page and enter the relevant parameters:
{{ToolInfoBox |tool name= |german= |image= |synonyms= |type= |status= |material= |used with= |location= |access= |made by= |tutors= |manual= |donation= |similar= }}
Most fields will only be shown when they are actually used, i.e. you can easily create more or less detailed boxes (at least name and image). Make frequent use of the "Show preview" button and it should be clear.
For example, entering the following leads to the box on the right:
{{ToolInfoBox |tool name=Example: Woodturning Tools |german= |image=cheap woodturning tools.JPG |synonyms=DE: Drechseleisen, Drechselmesser |type= |status= |material=[[wood]] |used with=[[Wood Lathe|wood lathe]] |location=[[Location::Wood Workshop|wood workshop]]<br>(wall above wood lathe) |access=[[Woodturning Introduction|woodturning introduction]] |tutors=[[Lukas]] |manual= |donation= |similar= }}
There are a few tool categories such as woodworking or saws that might be nice to link from "type" - please also categorize your page to make it easier to find!
Advanced Users (SMW)
There is a "hidden" parameter in this template that's not in the copy template: extrabox
. To enable extrabox
, just give it any value (e.g. "true", "blablabla") and it should cause the box to behave as an extra without "Has image::" and "Has German::".
You can use it when you don't want the InfoBox to set a "Has image::" and "Has German::" value (as it automatically does for "image" and "german"). That's useful on pretty much every page with multiple InfoBoxes so there is just one "main" image to represent the page in galleries.
Questions, feedback and further improvements are welcome!
ToolInfoBox Unnamed Tool | |
---|---|
![]() |
Template Parameters
Pretty much everything that does not qualify as a machine/power tool and is (usually) not a consumable material is called a "tool" in this wiki and should get its own page eventually. Dangerous or complicated tools first, of course!
Parameter | Description | Type | Status | |
---|---|---|---|---|
The name of your tool | tool name | The name of your tool
| String | required |
The (best) German name of your tool (invisible) | german | The (best) German name of your tool (not visible, but usable for advanced pages like automatic galleries) | String | suggested |
An image of the tool (example.jpg) | image | The file name of the image which represents the tool the best. If you do not fill the parameter "extrabox", this will be added to the page as a Semantic MediaWiki property. Do not include 'File:' or '[[', just the file name.
| File | suggested |
Synonyms for the tool's name | synonyms | Existing synonyms for the name of the tool. You might include translations here.
| String | suggested |
Which type of tool is it? | type | Which type of tool is this InfoBox referring to?
| String | optional |
The status of the tool | status | The status of the tool
| String | optional |
Material the tool can be used with | material | Links to materials the tool can be used with. Links should ideally be within our wiki.
| Page name | suggested |
Machines to use the tool with | used with | Links to machines the tool can be used with. Links should ideally be within our wiki
| Page name | optional |
The location of the tool | location | The location of the tool within the CoMakingSpace
| Page name | suggested |
Access requirements (if applicable) | access | If applicable, use this to indicate the access requirements to use the tool
| String | optional |
Maker of the tool (if applicable) | made by | For self-made tools or jigs: who may be able to answer questions (and gets the bragging rights)?
| String | optional |
Tutors for the tool (if applicable) | tutors | List of tutors who can give introductions to the tool
| String | optional |
Link to the manual | manual | Link to the manual of the tool. This should be a public source. If there is no link, indicate where the manual is located in the CoMakingSpace. Leave empty if not applicable | URL | optional |
Donation | donation | Indicate a suggested donation for the use of this tool. This is used mainly for expensive tools which generate maintenance costs based on their usage.
| String | optional |
Links to similar tools | similar | Provide links to similar tools in our wiki. | Page name | optional |
Extrabox? (advanced - if in doubt, ignore this) | extrabox | Apply this parameter if you use the template as an additional InfoBox on a tool page with an existing "main" box. This will remove the "Has Image" parameter from this infobox so its image is NOT included as an SMW property of the page. | Boolean | optional |