Template:SoundtrackTable/2kki/doc: Difference between revisions

Latest revision as of 19:56, 2 August 2024

Description

This template is used to auto-generate the Soundtrack pages for Yume 2kki based on the contents of location pages.

Usage

The first parameter specifies the range of a table. It should follow the format xxxx-yyyy, where xxxx and yyyy are numbers zero-padded to length 4. For example, {{SoundtrackTable/2kki|0226-0250}} would generate a table with IDs from 0226 to 0250, both inclusive.

To modify the table, you have two options.

The changes parameter can be used to change values in existing cells. The value of parameter consists of several lines, each in the format of param/id=value. For example, name/0767 C=delta_song_1 would change the "Track Name" column of a track with the ID of 0767C to "delta_song_1".
You can also omit the letter to assign the value to the cells of all tracks whose ID start with the specified number. For example, notes/0010=Translates to "sand". changes the notes for all tracks from 0010A throughout 0010G.
The extras parameter can be used to add rows for tracks the template wasn't able to detect. The value should consist of SoundtrackEntry templates with the following syntax:

{{SoundtrackEntry
|id=0003 E
|name=PC_音源差し替え
|speed=100
|location=[[Yume 2kki:Endings#Ending ---|Ending ---]]
|file=PC_音源差し替え.ogg
|notes=Translates to "PC_Sound Replacement".
}}

The example above adds a row to the table which would look like this:

No.	TRACK NAME	SPEED	LOCATION/EVENT	LISTEN	NOTES
0003 E	PC_音源差し替え	100%	Ending ---	Listen	Translates to "PC_Sound Replacement".

Entries are automatically sorted by ID, so additional entries can be specified in any order.

Parameters

Auto-updating Soundtrack table for Yume 2kki

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
ID Range	`1`	Start and end IDs separated by a dash Example 0001-0025	Line	required
Changes	`changes`	Used to change cells in auto-generated rows Example name/0767 C=delta_song_1 notes/0010=Translates to "sand".	String	optional
Extra Tracks	`extras`	Used to add additional rows Example {{SoundtrackEntry\|id=0003 E\|name=PC_音源差し替え\|speed=100\|location=[[Yume 2kki:Endings#Ending ---\|Ending ---]]\|file=PC_音源差し替え.ogg\|notes=Translates to "PC_Sound Replacement".}}	Content	optional

@@ Line 3: / Line 3: @@
 ==Usage==
-<!--How to use. Attempt to answer:
--	What does it present to the reader?
--	Why would an editor choose to use it?
--	What is the recommended use?
--	What does the template require in order to function?
--	What can the template NOT do? (limitations)
--	What are some potential issues that should be kept in mind? (troubleshooting)
-It may be helpful to give examples in this section instead of waiting until "Sample".-->
 The first parameter specifies the range of a table. It should follow the format <code>xxxx-yyyy</code>, where xxxx and yyyy are numbers zero-padded to length 4. For example, <code><nowiki>{{SoundtrackTable/2kki|0226-0250}}</nowiki></code> would generate a table with IDs from 0226 to 0250, both inclusive.
 To modify the table, you have two options.
-* To change the value of a certain cell, you can add a parameter in the format of <code>|param/id=value</code>. For example, <code>|name/0767 C=delta_song_1</code> would change the "Track Name" column of a track with the ID of 0767C to "delta_song_1". <br/> You can also omit the letter to assign the value to the cells of all tracks whose ID start with the specified number. For example, <code>|notes/0010=Translates to "sand".</code> changes the notes for all tracks from 0010A throughout 0010G.
+* The <code>changes</code> parameter can be used to change values in existing cells. The value of parameter consists of several lines, each in the format of <code>param/id=value</code>. For example, <code>name/0767 C=delta_song_1</code> would change the "Track Name" column of a track with the ID of 0767C to "delta_song_1". <br/> You can also omit the letter to assign the value to the cells of all tracks whose ID start with the specified number. For example, <code>notes/0010=Translates to "sand".</code> changes the notes for all tracks from 0010A throughout 0010G.
-* To add a track which the template wasn't able to detect, use the <code>extras</code> parameter. Add the missing tracks using the [[Template:SoundtrackEntry|SoundtrackEntry]] template with the following syntax:
+* The <code>extras</code> parameter can be used to add rows for tracks the template wasn't able to detect. The value should consist of [[Template:SoundtrackEntry|SoundtrackEntry]] templates with the following syntax:
   <nowiki>{{SoundtrackEntry</nowiki>
   <nowiki>|id=0003 E</nowiki>
@@ Line 26: / Line 18: @@
   <nowiki>}}</nowiki>
-This adds a row to the table which looks like this:
+The example above adds a row to the table which would look like this:
 {{SoundtrackTable
 |id,No.,width:60px;name,TRACK NAME;speed,SPEED;location,LOCATION/EVENT;file,LISTEN;notes,NOTES
@@ Line 42: / Line 34: @@
 ==Parameters==
-<templatedata>{	"description": "","params": {
+<templatedata>
+{
+    "description": "Auto-updating Soundtrack table for Yume 2kki",
+    "format": "block",
+    "params": {
 		"1": {
 			"label": "ID Range",
-			"type": "string",
+			"type": "line",
-			"description": "A start and end ID separated by a dash",
+			"description": "Start and end IDs separated by a dash",
 			"example": "0001-0025",
              "required": true
 		},
+        "changes": {
+			"label": "Changes",
+			"type": "string",
+			"description": "Used to change cells in auto-generated rows",
+			"example": "name/0767 C=delta_song_1\n\n\nnotes/0010=Translates to \"sand\"."
+	   },
 		"extras": {
 			"label": "Extra Tracks",
 			"type": "content",
-			"description": "A parameter for additional tracks",
+			"description": "Used to add additional rows",
 			"example": "{{SoundtrackEntry|id=0003 E|name=PC_音源差し替え|speed=100|location=[[Yume 2kki:Endings#Ending ---|Ending ---]]|file=PC_音源差し替え.ogg|notes=Translates to \"PC_Sound Replacement\".}}"
-	}}}</templatedata>
+	   }
-<!--The following is a template with all options listed:
+    }
-		},
+}
-		"parameter": {
+</templatedata>
-			"label": "Fancy_Name",
-			"aliases": ["Other_Name1","Other_Name2"],
-			"type": "Choose one of: number, string, line(no line breaks), content(formatted wikitext), boolean, url(https://example.com), date, wiki-page-name, wiki-file-name, wiki-user-name, wiki-template-name.",
-			"description": "Explanation",
-			"example": "Example_Input",
-			"default": "Default_If_Static",
-			"autovalue": "Default_If_Magic_Word",
-			"suggestedvalues": ["Value1","Value2"],
-			"required": true,
-			"suggested": true,
-			"deprecated": "What_To_Use_Instead",
-			"inherits": "put another parameter name here to copy its properties (gets overwritten by new ones)",
-IMPORTANT, the text < }, > must be removed from the very first parameter you list. Also, the last option you have for every parameter must not end with a comma (so for example if <"default"> was the last one you need to do <"default": "Default_If_Static"> - notice the lack of a comma)-->
 <noinclude>[[Category:Template documentation]]</noinclude>
 <includeonly>__NOEDITSECTION__
 [[Category:Templates]]
 </includeonly>