Template:MachineInfoBox: Difference between revisions

From CoMakingSpace Wiki

(added template parameters)
m (fix css syntax)
 
(45 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<noinclude>{{MachineInfoBox
<noinclude>{{MachineInfoBox
|machine name= Example: 3D Printer
|machine name= Example: 3D Printer
|german=3D-Drucker
|image=Prusa i3 MK2S.JPG
|image=Prusa i3 MK2S.JPG
|extrabox=yes
|extrabox=yes
|access=upon introduction
|access=
|status=working
|status=working
|type=[[CNC]] (additive manufacturing)
|type=
|location=[[3D Printer Farm|3D printer farm]]
|location=[[Electronics Room|Electronics Room]]
|material=[[3D Printing Materials|1.75 mm filament]]
|material=[[3D Printing Materials|1.75 mm filament]]
|used with=
|used with=
|firmware=[[Marlin]]
|firmware=[[Marlin]]
|software=[[Cura]]
|software=[[Cura]]
|tutors=[[User:Mitja|Mitja]], [[User:Lukas|Lukas]]
|tutors=
|manual=
|manual=
|similar=
|similar=
|assetid=
}}
}}
We call pretty much all electric devices and big or small power tools "[[machines]]" in this wiki. Their pages should contain this [[InfoBoxes|InfoBox]]!
We call pretty much all electric devices and big or small power tools "[[machines]]" in this wiki. Their pages should contain this [[InfoBoxes|InfoBox]]!
Line 22: Line 24:
{{MachineInfoBox
{{MachineInfoBox
|machine name=
|machine name=
|german=
|image=
|image=
|synonyms=
|synonyms=
Line 27: Line 30:
|material=
|material=
|location=
|location=
|access=
|status=
|status=
|firmware=
|firmware=
|software=
|software=
|manual=
|manual=
|tutors=
|used with=
|used with=
|similar=
|similar=
|assetid=
}}
}}
</pre>
</pre>
Line 43: Line 45:
{{MachineInfoBox
{{MachineInfoBox
|machine name= Example: 3D Printer
|machine name= Example: 3D Printer
|german=3D-Drucker
|image=Prusa i3 MK2S.JPG
|image=Prusa i3 MK2S.JPG
|access=[[3D Printer Introduction|3D printer introduction]]
|status=working
|status=working
|type=[[CNC]] (additive manufacturing)
|type=
|location=[[3D Printer Farm|3D printer farm]]
|location=[[Location::Electronics Room|Electronics Room]]
|material=[[3D Printing Materials|1.75 mm filament]]
|material=[[3D Printing Materials|1.75 mm filament]]
|used with=
|used with=
|firmware=[[Marlin]]
|firmware=[[Marlin]]
|software=[[Cura]]
|software=[[Cura]]
|tutors=[[User:Mitja|Mitja]], [[User:Lukas|Lukas]]
|manual=
|manual=
|similar=
|similar=
|assetid=
}}
}}
</pre>
</pre>
Line 61: Line 63:
There is a "hidden" parameter in this template that's not in the copy template: <code>extrabox</code>. To enable <code>extrabox</code>, just give it any value (e.g. "true", "blablabla") and it should cause the box to behave as an extra without "Has image::".
There is a "hidden" parameter in this template that's not in the copy template: <code>extrabox</code>. To enable <code>extrabox</code>, 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::" value (as it automatically does for "image"). That's useful on pretty much every page with multiple InfoBoxes so there is just one "main" image to represent the page in galleries.
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 [[Project:Navigation_Galleries#Outsourcing_Parts_of_a_Page|"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!
Questions, feedback and further improvements are welcome!


== Bugs/Future Development ==
*"smart" behavior like color change according to status would be nice
</noinclude>
</noinclude>
{| class="wikitable" style="float:right; margin-left: 10px; border-style: solid; border-width: 5px; border-color: black"
{| class="wikitable" style="float:right; margin-left: 10px; border-style: solid; border-width: 5px; border-color: black"
!colspan="2"|<small style="float:right">[[Template:MachineInfoBox|MachineInfoBox]]</small><br>
!colspan="2" style="background-color:{{#switch:{{#ask: [[Has Internal AssetID::{{{assetid}}}]]|?Has Internal Status_translated|format=plainlist|link=none|headers=hide|mainlabel=-}}| Working = green | In Commissioning = orange | Broken = red | grey}}; text-decoration:{{#switch:{{#ask: [[Has Internal AssetID::{{{assetid}}}]]|?Has Internal Status_translated|format=plainlist|link=none|headers=hide|mainlabel=-}}| Gone = line-through | none }}"|<small style="float:right">[[Template:MachineInfoBox|MachineInfoBox]]</small><br>
<big>'''{{{machine name|Unnamed Machine}}}'''</big>
<big>'''{{{machine name|Unnamed Machine}}}'''</big>
|-
|-
Line 82: Line 84:
|}}
|}}
|-
|-
{{#if: {{{type|}}} |
{{#if: {{{assetid|}}} |
{{!}}-
{{!}}-
{{!}} Type:
{{!}} Type:
{{!}} {{{type}}}
{{!}} [[MachineType::{{#ask: [[Has Internal AssetID::{{{assetid}}}]]|?Has Internal Category|format=plainlist|link=none|headers=hide|mainlabel=-}}]]
|}}
|}}
|-
|-
Line 100: Line 102:
|}}
|}}
|-
|-
{{#if: {{{location|}}} |
{{#if: {{{assetid|}}} |
{{!}}-
{{!}}-
{{!}} Location:
{{!}} Location:
{{!}} {{{location}}}
{{!}} [[Location::{{#ask: [[Has Internal AssetID::{{{assetid}}}]]|?Has Internal Location|format=plainlist|link=none|headers=hide|mainlabel=-}}]]
|}}
|}}
|-
|-
{{#if: {{{access|}}} |
|Access Requirements:
{{!}}-
| {{#ask: [[Introduction for::{{PAGENAME}}]] OR [[Introduction for::{{{type}}}]]}}
{{!}} Access Requirements:
{{!}} {{{access}}}
|}}
|-
|-
{{#if: {{{status|}}} |
{{#if: {{{assetid|}}} |
{{!}}-
{{!}}-
{{!}} Status:
{{!}} Status:
{{!}} {{{status}}}
{{!}} [[Has InfoBox Status::{{#ask: [[Has Internal AssetID::{{{assetid}}}]]|?Has Internal Status_translated|format=plainlist|link=none|headers=hide|mainlabel=-}}]]
|}}
|}}
|-
|-
Line 137: Line 136:
|-  
|-  
| [[Tutors]]:
| [[Tutors]]:
| {{{tutors|}}}
| {{#ask: [[Introduction for::{{PAGENAME}}]] OR [[Introduction for::{{{type}}}]] |?Tutor= |format=plainlist |mainlabel=-  |valuesep=<br/>  }}
|-
|-
{{#if: {{{similar|}}} |
{{#if: {{{similar|}}} |
Line 144: Line 143:
{{!}}  {{{similar}}}
{{!}}  {{{similar}}}
|}}  
|}}  
|}
|}  
[[Category:Machines]]
{{#if:{{NAMESPACE}}
[[Has caption::{{#if: {{{extrabox|}}} | |{{PAGENAME}}}}| ]]
|<!-- not main namespace do nothing, otherwise -->
[[Has redirect::{{#if: {{{extrabox|}}} | |{{PAGENAME}}}}| ]]
|{{#if: {{{extrabox|}}} | | [[Category:Machines]]}}
<noinclude>
}}[[Has caption::{{#if: {{{extrabox|}}} | | {{#if: {{{type|}}} |{{{type}}}| {{PAGENAME}}}}}}| ]] [[Has German::{{#if: {{{german|}}} |{{{german}}}|}}| ]] [[Has Asset ID::{{#if: {{{assetid|}}} |{{{assetid}}}|}}| ]] [[Has extrabox::{{#if: {{{extrabox|}}} |yes|}}| ]]
{{#if: {{{assetid|}}}|
[[Has SnipeIT Location::|:]]
[[Has SnipeIT Status::{{#ask: [[Has Internal AssetID::{{{assetid}}}]]|?Has Internal Status|format=plainlist|link=none|headers=hide|mainlabel=-}}|]]
[[Has SnipeIT Status_translated::{{#ask: [[Has Internal AssetID::{{{assetid}}}]]|?Has Internal Status_translated|format=plainlist|link=none|headers=hide|mainlabel=-}}|]]
[[Has SnipeIT Status Type::{{#ask: [[Has Internal AssetID::{{{assetid}}}]]|?Has Internal Status type|format=plainlist|link=none|headers=hide|mainlabel=-}}|]] [[Has SnipeIT Status Meta::{{#ask: [[Has Internal AssetID::{{{assetid}}}]]|?Has Internal Status meta|format=plainlist|link=none|headers=hide|mainlabel=-}}|]]|}}<noinclude>
 
== Template Parameters ==
== Template Parameters ==
<templatedata>
<templatedata>
Line 159: Line 164:
"default": "Unnamed Machine",
"default": "Unnamed Machine",
"required": true
"required": true
},
"german": {
"label": "The (best) German name of your machine (invisible)",
"description": "The (best) German name of your machine (not visible, but usable for advanced pages like automatic galleries)",
"type": "string",
"suggested": true
},
},
"extrabox": {
"extrabox": {
Line 167: Line 178:
"image": {
"image": {
"label": "An image of the machine (example.jpg)",
"label": "An image of the machine (example.jpg)",
"description": "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.",
"description": "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.",
"type": "wiki-file-name",
"type": "wiki-file-name",
"default": "machine-default.png",
"default": "machine-default.png",
Line 180: Line 191:
},
},
"type": {
"type": {
"label": "Which type of machine is it?",
"label": "Which type of machine is it? (legacy)",
"description": "Which type of machine is this InfoBox referring to? ",
"description": "Legacy parameter (automatically determined) - Which type of machine is this InfoBox referring to? Plain text please, will be linked automatically",
"example": "[[CNC]] / [[metalworking]]",
"example": "Circular Saw / Corded Drill",
"suggested": true,
"type": "string",
"type": "string"
"deprecated": "Please set the parameter \"assetid\" - this will automatically determine this parameter"
},
},
"status": {
"status": {
"label": "The status of the machine",
"label": "The status of the machine (legacy)",
"description": "The status of the machine - link the corresponding \"do-something\" issue in case of problems!",
"description": "Legacy parameter (automatically determined) - The status of the machine - link the corresponding \"do-something\" issue in case of problems!",
"example": "available / broken",
"example": "available / broken",
"type": "string"
"type": "string",
"deprecated": "Please set the parameter \"assetid\" - this will automatically determine this parameter"
},
},
"material": {
"material": {
Line 206: Line 218:
},
},
"location": {
"location": {
"label": "The location of the tool",
"label": "The location of the tool (legacy)",
"description": "The location of the tool within the CoMakingSpace",
"description": "Legacy parameter (automatically determined) - The location of the tool within the CoMakingSpace",
"example": "[[Location::Wood Workshop|wood workshop]]",
"example": "[[Location::Wood Workshop|wood workshop]]",
"type": "wiki-page-name",
"type": "wiki-page-name",
"suggested": true
"deprecated": "Please set the parameter \"assetid\" - this will automatically determine this parameter"
},
},
"access": {
"access": {
"label": "Access requirements",
"label": "Access requirements",
"description": "Use this to indicate the access requirements to use the machine",
"description": "Currently unused - previously indicated the access requirements to use the machine",
"example": "[[introduction]]",
"example": "[[introduction]]",
"type": "string",
"type": "string"
"required": true
},
},
"tutors": {
"tutors": {
"label": "Tutors for the machine",
"label": "Tutors for the machine",
"description": "List of tutors who can give introductions to the machine",
"description": "Currently unused - previously list of tutors who can give introductions to the machine",
"example": "[[Tutor::User:Lukas|Lukas]]",
"example": "[[Tutor::User:Lukas|Lukas]]",
"type": "string"
"type": "string"
Line 247: Line 258:
"description": "Provide links to similar machines or tools in our wiki.",
"description": "Provide links to similar machines or tools in our wiki.",
"type": "wiki-page-name"
"type": "wiki-page-name"
},
"assetid": {
"label": "Asset ID",
"description": "The asset id in our internal asset management system. Setting this parameter will automatically determine the status, location and type of the tool.",
"type": "number",
"suggested": true
}
}
},
},
Line 252: Line 269:
"paramOrder": [
"paramOrder": [
"machine name",
"machine name",
"german",
"image",
"image",
"assetid",
"synonyms",
"synonyms",
"type",
"status",
"material",
"material",
"used with",
"used with",
"similar",
"similar",
"location",
"access",
"access",
"tutors",
"tutors",
Line 265: Line 281:
"software",
"software",
"firmware",
"firmware",
"status",
"location",
"type",
"extrabox"
"extrabox"
]
]

Latest revision as of 10:57, 10 October 2024

MachineInfoBox

Example: 3D Printer

Prusa i3 MK2S.JPG
Material: 1.75 mm filament
Access Requirements: Some use of "" in your query was not closed by a matching "".
Firmware: Marlin
Software: Cura
Tutors: Some use of "" in your query was not closed by a matching "".


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=
|type=
|material=
|location=
|status=
|firmware=
|software=
|manual=
|used with=
|similar=
|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
|status=working
|type=
|location=[[Location::Electronics Room|Electronics Room]]
|material=[[3D Printing Materials|1.75 mm filament]]
|used with=
|firmware=[[Marlin]]
|software=[[Cura]]
|manual=
|similar=
|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

Machine-default.png
Access Requirements:
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!

Template parameters

ParameterDescriptionTypeStatus
The name of your machinemachine name

The name of your machine

Default
Unnamed Machine
Stringrequired
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)

Stringsuggested
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.

Default
machine-default.png
Filesuggested
Asset IDassetid

The asset id in our internal asset management system. Setting this parameter will automatically determine the status, location and type of the tool.

Numbersuggested
Synonyms for the machine's namesynonyms

Existing synonyms for the name of the machines. You might include translations here.

Example
DE: Bohrmaschine
Stringsuggested
Material the machine can be used withmaterial

Links to materials the machine can be used with. Links should ideally be within our wiki.

Example
[[wood]]
Pagesuggested
Tools to use the machine withused with

Links to tools the machine can be used with. Links should ideally be within our wiki

Example
[[Drill Bits|drill bits]]
Pageoptional
Links to similar machinessimilar

Provide links to similar machines or tools in our wiki.

Pageoptional
Access requirementsaccess

Currently unused - previously indicated the access requirements to use the machine

Example
[[introduction]]
Stringoptional
Tutors for the machinetutors

Currently unused - previously list of tutors who can give introductions to the machine

Example
[[Tutor::User:Lukas|Lukas]]
Stringoptional
Link to the manualmanual

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

URLsuggested
Softwaresoftware

Does the machine require a computer with a certain software?

Example
[[Slic3r]]
Stringoptional
Firmwarefirmware

Is a firmware installed on the machine that may need to be maintained?

Example
[[Marlin]]
Stringoptional
The status of the machine (legacy)status

Legacy parameter (automatically determined) - The status of the machine - link the corresponding "do-something" issue in case of problems!

Example
available / broken
Stringdeprecated
The location of the tool (legacy)location

Legacy parameter (automatically determined) - The location of the tool within the CoMakingSpace

Example
[[Location::Wood Workshop|wood workshop]]
Pagedeprecated
Which type of machine is it? (legacy)type

Legacy parameter (automatically determined) - Which type of machine is this InfoBox referring to? Plain text please, will be linked automatically

Example
Circular Saw / Corded Drill
Stringdeprecated
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.

Booleanoptional
Retrieved from "https://wiki.comakingspace.de/index.php?title=Template:MachineInfoBox&oldid=18170"