Template:FormatInfoBox: Difference between revisions
Created page with "{| class="wikitable" style="float:right; margin-left: 10px; border-style: solid; border-width: 5px; border-color: blue" !colspan="2"|<small style="float:right">Template:Form..." |
NitramLegov (talk | contribs) m Template Data |
||
| Line 38: | Line 38: | ||
</pre> | </pre> | ||
In addition to giving readers a quick glance of the format, the template automatically adds the page to the [[:Category:Software|"Software" category]]. Feel free to link other suitable categories by hand, e.g. <code><nowiki>[[Category:Design]]</nowiki></code> for common CAD formats! | In addition to giving readers a quick glance of the format, the template automatically adds the page to the [[:Category:Software|"Software" category]]. Feel free to link other suitable categories by hand, e.g. <code><nowiki>[[Category:Design]]</nowiki></code> for common CAD formats! | ||
<noinclude> | |||
== Template Parameters == | |||
<templatedata> | |||
{ | |||
"params": { | |||
"format name": { | |||
"label": "The name of the format", | |||
"description": "Please provide the name of the format you are providing information about", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"image": { | |||
"label": "Image", | |||
"description": "If there is any, feel free to provide an image which represents the format in a good way", | |||
"type": "wiki-file-name", | |||
"suggested": true | |||
}, | |||
"extension": { | |||
"label": "Extension", | |||
"description": "If needed, provide the extensions that identify your format", | |||
"example": ".jpg", | |||
"type": "string" | |||
}, | |||
"type": { | |||
"label": "Format Type", | |||
"description": "If valuable, please provide a (rough) type that would describe your format in a good way", | |||
"example": "2D or 3D CAD", | |||
"type": "string" | |||
}, | |||
"software": { | |||
"label": "Software", | |||
"description": "Please provide the software that can be used to edit/create the format you´re describing", | |||
"type": "string" | |||
}, | |||
"machines": { | |||
"label": "Machines", | |||
"description": "Are there any machines that depend on this format?", | |||
"example": "[[LaserCutter]]", | |||
"type": "wiki-page-name" | |||
}, | |||
"repositories": { | |||
"label": "Repositories", | |||
"description": "Are there any repositories online that provide more information about the format you´re describing", | |||
"type": "url" | |||
} | |||
}, | |||
"description": "Provide information about a (software) format you have used", | |||
"paramOrder": [ | |||
"format name", | |||
"image", | |||
"extension", | |||
"type", | |||
"software", | |||
"machines", | |||
"repositories" | |||
] | |||
} | |||
</templatedata> | |||
</noinclude> | |||
Latest revision as of 22:38, 14 March 2022
| FormatInfoBox Unnamed Format | |
|---|---|
| File Extension(s): | |
| Type: | e.g. 2D or 3D CAD |
| Software: | how to edit/create? |
| Machines: | which of our machines depend on it? |
| Repositories: | can you find examples online? |
This InfoBox is intended to give readers a quick overview of a file format page.
Documentation
To use this template, simply insert this code at the top of your page and enter the relevant parameters:
{{FormatInfoBox
|format name=
|image=
|extension=
|type=
|software=
|machines=
|repositories=
}}
In addition to giving readers a quick glance of the format, the template automatically adds the page to the "Software" category. Feel free to link other suitable categories by hand, e.g. [[Category:Design]] for common CAD formats!
Template Parameters
Provide information about a (software) format you have used
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| The name of the format | format name | Please provide the name of the format you are providing information about | String | required |
| Image | image | If there is any, feel free to provide an image which represents the format in a good way | File | suggested |
| Extension | extension | If needed, provide the extensions that identify your format
| String | optional |
| Format Type | type | If valuable, please provide a (rough) type that would describe your format in a good way
| String | optional |
| Software | software | Please provide the software that can be used to edit/create the format you´re describing | String | optional |
| Machines | machines | Are there any machines that depend on this format?
| Page name | optional |
| Repositories | repositories | Are there any repositories online that provide more information about the format you´re describing | URL | optional |