Template:Cover box/doc: Difference between revisions

From Hololive Fan Wiki
Content added Content deleted
No edit summary
(remove Title ENR parameter; minor touchups)
Line 2: Line 2:
<pre>
<pre>
{{Cover box
{{Cover box
| Title =
| Title =
| Title ENR = (optional)
| Main Link =
| Main Link =
| Original by =
| Original by =
| Sung by = (optional)
| Sung by = (optional)
| Credits =
| Credits =
| Image = (optional)
| Image = (optional)
| Size = (optional)
| Size = (optional)
| Headerstyle = (optional)
| Headerstyle = (optional)
}}
}}
Line 15: Line 14:


=== Required parameters ===
=== Required parameters ===
* <code>Title</code> = the title of the cover song
* <code>Title</code> = the title of the song being covered. Alternate names or romanizations may be put in parentheses.
* <code>Main Link</code> = the URL that the user will be directed to when the user clicks on the image
* <code>Main Link</code> = the URL that the user will be directed to when the user clicks on the image
* <code>Original by</code> = the creator(s) of the original song that is being covered. Please also provide a link to the original song here as a courtesy.
* <code>Original by</code> = the creator(s) of the original song that is being covered. Please also provide a link to the original song here as a courtesy.
Line 21: Line 20:


=== Optional parameters ===
=== Optional parameters ===
* <code>Title ENR</code> = title of the song in English or Romaji
* <code>Sung by</code> = the singer(s) featured in the cover. Mainly used for collab covers.
* <code>Sung by</code> = the singer(s) featured in the cover. Mainly used for collab covers.
* <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.
Line 28: Line 26:


==== Headerstyle ====
==== Headerstyle ====
Which headerstyle is displayed is determined in this order
Which headerstyle is displayed is determined in this order:
* what is specified in the <code>|Headerstyle=</code> parameter (if defined)
* whatever is specified in the <code>|Headerstyle=</code> parameter (if defined)
* <code>background-color:'''<nowiki>{{Template:{{PAGENAME}}/background-color2}}</nowiki>''';'''<nowiki>color:{{Template:{{PAGENAME}}/color2}}</nowiki>'''</code>
* <code>background-color:'''<nowiki>{{Template:{{PAGENAME}}/background-color2}}</nowiki>''';'''<nowiki>color:{{Template:{{PAGENAME}}/color2}}</nowiki>'''</code>
** In other words, the template reads the values in ''<nowiki>Template:{{PAGENAME}}/background-color2</nowiki>'' and ''<nowiki>Template:{{PAGENAME}}/color2</nowiki>'' via transclusion
** In other words, the template reads the values in ''<nowiki>Template:{{PAGENAME}}/background-color2</nowiki>'' and ''<nowiki>Template:{{PAGENAME}}/color2</nowiki>'' via transclusion
* if either page, ''<nowiki>Template:{{PAGENAME}}/background-color2</nowiki>'' or ''<nowiki>Template:{{PAGENAME}}/color2</nowiki>'' do not exist, the colors <nowiki>#27c7fe</nowiki> and <nowiki>#ffffff</nowiki> will be used respectively
** If either page does not exist, the colors <code>#27c7fe</code> and <code>#ffffff</code> will be used respectively.

Revision as of 10:57, 7 October 2021

Usage

{{Cover box
| Title       = 
| Main Link   = 
| Original by = 
| Sung by     = (optional)
| Credits     = 
| Image       = (optional)
| Size        = (optional)
| Headerstyle = (optional)
}}

Required parameters

  • Title = the title of the song being covered. 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
  • Original by = the creator(s) of the original song that is being covered. Please also provide a link to the original song here as a courtesy.
  • Credits = those who worked on the cover

Optional parameters

  • Sung by = the singer(s) featured in the cover. Mainly used for collab covers.
  • 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.
  • Size = the size to display the file. Defaults to 240x140px (or 100x100px if the placeholder is used)
  • 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.