Template:SoftwareInfoBox: Difference between revisions

Revision as of 12:24, 23 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

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

Template parameters
Parameter		Description	Type	Status
Software Name	`software name`	The name of the software	String	required
Image	`image`	An image representing the software. Can be the logo or a screenshot.	File	suggested
Type	`type`	The type of software Example Development Tool	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 Example GPL	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`	Your initial date of installation	Date	optional
Input Options	`input`	(File) Formats the software accepts as input.	String	optional
Output Formats	`output`	(File) Formats the software provides as output (options)	String	optional
Users	`users`	(List of) People which are known users of the software. Ideally, provide links to their user-page. Most likely this includes at least you.	Unknown	optional

@@ Line 59: / Line 59: @@
 == Bugs/Future Development ==
 *would be nice to display default when empty parameter values are set
+<templatedata>
+{
+	"params": {
+		"software name": {
+			"label": "Software Name",
+			"description": "The name of the software",
+			"type": "string",
+			"required": true
+		},
+		"image": {
+			"label": "Image",
+			"description": "An image representing the software. Can be the logo or a screenshot.",
+			"type": "wiki-file-name",
+			"suggested": true
+		},
+		"type": {
+			"label": "Type",
+			"description": "The type of software",
+			"example": "Development Tool",
+			"type": "string"
+		},
+		"platform": {
+			"label": "Platform",
+			"description": "Platform(s) the software can be installed on. Can be operating systems, but also microcontrollers or single board computers.",
+			"type": "string"
+		},
+		"license": {
+			"label": "License",
+			"description": "The license under which the software gets distrubuted",
+			"example": "GPL",
+			"type": "string"
+		},
+		"source": {
+			"label": "Source",
+			"description": "The source from which the software can be obtained. Ideally, this is a link to the respective download page.",
+			"type": "string"
+		},
+		"installed": {
+			"label": "Installed on",
+			"description": "Your initial date of installation",
+			"type": "date"
+		},
+		"input": {
+			"label": "Input Options",
+			"description": "(File) Formats the software accepts as input.",
+			"type": "string"
+		},
+		"output": {
+			"label": "Output Formats",
+			"description": "(File) Formats the software provides as output (options)",
+			"type": "string"
+		},
+		"users": {
+			"label": "Users",
+			"description": "(List of) People which are known users of the software. Ideally, provide links to their user-page. Most likely this includes at least you."
+		}
+	},
+	"description": "Adds the software infobox to the page. Additionally includes the page in the \"Software\" category.",
+	"paramOrder": [
+		"software name",
+		"image",
+		"type",
+		"platform",
+		"license",
+		"source",
+		"installed",
+		"input",
+		"output",
+		"users"
+	]
+}
+</templatedata>
+</noinclude>