(create documentation for song template) |
(Added documentation) |
||
Line 26: | Line 26: | ||
==Parameters== |
==Parameters== |
||
<templatedata> |
|||
{ |
|||
===color=== |
|||
"params": { |
|||
(Optional) The background color of the headers. Overrides background color set by unit. |
|||
"bg color": { |
|||
"example": "#000000", |
|||
(Optional) The text color of the headers. Overrides text color set by unit. |
|||
"type": "string", |
|||
"label": "Background Color", |
|||
===song title=== |
|||
"default": "#000000", |
|||
(Optional) The title of the song, defaults to page title if unset. |
|||
"description": "The background color of the headers. Overrides the colors associated with units if specified." |
|||
}, |
|||
===image=== |
|||
"text color": { |
|||
The jacket of the song, format should be Jacket<number>.png. <number> should be zero-padded to 3 widths. |
|||
"label": "Text Color", |
|||
===image_alt=== |
|||
"example": "#FFFFFF", |
|||
Alternate jacket of the song. Currently unused. |
|||
"type": "string", |
|||
"default": "#FFFFFF", |
|||
===kanji=== |
|||
"description": "The text color of the text inside headers. Overrides text colors associated with units if specified." |
|||
The official song title in Japanese. |
|||
}, |
|||
===romaji=== |
|||
"song title": { |
|||
The romanization of the official song title in Japanese. |
|||
"label": "Song Title", |
|||
===english=== |
|||
"example": "Miku Miku ni Shite Ageru ♪ 【Shiteyanyo】", |
|||
The official song title in English. |
|||
"suggested": true, |
|||
"type": "string", |
|||
===singer=== |
|||
"description": "The song title. Defaults to the page title if none given.", |
|||
The singer(s) in the original version of the song. |
|||
"required": true |
|||
===producer=== |
|||
}, |
|||
The producer(s) of the song. |
|||
"image": { |
|||
===composer=== |
|||
"label": "Image", |
|||
The composer(s) of the song. |
|||
"example": "Jacket001.png", |
|||
===lyricist=== |
|||
"type": "string", |
|||
The lyricist(s) of the song. |
|||
"default": "Dummyalbumart.png", |
|||
"suggested": true, |
|||
===unit=== |
|||
"description": "The jacket for the song." |
|||
The unit that the song belongs to. Use the following abbreviations to set the correct unit image and colors. |
|||
}, |
|||
* VIRTUAL SINGER = vs |
|||
"image alt": { |
|||
* Leo/need = ln |
|||
"label": "Image (alt)", |
|||
* MORE MORE JUMP! = mmj |
|||
"type": "string", |
|||
* Vivid BAD SQUAD = vbs |
|||
"description": "Alternative jacket for the song. Not implemented yet." |
|||
* Wonderlands×Showtime = wxs |
|||
}, |
|||
* 25-ji, Night Code de. = niigo |
|||
"kanji": { |
|||
"label": "Kanji", |
|||
"suggested": true, |
|||
"example": "みくみくにしてあげる♪【してやんよ】 ", |
|||
"description": "The official Japanese song title.", |
|||
"type": "string" |
|||
}, |
|||
"romaji": { |
|||
"label": "Romaji", |
|||
"suggested": true, |
|||
"example": "Miku Miku ni Shite Ageru♪ (Shite Yan yo) ", |
|||
"type": "string", |
|||
"description": "The romanized version of the Japanese song title." |
|||
}, |
|||
"english": { |
|||
"label": "English", |
|||
"suggested": true, |
|||
"example": "I'll Miku-Miku You♪ (For Reals) ", |
|||
"type": "string", |
|||
"description": "The official English song title." |
|||
}, |
|||
"singer": { |
|||
"label": "Original Singer(s)", |
|||
"required": true, |
|||
"description": "The original singer(s) of the song.", |
|||
"example": "Hatsune MIku", |
|||
"type": "string" |
|||
}, |
|||
"producer": { |
|||
"label": "Producer(s)", |
|||
"required": true, |
|||
"description": "The producer(s) of the song.", |
|||
"example": "ika", |
|||
"type": "string" |
|||
}, |
|||
"composer": { |
|||
"label": "Composer(s)", |
|||
"description": "The composer(s) of the song.", |
|||
"type": "string" |
|||
}, |
|||
"lyricist": { |
|||
"label": "Lyricist(s)", |
|||
"description": "The lyricist(s) associated with the song.", |
|||
"type": "string" |
|||
}, |
|||
"unit": { |
|||
"label": "Unit", |
|||
"type": "string", |
|||
"example": "vs", |
|||
"suggested": true, |
|||
"description": "The unit associated with the song. Use \"vs\" for VIRTUAL SINGER, \"ln\" for Leo/need, \"mmj\" for MORE MORE JUMP!, \"vbs\" for Vivid BAD SQUAD, \"wxs\" for Wonderlands×Showtime, \"niigo\" for 25-ji, Night Code de." |
|||
}, |
|||
"bpm": { |
|||
"label": "BPM", |
|||
"type": "number", |
|||
"suggested": true, |
|||
"description": "The BPM of the song. Use https://twitter.com/MaengZombie/status/1384862015156482052 as reference.", |
|||
"example": "160" |
|||
}, |
|||
"duration": { |
|||
"label": "Duration", |
|||
"type": "string", |
|||
"suggested": true, |
|||
"description": "The length of the song, not including beginning silence.", |
|||
"example": "1:41" |
|||
}, |
|||
"mv": { |
|||
"label": "MV", |
|||
"type": "string", |
|||
"example": "3D", |
|||
"suggested": true, |
|||
"description": "Whether or not the song has an MV. Use \"3D\", \"2D\", \"Original\", or \"None\"." |
|||
}, |
|||
"easy difficulty": { |
|||
"label": "Easy Difficulty", |
|||
"type": "number", |
|||
"suggested": true, |
|||
"example": "7", |
|||
"description": "The difficulty of the easy chart. Defaults to \"N/A\" if none given." |
|||
}, |
|||
"normal difficulty": { |
|||
"label": "Normal Difficulty", |
|||
"type": "number", |
|||
"suggested": true, |
|||
"example": "12", |
|||
"description": "The difficulty of the normal chart. Defaults to \"N/A\" if none given." |
|||
}, |
|||
"hard difficulty": { |
|||
"label": "Hard Difficulty", |
|||
"type": "number", |
|||
"suggested": true, |
|||
"example": "17", |
|||
"description": "The difficulty of the hard chart. Defaults to \"N/A\" if none given." |
|||
}, |
|||
"expert difficulty": { |
|||
"label": "Expert Difficulty", |
|||
"type": "number", |
|||
"suggested": true, |
|||
"example": "24", |
|||
"description": "The difficulty of the expert chart. Defaults to \"N/A\" if none given." |
|||
}, |
|||
"master difficulty": { |
|||
"label": "Master Difficulty", |
|||
"type": "number", |
|||
"suggested": true, |
|||
"example": "28", |
|||
"description": "The difficulty of the master chart. Defaults to \"N/A\" if none given." |
|||
}, |
|||
"easy notes": { |
|||
"label": "Easy Notes", |
|||
"example": "139", |
|||
"suggested": true, |
|||
"description": "The number of notes in the easy chart. Defaults to \"N/A\" if none given.", |
|||
"type": "number" |
|||
}, |
|||
"normal notes": { |
|||
"label": "Normal Notes", |
|||
"example": "339", |
|||
"suggested": true, |
|||
"description": "The number of notes in the normal chart. Defaults to \"N/A\" if none given.", |
|||
"type": "number" |
|||
}, |
|||
"hard notes": { |
|||
"label": "Hard Notes", |
|||
"type": "number", |
|||
"suggested": true, |
|||
"example": "439", |
|||
"description": "The number of notes in the hard chart. Defaults to \"N/A\" if none given." |
|||
}, |
|||
"expert notes": { |
|||
"label": "Expert Notes", |
|||
"example": "739", |
|||
"type": "number", |
|||
"suggested": true, |
|||
"description": "The number of notes in the expert chart. Defaults to \"N/A\" if none given." |
|||
}, |
|||
"master notes": { |
|||
"label": "Master Notes", |
|||
"example": "939", |
|||
"type": "number", |
|||
"suggested": true, |
|||
"description": "The number of notes in the master chart. Defaults to \"N/A\" if none given." |
|||
} |
|||
}, |
|||
"paramOrder": [ |
|||
"bg color", |
|||
"text color", |
|||
"song title", |
|||
"image", |
|||
"image alt", |
|||
"kanji", |
|||
"romaji", |
|||
"english", |
|||
"singer", |
|||
"producer", |
|||
"composer", |
|||
"lyricist", |
|||
"unit", |
|||
"bpm", |
|||
"duration", |
|||
"mv", |
|||
"easy difficulty", |
|||
"normal difficulty", |
|||
"hard difficulty", |
|||
"expert difficulty", |
|||
"master difficulty", |
|||
"easy notes", |
|||
"normal notes", |
|||
"hard notes", |
|||
"expert notes", |
|||
"master notes" |
|||
], |
|||
"description": "Infobox Song for displaying song information.", |
|||
"format": "block" |
|||
} |
|||
</templatedata> |
|||
==Quick Copy== |
==Quick Copy== |
||
<pre> |
<pre> |
||
{{Infobox Song |
{{Infobox Song |
||
|color |
|bg color = |
||
|text color = |
|text color = |
||
|song title = |
|song title = |
||
|image = |
|image = |
||
|image alt = |
|image alt = |
||
|kanji = |
|kanji = |
||
|romaji = |
|romaji = |
||
|english = |
|english = |
||
|singer = |
|singer = |
||
|producer = |
|producer = |
||
|composer = |
|composer = |
||
|lyricist = |
|lyricist = |
||
|unit = |
|unit = |
||
|bpm = |
|bpm = |
||
|duration = |
|duration = |
||
|mv = |
|mv = |
||
|easy difficulty = |
|easy difficulty = |
||
|normal difficulty = |
|normal difficulty = |
||
|hard difficulty = |
|hard difficulty = |
||
|expert difficulty = |
|expert difficulty = |
||
|master difficulty = |
|master difficulty = |
||
|easy notes = |
|easy notes = |
||
|normal notes = |
|normal notes = |
||
|hard notes = |
|hard notes = |
||
|expert notes = |
|expert notes = |
||
|master notes = |
|master notes = |
||
}} |
}} |
||
</pre> |
</pre> |
Revision as of 03:36, 14 May 2021
Parameters
Infobox Song for displaying song information.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Background Color | bg color | The background color of the headers. Overrides the colors associated with units if specified.
| String | optional |
Text Color | text color | The text color of the text inside headers. Overrides text colors associated with units if specified.
| String | optional |
Song Title | song title | The song title. Defaults to the page title if none given.
| String | required |
Image | image | The jacket for the song.
| String | suggested |
Image (alt) | image alt | Alternative jacket for the song. Not implemented yet. | String | optional |
Kanji | kanji | The official Japanese song title.
| String | suggested |
Romaji | romaji | The romanized version of the Japanese song title.
| String | suggested |
English | english | The official English song title.
| String | suggested |
Original Singer(s) | singer | The original singer(s) of the song.
| String | required |
Producer(s) | producer | The producer(s) of the song.
| String | required |
Composer(s) | composer | The composer(s) of the song. | String | optional |
Lyricist(s) | lyricist | The lyricist(s) associated with the song. | String | optional |
Unit | unit | The unit associated with the song. Use "vs" for VIRTUAL SINGER, "ln" for Leo/need, "mmj" for MORE MORE JUMP!, "vbs" for Vivid BAD SQUAD, "wxs" for Wonderlands×Showtime, "niigo" for 25-ji, Night Code de.
| String | suggested |
BPM | bpm | The BPM of the song. Use https://twitter.com/MaengZombie/status/1384862015156482052 as reference.
| Number | suggested |
Duration | duration | The length of the song, not including beginning silence.
| String | suggested |
MV | mv | Whether or not the song has an MV. Use "3D", "2D", "Original", or "None".
| String | suggested |
Easy Difficulty | easy difficulty | The difficulty of the easy chart. Defaults to "N/A" if none given.
| Number | suggested |
Normal Difficulty | normal difficulty | The difficulty of the normal chart. Defaults to "N/A" if none given.
| Number | suggested |
Hard Difficulty | hard difficulty | The difficulty of the hard chart. Defaults to "N/A" if none given.
| Number | suggested |
Expert Difficulty | expert difficulty | The difficulty of the expert chart. Defaults to "N/A" if none given.
| Number | suggested |
Master Difficulty | master difficulty | The difficulty of the master chart. Defaults to "N/A" if none given.
| Number | suggested |
Easy Notes | easy notes | The number of notes in the easy chart. Defaults to "N/A" if none given.
| Number | suggested |
Normal Notes | normal notes | The number of notes in the normal chart. Defaults to "N/A" if none given.
| Number | suggested |
Hard Notes | hard notes | The number of notes in the hard chart. Defaults to "N/A" if none given.
| Number | suggested |
Expert Notes | expert notes | The number of notes in the expert chart. Defaults to "N/A" if none given.
| Number | suggested |
Master Notes | master notes | The number of notes in the master chart. Defaults to "N/A" if none given.
| Number | suggested |
Quick Copy
{{Infobox Song |bg color = |text color = |song title = |image = |image alt = |kanji = |romaji = |english = |singer = |producer = |composer = |lyricist = |unit = |bpm = |duration = |mv = |easy difficulty = |normal difficulty = |hard difficulty = |expert difficulty = |master difficulty = |easy notes = |normal notes = |hard notes = |expert notes = |master notes = }}