Template:MaterialInfoBox: Difference between revisions
m (typo) |
NitramLegov (talk | contribs) m (Template Data) |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 67: | Line 67: | ||
{{#if: {{{donation|}}} | | {{#if: {{{donation|}}} | | ||
{{!}}- | {{!}}- | ||
{{!}} Suggested [[ | {{!}} Suggested [[Donation Boxes|Donation]]: | ||
{{!}} {{{donation|}}} | {{!}} {{{donation|}}} | ||
|}} | |}} | ||
Line 98: | Line 98: | ||
|}} | |}} | ||
|} | |} | ||
<noinclude> | |||
== Template Parameters == | |||
<templatedata> | |||
{ | |||
"params": { | |||
"material name": { | |||
"label": "The name of your material", | |||
"description": "The name of your material", | |||
"example": "Nails", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"image": { | |||
"label": "An image for your material (example.jpg)", | |||
"description": "The file name of the image which represents your material the best.", | |||
"type": "wiki-file-name", | |||
"suggested": true | |||
}, | |||
"synonyms": { | |||
"label": "Synonyms", | |||
"description": "Synonyms for the name of the material which might help others searching for this material. E.g. provide german names.", | |||
"suggested": true | |||
}, | |||
"available": { | |||
"label": "Availability indictor", | |||
"description": "An indicator, whether the material is available at the CoMakingSpace", | |||
"type": "boolean" | |||
}, | |||
"donation": { | |||
"label": "Suggested donation", | |||
"description": "The value of a suggested donation people should make when consuming the material", | |||
"type": "number" | |||
}, | |||
"location": { | |||
"label": "Material location", | |||
"description": "The place the material is located at the CoMakingSpace", | |||
"example": "[[Location::Wood Workshop]]", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"tools": { | |||
"label": "Tools", | |||
"description": "A list of tools the material can be used with", | |||
"example": "[[hammers]]", | |||
"type": "string" | |||
}, | |||
"used with": { | |||
"label": "Used with", | |||
"description": "Anything else (e.g. other materials) the material is used with", | |||
"example": "[[Wood Glue]]", | |||
"type": "string" | |||
}, | |||
"contains": { | |||
"label": "Contains", | |||
"description": "Anything the material contains you deem important", | |||
"type": "string" | |||
}, | |||
"similar": { | |||
"label": "Similar Material", | |||
"description": "A list of materials that are similar to the one you describe" | |||
} | |||
}, | |||
"description": "Provide information about a material you have used or know." | |||
} | |||
</templatedata> | |||
</noinclude> |
Revision as of 22:27, 13 March 2022
MaterialInfoBox Example: Nails | |
---|---|
Synonyms: | DE: Nägel, Drahtstifte |
On Site? | yes |
Suggested Donation: | 3 ct |
Location: | wood workshop |
Suggested Tools: | hammers, pincers, drift punch |
Used with: | wood, wood glue |
Contains: | usually galvanized iron ("wire nails") or steel |
Similar (More or Less): | screws, staples, rivets |
We call everything that is consumed and incorporated into a project a "material" - this InfoBox is intended to provide a quick and easy overview over each material, similar to the MachineInfoBox and ToolInfoBox.
Documentation
To use this template, simply copy this code into your page and enter the relevant parameters:
{{MaterialInfoBox |material name= |image= |synonyms= |available= |donation= |location= |tools= |used with= |contains= |similar= }}
For example, entering the following leads to the box on the right:
{{MaterialInfoBox |material name=Example: Nails |image=Alte Nägel.jpg |synonyms=DE: Nägel,<br>Drahtstifte |available=yes |donation=3 ct |location=[[Wood Workshop|wood workshop]] |tools=[[hammers]], [[pincers]],<br>[[Punches#Drift Punch|drift punch]] |used with=[[wood]], [[Wood Glue|wood glue]] |contains=usually galvanized iron<br>("wire nails") or steel |similar=[[screws]], [[staples]], [[rivets]] }}
You can also leave a field empty and it will either disappear or be filled with a default value. Make frequent use of the "Show preview" button while editing and it should be clear.
Please also check whether your page matches one of the material categories and, if so, categorize it so it is found more easily!
MaterialInfoBox Unnamed Material | |
---|---|
Synonyms: | or in German? |
Suggested Tools: |
Template Parameters
Provide information about a material you have used or know.
Parameter | Description | Type | Status | |
---|---|---|---|---|
The name of your material | material name | The name of your material
| String | required |
An image for your material (example.jpg) | image | The file name of the image which represents your material the best. | File | suggested |
Synonyms | synonyms | Synonyms for the name of the material which might help others searching for this material. E.g. provide german names. | Unknown | suggested |
Availability indictor | available | An indicator, whether the material is available at the CoMakingSpace | Boolean | optional |
Suggested donation | donation | The value of a suggested donation people should make when consuming the material | Number | optional |
Material location | location | The place the material is located at the CoMakingSpace
| String | suggested |
Tools | tools | A list of tools the material can be used with
| String | optional |
Used with | used with | Anything else (e.g. other materials) the material is used with
| String | optional |
Contains | contains | Anything the material contains you deem important | String | optional |
Similar Material | similar | A list of materials that are similar to the one you describe | Unknown | optional |