Template:MachineInfoBox: Difference between revisions

From CoMakingSpace Wiki

(added template parameters)
(adding "German" parameter)
Line 22: Line 22:
{{MachineInfoBox
{{MachineInfoBox
|machine name=
|machine name=
|german=
|image=
|image=
|synonyms=
|synonyms=
Line 43: Line 44:
{{MachineInfoBox
{{MachineInfoBox
|machine name= Example: 3D Printer
|machine name= Example: 3D Printer
|german=
|image=Prusa i3 MK2S.JPG
|image=Prusa i3 MK2S.JPG
|access=[[3D Printer Introduction|3D printer introduction]]
|access=[[3D Printer Introduction|3D printer introduction]]
Line 147: Line 149:
[[Category:Machines]]
[[Category:Machines]]
[[Has caption::{{#if: {{{extrabox|}}} | |{{PAGENAME}}}}| ]]
[[Has caption::{{#if: {{{extrabox|}}} | |{{PAGENAME}}}}| ]]
[[Has redirect::{{#if: {{{extrabox|}}} | |german}}| ]]
[[Has redirect::{{#if: {{{extrabox|}}} | |{{PAGENAME}}}}| ]]
[[Has redirect::{{#if: {{{extrabox|}}} | |{{PAGENAME}}}}| ]]
<noinclude>
<noinclude>
Line 159: Line 162:
"default": "Unnamed Machine",
"default": "Unnamed Machine",
"required": true
"required": true
},
"german": {
"label": "The (best) German name of your machine",
"description": "The (best) German name of your machine",
"type": "string",
"suggested": true
},
},
"extrabox": {
"extrabox": {
Line 252: Line 261:
"paramOrder": [
"paramOrder": [
"machine name",
"machine name",
"german",
"image",
"image",
"synonyms",
"synonyms",

Revision as of 07:47, 23 October 2021


MachineInfoBox

Example: 3D Printer

Prusa i3 MK2S.JPG
Type: CNC (additive manufacturing)
Material: 1.75 mm filament
Location: 3D printer farm
Access Requirements: upon introduction
Status: working
Firmware: Marlin
Software: Cura
Tutors: Mitja, Lukas



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=
|access=
|status=
|firmware=
|software=
|manual=
|tutors=
|used with=
|similar=
}}

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=
|image=Prusa i3 MK2S.JPG
|access=[[3D Printer Introduction|3D printer introduction]]
|status=working
|type=[[CNC]] (additive manufacturing)
|location=[[3D Printer Farm|3D printer farm]]
|material=[[3D Printing Materials|1.75 mm filament]]
|used with=
|firmware=[[Marlin]]
|software=[[Cura]]
|tutors=[[User:Mitja|Mitja]], [[User:Lukas|Lukas]]
|manual=
|similar=
}}

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::" 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.

Questions, feedback and further improvements are welcome!

Bugs/Future Development

  • "smart" behavior like color change according to status would be nice


MachineInfoBox

Unnamed Machine

Machine-default.png
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 machinegerman

The (best) German name of your machine

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.

Default
machine-default.png
Filesuggested
Synonyms for the machine's namesynonyms

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

Example
DE: Bohrmaschine
Stringsuggested
Which type of machine is it?type

Which type of machine is this InfoBox referring to?

Example
[[CNC]] / [[metalworking]]
Stringsuggested
The status of the machinestatus

The status of the machine - link the corresponding "do-something" issue in case of problems!

Example
available / broken
Stringoptional
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
The location of the toollocation

The location of the tool within the CoMakingSpace

Example
[[Location::Wood Workshop|wood workshop]]
Pagesuggested
Access requirementsaccess

Use this to indicate the access requirements to use the machine

Example
[[introduction]]
Stringrequired
Tutors for the machinetutors

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