Template:SoftwareInfoBox

From CoMakingSpace Wiki
Jump to navigation Jump to search
SoftwareInfoBox

Unnamed Software

Software-default.png
Type:
Platform: supported OS?
License: e.g. open source
Source: where to get it?
Input Formats:
Output Formats:
Users: who might be able to help?


This InfoBox is intended to give readers a quick overview of a software page.

Documentation

To use this template, simply insert this code at the top of your page and enter the relevant parameters:

{{SoftwareInfoBox
|software name=
|image=
|type=
|platform=
|license=
|source=
|installed=
|input=
|output=
|users=
}}

Default values for some parameters exist, but will only be used if the entire line is omitted. For example, |image= leads to no image being displayed while not entering the image parameter at all will lead to the default image (cd and floppy) being displayed. Please make use of the "Show preview" button and it should be clear.

The "type" should be a brief categorization of the software, e.g. "3D printer firmware" or "CAD". For a rather complete example, have a look at the Tinkercad page.

Bugs/Future Development

  • would be nice to display default when empty parameter values are set

Template Parameters

Adds the software infobox to the page. Additionally includes the page in the "Software" category.

Template parameters

ParameterDescriptionTypeStatus
Software Namesoftware name

The name of the software

Stringrequired
Image (example.jpg)image

File name of an image representing the software. Can be the logo or a screenshot.

Filesuggested
Typetype

The type of software

Example
Development Tool
Stringoptional
Platformplatform

Platform(s) the software can be installed on. Can be operating systems, but also microcontrollers or single board computers.

Stringoptional
Licenselicense

The license under which the software gets distrubuted

Example
GPL
Stringoptional
Sourcesource

The source from which the software can be obtained. Ideally, this is a link to the respective download page.

Stringoptional
Installed oninstalled

The computer(s) in the Space with this software.

Stringoptional
Input Options (wiki links, if possible)input

(File) Formats the software accepts as input.

Stringoptional
Output Formats (wiki links, if possible)output

(File) Formats the software provides as output (options)

Stringoptional
Users (wiki links, if possible)users

(List of) People who are known users of the software. Ideally, provide links to their user-page. Most likely this includes at least you.

Unknownoptional