Template:Infobox homebrew/doc: Difference between revisions

Template page
m (1 revision imported)
(→‎TemplateData: add osc)
 
(13 intermediate revisions by 2 users not shown)
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>
<templatedata>
Line 12: Line 47:
"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)",
"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
},
"screenshot": {
"type": "wiki-file-name",
"label": "Screenshot",
"description": "A screenshot of the application. Please also set screenshot alt text.",
"suggested": true
"suggested": true
},
},
Line 19: Line 60:
"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 25: Line 67:
"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 31: Line 74:
"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",
"description": "Currently released version",
"suggested": true
"suggested": true,
"type": "string"
},
},
"github": {
"github": {
Line 65: Line 117:
"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 95: Line 153:
"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"
},
},
"forwindows": {
"forwindows": {
"label": "For Microsoft Windows",
"label": "For Windows",
"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 107: Line 184:
"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 113: Line 191:
"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 119: Line 198:
"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 128: Line 228:
"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 137: Line 245:
"releaseurl",
"releaseurl",
"universaldb",
"universaldb",
"osc",
"githubtag",
"githubtag",
"gitlabtag",
"gitlabtag",
"imagesize",
"caption",
"caption",
"screenshotcaption",
"forwindows",
"forwindows",
"formac",
"formac",

Latest revision as of 21:30, 3 May 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.

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). Please also set image alt text.

Filesuggested
Image alt textimagealt

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

Example
Checkpoint banner on the Home Menu
Stringsuggested
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
Screenshotscreenshot

A screenshot of the application. Please also set screenshot alt text.

Filesuggested
Screenshot alt textscreenshotalt

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

Example
Checkpoint main screen
Stringsuggested
Screenshot sizescreenshotsize

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

Example
256px
Stringoptional
For 3DSfor3ds

If the homebrew is for the Nintendo 3DS

Auto value
0
Booleansuggested
For Wii Uforwiiu

If the homebrew is for the Wii U

Auto value
0
Booleansuggested
For Switchforswitch

If the homebrew is for the Nintendo Switch

Auto value
0
Booleansuggested
For Wiiforwii

If the homebrew is for the Wii

Auto value
0
Booleansuggested
Developersdevelopers

List of primary developers

Example
smealum, yellows8
Contentsuggested
Versionversion

Currently released version

Stringsuggested
Release datereleasedate

Date of the latest release in YYYY-MM-DD format

Example
2004-11-16
Datesuggested
Websitewebsite

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.

URLsuggested
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
Open Shop Channel URL pathosc

URL path to the homebrew's page on Open Shop Channel (oscwii.org/library)

Example
homebrew_browser
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 captioncaption

Caption to display below the image

Stringoptional
Screenshot captionscreenshotcaption

Caption to display below the screenshot

Stringoptional
For Windowsforwindows

If this is a PC tool that runs on Windows

Auto value
0
Booleansuggested
For macOSformac

If this is a PC tool that runs on macOS

Auto value
0
Booleansuggested
For Linuxforlinux

If this is a PC tool that runs on Linux

Auto value
0
Booleansuggested
For Javaforjava

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

Auto value
0
Booleansuggested