Template:Badge/doc

Description

Formats the table entries in YNOproject:Badges/Badge List, useful as it creates badge subobjects that point a "Badge/Location" property to any locations the badge appears in. Also creates other properties that may be useful.
Technically there is no use for the template in the section for YNOproject badges since they never have a location attached to them.

Syntax

On the badge page you should already have a table that begins like this:

{| style="width: 100%;" cellspacing="0" cellpadding="4" border="1"
|-
| style="text-align: center;" |<u>'''Icon(s)'''</u>
| style="text-align: center;" |<u>'''Name'''</u>
| style="text-align: center;" |<u>'''Location'''</u>
| style="text-align: center;" |<u>'''Description'''</u>
| style="text-align: center;" |<u>'''Condition(s)'''</u>
| style="text-align: center;" |<u>'''Note(s)'''</u>
| style="text-align: center;" |<u>'''Author(s)'''</u>
| style="text-align: center;" |<u>'''Release batch/Date'''</u>

The template is used after the table beginning. Here is an example input:

{{badge|type=Yume Nikki|
|id = fc_moai
|Icon = Nasu gold(badgeyn).gif, Nasu gold(badgeyn).png
|Name = Tomb of the Moai
|Location = FC Dungeon
|Description = What a nice statue!
|Condition = Enter the moai head room in the FC Dungeon
|Author = WikiOdd
}}

Each badge entry should be written in that format. Note there are more parameters that were absent in the example as they were not needed (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 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

TBA

Parameters

Template parameters

Parameter		Description	Type	Status
Badge Namespace	type Namespace	The wiki namespace the badge belongs to, which is used to format the wikilinks for the ''Location'' field. The location column is also removed if the namespace is set to YNOproject. Example Yume 2kki	Line	required
Badge ID	id	The id of the badge, taken from https://github.com/ynoproject/ynobadges/tree/master/badges. Do not include the filename. Example akako	Line	required
Badge Icon(s)	Icon	The filename(s) of the badge to present in the table, without the ''File:'' prefix. If multiple, separate using commas. Note: image files on the wiki likely have different names than the files in the YNOproject github. Default TBA Example Akako Gif Bdg.gif, AkakoStill Bdg.png	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. Default Missing Example White Scarlet Akako	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). Example White Scarlet Exhibition	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. Default Please add the condition of this badge! Example Show Akako in the White Scarlet Exhibition all of the effects she likes	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. Default Please add author credits! Example Rose	String	suggested
Release Date	Date	The date the badge was released, preferably in the ISO YYYY-MM-DD format. Can be found by checking the commit history on github. Default value for Batch Example 2023-07-08	Date	suggested
Batch Number	Batch	If there is no input for ''Date'', you can specify the batch number instead. Default TBA Example 32	Number	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. Default false Example true	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. Example 14c932	Line	optional

Sample

The example given in "Syntax" above would produce the following output:

Icon(s)	Name	Location	Description	Condition(s)	Note(s)	Author(s)	Release batch/Date
	Tomb of the Moai	FC Dungeon	What a nice statue!	Enter the moai head room in the FC Dungeon		WikiOdd	TBA

The table start and end are provided, as is necessary.