Template:ToolBox: Difference between revisions

From Artisans Asylum Wiki
(Created page with "<onlyinclude>__NOTOC__</onlyinclude> {{ToolBox-Base |tool_title = {{{tool_title}}} |tool_subtitle = {{{tool_subtitle}}} |image = {{{image|No_image.jpeg}}} |caption = {{{caption|Real image coming soon}}} |make = {{{make|N/A}}} |model = {{{model|N/A}}} |serial = {{{serial|N/A}}} |manufacturer_specs = {{{manufacturer_specs|N/A}}} |manual = {{{manual|N/A}}} |location = {{{locat...")
 
mNo edit summary
 
(34 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<onlyinclude>__NOTOC__</onlyinclude>
<noinclude>__NOTOC__</noinclude>
 
{{ToolBox-Base
{{ToolBox-Base
|tool_title        = {{{tool_title}}}
|tool_title        = {{{tool_title}}}
|tool_subtitle      = {{{tool_subtitle}}}
|tool_subtitle      = {{{tool_subtitle}}}
|image              = {{{image|No_image.jpeg}}}
|image              = {{{image}}}
|caption            = {{{caption|Real image coming soon}}}
|caption            = {{{caption}}}
|make              = {{{make|N/A}}}
|make              = {{{make}}}
|model              = {{{model|N/A}}}
|model              = {{{model}}}
|serial            = {{{serial|N/A}}}
|serial            = {{{serial}}}
|manufacturer_specs = {{{manufacturer_specs|N/A}}}
|manufacturer_specs = {{{manufacturer_specs}}}
|manual            = {{{manual|N/A}}}
|manual            = {{{manual}}}
|location          = {{{location|unknown}}}
|location          = [[:Category:{{{location}}}|{{{location}}}]]
|rubric            = {{{rubric|ask the shop lead}}}
|rubric            = {{{rubric}}}
|training          = {{{training|N/A}}}
|training          = {{{training}}}
|testing            = {{{testing|N/A}}}
|testing            = {{{testing}}}
|restrictions      = {{{restrictions}}}
}}
}}
 
<includeonly>[[Category:{{{location}}}]][[Category:Tools]]</includeonly>
<includeonly>{{{tool_categories}}}</includeonly>
<includeonly>{{{tool_categories}}}</includeonly>
<noinclude>
<noinclude>


Line 43: Line 42:
|model              = HD1234
|model              = HD1234
|serial            = 48
|serial            = 48
|manufacturer_specs = [http://somewhere.com/product.html From Manufacturer]
|manufacturer_specs = [https://somewhere.com/product.html From manufacturer]
|manual            = [http://somewhere.com/manual.htm |From Manufacturer]
|manual            = [https://somewhere.com/manual.html From manufacturer]
|location          = Woodworking
|location          = Woodworking
|rubric            = {{{rubric|N/A}}}
|training          = {{{training|N/A}}}
|testing            = {{{testing|N/A}}}
|restrictions      = {{{red|green}}}
|tool_categories    = [[Category: Drills]]
|tool_categories    = [[Category: Drills]]
}}
}}
Line 64: Line 67:
   |manual            =  
   |manual            =  
   |location          =  
   |location          =  
  |rubric            =
  |training          =
  |testing            =
  |restrictions      =
   |tool_categories    =  
   |tool_categories    =  
}}
}}
Line 101: Line 108:
<pre>
<pre>
{{ToolBox
{{ToolBox
   |tool_categories = [[Category:SCUL-owned tools]] [[Category:Air Tools]]
   |tool_categories = [[Category:Woodworking Tools]] [[Category:Sanding Tools]]
}}
}}
</pre>
</pre>


In the above example, the tool would be placed into the SCUL-owned tools and Air Tools categories and removed from those categories when the template is switched from ToolBox to ToolBox-Gone.
In the above example, the tool would be placed into the Woodworking Tools and Sanding Tools categories and removed from those categories when the template is switched from ToolBox to ToolBox-Gone.


Do not add the tool species nor the shop category names to the tool_categories field because it will cause inaccuracies in category listings.
Do not add the tool species nor the shop category names to the tool_categories field because it will cause inaccuracies in category listings.
<templatedata>
{
    "description": "Adds an easily scannable information block to a tool page.",
    "params": {
        "tool_title": {
            "label": "Tool name",
            "type": "string",
            "required": true,
            "description": "Tool name (i.e. Makita MGA700 Angle Grinder)",
            "aliases": ["1"]
        },
        "tool_subtitle": {
            "label": "Tool subtitle",
            "type": "string",
            "description": "Subtitle (typically an alternate name)",
            "aliases": ["1"]
        },
        "image": {
            "label": "Image file name",
            "type": "wiki-file-name",
            "description": "File name of a picture of the tool",
            "autovalue": "No_image.jpeg",
            "aliases": ["1"]
        },
        "caption": {
            "label": "Image caption",
            "type": "string",
            "description": "Caption for the picture of the tool",
            "aliases": ["1"]
        },
        "make": {
            "label": "Make",
            "type": "string",
            "description": "Make (i.e. Makita)",
            "aliases": ["1"]
        },
        "model": {
            "label": "Model",
            "type": "string",
            "description": "Model (i.e. MGA700)",
            "aliases": ["1"]
        },
        "serial": {
            "label": "Serial",
            "type": "string",
            "description": "Serial number",
            "autovalue": "Unknown",
            "aliases": ["1"]
        },
        "manufacturer_specs": {
            "label": "Manufacturer specs",
            "type": "string",
            "description": "Wiki-formatted link to product specifications",
            "aliases": ["1"]
        },
        "manual": {
            "label": "Manual",
            "type": "string",
            "description": "Wiki-formatted link to product manual",
            "aliases": ["1"]
        },
        "location": {
            "label": "Location",
            "type": "string",
            "description": "Name of the shop the tool is in (i.e. Wood Shop)",
            "aliases": ["1"]
        },
        "rubric": {
            "label": "Rubric",
            "type": "string",
            "description": "Wiki-formatted link to the tool training rubric",
            "aliases": ["1"]
        },
        "training": {
            "label": "Tool training",
            "type": "string",
            "description": "Wiki-formatted link to class or short description on how to get trained on this tool",
            "autovalue": "[https://www.artisansasylum.com/class-catalog Tool classes]",
            "aliases": ["1"]
        },
        "testing": {
            "label": "Tool testing",
            "type": "string",
            "description": "List of testers or wiki-formatted link to testing signup form",
            "autovalue": "[https://www.artisansasylum.com/tool-testing Tool testing]",
            "aliases": ["1"]
        },
        "restrictions": {
            "label": "Tool restrictions",
            "type": "string",
            "description": "Tool restriction (red or green)",
            "autovalue": "red",
            "aliases": ["1"]
        },
        "tool_categories": {
            "label": "Tool Category",
            "type": "string",
            "description": "Wiki-formatted link to the wiki category the tool is in (i.e. [[Category:Drills]])",
            "aliases": ["1"]
        }
    }
}
</templatedata>


</noinclude>
</noinclude>

Latest revision as of 14:03, 2 February 2024


{{{tool_title}}}
[[File:{{{image}}}|thumb|250px|{{{caption}}}]]
General Info
Make {{{make}}}
Model {{{model}}}
Serial {{{serial}}}
Specs {{{manufacturer_specs}}}
Manual {{{manual}}}
Asylum Info
Location [[:Category:{{{location}}}|{{{location}}}]]
Rubric {{{rubric}}}
Training {{{training}}}
Testing {{{testing}}}
Restrictions {{{restrictions}}}



Usage

This is a template for any publicly-available tool at the Asylum. This template provides information about:

  • Tool specifications
  • Where this tool is
  • How this tool fits into the Asylum's tool training system
  • What tools are available at the Asylum

This is achieved through a MediaWiki-based system described in Help:Tools, Training, and Testing.

Example

{{ToolBox
|tool_title         = Millers Falls HD1234
|tool_subtitle      = Hand drill
|image              = Pic_unrelated_zebra.jpg
|caption            = This is not a picture of the drill
|make               = Millers Falls
|model              = HD1234
|serial             = 48
|manufacturer_specs = [https://somewhere.com/product.html From manufacturer]
|manual             = [https://somewhere.com/manual.html From manufacturer]
|location           = Woodworking
|rubric             = {{{rubric|N/A}}}
|training           = {{{training|N/A}}}
|testing            = {{{testing|N/A}}}
|restrictions       = {{{red|green}}}
|tool_categories    = [[Category: Drills]]
}}

Pasteable version

{{ToolBox
  |tool_title         = 
  |tool_subtitle      = 
  |image              = 
  |caption            = 
  |make               = 
  |model              = 
  |serial             = N/A
  |manufacturer_specs = 
  |manual             = 
  |location           = 
  |rubric             = 
  |training           = 
  |testing            = 
  |restrictions       = 
  |tool_categories    = 
}}

Special Fields

There are several fields that require special consideration in this template.

Species


The species field refers to a wiki category (minus the Category: part of the identifier) for the correct tool species. This will indicate the Asylum training information for the tool. If you don't know the proper value for this field, don't include this line.

{{ToolBox
  |species = Vertical Band Saws
}}

Location

The location field refers to a wiki category (minus the Category: part of the identifier) for the correct Shop. This will place a listing for the tool on that Shop category page. If you don't know the proper value for this field, don't include this line.

{{ToolBox
  |location = Woodworking
}}

Tool Categories

When tools are permanently removed from the Asylum, they are switched to the ToolBox-Gone Template. This is as simple as changing the name of the template.

Using the template system is the easiest way to remove decommissioned tools from category listings on the wiki. Put the categories inside the template instead of listing the categories at the bottom of the article. Only the main ToolBox template will apply the categories, which means less editing to keep everything accurate.

{{ToolBox
  |tool_categories = [[Category:Woodworking Tools]] [[Category:Sanding Tools]]
}}

In the above example, the tool would be placed into the Woodworking Tools and Sanding Tools categories and removed from those categories when the template is switched from ToolBox to ToolBox-Gone.

Do not add the tool species nor the shop category names to the tool_categories field because it will cause inaccuracies in category listings.

Adds an easily scannable information block to a tool page.

Template parameters

ParameterDescriptionTypeStatus
Tool nametool_title 1

Tool name (i.e. Makita MGA700 Angle Grinder)

Stringrequired
Tool subtitletool_subtitle 1

Subtitle (typically an alternate name)

Stringoptional
Image file nameimage 1

File name of a picture of the tool

Auto value
No_image.jpeg
Fileoptional
Image captioncaption 1

Caption for the picture of the tool

Stringoptional
Makemake 1

Make (i.e. Makita)

Stringoptional
Modelmodel 1

Model (i.e. MGA700)

Stringoptional
Serialserial 1

Serial number

Auto value
Unknown
Stringoptional
Manufacturer specsmanufacturer_specs 1

Wiki-formatted link to product specifications

Stringoptional
Manualmanual 1

Wiki-formatted link to product manual

Stringoptional
Locationlocation 1

Name of the shop the tool is in (i.e. Wood Shop)

Stringoptional
Rubricrubric 1

Wiki-formatted link to the tool training rubric

Stringoptional
Tool trainingtraining 1

Wiki-formatted link to class or short description on how to get trained on this tool

Auto value
[https://www.artisansasylum.com/class-catalog Tool classes]
Stringoptional
Tool testingtesting 1

List of testers or wiki-formatted link to testing signup form

Auto value
[https://www.artisansasylum.com/tool-testing Tool testing]
Stringoptional
Tool restrictionsrestrictions 1

Tool restriction (red or green)

Auto value
red
Stringoptional
Tool Categorytool_categories 1

Wiki-formatted link to the wiki category the tool is in (i.e. [[Category:Drills]])

Stringoptional