Template:Infobox song/doc: Difference between revisions

Template page
Content added Content deleted
(create documentation for song template)
 
mNo edit summary
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Infobox Song
{{Lua|Module:Infobox song}} {{Cargo|songs}}
|song title = Tell Your World
|image = jacket_s_001.png
|kanji = Tell Your World
|romaji = Tell Your World
|english = Tell Your World
|singer = Hatsune Miku
|producer = kz (livetune)
|unit = vs
|bpm = 150
|duration = 2:05
|mv = 3D
|easy difficulty = 5
|normal difficulty = 10
|hard difficulty = 16
|expert difficulty = 22
|master difficulty = 26
|easy notes = 220
|normal notes = 490
|hard notes = 717
|expert notes = 963
|master notes = 1147
}}


== Parameters ==
__TOC__
<templatedata>
{
"params": {
"bg color": {
"example": "#000000",
"type": "string",
"label": "Background color",
"default": "#000000",
"description": "The background color of the headers. Overrides the colors associated with units if specified."
},
"text color": {
"label": "Text color",
"example": "#FFFFFF",
"type": "string",
"default": "#FFFFFF",
"description": "The text color of the text inside headers. Overrides text colors associated with units if specified."
},
"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."
},
"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": "number",
"suggested": true,
"description": "The length of the full song.",
"example": "308"
},
"easy difficulty": {
"label": "Easy difficulty",
"type": "number",
"example": "7",
"description": "The difficulty of the easy chart.",
"required": true
},
"normal difficulty": {
"label": "Normal difficulty",
"type": "number",
"example": "12",
"description": "The difficulty of the normal chart.",
"required": true
},
"hard difficulty": {
"label": "Hard difficulty",
"type": "number",
"example": "17",
"description": "The difficulty of the hard chart.",
"required": true
},
"expert difficulty": {
"label": "Expert difficulty",
"type": "number",
"example": "24",
"description": "The difficulty of the expert chart.",
"required": true
},
"master difficulty": {
"label": "Master difficulty",
"type": "number",
"example": "28",
"description": "The difficulty of the master chart.",
"required": true
},
"easy notes": {
"label": "Easy notes",
"example": "139",
"description": "The number of notes in the easy chart.",
"type": "number",
"required": true
},
"normal notes": {
"label": "Normal notes",
"example": "339",
"description": "The number of notes in the normal chart.",
"type": "number",
"required": true
},
"hard notes": {
"label": "Hard notes",
"type": "number",
"example": "439",
"description": "The number of notes in the hard chart.",
"required": true
},
"expert notes": {
"label": "Expert notes",
"example": "739",
"type": "number",
"description": "The number of notes in the expert chart.",
"required": true
},
"master notes": {
"label": "Master notes",
"example": "939",
"type": "number",
"description": "The number of notes in the master chart.",
"required": true
},
"japanese": {
"label": "Japanese",
"description": "The official Japanese song title.",
"example": "みくみくにしてあげる♪【してやんよ】 ",
"type": "string",
"suggested": true
},
"song id": {
"label": "Song ID",
"description": "The internal ID of the song.",
"example": "124",
"type": "number",
"required": true
},
"date": {
"label": "Release Date",
"description": "The date that the song was released in game. Use format YYYY/MM/DD",
"example": "2021/03/09",
"type": "date",
"required": true
},
"3d mv": {
"label": "3D MV",
"description": "Whether or not the song has a 3D MV. Use \"yes\" or \"no\".",
"type": "boolean",
"example": "No",
"required": true
},
"2d mv": {
"description": "Whether or not the song has a 2D MV. Use \"yes\" or \"no\".",
"type": "boolean",
"label": "2D MV",
"example": "No",
"required": true
},
"original mv": {
"label": "Original MV",
"type": "boolean",
"description": "Whether or not the song has an original MV. Use \"yes\" or \"no\".",
"example": "No",
"required": true
},
"song name": {
"label": "Song name",
"description": "The song name. Defaults to the page title if none given.",
"example": "Miku Miku ni Shite Ageru ♪ 【Shiteyanyo】",
"type": "string",
"required": true
},
"jacket": {
"label": "Jacket",
"description": "The jacket for the song.",
"example": "Jacket001.png",
"type": "string",
"default": "Dummyalbumart.png",
"suggested": true
},
"jacket alt": {
"label": "Jacket (alt)",
"description": "Alternative jacket for the song",
"example": "Jacket001 (alt).png",
"type": "string"
},
"jacket alt 2": {
"label": "Jacket (alt 2)",
"description": "Alternative jacket for the song",
"type": "string"
},
"type": {
"label": "Song type",
"description": "The type of song. Can be one of \"Pre-existing\", \"Commissioned\", or \"Contest winner\".",
"example": "no",
"type": "string",
"suggested": true
},
"game duration": {
"label": "Duration (game-size)",
"description": "The length of the song in game. Does not include beginning silence.",
"example": "101",
"type": "number",
"required": true
},
"singers": {
"label": "Original singer(s)",
"description": "The original singer(s) of the song, separated by commas.",
"example": "Hatsune MIku",
"type": "string",
"suggested": true
},
"producers": {
"label": "Producer(s)",
"description": "The producer(s) of the song, separated by commas.",
"example": "ika",
"type": "string",
"required": true
},
"composers": {
"label": "Composer(s)",
"description": "The composer(s) of the song, separated by commas.",
"example": "ika",
"type": "string",
"suggested": true
},
"arrangers": {
"label": "Arranger(s)",
"description": "The arranger(s) of the song, separated by commas.",
"example": "ika",
"type": "string",
"suggested": true
},
"lyricists": {
"label": "Lyricist(s)",
"description": "The lyricist(s) of the song, separated by commas.",
"example": "ika",
"type": "string",
"suggested": true
},
"units": {
"label": "Unit categories",
"description": "The category that this song belongs to. Options are \"VIRTUAL SINGER\", \"Leo/need\", \"MORE MORE JUMP!\", \"Vivid BAD SQUAD\", \"Wonderlands×Showtime\", \"25-ji, Nightcord de.\", and \"Other\"",
"example": "VIRTUAL SINGER",
"type": "string",
"suggested": true
},
"unlock": {
"label": "Unlock method",
"description": "The way this song is unlocked. Is one of the options: \"Automatically unlocked\", \"Music Shop\", \"Present Box\", or \"Main Story\"",
"type": "string",
"required": true
}
},
"paramOrder": [
"bg color",
"text color",
"song id",
"song name",
"jacket",
"jacket alt",
"jacket alt 2",
"japanese",
"romaji",
"english",
"singers",
"producers",
"duration",
"composers",
"arrangers",
"lyricists",
"units",
"unlock",
"type",
"bpm",
"game duration",
"3d mv",
"2d mv",
"original mv",
"date",
"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>


==Parameters==
== Quick copy ==
<pre>
{{Infobox song
| song id =
| song name =
| jacket =
| jacket alt =
| jacket alt 2 =
| japanese =
| romaji =
| english =
| singers =
| producers =
| duration =
| units =
| unlock =
| arrangers =
| composers =
| lyricists =
| type =
| bpm =
| game duration =
| date =
| 3d mv =
| 2d mv =
| original mv =
| easy difficulty =
| normal difficulty =
| hard difficulty =
| expert difficulty =
| master difficulty =
| easy notes =
| normal notes =
| hard notes =
| expert notes =
| master notes =
}}
</pre>


===color===
== Examples ==
{{Infobox song
(Optional) The background color of the headers. Overrides background color set by unit.
| song id = 1
===text color===
| song name = Tell Your World
(Optional) The text color of the headers. Overrides text color set by unit.
| jacket = Jacket001.png
| singers = Hatsune Miku
| producers = kz (livetune)
| duration = 257
| arrangers = kz (livetune)
| composers = kz (livetune)
| lyricists = kz (livetune)
| units = VIRTUAL SINGER
| unlock = Automatically unlocked
| type = Pre-existing
| bpm = 150
| game duration = 123
| date = 2020/09/30
| 3d mv = Yes
| 2d mv = No
| original mv = No
| easy difficulty = 5
| normal difficulty = 10
| hard difficulty = 16
| expert difficulty = 22
| master difficulty = 26
| easy notes = 220
| normal notes = 492
| hard notes = 719
| expert notes = 961
| master notes = 1147
}}


<pre>
===song title===
{{Infobox song
(Optional) The title of the song, defaults to page title if unset.
| song id = 1
| song name = Tell Your World
| jacket = Jacket001.png
| singers = Hatsune Miku
| producers = kz (livetune)
| duration = 257
| arrangers = kz (livetune)
| composers = kz (livetune)
| lyricists = kz (livetune)
| units = VIRTUAL SINGER
| unlock = Automatically unlocked
| type = Pre-existing
| bpm = 150
| game duration = 123
| date = 2020/09/30
| 3d mv = Yes
| 2d mv = No
| original mv = No
| easy difficulty = 5
| normal difficulty = 10
| hard difficulty = 16
| expert difficulty = 22
| master difficulty = 26
| easy notes = 220
| normal notes = 492
| hard notes = 719
| expert notes = 961
| master notes = 1147
}}
</pre>


{{clear}}
===image===
The jacket of the song, format should be Jacket<number>.png. <number> should be zero-padded to 3 widths.
===image_alt===
Alternate jacket of the song. Currently unused.


{{Infobox song
===kanji===
|bg color = #FFFFA8
The official song title in Japanese.
|text color = #000000
===romaji===
|song name = Sweet Magic
The romanization of the official song title in Japanese.
|japanese = スイートマジック
===english===
|romaji = Sweet Magic
The official song title in English.
|english = Sweet Magic

|producer = Junky
===singer===
|units = Wonderlands×Showtime
The singer(s) in the original version of the song.
|bpm = 123
===producer===
|game duration = 149
The producer(s) of the song.
|3d mv = Yes
===composer===
}}
The composer(s) of the song.
===lyricist===
The lyricist(s) of the song.


===unit===
The unit that the song belongs to. Use the following abbreviations to set the correct unit image and colors.
* VIRTUAL SINGER = vs
* Leo/need = ln
* MORE MORE JUMP! = mmj
* Vivid BAD SQUAD = vbs
* Wonderlands×Showtime = wxs
* 25-ji, Night Code de. = niigo

==Quick Copy==
<pre>
<pre>
{{Infobox Song
{{Infobox song
|color =
|bg color = #FFFFA8
|text color =
|text color = #000000
|song title =
|song name = Sweet Magic
|japanese = スイートマジック
|image =
|romaji = Sweet Magic
|image alt =
|kanji =
|english = Sweet Magic
|romaji =
|producer = Junky
|units = Wonderlands×Showtime
|english =
|singer =
|bpm = 123
|game duration = 149
|producer =
|3d mv = Yes
|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 =
}}
}}
</pre>
</pre>

<includeonly>[[Category:Infobox templates]]</includeonly>

Latest revision as of 22:41, 28 April 2023

Parameters[edit source]

Infobox song for displaying song information.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Background colorbg color

The background color of the headers. Overrides the colors associated with units if specified.

Default
#000000
Example
#000000
Stringoptional
Text colortext color

The text color of the text inside headers. Overrides text colors associated with units if specified.

Default
#FFFFFF
Example
#FFFFFF
Stringoptional
Song IDsong id

The internal ID of the song.

Example
124
Numberrequired
Song namesong name

The song name. Defaults to the page title if none given.

Example
Miku Miku ni Shite Ageru ♪ 【Shiteyanyo】
Stringrequired
Jacketjacket

The jacket for the song.

Default
Dummyalbumart.png
Example
Jacket001.png
Stringsuggested
Jacket (alt)jacket alt

Alternative jacket for the song

Example
Jacket001 (alt).png
Stringoptional
Jacket (alt 2)jacket alt 2

Alternative jacket for the song

Stringoptional
Japanesejapanese

The official Japanese song title.

Example
みくみくにしてあげる♪【してやんよ】
Stringsuggested
Romajiromaji

The romanized version of the Japanese song title.

Example
Miku Miku ni Shite Ageru♪ (Shite Yan yo)
Stringsuggested
Englishenglish

The official English song title.

Example
I'll Miku-Miku You♪ (For Reals)
Stringsuggested
Original singer(s)singers

The original singer(s) of the song, separated by commas.

Example
Hatsune MIku
Stringsuggested
Producer(s)producers

The producer(s) of the song, separated by commas.

Example
ika
Stringrequired
Durationduration

The length of the full song.

Example
308
Numbersuggested
Composer(s)composers

The composer(s) of the song, separated by commas.

Example
ika
Stringsuggested
Arranger(s)arrangers

The arranger(s) of the song, separated by commas.

Example
ika
Stringsuggested
Lyricist(s)lyricists

The lyricist(s) of the song, separated by commas.

Example
ika
Stringsuggested
Unit categoriesunits

The category that this song belongs to. Options are "VIRTUAL SINGER", "Leo/need", "MORE MORE JUMP!", "Vivid BAD SQUAD", "Wonderlands×Showtime", "25-ji, Nightcord de.", and "Other"

Example
VIRTUAL SINGER
Stringsuggested
Unlock methodunlock

The way this song is unlocked. Is one of the options: "Automatically unlocked", "Music Shop", "Present Box", or "Main Story"

Stringrequired
Song typetype

The type of song. Can be one of "Pre-existing", "Commissioned", or "Contest winner".

Example
no
Stringsuggested
BPMbpm

The BPM of the song. Use https://twitter.com/MaengZombie/status/1384862015156482052 as reference.

Example
160
Numbersuggested
Duration (game-size)game duration

The length of the song in game. Does not include beginning silence.

Example
101
Numberrequired
3D MV3d mv

Whether or not the song has a 3D MV. Use "yes" or "no".

Example
No
Booleanrequired
2D MV2d mv

Whether or not the song has a 2D MV. Use "yes" or "no".

Example
No
Booleanrequired
Original MVoriginal mv

Whether or not the song has an original MV. Use "yes" or "no".

Example
No
Booleanrequired
Release Datedate

The date that the song was released in game. Use format YYYY/MM/DD

Example
2021/03/09
Daterequired
Easy difficultyeasy difficulty

The difficulty of the easy chart.

Example
7
Numberrequired
Normal difficultynormal difficulty

The difficulty of the normal chart.

Example
12
Numberrequired
Hard difficultyhard difficulty

The difficulty of the hard chart.

Example
17
Numberrequired
Expert difficultyexpert difficulty

The difficulty of the expert chart.

Example
24
Numberrequired
Master difficultymaster difficulty

The difficulty of the master chart.

Example
28
Numberrequired
Easy noteseasy notes

The number of notes in the easy chart.

Example
139
Numberrequired
Normal notesnormal notes

The number of notes in the normal chart.

Example
339
Numberrequired
Hard noteshard notes

The number of notes in the hard chart.

Example
439
Numberrequired
Expert notesexpert notes

The number of notes in the expert chart.

Example
739
Numberrequired
Master notesmaster notes

The number of notes in the master chart.

Example
939
Numberrequired

Quick copy[edit source]

{{Infobox song
| song id   = 
| song name = 
| jacket    = 
| jacket alt   = 
| jacket alt 2 =
| japanese  = 
| romaji    = 
| english   = 
| singers   = 
| producers = 
| duration  = 
| units     = 
| unlock    =
| arrangers = 
| composers = 
| lyricists = 
| type      = 
| bpm           = 
| game duration = 
| date        = 
| 3d mv       = 
| 2d mv       = 
| original mv = 
| easy difficulty   = 
| normal difficulty = 
| hard difficulty   = 
| expert difficulty = 
| master difficulty = 
| easy notes   = 
| normal notes = 
| hard notes   = 
| expert notes = 
| master notes = 
}}

Examples[edit source]

Tell Your World
Song Information
Original singer
  • Hatsune Miku
Producer
  • kz (livetune)
Duration4:17
In-game Information
Song ID1
Unit category
  • VIRTUAL SINGER
How to unlockAutomatically unlocked
Arranger
  • kz (livetune)
Composer
  • kz (livetune)
Lyricist
  • kz (livetune)
TypePre-existing
BPM150
Duration (game)2:03
Release date2020/09/30
Music Video
3D2DOriginal
Difficulties
EasyNormalHard
51016
ExpertMasterAppend
2226N/A
Notes
EasyNormalHard
220492719
ExpertMasterAppend
9611147N/A
{{Infobox song
| song id    = 1
| song name  = Tell Your World
| jacket     = Jacket001.png
| singers   = Hatsune Miku
| producers = kz (livetune)
| duration  = 257
| arrangers = kz (livetune)
| composers = kz (livetune)
| lyricists = kz (livetune)
| units  = VIRTUAL SINGER
| unlock = Automatically unlocked
| type   = Pre-existing
| bpm    = 150
| game duration = 123
| date          = 2020/09/30
| 3d mv       = Yes
| 2d mv       = No
| original mv = No
| easy difficulty   = 5
| normal difficulty = 10
| hard difficulty   = 16
| expert difficulty = 22
| master difficulty = 26
| easy notes   = 220
| normal notes = 492
| hard notes   = 719
| expert notes = 961
| master notes = 1147
}}
Sweet Magic
Japaneseスイートマジック
RomajiSweet Magic
EnglishSweet Magic
Song Information
Producers
In-game Information
Song ID
Unit category
  • Wonderlands×Showtime
How to unlock
Type
BPM123
Duration (game)2:29
Release date
Music Video
3D2DOriginal
Difficulties
EasyNormalHard
ExpertMasterAppend
N/A
Notes
EasyNormalHard
ExpertMasterAppend
N/A
{{Infobox song
|bg color   = #FFFFA8
|text color = #000000
|song name  = Sweet Magic
|japanese   = スイートマジック
|romaji     = Sweet Magic
|english    = Sweet Magic
|producer   = Junky
|units      = Wonderlands×Showtime
|bpm           = 123
|game duration = 149
|3d mv       = Yes
}}


Cookies help us deliver our services. By using our services, you agree to our use of cookies.