Template:Infobox software/doc: Difference between revisions

Checkpoint
Developer(s)	FlagBrew
Console	Nintendo 3DS, Nintendo Switch
Version	3.8.0 (November 13, 2021; 2 years ago)
Links
GitHub	FlagBrew/Checkpoint
Download
	GitHub release;
	v; t; e;

Latest revision as of 02:20, 31 October 2024

This places an infobox about homebrew software.

Example

If this were on the Checkpoint page...

{{Infobox homebrew
| for3ds = 1
| developers = FlagBrew
| forswitch = 1
| image = Checkpoint-Banner.png
| imagealt = Checkpoint banner on the Home Menu
| version = 3.8.0
| releasedate = 2021-11-13
| github = FlagBrew/Checkpoint
| githubtag = v3.8.0
}}

TemplateData

Console homebrew infobox.

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Homebrew name	`title`	Name of the homebrew - only set this if the page title shouldn't be automatically used Default Page title	String	optional
Image	`image`	Image to use. Preference order: Banner image (3DS/Wii U), Banner screenshot (3DS), then Icon (3DS/Wii U/Switch). Please also set image alt text.	File	suggested
Image alt text	`imagealt`	Alt text for the image, appears on hover and to screen readers Example Checkpoint banner on the Home Menu	String	suggested
Image size	`imagesize`	Resize the image, accepts any value that the MediaWiki image syntax uses (recommended to use if image is over is 256px wide) Example 256px	String	optional
Screenshot	`screenshot`	A screenshot of the application. Please also set screenshot alt text.	File	suggested
Screenshot alt text	`screenshotalt`	Alt text for the screenshot, appears on hover and to screen readers Example Checkpoint main screen	String	suggested
Screenshot size	`screenshotsize`	Resize the screenshot, accepts any value that the MediaWiki image syntax uses (recommended to use if image is over is 256px wide) Example 256px	String	optional
For 3DS	`for3ds`	If the homebrew is for the Nintendo 3DS Auto value `0`	Boolean	suggested
For Wii U	`forwiiu`	If the homebrew is for the Wii U Auto value `0`	Boolean	suggested
For Switch	`forswitch`	If the homebrew is for the Nintendo Switch Auto value `0`	Boolean	suggested
For Wii	`forwii`	If the homebrew is for the Wii Auto value `0`	Boolean	suggested
Developers	`developers`	List of primary developers Example smealum, yellows8	Content	suggested
Version	`version`	Currently released version (NOTE: currently you must manually update GitHub release tag or GitLab release tag)	String	suggested
Release date	`releasedate`	Date of the latest release in YYYY-MM-DD format Example 2004-11-16	Date	suggested
Website	`website`	Link to a page for the homebrew. Can be something like a forum thread link too. Use the GitHub or GitLab parameters for those sites instead.	URL	suggested
GitHub repository	`github`	Where the source code is on GitHub Example FlagBrew/Checkpoint	String	optional
GitLab.com repository	`gitlab`	Where the source code is on GitLab (not self-hosted instances) Example FlagBrew/Checkpoint	String	optional
Source code URL	`sourceurl`	Where the source code is (if not on GitHub or GitLab.com)	URL	optional
External release URL	`releaseurl`	URL to find the latest release of the homebrew - can either be a direct download or a page that links to one Example https://example.com/hb/release-info/, https://example.com/hb/release.3dsx	URL	optional
Universal-DB URL path	`universaldb`	URL path to the homebrew's page on Universal-DB (db.universal-team.net) Example 3ds/open_agb_firm	String	optional
Open Shop Channel URL path	`osc`	URL path to the homebrew's page on Open Shop Channel (oscwii.org/library) Example homebrew_browser	String	optional
GitHub release tag	`githubtag`	Tag for the latest release on GitHub (requires GitHub repository to be set) Example latest, v1.0.2	String	optional
GitLab release tag	`gitlabtag`	Tag for the latest release on GitLab.com (requires GitLab repository to be set, not self-hosted instances) Example permalink/latest, v1.0.2	String	optional
Image caption	`caption`	Caption to display below the image	String	optional
Screenshot caption	`screenshotcaption`	Caption to display below the screenshot	String	optional
For Windows	`forwindows`	If this is a PC tool that runs on Windows Auto value `0`	Boolean	suggested
For macOS	`formac`	If this is a PC tool that runs on macOS Auto value `0`	Boolean	suggested
For Linux	`forlinux`	If this is a PC tool that runs on Linux Auto value `0`	Boolean	suggested
For Java	`forjava`	If this is a PC tool that is a Java-based program Auto value `0`	Boolean	suggested

@@ Line 47: / Line 47: @@
 			"type": "wiki-file-name",
 			"label": "Image",
-			"description": "Image to use. Preference order: Banner image (3DS/Wii U), Banner screenshot (3DS), then Icon (3DS/Wii U/Switch)",
+			"description": "Image to use. Preference order: Banner image (3DS/Wii U), Banner screenshot (3DS), then Icon (3DS/Wii U/Switch). Please also set image alt text.",
 			"suggested": true
 		},
@@ Line 53: / Line 53: @@
 			"type": "wiki-file-name",
 			"label": "Screenshot",
-			"description": "A screenshot of the application",
+			"description": "A screenshot of the application. Please also set screenshot alt text.",
 			"suggested": true
 		},
@@ Line 60: / Line 60: @@
 			"description": "If the homebrew is for the Nintendo 3DS",
 			"type": "boolean",
-			"autovalue": "0"
+			"autovalue": "0",
+			"suggested": true
 		},
 		"forwiiu": {
@@ Line 66: / Line 67: @@
 			"description": "If the homebrew is for the Wii U",
 			"type": "boolean",
-			"autovalue": "0"
+			"autovalue": "0",
+			"suggested": true
 		},
 		"forswitch": {
@@ Line 72: / Line 74: @@
 			"description": "If the homebrew is for the Nintendo Switch",
 			"type": "boolean",
-			"autovalue": "0"
+			"autovalue": "0",
+			"suggested": true
 		},
 		"forwii": {
@@ Line 78: / Line 81: @@
 			"description": "If the homebrew is for the Wii",
 			"type": "boolean",
-			"autovalue": "0"
+			"autovalue": "0",
+			"suggested": true
 		},
 		"version": {
 			"label": "Version",
-			"description": "Currently released version",
+			"description": "Currently released version (NOTE: currently you must manually update GitHub release tag or GitLab release tag)",
-			"suggested": true
+			"suggested": true,
+			"type": "string"
 		},
 		"github": {
@@ Line 112: / Line 117: @@
 			"description": "URL path to the homebrew's page on Universal-DB (db.universal-team.net)",
 			"example": "3ds/open_agb_firm",
+			"type": "string"
+		},
+		"osc": {
+			"label": "Open Shop Channel URL path",
+			"description": "URL path to the homebrew's page on Open Shop Channel (oscwii.org/library)",
+			"example": "homebrew_browser",
 			"type": "string"
 		},
@@ Line 166: / Line 177: @@
 			"description": "If this is a PC tool that runs on Windows",
 			"type": "boolean",
-			"autovalue": "0"
+			"autovalue": "0",
+			"suggested": true
 		},
 		"formac": {
@@ Line 172: / Line 184: @@
 			"description": "If this is a PC tool that runs on macOS",
 			"type": "boolean",
-			"autovalue": "0"
+			"autovalue": "0",
+			"suggested": true
 		},
 		"forlinux": {
@@ Line 178: / Line 191: @@
 			"description": "If this is a PC tool that runs on Linux",
 			"type": "boolean",
-			"autovalue": "0"
+			"autovalue": "0",
+			"suggested": true
 		},
 		"forjava": {
@@ Line 184: / Line 198: @@
 			"description": "If this is a PC tool that is a Java-based program",
 			"type": "boolean",
-			"autovalue": "0"
+			"autovalue": "0",
+			"suggested": true
 		},
 		"developers": {
@@ Line 220: / Line 235: @@
 		"forwiiu",
 		"forswitch",
-        "forwii",
+		"forwii",
 		"developers",
 		"version",
@@ Line 230: / Line 245: @@
 		"releaseurl",
 		"universaldb",
+		"osc",
 		"githubtag",
 		"gitlabtag",