Template:ToolBox: Difference between revisions

From Artisans Asylum Wiki
mNo edit summary
mNo edit summary
Line 144: Line 144:
             "type": "string",
             "type": "string",
             "description": "Caption for the picture of the shop",
             "description": "Caption for the picture of the shop",
            "aliases": ["1"]
        },
        "tool_subtitle": {
            "label": "Tool subtitle",
            "type": "string",
            "description": "Subtitle (typically type of tool or nickname)",
             "aliases": ["1"]
             "aliases": ["1"]
         },
         },

Revision as of 18:15, 30 January 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

Name of the tool (i.e. Makita MGA700 Angle Grinder)

Stringrequired
Tool subtitletool_subtitle 1

Subtitle (typically type of tool or an alternate name)

Stringoptional
Image file nameimage 1

File name of a picture of the shop

Auto value
No_image.jpeg
Fileoptional
Image captioncaption 1

Caption for the picture of the shop

Stringoptional
Makemake 1

Tool make (i.e. Makita)

Stringoptional
Modelmodel 1

Tool model (i.e. MGA700)

Stringoptional
Serialserial 1

Serial number

Stringoptional
Manufacturer specsmanufacturer_specs 1

Link to product specifications

Stringoptional
Manualmanual 1

Link to product manual

Stringoptional
Locationlocation 1

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

Stringoptional
rubricrubric 1

Link to the tool training rubric

Stringoptional
Tool trainingtraining 1

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 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
Open hourstool_categories 1

Link to category page(s) for tool is in (i.e. Category: Drills)

Stringoptional