(switch to lowercase) |
(update some parts, add notice to update other parts) |
||
| Line 1: | Line 1: | ||
{{MissingInfo|New Traits parameter and other changes}} | |||
==Description== | ==Description== | ||
{{BadgeListNavbar}} | {{BadgeListNavbar}} | ||
| Line 8: | Line 9: | ||
On the badge page you should already have a table that begins using {{T|badge/Start}}. | On the badge page you should already have a table that begins using {{T|badge/Start}}. | ||
The template is used after the table beginning. Here is an example | The template is used after the table beginning. Here is an empty example for a table with 1 entry: | ||
<pre><nowiki>{{badge/Start}} | <pre><nowiki>{{badge/Start}} | ||
{{badge|type= | {{badge|type= | ||
|id = | |id = | ||
|Icon = | |Icon = | ||
|Name = | |Name = | ||
|Location = | |Traits = | ||
|Description = | |Parent = | ||
|Condition = | |Location = | ||
|Author = | |Description = | ||
|Batch= | |Condition = | ||
|Author = | |||
|Batch = | |||
}} | }} | ||
|}</nowiki></pre> | |}</nowiki></pre> | ||
Each badge entry should be written in that format. | Each badge entry should be written in that format. Not every field is required. | ||
The "id" parameter is '''absolutely required''' for the template to work. However, it is hidden from the table itself. | 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 on the badge name. | ||
The most important parameters for the actual function of the template are the "id" and "Location" fields, so endevour to at least add those (if available). Normal wikitext for formatting a table should still work even if it is surrounded by the badge template calls. If a badge has no "Location" field then it would be OK to use this normal wikitext as the subobject the template creates would be useless anyways if no location is specified. | The most important parameters for the actual function of the template are the "id" and "Location" fields, so endevour to at least add those (if available). Normal wikitext for formatting a table should still work even if it is surrounded by the badge template calls. If a badge has no "Location" field then it would be OK to use this normal wikitext as the subobject the template creates would be useless anyways if no location is specified. | ||
| Line 54: | Line 57: | ||
|Page ''(in file namespace)'' | |Page ''(in file namespace)'' | ||
|- | |- | ||
|[[Property: | |[[Property:Is part of game|Is part of game]] | ||
|The game the badge is from. Taken from the type/Namespace parameter, or from the subpage name by default. | |The game the badge is from. Taken from the type/Namespace parameter, or from the subpage name by default. | ||
|''TBA'' | |''TBA'' | ||
| Line 165: | Line 168: | ||
==Sample== | ==Sample== | ||
<!-- Add the template code example here --> | |||
{{badge/Start}} | {{badge/Start}} | ||
|- | |||
|id = | |style="text-align:center; background:#" id="white_tulip"|[[File:White tulip(badgeyn).png]] | ||
| | |<span title="white_tulip" tabindex="0">Rain and Flowers</span> | ||
| | |style="text-align:center; "|<span tabindex="0" title="Secret condition"> 🤐</span><br><span tabindex="0" title="Secret map"> 🗺</span><br> | ||
| | |[[Yume Nikki:Sky Garden#Crossover Garden|Sky Garden: Crossover Garden]] | ||
| | |style="background:#CCC"| | ||
| | |Visit the white tulip passage between Sky Garden and [[Yume Nikki:Ghost World|Ghost World]] | ||
| | |Badge name references a [https://www.youtube.com/watch?v=8ER6sXss5EU ''Yume Nikki'' remix of the same name]. | ||
|Batch | |WikiOdd | ||
}} | |2023-12-01<br>Batch 86}} | ||
|} | |} | ||
The table start and end are provided, as is necessary. | The table start and end are provided, as is necessary. | ||
<noinclude> | |||
<noinclude>[[Category:Template documentation]]</noinclude> | |||
<includeonly>__NOEDITSECTION__</includeonly> | <includeonly>__NOEDITSECTION__</includeonly> | ||
Revision as of 00:38, 4 August 2024
 |
This page is missing information. You can help YumeWiki by expanding it. Details: New Traits parameter and other changes |
Description
Formats the table entries in subpages of YNOproject:Badges. It may be useful as it creates badge subobjects that point a "Badge/Location" property to any locations the badge appears in.
Technically there is no use for the template for YNOproject badges since they never have a location attached to them. You can still use it to auto-format the table row if you wish, but it's best to add normal table entries instead, to avoid lag.
Syntax
On the badge page you should already have a table that begins using {{badge/Start}}.
The template is used after the table beginning. Here is an empty example for a table with 1 entry:
{{badge/Start}}
{{badge|type=
|id =
|Icon =
|Name =
|Traits =
|Parent =
|Location =
|Description =
|Condition =
|Author =
|Batch =
}}
|}
Each badge entry should be written in that format. Not every field is required.
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 on the badge name.
The most important parameters for the actual function of the template are the "id" and "Location" fields, so endevour to at least add those (if available). Normal wikitext for formatting a table should still work even if it is surrounded by the badge template calls. If a badge has no "Location" field then it would be OK to use this normal wikitext as the subobject the template creates would be useless anyways if no location is specified.
After adding all badges, make sure to end the table with:
|}
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 for this property. | Text |
| Badge/Batch | The batch the badge was released in, taken from the ynobadges commits page. Badges before 2022-05-06 will not have a batch number and would only have a date. | Number |
| 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}} if a batch number is provided (recommended), and must be manually provided otherwise. | Date |
| 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) |
| Is part of game | The game the badge is from. Taken from the type/Namespace parameter, or from the subpage name by default. | TBA |
| Badge/ID | The ID of the badge, same as the subobject name. | Text |
| 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/Is hidden | Sets to true for badges with the hidden property in YNOproject. | Boolean |
Parameters
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Badge ID | id | The id of the badge, taken from https://github.com/ynoproject/ynobadges/tree/master/badges. Do not include the filename.
| Line | required |
| Badge Namespace | type Namespace | The wiki namespace the badge belongs to, which is used to format the wikilinks for the ''Location'' field.
| Line | suggested |
| Badge 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 | suggested |
| 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 | suggested |
| Badge Location(s) | Location | The locations that the badge is found in, if any, without the namespace. Found on the badge (the github only provides Map IDs).
| Page name | optional |
| Badge Description | Description | The description of the badge, if any. | Content | optional |
| Badge 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 | suggested |
| 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 commas.
| Line | suggested |
| Batch Number | Batch | The batch which contained the badge. Can be found by checking the commit history on github. For badges prior to 2022-05-06, specify 'Date' instead.
| Number | suggested |
| Release Date | Date | If there is no batch number for the badge, provide the date the badge was released.
| Date | optional |
| Hidden Badge Property | Hidden | Set to ''true'' to signify the badge is hidden. Hidden badges have unique backgrounds, give no BP, and are not counted for certain milestones.
| Boolean | optional |
| 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 |
Sample
| Icon | Name | BP | 🌟 | Location | Description | Condition | Notes | Author | Date/Batch |
|---|---|---|---|---|---|---|---|---|---|
.png){kind=small}
|
Rain and Flowers | 🤐 🗺 |
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. | WikiOdd | 2023-12-01 Batch 86}} |
The table start and end are provided, as is necessary.