Template:ToolInfoBox: Difference between revisions

From CoMakingSpace Wiki

(changed categorization to "Tools" instead of "Hardware"; made "tutors" parameter optional (also see #130))
(invisible page contents (category, SMW) inside the wikitable code were only okay if the "similar" field was unused, otherwise the empty lines appeared there. New solution: all in one line...)
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<noinclude>{{ToolInfoBox
<noinclude>{{ToolInfoBox
|tool name=Example: Scroll Saw
|tool name=Example: Woodturning Tools
|image=scroll saw.JPG
|image=cheap woodturning tools.JPG
|synonyms=DE: Dekupiersäge,<br>Feinschnittsäge
|synonyms=DE: Drechseleisen, Drechselmesser
|type=power tool/[[:Category:Saws|saw]]
|type=
|status=functional
|status=
|access=upon introduction
|material=[[wood]]
|used with=[[Shop Vac|shop vac]]
|used with=[[Wood Lathe|wood lathe]]
|location=[[Wood Workshop|wood workshop]]
|location=[[Wood Workshop|wood workshop]]<br>(wall above wood lathe)
|material=[[wood]], [[Acrylic Glass|acrylic glass]], [[metal]]
|access=[[Woodturning Introduction|woodturning introduction]]
|tutors=[[User:Lukas|Lukas]], [[User:Mitja|Mitja]]
|tutors=[[Lukas]]
|manual=
|manual=
|similar=[[fretsaw]], [[bandsaw]], ''[[Laser Cutter|laser cutter]]''
|donation=
|similar=
}}
}}


Pretty much everything that does not qualify as a [[Template:MachineInfoBox|machine/power tool]] and is (usually) not a consumable [[material]] 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 21: Line 22:
{{ToolInfoBox
{{ToolInfoBox
|tool name=
|tool name=
|german=
|image=
|image=
|synonyms=
|synonyms=
Line 40: Line 42:
<pre>
<pre>
{{ToolInfoBox
{{ToolInfoBox
|tool name=Example: Scroll Saw
|tool name=Example: Woodturning Tools
|image=scroll saw.JPG
|german=
|synonyms=DE: Dekupiersäge,<br>Feinschnittsäge
|image=cheap woodturning tools.JPG
|type=power tool/[[:Category:Saws|saw]]
|synonyms=DE: Drechseleisen, Drechselmesser
|status=functional
|type=
|access=upon introduction
|status=
|used with=[[Shop Vac|shop vac]]
|material=[[wood]]
|location=[[Wood Workshop|wood workshop]]
|used with=[[Wood Lathe|wood lathe]]
|material=[[wood]], [[Acrylic Glass|acrylic glass]], [[metal]]
|location=[[Location::Wood Workshop|wood workshop]]<br>(wall above wood lathe)
|tutors=[[User:Lukas|Lukas]], [[User:Mitja|Mitja]]
|access=[[Woodturning Introduction|woodturning introduction]]
|tutors=[[Lukas]]
|manual=
|manual=
|similar=[[fretsaw]], [[bandsaw]], ''[[Laser Cutter|laser cutter]]''
|donation=
|similar=
}}
}}
</pre>
</pre>


There are a few tool categories such as [[woodworking]] or [[saws]] - please also [[Help:Wiki Basics#Categories & Namespaces|categorize]] your page to make it easier to find!
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!


</noinclude>
== 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 75: Line 84:
{{!}}-
{{!}}-
{{!}} Type:
{{!}} Type:
{{!}} {{{type|hand tool or power tool?}}}
{{!}} {{{type|tool classification?}}}
|}}
|}}
|-
|-
Line 131: Line 140:
{{!}}  {{{similar}}}
{{!}}  {{{similar}}}
|}}   
|}}   
|}
|}[[Category:Tools]] [[Has caption::{{#if: {{{extrabox|}}} | |{{PAGENAME}}}}| ]] {{#if:{{{german|}}} | [[Has German::{{{german}}}|]] | }}<noinclude>
[[Category:Tools]]
 
== 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"
},
"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",
"tutors",
"manual",
"donation",
"similar",
"extrabox"
]
}
</templatedata>
</noinclude>

Latest revision as of 12:34, 7 September 2022

ToolInfoBox

Example: Woodturning Tools

Cheap woodturning tools.JPG
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=
|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

Tool-default.png

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!

Template parameters

ParameterDescriptionTypeStatus
The name of your tooltool name

The name of your tool

Default
Unnamed Tool
Stringrequired
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)

Stringsuggested
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.

Default
tool-default.png
Filesuggested
Synonyms for the tool's namesynonyms

Existing synonyms for the name of the tool. You might include translations here.

Example
DE: Schraubendreher
Stringsuggested
Which type of tool is it?type

Which type of tool is this InfoBox referring to?

Example
[[saw]]
Stringoptional
The status of the toolstatus

The status of the tool

Example
available / broken
Stringoptional
Material the tool can be used withmaterial

Links to materials the tool can be used with. Links should ideally be within our wiki.

Example
[[wood]]
Pagesuggested
Machines to use the tool withused with

Links to machines the tool can be used with. Links should ideally be within our wiki

Example
[[Wood Lathe|wood lathe]]
Pageoptional
The location of the toollocation

The location of the tool within the CoMakingSpace

Example
[[Location::Wood Workshop|wood workshop]]
Pagesuggested
Access requirements (if applicable)access

If applicable, use this to indicate the access requirements to use the tool

Example
ask nicely
Stringoptional
Tutors for the tool (if applicable)tutors

List of tutors who can give introductions to the tool

Example
[[Tutor::User:Lukas|Lukas]]
Stringoptional
Link to the manualmanual

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

URLoptional
Donationdonation

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
Stringoptional
Links to similar toolssimilar

Provide links to similar tools in our wiki.

Pageoptional
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.

Booleanoptional