Template:BGM box/doc: Difference between revisions

Content added Content deleted

Inline

Latest revision as of 12:53, 18 October 2021

Usage[edit]

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

Required parameters[edit]

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[edit]

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.
Size = the size to display the Image / Embed. Defaults to 240px wide (or 100px if a placeholder is used).
Embed = embeds Main Link instead of showing a static image. Only accepts the following values: archiveorg, soundcloud, spotifyalbum, spotifyartist, spotifytrack, twitch, vimeo, youtube, or youtubeplaylist (see this page for details)
- Image and Size can be used to specify the cover image and dimensions of the embed, respectively
Headerstyle = see #Headerstyle below

Headerstyle[edit]

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.

@@ Line 9: / Line 9: @@
 | Image       = (optional)
 | Size        = (optional)
+| Embed       = {optional)
 | Headerstyle = (optional)
 }}
@@ Line 23: / Line 24: @@
 * <code>Image</code> = the filename of the image to display, e.g. a thumbnail of the cover. Just the filename only. Do not surround the filename with <code><nowiki>[[File:...]]</nowiki></code>. A placeholder will be shown if no image is specified.
 ** A special case exists if <code>Image = DOVA-SYNDROME</code>. This will display the DOVA-SYNDROME logo as the placeholder image.
+* <code>Size</code> = the size to display the Image / Embed. Defaults to 240px wide (or 100px if a placeholder is used).
-** You can also embed the <code>Main Link</code> 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 [https://www.mediawiki.org/wiki/Extension:YouTube here.] For example, <code>Image = youtube</code> will embed a YouTube video. Embeds are fixed at 240x140px and are unaffected by the <code>Size</code> parameter.
+* <code>Embed</code> = embeds <code>Main Link</code> instead of showing a static image. Only accepts the following values: <code>archiveorg</code>, <code>soundcloud</code>, <code>spotifyalbum</code>, <code>spotifyartist</code>, <code>spotifytrack</code>, <code>twitch</code>, <code>vimeo</code>, <code>youtube</code>, or <code>youtubeplaylist</code> (see [[github:StarCitizenWiki/mediawiki-extensions-EmbedVideo#supported-services|this page]] for details)
-* <code>Size</code> = the size to display the file. Defaults to 240x140px (or 100x100px if a placeholder is used). Does not affect embeds.
+** <code>Image</code> and <code>Size</code> can be used to specify the cover image and dimensions of the embed, respectively
 * <code>Headerstyle</code> = see [[#Headerstyle]] below