Template:MachineInfoBox
| MachineInfoBox Example: 3D Printer | |
|---|---|
| |
| Material: | 1.75 mm filament |
| Access Requirements: | The query description has an empty condition. |
| Software: | Cura |
| Firmware: | Marlin |
| Tutors: | |
We call pretty much all electric devices and big or small power tools "machines" in this wiki. Their pages should contain this InfoBox!
Documentation
To use this template, simply copy this code into your page and enter the relevant parameters:
{{MachineInfoBox
|machine name=
|german=
|image=
|synonyms=
|manual=
|material=
|used with=
|similar=
|software=
|firmware=
|assetid=
}}
Most fields will only be shown when used, so the box can be more or less detailed. Make frequent use of the "Show preview" button and it should be clear.
For example, entering the following leads to the box on the right:
{{MachineInfoBox
|machine name= Example: 3D Printer
|german=3D-Drucker
|image=Prusa i3 MK2S.JPG
|manual=
|material=[[3D Printing Materials|1.75 mm filament]]
|used with=
|similar=
|software=[[Cura]]
|firmware=[[Marlin]]
|assetid=
}}
Advanced Users (SMW)
There is a "hidden" parameter in this template that's not in the copy template: extrabox. To enable extrabox, just give it any value (e.g. "true", "blablabla") and it should cause the box to behave as an extra without "Has image::".
You can use it when you don't want the InfoBox to set a "Has image::" and "Has German::" value (as it automatically does for "image" and "german"). That's useful on pretty much every page with multiple InfoBoxes so there is just one "main" image to represent the page in galleries.
"Machinetype::" is automatically determined from the "assetid" parameter by using data of our internal asset management system. We use this property to "outsource" individual machine pages from the general overview content, so it is important to get it right.
"Access" and "Tutors" should automatically gather their content from the SMW property "Introduction for::" since January 2022. This works based on the page name or machine type. A link is added automatically for easy navigation to the "parent" page and as an easy way to check possible values.
Questions, feedback and further improvements are welcome!
| MachineInfoBox Unnamed Machine | |
|---|---|
| |
| Access Requirements: | [[Needs Introduction::Some use of "" in your query was not closed by a matching "".]] |
| Tutors: | |
Template Parameters
We call pretty much all electric devices and big or small power tools "machines" in this wiki. Their pages should contain this InfoBox!
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| The name of your machine | machine name | The name of your machine
| String | required |
| The (best) German name of your machine (invisible) | german | The (best) German name of your machine (not visible, but usable for advanced pages like automatic galleries) | String | suggested |
| An image of the machine (example.jpg) | image | The file name of the image which best represents the machine. If you do not fill the parameter "extrabox", this will be added to the page as a Semantic MediaWiki property. Do not include 'File:' or '[[', just the file name.
| File | suggested |
| Asset ID | assetid | The asset ID in our internal asset management system. Setting this parameter will automatically determine the status, location and type of the tool. | Number | suggested |
| Synonyms for the machine's name | synonyms | Existing synonyms for the name of the machines. You might include translations here.
| String | suggested |
| Link to the manual | manual | Link to the manual of the machine. This should be a public source. If there is no link, indicate where the manual is located in the CoMakingSpace. Leave empty if not applicable | URL | suggested |
| Material the machine can be used with | material | Links to materials the machine can be used with. Links should ideally be within our wiki.
| Page name | suggested |
| Tools to use the machine with | used with | Links to tools the machine can be used with. Links should ideally be within our wiki
| Page name | optional |
| Links to similar machines | similar | Provide links to similar machines or tools in our wiki. | Page name | optional |
| Software | software | Does the machine require a computer with a certain software?
| String | optional |
| Firmware | firmware | Is a firmware installed on the machine that may need to be maintained?
| String | optional |
| Extrabox? (advanced - if in doubt, ignore this) | extrabox | Apply this parameter if you use the template as an additional InfoBox on a machine page with an existing "main" box. This will remove the "Has Image" parameter from this infobox so its image is NOT included as an SMW property of the page. | Boolean | optional |
| The status of the machine (legacy) | status | Legacy parameter (automatically determined from "assetid" - ask a manager!) | String | deprecated |
| The location of the tool (legacy) | location | Legacy parameter (automatically determined from "assetid" - ask a manager!) | Page name | deprecated |
| Which type of machine is it? (legacy) | type | Legacy parameter (automatically determined from "assetid" - ask a manager!) | String | deprecated |
| Access requirements (legacy) | access | Legacy parameter (automatically determined from SMW properties) | String | deprecated |
| Tutors for the machine (legacy) | tutors | Legacy parameter (automatically determined from SMW properties) | String | deprecated |
