Template:BGM box/doc: Difference between revisions
Content added Content deleted
(→Optional parameters: document embeds feature) |
(update how embeds work) |
||
Line 9: | Line 9: | ||
| Image = (optional) |
| Image = (optional) |
||
| Size = (optional) |
| Size = (optional) |
||
| Embed = {optional) |
|||
| Headerstyle = (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. |
* <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. |
** A special case exists if <code>Image = DOVA-SYNDROME</code>. This will display the DOVA-SYNDROME logo as the placeholder image. |
||
⚫ | |||
** 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>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 |
* <code>Headerstyle</code> = see [[#Headerstyle]] below |
||