Template:ToolInfoBox: Difference between revisions
(added "extrabox" & HasImage functionality for use with semantic image queries) |
NitramLegov (talk | contribs) (add template parameter) |
||
Line 144: | Line 144: | ||
[[Has caption::{{#if: {{{extrabox|}}} | |{{PAGENAME}}}}| ]] | [[Has caption::{{#if: {{{extrabox|}}} | |{{PAGENAME}}}}| ]] | ||
[[Has redirect::{{#if: {{{extrabox|}}} | |{{PAGENAME}}}}| ]] | [[Has redirect::{{#if: {{{extrabox|}}} | |{{PAGENAME}}}}| ]] | ||
<noinclude> | |||
<templatedata> | |||
{ | |||
"params": { | |||
"tool name": { | |||
"label": "The name of your tool", | |||
"description": "The name of your tool", | |||
"type": "string", | |||
"default": "Unnamed Tool", | |||
"required": true | |||
}, | |||
"extrabox": { | |||
"label": "Extrabox?", | |||
"description": "Apply this parameter if you use the template as an additional InfoBox on a tool page. This will remove the \"Has Image\" parameter from this infobox.", | |||
"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 \"extabox\", this will be added as a Semantic MediaWiki parameter to the page.", | |||
"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": "Hand Tool or Power Tool", | |||
"suggested": true, | |||
"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]]", | |||
"type": "wiki-page-name" | |||
}, | |||
"location": { | |||
"label": "The location of the tool", | |||
"description": "The location of the tool within the CoMakingSpace", | |||
"example": "[[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" | |||
}, | |||
"tutors": { | |||
"label": "Tutors for the tool (if applicable)", | |||
"description": "List of tutors which 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", | |||
"image", | |||
"synonyms", | |||
"type", | |||
"status", | |||
"material", | |||
"used with", | |||
"location", | |||
"access", | |||
"tutors", | |||
"manual", | |||
"donation", | |||
"similar", | |||
"extrabox" | |||
] | |||
} | |||
</templatedata> | |||
</noinclude> |
Revision as of 14:40, 3 March 2021
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= |image= |synonyms= |type= |status= |material= |used with= |location= |access= |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 |image=cheap woodturning tools.JPG |synonyms=DE: Drechseleisen, Drechselmesser |type= |status= |material=[[wood]] |used with=[[Wood Lathe|wood lathe]] |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 - 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::".
You can use it when you don't want the InfoBox to set a "Has image::" value (as it automatically does for "image"). 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 | |
---|---|
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 |
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 "extabox", this will be added as a Semantic MediaWiki parameter to the page.
| 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 | suggested |
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 | 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 | optional |
The location of the tool | location | The location of the tool within the CoMakingSpace
| Page | suggested |
Access requirements (if applicable) | access | If applicable, use this to indicate the access requirements to use the tool
| String | optional |
Tutors for the tool (if applicable) | tutors | List of tutors which 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 | optional |
Extrabox? | extrabox | Apply this parameter if you use the template as an additional InfoBox on a tool page. This will remove the "Has Image" parameter from this infobox. | Boolean | optional |