(add missing file detection) |
(add author check for CoUn and remake comments) |
||
| Line 1: | Line 1: | ||
<includeonly><!-- | <includeonly><!-- | ||
-->{{#if: {{{title|}}} | -->{{#if: {{{title|}}}<!-- Check for title | ||
-->| {{#if: {{{filename|}}}<!-- Check for filename | |||
-->| {{#set: Has BGM={{{title}}};{{filepath:{{{filename}}}}};File:{{{filename}}};{{{label|}}} }}<!-- Create record | |||
-->{{#if:{{filepath:{{{filename}}}}}<!-- Check if file is uploaded | |||
-->{{#if:{{filepath:{{{filename}}}}} | -->|[{{filepath:{{{filename}}}}} {{{title}}}]<!-- Visible file link | ||
-->[{{filepath:{{{filename}}}}} {{{title}}}]<!-- | -->|[https://yume.wiki/index.php?title=Special:Upload&wpDestFile={{{filename}}} <span style="color:red; background:white;">{{{title}}} (Missing)</span>] [[Category:Missing BGM]]<!-- Not uploaded = highlight and place category | ||
-->|[https://yume.wiki/index.php?title=Special:Upload&wpDestFile={{{filename}}} <span style="color:red; background:white;">{{{title}}} (Missing)</span>] [[Category:Missing BGM]]<!-- | -->}}<!-- End upload check | ||
-->}}<!-- | -->|{{{title}}}[[Category:Missing BGM]]<!-- No filename, title is still shown, places category | ||
-->|{{{title}}}[[Category:Missing BGM]]<!-- | -->}}<!-- End filename check | ||
-->}}<!-- | --> <!-- Space between listen link and label | ||
-->{{#if:{{{label|}}}<!-- Check for label | |||
-->|({{{label}}})<!-- Add label in parantheses | |||
-->}}<!-- End label check | |||
--> <!-- Space between label and author | |||
-->{{#if: {{{author|}}}|<!-- Check for author | |||
-->by {{{author}}}<!-- | |||
-->}}<!-- End author check | |||
--> <!-- | --> <!-- | ||
-->{{#if:{{{ | -->{{#if:{{{soundroom|}}}<!-- Soundroom number check | ||
-->|(No. <!-- Beginning part | |||
-->{{#arraymap:{{{soundroom}}}|,|x|x|,\s|and}}<!-- List of numbers | |||
-->)<!-- End part | |||
--> | -->}}<!-- End soundroom check | ||
-->|Please specify the BGM's title.<!-- If no title, output error | |||
-->}}<!-- End title check | |||
-->{{#ifexpr: {{NAMESPACENUMBER}} = 3018<!-- Limit to CoUn | |||
-->| {{#if: {{{author|}}}<!-- Check if author has any value | |||
-->|<!-- | |||
-->|[[Category:Missing BGM author]]<!-- If empty add category | |||
--> | -->}}<!-- End author check | ||
--> | -->}}<!-- End namespace check | ||
-->}}<!-- | |||
--></includeonly> | --></includeonly> | ||
<noinclude> | <noinclude> | ||
Revision as of 05:54, 24 June 2024
Documentation (for the above template, sometimes hidden or invisible)
 |
This template conditionally sets categories on pages. Please only use this template as intended. Conditions: On Collective Unconscious pages, it adds Category:Missing BGM author if no author is specified. |
 |
This template automatically sets Semantic MediaWiki properties on pages. This may include creating subobjects. Please only use this template as intended. |
Description
Renders a link (if provided) to an area's BGM, and sets a record that can be queried.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Title | title | The BGM's title to be displayed. This could either be an official title, or the original filename exclusive of extension.
| String | required |
| Filename | filename | The audio's filename, pointing to the file as uploaded. If left blank, no link will be displayed.
| String | suggested |
| Label | label | A label describing where or when the BGM would play. This could be a sub-area, an event, or the area under different conditions.
| String | optional |
| Sound Room ID | soundroom | If the BGM is featured in a Sound Room like in Yume 2kki, provide the ID as seen in the Sound Room.
| String | optional |
| Speed | speed | The speed at which the track is set to play in-game.
| Number | required |
| Author | author | Credit the track's composer/author. Usually only applicable to collaborative games.
| String | optional |
Semantic properties
This template exposes the following semantic properties.
| Property name | Description | Data type | Cardinality |
|---|---|---|---|
| Has BGM | The main record that holds all the other properties. | Record | Single |
| BGM/Title | The title of the BGM, either official or from the game files. | Text | Single |
| Has media path | The path leading to the audio file on the wiki. | URL | Single |
| BGM/Audio | The wiki page of the audio file. | Page | Single |
| BGM/Label | A label describing the BGM, usually where it plays in the location. | Text | Single |
| BGM/Soundroom | The ID of the track in the game's Sound Room or equivalent feature, if one is present in the game. | Text | Multiple |
| BGM/Speed | The speed at which the BGM is set to play in the location. This should correspond to the audio file on the wiki. | Number | Single |
| BGM/Author | The author(s) who created the BGM. Usually only applicable to collaborative games. | Text | Multiple |
Syntax
{{BGM|title= |filename= |label= |speed= |soundroom= |author= }}
Sample
The following input:
{{BGM|title = tonny31.6|filename = Tonny31.6 (284D).ogg|label = Budding Life World|soundroom = 248D}}
Produces:
tonny31.6 (??%) (No. 248D): Budding Life World
Visit Template:BGM/doc to edit this text! (How does this work?)