Template:SoftwareInfoBox: Difference between revisions
NitramLegov (talk | contribs) (added template info) |
(→Template Parameters: example label for "image") |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 59: | Line 59: | ||
== Bugs/Future Development == | == Bugs/Future Development == | ||
*would be nice to display default when empty parameter values are set | *would be nice to display default when empty parameter values are set | ||
== Template Parameters == | |||
<templatedata> | <templatedata> | ||
{ | { | ||
| Line 69: | Line 71: | ||
}, | }, | ||
"image": { | "image": { | ||
"label": "Image", | "label": "Image (example.jpg)", | ||
"description": " | "description": "File name of an image representing the software. Can be the logo or a screenshot.", | ||
"type": "wiki-file-name", | "type": "wiki-file-name", | ||
"suggested": true | "suggested": true | ||
| Line 98: | Line 100: | ||
"installed": { | "installed": { | ||
"label": "Installed on", | "label": "Installed on", | ||
"description": " | "description": "The computer(s) in the Space with this software.", | ||
"type": " | "type": "string" | ||
}, | }, | ||
"input": { | "input": { | ||
"label": "Input Options", | "label": "Input Options (wiki links, if possible)", | ||
"description": "(File) Formats the software accepts as input.", | "description": "(File) Formats the software accepts as input.", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
"output": { | "output": { | ||
"label": "Output Formats", | "label": "Output Formats (wiki links, if possible)", | ||
"description": "(File) Formats the software provides as output (options)", | "description": "(File) Formats the software provides as output (options)", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
"users": { | "users": { | ||
"label": "Users", | "label": "Users (wiki links, if possible)", | ||
"description": "(List of) People | "description": "(List of) People who are known users of the software. Ideally, provide links to their user-page. Most likely this includes at least you." | ||
} | } | ||
}, | }, | ||
Latest revision as of 22:48, 30 December 2020
| SoftwareInfoBox Unnamed Software | |
|---|---|
| |
| 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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Software Name | software name | The name of the software | String | required |
| Image (example.jpg) | image | File name of an image representing the software. Can be the logo or a screenshot. | File | suggested |
| Type | type | The type of software
| String | optional |
| Platform | platform | Platform(s) the software can be installed on. Can be operating systems, but also microcontrollers or single board computers. | String | optional |
| License | license | The license under which the software gets distrubuted
| String | optional |
| Source | source | The source from which the software can be obtained. Ideally, this is a link to the respective download page. | String | optional |
| Installed on | installed | The computer(s) in the Space with this software. | String | optional |
| Input Options (wiki links, if possible) | input | (File) Formats the software accepts as input. | String | optional |
| Output Formats (wiki links, if possible) | output | (File) Formats the software provides as output (options) | String | optional |
| 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. | Unknown | optional |
