Toggle search
Toggle menu
303
299
452
7K
Hacks Guide Wiki
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:Infobox software/doc: Difference between revisions

Template page
More actions
m (Ihaveahax moved page Template:Infobox homebrew/doc to Template:Infobox software/doc: this is a more accurate name since it's being used for non-homebrew software as well as PC tools)
m (→‎Example: typo in example source)
(9 intermediate revisions by 2 users not shown)
Line 11: Line 11:
| imagealt = Checkpoint banner on the Home Menu
| imagealt = Checkpoint banner on the Home Menu
| version = 3.8.0
| version = 3.8.0
| releasedate = 2021-11-13
| github = FlagBrew/Checkpoint
| github = FlagBrew/Checkpoint
| githubtag = v3.8.0
| githubtag = v3.8.0
Line 25: Line 24:
| imagealt = Checkpoint banner on the Home Menu
| imagealt = Checkpoint banner on the Home Menu
| version = 3.8.0
| version = 3.8.0
| releasedate = 2021-11-13
| github = FlagBrew/Checkpoint
| github = FlagBrew/Checkpoint
| githubtag = v3.8.0
| githubtag = v3.8.0
Line 47: Line 45:
"type": "wiki-file-name",
"type": "wiki-file-name",
"label": "Image",
"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
"suggested": true
},
},
Line 60: Line 52:
"description": "If the homebrew is for the Nintendo 3DS",
"description": "If the homebrew is for the Nintendo 3DS",
"type": "boolean",
"type": "boolean",
"autovalue": "0",
"autovalue": "0"
"suggested": true
},
},
"forwiiu": {
"forwiiu": {
Line 67: Line 58:
"description": "If the homebrew is for the Wii U",
"description": "If the homebrew is for the Wii U",
"type": "boolean",
"type": "boolean",
"autovalue": "0",
"autovalue": "0"
"suggested": true
},
},
"forswitch": {
"forswitch": {
Line 74: Line 64:
"description": "If the homebrew is for the Nintendo Switch",
"description": "If the homebrew is for the Nintendo Switch",
"type": "boolean",
"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": {
"version": {
"label": "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": {
"github": {
Line 117: Line 98:
"description": "URL path to the homebrew's page on Universal-DB (db.universal-team.net)",
"description": "URL path to the homebrew's page on Universal-DB (db.universal-team.net)",
"example": "3ds/open_agb_firm",
"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"
"type": "string"
},
},
Line 153: Line 128:
"label": "Image caption",
"label": "Image caption",
"description": "Caption to display below the image",
"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"
"type": "string"
},
},
Line 177: Line 134:
"description": "If this is a PC tool that runs on Windows",
"description": "If this is a PC tool that runs on Windows",
"type": "boolean",
"type": "boolean",
"autovalue": "0",
"autovalue": "0"
"suggested": true
},
},
"formac": {
"formac": {
Line 184: Line 140:
"description": "If this is a PC tool that runs on macOS",
"description": "If this is a PC tool that runs on macOS",
"type": "boolean",
"type": "boolean",
"autovalue": "0",
"autovalue": "0"
"suggested": true
},
},
"forlinux": {
"forlinux": {
Line 191: Line 146:
"description": "If this is a PC tool that runs on Linux",
"description": "If this is a PC tool that runs on Linux",
"type": "boolean",
"type": "boolean",
"autovalue": "0",
"autovalue": "0"
"suggested": true
},
},
"forjava": {
"forjava": {
Line 198: Line 152:
"description": "If this is a PC tool that is a Java-based program",
"description": "If this is a PC tool that is a Java-based program",
"type": "boolean",
"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 161:
"image",
"image",
"imagealt",
"imagealt",
"imagesize",
"screenshot",
"screenshotalt",
"screenshotsize",
"for3ds",
"for3ds",
"forwiiu",
"forwiiu",
"forswitch",
"forswitch",
"forwii",
"developers",
"version",
"version",
"releasedate",
"website",
"github",
"github",
"gitlab",
"gitlab",
Line 245: Line 170:
"releaseurl",
"releaseurl",
"universaldb",
"universaldb",
"osc",
"githubtag",
"githubtag",
"gitlabtag",
"gitlabtag",
"imagesize",
"caption",
"caption",
"screenshotcaption",
"forwindows",
"forwindows",
"formac",
"formac",

Revision as of 08:19, 26 June 2022

This places an infobox about homebrew software.

Example

Checkpoint
Checkpoint banner on the Home Menu
Developer(s)FlagBrew
ConsoleNintendo 3DS, Nintendo Switch
Version3.8.0
Links
GitHubFlagBrew/Checkpoint
Download

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
| github = FlagBrew/Checkpoint
| githubtag = v3.8.0
}}

TemplateData

Console homebrew infobox.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Homebrew nametitle

Name of the homebrew - only set this if the page title shouldn't be automatically used

Default
Page title
Stringoptional
Imageimage

Image to use. Preference order: Banner image (3DS/Wii U), Banner screenshot (3DS), then Icon (3DS/Wii U/Switch)

Filesuggested
Image alt textimagealt

Alt text for the image, appears on hover and to screen readers

Example
Checkpoint banner on the Home Menu
Stringsuggested
For 3DSfor3ds

If the homebrew is for the Nintendo 3DS

Auto value
0
Booleanoptional
For Wii Uforwiiu

If the homebrew is for the Wii U

Auto value
0
Booleanoptional
For Switchforswitch

If the homebrew is for the Nintendo Switch

Auto value
0
Booleanoptional
Versionversion

Currently released version

Unknownsuggested
GitHub repositorygithub

Where the source code is on GitHub

Example
FlagBrew/Checkpoint
Stringoptional
GitLab.com repositorygitlab

Where the source code is on GitLab (not self-hosted instances)

Example
FlagBrew/Checkpoint
Stringoptional
Source code URLsourceurl

Where the source code is (if not on GitHub or GitLab.com)

URLoptional
External release URLreleaseurl

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
URLoptional
Universal-DB URL pathuniversaldb

URL path to the homebrew's page on Universal-DB (db.universal-team.net)

Example
3ds/open_agb_firm
Stringoptional
GitHub release taggithubtag

Tag for the latest release on GitHub (requires GitHub repository to be set)

Example
latest, v1.0.2
Stringoptional
GitLab release taggitlabtag

Tag for the latest release on GitLab.com (requires GitLab repository to be set, not self-hosted instances)

Example
permalink/latest, v1.0.2
Stringoptional
Image sizeimagesize

Resize the image, accepts any value that the MediaWiki image syntax uses (recommended to use if image is over is 256px wide)

Example
256px
Stringoptional
Image captioncaption

Caption to display below the image

Stringoptional
For Windowsforwindows

If this is a PC tool that runs on Windows

Auto value
0
Booleanoptional
For macOSformac

If this is a PC tool that runs on macOS

Auto value
0
Booleanoptional
For Linuxforlinux

If this is a PC tool that runs on Linux

Auto value
0
Booleanoptional
For Javaforjava

If this is a PC tool that is a Java-based program

Auto value
0
Booleanoptional
Retrieved from "https://wiki.hacks.guide/w/index.php?title=Template:Infobox_software/doc&oldid=1349"