 |
This template automatically sets Semantic MediaWiki properties on pages. This may include creating subobjects. Please only use this template as intended. |
Description
This template formats the table entries in subpages of YNOproject:Badges. Besides adding markup and tags, it creates badge subobjects with a "Badge/Location" property that interacts with each location the badge appears in.
On the badge page you should already have a table that begins using {{badge/Start}}. The template is used after the table start. At the end of the last template usage, make sure to close the table with the |} table end.
The "id" parameter is absolutely required for the template to work. However, it is hidden from the table itself, only present as a title when hovering over the badge name (or tapping on mobile). The most important parameters for the intended function of the template are the "id" and "Location" fields, so endevour to at least add those if possible.
Usage
The template creates a subobject with the id as a name. For example, using the template with |id = fc_moai in page YNOproject:Badges/Yume Nikki would create the subobject YNOproject:Badges/Yume Nikki#fc_moai. The subobject is also given properties related to the badge.
| Property | Function | Datatype |
|---|---|---|
| Badge/Author | Each author for a badge is listed as a value of this property. | Text |
| Badge/BP | The number of Badge Points the badge awards. | Number |
| Badge/Batch | The batch the badge was released in, taken from the ynobadges commits page. | Number |
| Badge/Condition | The condition string of the badge, including any wiki markup. | Text |
| Badge/Date | The date on which the badge was added to ynobadges: this may not be the day it was made available on the website. This is automatically filled in using {{Badge/Batch2Date}}. However, badges with batch 1 should specify date manually using |Date = in addition to the batch.
|
Date |
| Badge/Description | The description of the badge, including any wiki markup. | Text |
| Badge/Has parent | Sets to true for badges with the parent property in YNOproject, otherwise false.
|
Boolean |
| Badge/Has secret condition | Sets to true for badges with the secretCondition property in YNOproject, otherwise false. If a badge has both secretCondition and secret, the trait should be omitted and the value would remain false.
|
Boolean |
| Badge/Has secret map | Sets to true for badges with the secretMap property in YNOproject, otherwise false.
|
Boolean |
| Badge/ID | The ID of the badge, same as the subobject name. | Text |
| Badge/Icon | The icon of the badge. In many cases both an animated version (.gif) and a static version (.png) as separate values. | Page (in file namespace) |
| Badge/Is hidden | Sets to true for badges with the hidden property in YNOproject, otherwise false.
|
Boolean |
| Badge/Is secret | Sets to true for badges with the secret property in YNOproject, otherwise false.
|
Boolean |
| Badge/Location | The location of the badge. Can be multiple. This lists the badge subobject as an incoming property of that location. | Page |
| Badge/Name | The name of the badge as presented in YNOproject. | Text |
| Badge/Parent | The badge ID of the parent badge, which is the value of the parent property in YNOproject.
|
Text |
| Is part of game | The game the badge is from. Taken from the type/Namespace parameter, or from the subpage name by default. | Text |
Parameters
The badge template handles both subobject data and table row presentation.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Badge ID | id | The id of the badge, taken from https://github.com/ynoproject/ynobadges/tree/master/badges. | Line | required |
| Icon(s) | Icon | The filename(s) of the badge to present in the table, without the "File:" prefix. If animated, put the gif first and separate using commas. Image files on the wiki usually have different names than on the YNOproject GitHub. | File | required |
| Icon Background Override | Icon_bg | Set a hex code to use for the background of an icon cell, to potentially clear any visibility issues. | Line | optional |
| Badge Name | Name | The name of the badge as presented in YNOproject itself, or as found in https://github.com/ynoproject/ynobadges/blob/master/lang/en.json. | Line | required |
| BP | BP | The number of Badge Points the badge awards. | Number | optional |
| Traits | Traits | Any traits the badge may have, such as hidden or secret. Separate multiple traits using commas. Possible values: Is hidden, Is Secret, Has secret condition, Has secret map, Has parent.
| Line | optional |
| Secret Badge Parent | Parent | The badge ID of this badge's parent, if this badge has the trait "Has parent". | Line | optional |
| Badge Location(s) | Location | The locations that the badge is found in, if any, without the namespace. Found on the website (the GitHub only provides Map IDs). | Page name | optional |
| Description | Description | The description of the badge, if any. | Content | suggested |
| Unlock Conditions | Condition | The condition of the badge, as found on the site or in https://github.com/ynoproject/ynobadges/blob/master/lang/en.json. | Content | required |
| Notes | Notes | Any notes you wish to give regarding the badge. For example, you can point out a game reference that you spotted in the badge description. | Content | optional |
| Badge Author(s) | Author | Badge artist names. If multiple, separate using the & symbol.
| Line | required |
| Batch Number | Batch | The batch which contained the badge. Can be found in the badge file. For batch 1 badges, you may need to specify "Date" as well.
| Number | suggested |
| Release Date | Date | Provide the date the badge was released if there is no batch number, or if the batch number may be inaccurate/not specific, such as for batch 1 badges.
| Date | optional |
Sample
| Icon | Name | BP | 🌟 | Location | Description | Condition | Notes | Author | Date/Batch |
|---|---|---|---|---|---|---|---|---|---|
.png){kind=small}
|
Rain and Flowers | 15 | 🤐 🗺 |
Sky Garden: Crossover Garden | Visit the white tulip passage between Sky Garden and Ghost World | Badge name references a Yume Nikki remix of the same name. | wiki0dd | 2023-12-01 Batch 86 |
The table start and end are provided, as is necessary.