Template:MachineInfoBox: Difference between revisions

From CoMakingSpace Wiki

← Older editNewer edit →
Visual
m fixing assetid (hopefully)
removed QR-printing link (leads to errors when executed from inclusion pages)
(35 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|german=3D-Drucker
|german=3D-Drucker
|image=Prusa i3 MK2S.JPG
|image=Prusa i3 MK2S.JPG
|extrabox=yes
|manual=
|access=
|status=working
|type=
|location=[[3D Printer Farm|3D printer farm]]
|material=[[3D Printing Materials|1.75 mm filament]]
|material=[[3D Printing Materials|1.75 mm filament]]
|used with=
|used with=
|similar=
|software=[[Cura]]
|firmware=[[Marlin]]
|firmware=[[Marlin]]
|software=[[Cura]]
|tutors=
|manual=
|similar=
|assetid=
|assetid=
|extrabox=yes
}}
}}
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 27: Line 22:
|image=
|image=
|synonyms=
|synonyms=
|type=
|manual=
|material=
|material=
|location=
|status=
|firmware=
|software=
|manual=
|used with=
|used with=
|similar=
|similar=
|software=
|firmware=
|assetid=
|assetid=
}}
}}
Line 47: Line 39:
|german=3D-Drucker
|german=3D-Drucker
|image=Prusa i3 MK2S.JPG
|image=Prusa i3 MK2S.JPG
|status=working
|manual=
|type=
|location=[[3D Printer Farm|3D printer farm]]
|material=[[3D Printing Materials|1.75 mm filament]]
|material=[[3D Printing Materials|1.75 mm filament]]
|used with=
|used with=
|similar=
|software=[[Cura]]
|firmware=[[Marlin]]
|firmware=[[Marlin]]
|software=[[Cura]]
|manual=
|similar=
|assetid=
|assetid=
}}
}}
Line 65: Line 54:
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.
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 set from the "type" value. 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.
"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 - therefore, the value entered for "type" should be plain text and not a wiki link to avoid query warnings. A link is added automatically for easy navigation to the "parent" page and as an easy way to check possible values.
"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 87: Line 73:
|}}
|}}
|-
|-
{{#if: {{{type|}}} |
{{#if: {{{assetid|}}} |
{{!}}-
{{!}}-
{{!}} Type:
{{!}} Type:
{{!}} [[{{{type}}}]]
{{!}} [[MachineType::{{#ask: [[Has Internal AssetID::{{{assetid}}}]]|?Has Internal Category|format=plainlist|link=none|headers=hide|mainlabel=-}}]]
|}}
|}}
|-
|-
Line 105: Line 91:
|}}
|}}
|-
|-
{{#if: {{{location|}}} |
{{#if: {{{assetid|}}} |
{{!}}-
{{!}}-
{{!}} Location:
{{!}} Location:
{{!}} {{{location}}}
{{!}} [[Location::{{#ask: [[Has Internal AssetID::{{{assetid}}}]]|?Has Internal Location|format=plainlist|link=none|headers=hide|mainlabel=-}}]]
|}}
|}}
|-
|-
|Access Requirements:
|Access Requirements:
| {{#ask: [[Introduction for::{{PAGENAME}}]] OR [[Introduction for::{{{type}}}]]}}
| [[Needs Introduction::{{#ask: [[Introduction for::{{PAGENAME}}]] OR [[Introduction for::{{#ask: [[Has Internal AssetID::{{{assetid}}}]]|?Has Internal Category|format=plainlist|link=none|headers=hide|mainlabel=-}}]]|format=plainlist|link=none|headers=hide}}]]
|-
|-
{{#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=-}}]]
|}}
|-
{{#if: {{{software|}}} |
{{!}}-
{{!}} Software:
{{!}}  {{{software}}}
|}}
|}}
|-
|-
Line 124: Line 116:
{{!}} Firmware:
{{!}} Firmware:
{{!}} {{{firmware}}}
{{!}} {{{firmware}}}
|}}
|-
{{#if: {{{software|}}} |
{{!}}-
{{!}} Software:
{{!}}  {{{software}}}
|}}
|}}
|-
|-
Line 146: Line 132:
{{!}}  {{{similar}}}
{{!}}  {{{similar}}}
|}}  
|}}  
|}
|}  
[[Category:Machines]]
{{#if:{{NAMESPACE}}
[[Has caption::{{#if: {{{extrabox|}}} | |{{PAGENAME}}}}| ]]
|<!-- not main namespace do nothing, otherwise -->
[[Has German::{{#if: {{{german|}}} |{{{german}}}|}}| ]]
|{{#if: {{{extrabox|}}} | | [[Category:Machines]]}}
[[MachineType::{{#if: {{{type|}}} |{{{type}}}|}}| ]]
}}[[Has caption::{{#if: {{{extrabox|}}} | | {{#if: {{{type|}}} |{{{type}}}| {{PAGENAME}}}}}}| ]] [[Has German::{{#if: {{{german|}}} |{{{german}}}|}}| ]] [[Has Asset ID::{{#if: {{{assetid|}}} |{{{assetid}}}|}}| ]] [[Has extrabox::{{#if: {{{extrabox|}}} |yes|}}| ]]
[[Has Asset ID::{{#if: {{{assetid|}}} |{{{assetid}}}|}}| ]]<noinclude>
{{#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 ==
Line 177: Line 167:
"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 190: Line 180:
},
},
"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? Plain text please, will be linked automatically",
"description": "Legacy parameter (automatically determined from \"assetid\" - ask a manager!)",
"example": "Circular Saw / Corded Drill",
"type": "string",
"suggested": true,
"deprecated": "Please set the parameter \"assetid\" - this will automatically determine this parameter"
"type": "string"
},
},
"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 from \"assetid\" - ask a manager!)",
"example": "available / broken",
"type": "string",
"type": "string"
"deprecated": "Please set the parameter \"assetid\" - this will automatically determine this parameter"
},
},
"material": {
"material": {
Line 216: Line 205:
},
},
"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 from \"assetid\" - ask a manager!)",
"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 (legacy)",
"description": "Currently unused - previously indicated the access requirements to use the machine",
"description": "Legacy parameter (automatically determined from SMW properties)",
"example": "[[introduction]]",
"type": "string",
"type": "string"
            "deprecated": "Please set the correct properties on the introduction page - this will automatically determine this parameter"
},
},
"tutors": {
"tutors": {
"label": "Tutors for the machine",
"label": "Tutors for the machine (legacy)",
"description": "Currently unused - previously list of tutors who can give introductions to the machine",
"description": "Legacy parameter (automatically determined from SMW properties)",
"example": "[[Tutor::User:Lukas|Lukas]]",
"type": "string",
"type": "string"
            "deprecated": "Please set the correct properties on the introduction page - this will automatically determine this parameter"
},
},
"manual": {
"manual": {
Line 257: Line 245:
"type": "wiki-page-name"
"type": "wiki-page-name"
},
},
"Asset ID": {
"assetid": {
"label": "Asset ID",
"label": "Asset ID",
"description": "The asset id in our internal asset management system",
"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"
"type": "number",
"suggested": true
}
}
},
},
Line 268: Line 257:
"german",
"german",
"image",
"image",
"assetid",
"synonyms",
"synonyms",
"type",
"manual",
"status",
"material",
"material",
"used with",
"used with",
"similar",
"similar",
"location",
"access",
"tutors",
"manual",
"software",
"software",
"firmware",
"firmware",
"extrabox",
"extrabox",
"Asset ID"
"status",
"location",
"type",
"access",
"tutors"
]
]
}
}
</templatedata>
</templatedata>
</noinclude>
</noinclude>

Revision as of 15:10, 28 March 2025

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: The query description has an empty condition.
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[Edit template data]

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
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
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]]
Page namesuggested
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]]
Page nameoptional
Links to similar machinessimilar

Provide links to similar machines or tools in our wiki.

Page nameoptional
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
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
The status of the machine (legacy)status

Legacy parameter (automatically determined from "assetid" - ask a manager!)

Stringdeprecated
The location of the tool (legacy)location

Legacy parameter (automatically determined from "assetid" - ask a manager!)

Page namedeprecated
Which type of machine is it? (legacy)type

Legacy parameter (automatically determined from "assetid" - ask a manager!)

Stringdeprecated
Access requirements (legacy)access

Legacy parameter (automatically determined from SMW properties)

Stringdeprecated
Tutors for the machine (legacy)tutors

Legacy parameter (automatically determined from SMW properties)

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