Template:Infobox homebrew/doc: Difference between revisions

Revision as of 13:03, 11 June 2022

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)	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
For 3DS	`for3ds`	If the homebrew is for the Nintendo 3DS Auto value `0`	Boolean	optional
For Wii U	`forwiiu`	If the homebrew is for the Wii U Auto value `0`	Boolean	optional
For Switch	`forswitch`	If the homebrew is for the Nintendo Switch Auto value `0`	Boolean	optional
Version	`version`	Currently released version	Unknown	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
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 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
Image caption	`caption`	Caption to display below the image	String	optional
For Microsoft Windows	`forwindows`	If this is a PC tool that runs on Windows Auto value `0`	Boolean	optional
For macOS	`formac`	If this is a PC tool that runs on macOS Auto value `0`	Boolean	optional
For Linux	`forlinux`	If this is a PC tool that runs on Linux Auto value `0`	Boolean	optional
For Java	`forjava`	If this is a PC tool that is a Java-based program Auto value `0`	Boolean	optional

@@ Line 1: / Line 1: @@
-This places an infobox about homebrew software.
-=== Example ===
-{{Infobox homebrew
-| title = Checkpoint
-| developers = FlagBrew
-| for3ds = 1
-| 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
-| nocat = 1
-}}
-If this were on the '''Checkpoint''' page...
-<pre><nowiki>
-{{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
-}}
-</nowiki></pre>
-{{clear}}
-=== TemplateData ===
 <templatedata>
@@ Line 47: / Line 12: @@
 			"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). Please also set image alt text.",
+			"description": "Image to use. Preference order: Banner image (3DS/Wii U), , Banner screenshot (3DS), then Icon (3DS/Wii U/Switch)",
-			"suggested": true
-		},
-		"screenshot": {
-			"type": "wiki-file-name",
-			"label": "Screenshot",
-			"description": "A screenshot of the application. Please also set screenshot alt text.",
 			"suggested": true
 		},
@@ Line 60: / Line 19: @@
 			"description": "If the homebrew is for the Nintendo 3DS",
 			"type": "boolean",
-			"autovalue": "0",
+			"autovalue": "0"
-			"suggested": true
 		},
 		"forwiiu": {
@@ Line 67: / Line 25: @@
 			"description": "If the homebrew is for the Wii U",
 			"type": "boolean",
-			"autovalue": "0",
+			"autovalue": "0"
-			"suggested": true
 		},
 		"forswitch": {
@@ Line 74: / Line 31: @@
 			"description": "If the homebrew is for the Nintendo Switch",
 			"type": "boolean",
-			"autovalue": "0",
+			"autovalue": "0"
-			"suggested": true
-		},
-		"forwii": {
-			"label": "For Wii",
-			"description": "If the homebrew is for the Wii",
-			"type": "boolean",
-			"autovalue": "0",
-			"suggested": true
 		},
 		"version": {
 			"label": "Version",
-			"description": "Currently released version (NOTE: currently you must manually update GitHub release tag or GitLab release tag)",
+			"description": "Currently released version",
-			"suggested": true,
+			"suggested": true
-			"type": "string"
 		},
 		"github": {
@@ Line 117: / Line 65: @@
 			"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 153: / Line 95: @@
 			"label": "Image caption",
 			"description": "Caption to display below the image",
-			"type": "string"
-		},
-		"screenshotalt": {
-			"label": "Screenshot alt text",
-			"type": "string",
-			"description": "Alt text for the screenshot, appears on hover and to screen readers",
-			"example": "Checkpoint main screen",
-			"suggested": true
-		},
-		"screenshotsize": {
-			"label": "Screenshot size",
-			"description": "Resize the screenshot, accepts any value that the MediaWiki image syntax uses (recommended to use if image is over is 256px wide)",
-			"example": "256px",
-			"type": "string"
-		},
-		"screenshotcaption": {
-			"label": "Screenshot caption",
-			"description": "Caption to display below the screenshot",
 			"type": "string"
 		},
 		"forwindows": {
-			"label": "For Windows",
+			"label": "For Microsoft Windows",
 			"description": "If this is a PC tool that runs on Windows",
 			"type": "boolean",
-			"autovalue": "0",
+			"autovalue": "0"
-			"suggested": true
 		},
 		"formac": {
@@ Line 184: / Line 107: @@
 			"description": "If this is a PC tool that runs on macOS",
 			"type": "boolean",
-			"autovalue": "0",
+			"autovalue": "0"
-			"suggested": true
 		},
 		"forlinux": {
@@ Line 191: / Line 113: @@
 			"description": "If this is a PC tool that runs on Linux",
 			"type": "boolean",
-			"autovalue": "0",
+			"autovalue": "0"
-			"suggested": true
 		},
 		"forjava": {
@@ Line 198: / Line 119: @@
 			"description": "If this is a PC tool that is a Java-based program",
 			"type": "boolean",
-			"autovalue": "0",
+			"autovalue": "0"
-			"suggested": true
-		},
-		"developers": {
-			"label": "Developers",
-			"description": "List of primary developers",
-			"example": "smealum, yellows8",
-			"type": "content",
-			"suggested": true
-		},
-		"website": {
-			"label": "Website",
-			"description": "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.",
-			"type": "url",
-			"suggested": true
-		},
-		"releasedate": {
-			"label": "Release date",
-			"description": "Date of the latest release in YYYY-MM-DD format",
-			"example": "2004-11-16",
-			"type": "date",
-			"suggested": true
 		}
 	},
@@ Line 228: / Line 128: @@
 		"image",
 		"imagealt",
-		"imagesize",
-		"screenshot",
-		"screenshotalt",
-		"screenshotsize",
 		"for3ds",
 		"forwiiu",
 		"forswitch",
-		"forwii",
-		"developers",
 		"version",
-		"releasedate",
-		"website",
 		"github",
 		"gitlab",
@@ Line 245: / Line 137: @@
 		"releaseurl",
 		"universaldb",
-		"osc",
 		"githubtag",
 		"gitlabtag",
+		"imagesize",
 		"caption",
-		"screenshotcaption",
 		"forwindows",
 		"formac",