3DS:WifiManager and Template:Infobox software/doc: Difference between pages
More actions
m fix releasedate |
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 |
||
| Line 1: | Line 1: | ||
This places an infobox about homebrew software. | |||
=== Example === | |||
{{Infobox homebrew | {{Infobox homebrew | ||
| title = | | title = Checkpoint | ||
| | | developers = FlagBrew | ||
| for3ds = 1 | | 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 = | | 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> | ||
{ | |||
"params": { | |||
"title": { | |||
"label": "Homebrew name", | |||
"type": "string", | |||
"default": "Page title", | |||
"description": "Name of the homebrew - only set this if the page title shouldn't be automatically used" | |||
}, | |||
"image": { | |||
"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.", | |||
"suggested": true | |||
}, | |||
"screenshot": { | |||
"type": "wiki-file-name", | |||
"label": "Screenshot", | |||
"description": "A screenshot of the application. Please also set screenshot alt text.", | |||
"suggested": true | |||
}, | |||
"for3ds": { | |||
"label": "For 3DS", | |||
"description": "If the homebrew is for the Nintendo 3DS", | |||
"type": "boolean", | |||
"autovalue": "0", | |||
"suggested": true | |||
}, | |||
"forwiiu": { | |||
"label": "For Wii U", | |||
"description": "If the homebrew is for the Wii U", | |||
"type": "boolean", | |||
"autovalue": "0", | |||
"suggested": true | |||
}, | |||
"forswitch": { | |||
"label": "For Switch", | |||
"description": "If the homebrew is for the Nintendo Switch", | |||
"type": "boolean", | |||
"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)", | |||
"suggested": true, | |||
"type": "string" | |||
}, | |||
"github": { | |||
"label": "GitHub repository", | |||
"description": "Where the source code is on GitHub", | |||
"example": "FlagBrew/Checkpoint", | |||
"type": "string" | |||
}, | |||
"gitlab": { | |||
"label": "GitLab.com repository", | |||
"description": "Where the source code is on GitLab (not self-hosted instances)", | |||
"example": "FlagBrew/Checkpoint", | |||
"type": "string" | |||
}, | |||
"sourceurl": { | |||
"label": "Source code URL", | |||
"description": "Where the source code is (if not on GitHub or GitLab.com)", | |||
"type": "url" | |||
}, | |||
"releaseurl": { | |||
"label": "External release URL", | |||
"description": "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", | |||
"type": "url" | |||
}, | |||
"universaldb": { | |||
"label": "Universal-DB URL path", | |||
"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" | |||
}, | |||
"githubtag": { | |||
"label": "GitHub release tag", | |||
"description": "Tag for the latest release on GitHub (requires GitHub repository to be set)", | |||
"example": "latest, v1.0.2", | |||
"type": "string" | |||
}, | |||
"gitlabtag": { | |||
"label": "GitLab release tag", | |||
"description": "Tag for the latest release on GitLab.com (requires GitLab repository to be set, not self-hosted instances)", | |||
"example": "permalink/latest, v1.0.2", | |||
"type": "string" | |||
}, | |||
"imagealt": { | |||
"label": "Image alt text", | |||
"type": "string", | |||
"description": "Alt text for the image, appears on hover and to screen readers", | |||
"example": "Checkpoint banner on the Home Menu", | |||
"suggested": true | |||
}, | |||
"imagesize": { | |||
"label": "Image size", | |||
"description": "Resize the image, accepts any value that the MediaWiki image syntax uses (recommended to use if image is over is 256px wide)", | |||
"example": "256px", | |||
"type": "string" | |||
}, | |||
"caption": { | |||
"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", | |||
"description": "If this is a PC tool that runs on Windows", | |||
"type": "boolean", | |||
"autovalue": "0", | |||
"suggested": true | |||
}, | |||
"formac": { | |||
"label": "For macOS", | |||
"description": "If this is a PC tool that runs on macOS", | |||
"type": "boolean", | |||
"autovalue": "0", | |||
"suggested": true | |||
}, | |||
"forlinux": { | |||
"label": "For Linux", | |||
"description": "If this is a PC tool that runs on Linux", | |||
"type": "boolean", | |||
"autovalue": "0", | |||
"suggested": true | |||
}, | |||
"forjava": { | |||
"label": "For Java", | |||
"description": "If this is a PC tool that is a Java-based program", | |||
"type": "boolean", | |||
"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 | |||
} | |||
}, | |||
"format": "block", | |||
"description": "Console homebrew infobox.", | |||
"paramOrder": [ | |||
"title", | |||
"image", | |||
"imagealt", | |||
"imagesize", | |||
"screenshot", | |||
"screenshotalt", | |||
"screenshotsize", | |||
"for3ds", | |||
"forwiiu", | |||
"forswitch", | |||
"forwii", | |||
"developers", | |||
"version", | |||
"releasedate", | |||
"website", | |||
"github", | |||
"gitlab", | |||
"sourceurl", | |||
"releaseurl", | |||
"universaldb", | |||
"osc", | |||
"githubtag", | |||
"gitlabtag", | |||
"caption", | |||
"screenshotcaption", | |||
"forwindows", | |||
"formac", | |||
"forlinux", | |||
"forjava" | |||
] | |||
} | |||
</templatedata> | |||
Latest revision as of 02:20, 31 October 2024
This places an infobox about homebrew software.
Example
![]() | |
| Developer(s) | FlagBrew |
|---|---|
| Console | Nintendo 3DS, Nintendo Switch |
| Version | 3.8.0 (November 13, 2021) |
| Links | |
| GitHub | FlagBrew/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
| releasedate = 2021-11-13
| github = FlagBrew/Checkpoint
| githubtag = v3.8.0
}}
TemplateData
Console homebrew infobox.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Homebrew name | title | Name of the homebrew - only set this if the page title shouldn't be automatically used
| 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
| 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)
| 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
| 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)
| String | optional |
| For 3DS | for3ds | If the homebrew is for the Nintendo 3DS
| Boolean | suggested |
| For Wii U | forwiiu | If the homebrew is for the Wii U
| Boolean | suggested |
| For Switch | forswitch | If the homebrew is for the Nintendo Switch
| Boolean | suggested |
| For Wii | forwii | If the homebrew is for the Wii
| Boolean | suggested |
| Developers | developers | List of primary developers
| 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
| 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
| String | optional |
| GitLab.com repository | gitlab | Where the source code is on GitLab (not self-hosted instances)
| 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
| URL | optional |
| Universal-DB URL path | universaldb | URL path to the homebrew's page on Universal-DB (db.universal-team.net)
| String | optional |
| Open Shop Channel URL path | osc | URL path to the homebrew's page on Open Shop Channel (oscwii.org/library)
| String | optional |
| GitHub release tag | githubtag | Tag for the latest release on GitHub (requires GitHub repository to be set)
| String | optional |
| GitLab release tag | gitlabtag | Tag for the latest release on GitLab.com (requires GitLab repository to be set, not self-hosted instances)
| 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
| Boolean | suggested |
| For macOS | formac | If this is a PC tool that runs on macOS
| Boolean | suggested |
| For Linux | forlinux | If this is a PC tool that runs on Linux
| Boolean | suggested |
| For Java | forjava | If this is a PC tool that is a Java-based program
| Boolean | suggested |
