Template:BGM box/doc

From Hololive Fan Wiki
Revision as of 13:42, 7 October 2021 by Aesulus (talk | contribs) (→‎Optional parameters: document embeds feature)

Usage

{{BGM box
| Title       = 
| Main Link   = 
| Made by     = 
| Usage       = 
| Extra Links = (optional)
| Image       = (optional)
| Size        = (optional)
| Headerstyle = (optional)
}}

Required parameters

  • Title = the title of the BGM track. Alternate names or romanizations may be put in parentheses.
  • Main Link = the URL that the user will be directed to when the user clicks on the image
  • Made by = the creator(s) of the BGM.
  • Usage = how the BGM is used in streams / videos

Optional parameters

  • Extra Links = any extra links in addition to the Main Link go here
  • Image = the filename of the image to display, e.g. a thumbnail of the cover. Just the filename only. Do not surround the filename with [[File:...]]. A placeholder will be shown if no image is specified.
    • A special case exists if Image = DOVA-SYNDROME. This will display the DOVA-SYNDROME logo as the placeholder image.
    • You can also embed the Main Link instead of showing a file by entering the name of a video service instead of a filename. The full list of supported video services can be found here. For example, Image = youtube will embed a YouTube video. Embeds are fixed at 240x140px and are unaffected by the Size parameter.
  • Size = the size to display the file. Defaults to 240x140px (or 100x100px if a placeholder is used). Does not affect embeds.
  • Headerstyle = see #Headerstyle below

Headerstyle

Which headerstyle is displayed is determined in this order:

  • whatever is specified in the |Headerstyle= parameter (if defined)
  • background-color:{{Template:{{PAGENAME}}/background-color2}};color:{{Template:{{PAGENAME}}/color2}}
    • In other words, the template reads the values in Template:{{PAGENAME}}/background-color2 and Template:{{PAGENAME}}/color2 via transclusion
    • If either page does not exist, the colors #27c7fe and #ffffff will be used respectively.