Template:Infobox song/doc: Difference between revisions

Template page
Content added Content deleted
m (FuzzyBot moved page Template:Infobox Song/doc to Template:Infobox song/doc without leaving a redirect: Part of translatable page "Template:Infobox Song")
mNo edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{Lua|Module:Infobox song}}
{{Lua|Module:Infobox song}} {{Cargo|songs}}


== Parameters ==
__TOC__

==Parameters==
<templatedata>
<templatedata>
{
{
Line 11: Line 9:
"example": "#000000",
"example": "#000000",
"type": "string",
"type": "string",
"label": "Background Color",
"label": "Background color",
"default": "#000000",
"default": "#000000",
"description": "The background color of the headers. Overrides the colors associated with units if specified."
"description": "The background color of the headers. Overrides the colors associated with units if specified."
},
},
"text color": {
"text color": {
"label": "Text Color",
"label": "Text color",
"example": "#FFFFFF",
"example": "#FFFFFF",
"type": "string",
"type": "string",
"default": "#FFFFFF",
"default": "#FFFFFF",
"description": "The text color of the text inside headers. Overrides text colors associated with units if specified."
"description": "The text color of the text inside headers. Overrides text colors associated with units if specified."
},
"image": {
"label": "Image",
"example": "Jacket001.png",
"type": "string",
"default": "Dummyalbumart.png",
"suggested": true,
"description": "The jacket for the song."
},
"image alt": {
"label": "Image (alt)",
"type": "string",
"description": "Alternative jacket for the song",
"example": "Jacket001 (alt).png"
},
},
"romaji": {
"romaji": {
Line 49: Line 33:
"type": "string",
"type": "string",
"description": "The official English song title."
"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",
"example": "ika"
},
"lyricist": {
"label": "Lyricist(s)",
"description": "The lyricist(s) of the song.",
"type": "string",
"example": "ika"
},
"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, \"25ji\" for 25-ji, Nightcord de., \"other\" for Other"
},
},
"bpm": {
"bpm": {
Line 92: Line 43:
"duration": {
"duration": {
"label": "Duration",
"label": "Duration",
"type": "string",
"type": "number",
"suggested": true,
"suggested": true,
"description": "The length of the song, not including beginning silence.",
"description": "The length of the full song.",
"example": "1:41"
"example": "308"
},
},
"easy difficulty": {
"easy difficulty": {
"label": "Easy Difficulty",
"label": "Easy difficulty",
"type": "number",
"type": "number",
"suggested": true,
"example": "7",
"example": "7",
"description": "The difficulty of the easy chart. Defaults to \"N/A\" if none given."
"description": "The difficulty of the easy chart.",
"required": true
},
},
"normal difficulty": {
"normal difficulty": {
"label": "Normal Difficulty",
"label": "Normal difficulty",
"type": "number",
"type": "number",
"suggested": true,
"example": "12",
"example": "12",
"description": "The difficulty of the normal chart. Defaults to \"N/A\" if none given."
"description": "The difficulty of the normal chart.",
"required": true
},
},
"hard difficulty": {
"hard difficulty": {
"label": "Hard Difficulty",
"label": "Hard difficulty",
"type": "number",
"type": "number",
"suggested": true,
"example": "17",
"example": "17",
"description": "The difficulty of the hard chart. Defaults to \"N/A\" if none given."
"description": "The difficulty of the hard chart.",
"required": true
},
},
"expert difficulty": {
"expert difficulty": {
"label": "Expert Difficulty",
"label": "Expert difficulty",
"type": "number",
"type": "number",
"suggested": true,
"example": "24",
"example": "24",
"description": "The difficulty of the expert chart. Defaults to \"N/A\" if none given."
"description": "The difficulty of the expert chart.",
"required": true
},
},
"master difficulty": {
"master difficulty": {
"label": "Master Difficulty",
"label": "Master difficulty",
"type": "number",
"type": "number",
"suggested": true,
"example": "28",
"example": "28",
"description": "The difficulty of the master chart. Defaults to \"N/A\" if none given."
"description": "The difficulty of the master chart.",
"required": true
},
},
"easy notes": {
"easy notes": {
"label": "Easy Notes",
"label": "Easy notes",
"example": "139",
"example": "139",
"description": "The number of notes in the easy chart.",
"suggested": true,
"type": "number",
"description": "The number of notes in the easy chart. Defaults to \"N/A\" if none given.",
"type": "number"
"required": true
},
},
"normal notes": {
"normal notes": {
"label": "Normal Notes",
"label": "Normal notes",
"example": "339",
"example": "339",
"description": "The number of notes in the normal chart.",
"suggested": true,
"type": "number",
"description": "The number of notes in the normal chart. Defaults to \"N/A\" if none given.",
"type": "number"
"required": true
},
},
"hard notes": {
"hard notes": {
"label": "Hard Notes",
"label": "Hard notes",
"type": "number",
"type": "number",
"suggested": true,
"example": "439",
"example": "439",
"description": "The number of notes in the hard chart. Defaults to \"N/A\" if none given."
"description": "The number of notes in the hard chart.",
"required": true
},
},
"expert notes": {
"expert notes": {
"label": "Expert Notes",
"label": "Expert notes",
"example": "739",
"example": "739",
"type": "number",
"type": "number",
"description": "The number of notes in the expert chart.",
"suggested": true,
"required": true
"description": "The number of notes in the expert chart. Defaults to \"N/A\" if none given."
},
},
"master notes": {
"master notes": {
"label": "Master Notes",
"label": "Master notes",
"example": "939",
"example": "939",
"type": "number",
"type": "number",
"description": "The number of notes in the master chart.",
"suggested": true,
"required": true
"description": "The number of notes in the master chart. Defaults to \"N/A\" if none given."
},
},
"japanese": {
"japanese": {
Line 173: Line 124:
"type": "string",
"type": "string",
"suggested": true
"suggested": true
},
"arranger": {
"label": "Arranger",
"description": "The composer(s) of the song.",
"type": "string",
"example": "ika"
},
},
"song id": {
"song id": {
Line 189: Line 134:
"date": {
"date": {
"label": "Release Date",
"label": "Release Date",
"description": "The date that the song was released",
"description": "The date that the song was released in game. Use format YYYY/MM/DD",
"example": "2021/03/09",
"example": "2021/03/09",
"type": "date",
"type": "date",
"suggested": true
"required": true
},
},
"3d mv": {
"3d mv": {
"label": "3D MV",
"label": "3D MV",
"description": "Whether or not the song has a 3D MV. Use \"yes\" or \"no\".",
"description": "Whether or not the song has a 3D MV. Use \"yes\" or \"no\".",
"type": "string",
"type": "boolean",
"suggested": true,
"example": "No",
"example": "no"
"required": true
},
},
"2d mv": {
"2d mv": {
"description": "Whether or not the song has a 2D MV. Use \"yes\" or \"no\".",
"description": "Whether or not the song has a 2D MV. Use \"yes\" or \"no\".",
"type": "string",
"type": "boolean",
"suggested": true,
"label": "2D MV",
"label": "2D MV",
"example": "no"
"example": "No",
"required": true
},
},
"original mv": {
"original mv": {
"label": "Original MV",
"label": "Original MV",
"type": "string",
"type": "boolean",
"suggested": true,
"description": "Whether or not the song has an original MV. Use \"yes\" or \"no\".",
"description": "Whether or not the song has an original MV. Use \"yes\" or \"no\".",
"example": "no"
"example": "No",
"required": true
},
},
"song name": {
"song name": {
"label": "Song Name",
"label": "Song name",
"description": "The song name. Defaults to the page title if none given.",
"description": "The song name. Defaults to the page title if none given.",
"example": "Miku Miku ni Shite Ageru ♪ 【Shiteyanyo】",
"example": "Miku Miku ni Shite Ageru ♪ 【Shiteyanyo】",
"type": "string",
"type": "string",
"required": true,
"required": true
},
"jacket": {
"label": "Jacket",
"description": "The jacket for the song.",
"example": "Jacket001.png",
"type": "string",
"default": "Dummyalbumart.png",
"suggested": true
"suggested": true
},
},
"commissioned": {
"jacket alt": {
"label": "Commissioned",
"label": "Jacket (alt)",
"description": "Whether or not the song was commissioned for Project SEKAI.",
"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",
"example": "no",
"type": "boolean",
"type": "string",
"suggested": true
"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
}
}
},
},
Line 236: Line 254:
"song id",
"song id",
"song name",
"song name",
"image",
"jacket",
"image alt",
"jacket alt",
"jacket alt 2",
"japanese",
"japanese",
"romaji",
"romaji",
"english",
"english",
"singer",
"singers",
"producer",
"producers",
"composer",
"arranger",
"lyricist",
"unit",
"commissioned",
"bpm",
"duration",
"duration",
"composers",
"arrangers",
"lyricists",
"units",
"unlock",
"type",
"bpm",
"game duration",
"3d mv",
"3d mv",
"2d mv",
"2d mv",
Line 265: Line 286:
"master notes"
"master notes"
],
],
"description": "Infobox Song for displaying song information.",
"description": "Infobox song for displaying song information.",
"format": "block"
"format": "block"
}
}
</templatedata>
</templatedata>


==Quick Copy==
== Quick copy ==
<pre>
<pre>
{{Infobox Song
{{Infobox song
|bg color =
| song id =
|text color =
| song name =
|song id =
| jacket =
|song name =
| jacket alt =
|image =
| jacket alt 2 =
|image alt =
| japanese =
|japanese =
| romaji =
|romaji =
| english =
|english =
| singers =
|singer =
| producers =
|producer =
| duration =
|arranger =
| units =
| unlock =
|composer =
|lyricist =
| arrangers =
|unit =
| composers =
|commissioned =
| lyricists =
|bpm =
| type =
|duration =
| bpm =
|date =
| game duration =
|3d mv =
| date =
|2d mv =
| 3d mv =
|original mv =
| 2d mv =
| original mv =
|easy difficulty =
|normal difficulty =
| easy difficulty =
|hard difficulty =
| normal difficulty =
|expert difficulty =
| hard difficulty =
|master difficulty =
| expert difficulty =
| master difficulty =
|easy notes =
|normal notes =
| easy notes =
|hard notes =
| normal notes =
|expert notes =
| hard notes =
|master notes =
| expert notes =
| master notes =
}}
}}
</pre>
</pre>


==Examples==
== Examples ==
{{Infobox Song
{{Infobox song
|song id = 1
| song id = 1
|song name = Tell Your World
| song name = Tell Your World
|image = Jacket001.png
| jacket = Jacket001.png
| singers = Hatsune Miku
|japanese = Tell Your World
| producers = kz (livetune)
|romaji = Tell Your World
| duration = 257
|english = Tell Your World
| arrangers = kz (livetune)
|singer = Hatsune Miku
|producer = kz (livetune)
| composers = kz (livetune)
|arranger = kz (livetune)
| lyricists = kz (livetune)
| units = VIRTUAL SINGER
|composer = kz (livetune)
| unlock = Automatically unlocked
|lyricist = kz (livetune)
|unit = vs
| type = Pre-existing
|commissioned = no
| bpm = 150
|bpm = 150
| game duration = 123
| date = 2020/09/30
|duration = 2:05
|date = 2020/09/30
| 3d mv = Yes
|3d mv = yes
| 2d mv = No
|2d mv = no
| original mv = No
| easy difficulty = 5
|original mv = no
|easy difficulty = 5
| normal difficulty = 10
|normal difficulty = 10
| hard difficulty = 16
|hard difficulty = 16
| expert difficulty = 22
|expert difficulty = 22
| master difficulty = 26
| easy notes = 220
|master difficulty = 26
|easy notes = 220
| normal notes = 492
|normal notes = 490
| hard notes = 719
|hard notes = 717
| expert notes = 961
|expert notes = 963
| master notes = 1147
|master notes = 1147
}}
}}

<pre>
<pre>
{{Infobox Song
{{Infobox song
|song id = 1
| song id = 1
|song name = Tell Your World
| song name = Tell Your World
|image = Jacket001.png
| jacket = Jacket001.png
| singers = Hatsune Miku
|japanese = Tell Your World
| producers = kz (livetune)
|romaji = Tell Your World
| duration = 257
|english = Tell Your World
| arrangers = kz (livetune)
|singer = Hatsune Miku
|producer = kz (livetune)
| composers = kz (livetune)
|arranger = kz (livetune)
| lyricists = kz (livetune)
| units = VIRTUAL SINGER
|composer = kz (livetune)
| unlock = Automatically unlocked
|lyricist = kz (livetune)
|unit = vs
| type = Pre-existing
|commissioned = no
| bpm = 150
|bpm = 150
| game duration = 123
| date = 2020/09/30
|duration = 2:05
|date = 2020/09/30
| 3d mv = Yes
|3d mv = yes
| 2d mv = No
|2d mv = no
| original mv = No
| easy difficulty = 5
|original mv = no
|easy difficulty = 5
| normal difficulty = 10
|normal difficulty = 10
| hard difficulty = 16
|hard difficulty = 16
| expert difficulty = 22
|expert difficulty = 22
| master difficulty = 26
| easy notes = 220
|master difficulty = 26
|easy notes = 220
| normal notes = 492
|normal notes = 490
| hard notes = 719
|hard notes = 717
| expert notes = 961
|expert notes = 963
| master notes = 1147
|master notes = 1147
}}
}}
</pre>
</pre>
Line 376: Line 397:
{{clear}}
{{clear}}


{{Infobox Song
{{Infobox song
|bg color = #FFFFA8
|bg color = #FFFFA8
|text color = #000000
|text color = #000000
|song name = Sweet Magic
|song name = Sweet Magic
|japanese = スイートマジック
|japanese = スイートマジック
|romaji = Sweet Magic
|romaji = Sweet Magic
|english = Sweet Magic
|english = Sweet Magic
|producer = Junky
|producer = Junky
|unit = wxs
|units = Wonderlands×Showtime
|bpm = 123
|bpm = 123
|duration = 2:38
|game duration = 149
|3d mv = yes
|3d mv = Yes
}}
}}

<pre>
<pre>
{{Infobox Song
{{Infobox song
|bg color = #FFFFA8
|bg color = #FFFFA8
|text color = #000000
|text color = #000000
|song name = Sweet Magic
|song name = Sweet Magic
|japanese = スイートマジック
|japanese = スイートマジック
|romaji = Sweet Magic
|romaji = Sweet Magic
|english = Sweet Magic
|english = Sweet Magic
|producer = Junky
|producer = Junky
|unit = wxs
|units = Wonderlands×Showtime
|bpm = 123
|bpm = 123
|duration = 2:38
|game duration = 149
|3d mv = yes
|3d mv = Yes
}}
}}
</pre>
</pre>

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.