Template:Tool: Difference between revisions
From 10BitWorks Makerspace Wiki
No edit summary Tag: Manual revert |
mNo edit summary Tag: Manual revert |
||
(68 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Tool | <noinclude>__NOTOC__</noinclude> | ||
| | {{Tool-Blank | ||
|tool_nickname = {{{tool_nickname}}} | |tool_fullname = {{{tool_fullname}}} | ||
|tool_nickname = {{{tool_nickname|}}} | |||
|image = {{{image}}} | |image = {{{image}}} | ||
|img_caption = {{{img_caption}}} | |img_caption = {{{img_caption}}} | ||
|status = {{{status}}} | |status = {{{status|}}} | ||
|make = {{{make}}} | |make = {{{make|}}} | ||
|model = {{{model}}} | |model = {{{model|}}} | ||
|serial = {{{serial}}} | |serial = {{{serial|}}} | ||
|manufacturer_specs = {{{manufacturer_specs}}} | |manufacturer_specs = {{{manufacturer_specs|}}} | ||
|manual = {{{manual}}} | |manual = [[Media:{{{manual}}}]] | ||
|location = {{{location}}} | |area = [[{{{area|}}}]] | ||
|private_owner | |location = {{{location|}}} | ||
|private_access | |private_owner = {{{private_owner|}}} | ||
|training | |private_access = {{{private_access|}}} | ||
|restrictions = {{{restrictions}}} | |training = {{{training|}}} | ||
|restrictions = {{{restrictions|}}} | |||
}} | }} | ||
<includeonly>[[Category:Tools]][[Category:{{{area}}}]]</includeonly> | |||
<noinclude> | <noinclude> | ||
== Usage == | |||
* A template to add at the top of every tool page with basic tool information | |||
=== Method 1 [preferred]: Using the visual editor === | |||
* Under Insert Menu, choose template | |||
* search for Tool under available template | |||
* click parameters required in left window, fill out text boxes in right window | |||
* some suggested defaults will be shown for different parameters | |||
=== Method 2: Copy paste the blank text version below, filling as much as data is available === | |||
== Copy Paste version == | |||
<pre> | |||
{{Tool | |||
|tool_fullname = | |||
|tool_nickname = | |||
|image = | |||
|img_caption = | |||
|status = | |||
|make = | |||
|model = | |||
|serial = | |||
|manufacturer_specs = | |||
|manual = | |||
|area = | |||
|location = | |||
|private_owner = | |||
|private_access = | |||
|training = | |||
|restrictions = | |||
}} | |||
</pre> | |||
== Example Tool == | |||
grab data from sawstop tool | |||
<templatedata> | <templatedata> | ||
{ | { | ||
"params": { | "params": { | ||
"tool_nickname": { | "tool_nickname": { | ||
"type": "string" | "type": "string", | ||
"aliases": [ | |||
"1" | |||
], | |||
"label": "Tool nickname", | |||
"description": "Alternate or nickname", | |||
"example": "Big Red Laser" | |||
}, | }, | ||
"image": { | "image": { | ||
"type": "wiki-file-name" | "type": "wiki-file-name", | ||
"aliases": [ | |||
"1" | |||
], | |||
"description": "Wiki filename of tool picture", | |||
"example": "Sawstop.jpg", | |||
"suggested": true | |||
}, | |||
"img_caption": { | |||
"type": "string", | |||
"aliases": [ | |||
"1" | |||
], | |||
"label": "Image caption", | |||
"description": "Image caption", | |||
"example": "This is the sawstop saw" | |||
}, | |||
"status": { | |||
"type": "string", | |||
"aliases": [ | |||
"1" | |||
], | |||
"description": "Tool Readiness", | |||
"example": "Working", | |||
"suggestedvalues": [ | |||
"Maintenance ", | |||
"Repair Needed", | |||
"Other", | |||
"Working" | |||
], | |||
"default": "Working", | |||
"suggested": true | |||
}, | |||
"make": { | |||
"type": "string", | |||
"aliases": [ | |||
"1" | |||
], | |||
"label": "manufacturer", | |||
"description": "manufacturer", | |||
"example": "Sawstop" | |||
}, | |||
"model": { | |||
"type": "string", | |||
"aliases": [ | |||
"1" | |||
], | |||
"label": "Model", | |||
"description": "Model", | |||
"example": "CNS175" | |||
}, | |||
"serial": { | |||
"type": "string", | |||
"aliases": [ | |||
"1" | |||
], | |||
"label": "Serial", | |||
"description": "Serial number", | |||
"example": "4857833853", | |||
"autovalue": "" | |||
}, | |||
"manufacturer_specs": { | |||
"type": "url", | |||
"label": "Manufacturer specs", | |||
"description": "URL link to product specifications", | |||
"example": "[[Fancy sawstop specifications]]" | |||
}, | |||
"manual": { | |||
"type": "string", | |||
"label": "Manual", | |||
"description": "Wiki link to product manual file page", | |||
"example": "Sawstop manual.pdf", | |||
"default": "missing_manual.pdf", | |||
"suggested": true | |||
}, | |||
"area": { | |||
"type": "string", | |||
"description": "Which main area of 10bits is this tool physically at", | |||
"example": "Woodworking", | |||
"required": true | |||
}, | |||
"location": { | |||
"type": "string", | |||
"aliases": [ | |||
"1" | |||
], | |||
"description": "Further description of physical location if needed", | |||
"example": "Front and Left corner in the Woodworking, next to the outgoing wood scrap" | |||
}, | |||
"private_owner": { | |||
"type": "string", | |||
"aliases": [ | |||
"1" | |||
], | |||
"description": "Owner, if machine on loan", | |||
"example": "Ken" | |||
}, | |||
"private_access": { | |||
"type": "string", | |||
"aliases": [ | |||
"1" | |||
], | |||
"description": "Area, group, or individuals that may use tool" | |||
}, | |||
"training": { | |||
"type": "string", | |||
"aliases": [ | |||
"1" | |||
], | |||
"description": "Any additional training requirements" | |||
}, | |||
"restrictions": { | |||
"type": "string", | |||
"aliases": [ | |||
"1" | |||
], | |||
"description": "List any additional tool usage restrictions or requirements" | |||
}, | }, | ||
"tool_fullname": { | "tool_fullname": { | ||
"type": "string", | "type": "string", | ||
"required": true | "required": true, | ||
"aliases": [ | |||
"1" | |||
], | |||
"label": "Tool name", | |||
"description": "Tool's full name", | |||
"example": "Sawstop Contractor Table Saw" | |||
} | } | ||
}, | }, | ||
"paramOrder": [ | "paramOrder": [ | ||
"tool_fullname", | "tool_fullname", | ||
Line 57: | Line 209: | ||
"manufacturer_specs", | "manufacturer_specs", | ||
"manual", | "manual", | ||
" | "area", | ||
"location", | "location", | ||
"private_owner", | "private_owner", | ||
"private_access", | "private_access", | ||
"training", | "training", | ||
"restrictions", | "restrictions" | ||
], | |||
"description": "A template for any 10bit tool currently onsite.", | |||
"format": "block" | |||
} | } | ||
</templatedata> | </templatedata> | ||
</noinclude> | </noinclude> |
Latest revision as of 04:30, 19 May 2024
{{{tool_fullname}}} | |
---|---|
[[File:{{{image}}}|thumb|280px|{{{img_caption}}}]] | |
General Info | |
Status | |
Make | |
Model | |
Serial | |
Specs | |
Manual | [[Media:{{{manual}}}]] |
10Bit Data | |
Area | [[]] |
Private Owner | |
Private Access | |
Training | |
Restrictions |
Usage
- A template to add at the top of every tool page with basic tool information
Method 1 [preferred]: Using the visual editor
- Under Insert Menu, choose template
- search for Tool under available template
- click parameters required in left window, fill out text boxes in right window
- some suggested defaults will be shown for different parameters
Method 2: Copy paste the blank text version below, filling as much as data is available
Copy Paste version
{{Tool |tool_fullname = |tool_nickname = |image = |img_caption = |status = |make = |model = |serial = |manufacturer_specs = |manual = |area = |location = |private_owner = |private_access = |training = |restrictions = }}
Example Tool
grab data from sawstop tool
A template for any 10bit tool currently onsite.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Tool name | tool_fullname 1 | Tool's full name
| String | required |
Tool nickname | tool_nickname 1 | Alternate or nickname
| String | optional |
image | image 1 | Wiki filename of tool picture
| File | suggested |
Image caption | img_caption 1 | Image caption
| String | optional |
status | status 1 | Tool Readiness
| String | suggested |
manufacturer | make 1 | manufacturer
| String | optional |
Model | model 1 | Model
| String | optional |
Serial | serial 1 | Serial number
| String | optional |
Manufacturer specs | manufacturer_specs | URL link to product specifications
| URL | optional |
Manual | manual | Wiki link to product manual file page
| String | suggested |
area | area | Which main area of 10bits is this tool physically at
| String | required |
location | location 1 | Further description of physical location if needed
| String | optional |
private_owner | private_owner 1 | Owner, if machine on loan
| String | optional |
private_access | private_access 1 | Area, group, or individuals that may use tool | String | optional |
training | training 1 | Any additional training requirements | String | optional |
restrictions | restrictions 1 | List any additional tool usage restrictions or requirements | String | optional |