Help:Templates
From LyricWiki
Help - The LyricWiki DocumentationGetting Started
Editing
| Reference
|
Contents |
General Information
Templates are provided to reduce the amount of repetitive wikitext in pages. Templates are a sort of shorthand, to make creating and editing wiki pages easier. Templates also help to make LyricWiki visually more uniform. Templates are placed within two sets of curly brackets, or braces, {{}} and contain one or more divisions of information.
If the template has more than one division, each division is separated by a vertical line, or pipe |. The first division contains the name of the template, followed by any number of divisions containing information that are used to complete the template. More often, the template uses named parameters to make the order irrelevant and the parameters optional.
This page contains a listing of all frequently used and useful templates available on LyricWiki. If you find a template to be missing, please insert it at the appropriate location in the list. For documentation and use of the template, please refer to the template page.
Templates without much information are usually formatted as:
{{Name|Division Two|Division Three}}
Templates containing more information are usually formatted as:
{{Name
|Division Two
|Division Three
|Division Four
|Named Parameter One = value
|Named Parameter Two = value
}}
NOTE: Like all pages on LyricWiki, templates are case-sensitive, except the first letter of the template name. Therefore, {{Wikipedia}} and {{wikipedia}} will produce the same result, but {{WikiPedia}} won't.
Wikipedia
All LyricWiki articles for which a Wikipedia page exists should include a link to that page. The {{ArtistHeader}}, {{Album}} and {{SongFooter}} templates have parameters for producing such a link. Here are some additional options:
Floating Box
A floating box containing the article link and the Wikipedia graphic.
For example, the Wikipedia template:
{{Wikipedia|Country (film)|Country}}
produces:
In this example, the first division holds the template's name (in this case, Wikipedia), followed by two divisions that specify information for completing the template. The second division specifies the name of the Wikipedia article being linked to. In this case, "Country" wouldn't be specific enough to link to the film's article, so "Country (film)" must be used. The final division specifies the title that LyricWiki users will see, i.e. "Country".
See the template documentation for more information.
NOTE:
- For song pages, the {{WP-Song}} template is preferred over {{Wikipedia}}.
- For country, state and hometown categories, {{WP-Flag}} can be used instead of {{Wikipedia}}. This will display the country's flag instead of the Wikipedia globe.
Simple Text
A simple text link to a Wikipedia page can be created using the {{wp}} template:
{{wp|Article name|display text}}
All parameters of the {{wp}} are the same as for the {{Wikipedia}} template. For example, this text...
Read about {{wp|Country (film)|Country}} on Wikipedia.
...produces the following result:
Read about Country on Wikipedia.
Simple Text with Icon
The template {{wpi}} is similar to the simple text link above but is preceded by a Wikipedia icon:
Read about {{wpi|Country (film)|Country}} on Wikipedia.
...produces the following result:
Read about 
Country on Wikipedia.
Song Flagging
Multiple Languages
In the case that a song is released in more than one language, it is recommended that links to the other versions of the lyrics be added. The {{MultipleLanguages}} template makes this task easier.
{{MultipleLanguages
|English Song Title/en
|Spanish Song Title/es
|...
}}
See David Bowie:"Heroes" for a working example.
Common language codes are:
- de (German)
- en (English)
- es (Spanish)
- fr (French)
- ja (Japanese)
- ko (Korean)
- pl (Polish)
- ru (Russian)
- zh (Chinese)
A complete Wikipedia list of ISO 639-1 language codes can be found here.
Instrumental Tracks
Tracks that are instrumentals should be marked with the {{Instrumental}} template inside the lyric tags:
<lyrics>{{Instrumental}}</lyrics>
This template only has one division, its name. It produces the following:
Instrumental
Informational templates
- Information about the song: {{SInfo}}
- General information box: {{Info}}
- Instrumental song: {{Instrumental}}
- Cover version of a song:
- Additional albums song released on: {{AddAlb}}
- Parody of another song: {{Parody}}
- Unplugged (Acoustic) album: {{Unplugged}}
- Remix of original song: {{Remix}}
- {{GameFeature}}
- {{Live Lyrics}}
- {{No.1}}
Awards
- (Grammy) award: {{Award}} (or specifically: {{Grammy}}).
- Album Of The Week: {{AOTW}}
- Song Of The Day: {{SOTD}}
Flagging for Edits
- General request for editing: {{Edit}}
- When possible, please use one of the following instead:
- Accented characters displayed incorrectly: {{AccentedCharacters}} (shortcut: {{Accent}}).
- Artist pages with songs not split into albums: {{Split}}
- Request meaning of song: {{Songmeaning}}
- Merge request: {{Mergefrom}} and {{Mergeto}}
- Mass rename request: {{Move}}
- Song pages with parts of lyrics missing: {{Partial}}
Artist Pages
See Help:Contents/Editing/Formatting/Artists for more information.
- To display an album picture next to a track listing insert the {{Album Art}} template directly under the album's title:
{{Album Art|IMAGE|ALBUM NAME}}
IMAGE is generally in the form ARTIST - ALBUM NAME.jpg
- When {{Album Art}} invades into an album listing below it, use {{Clear}} after that album listing to prevent the invasion. {{Clear}} inserts a division break.
- {{ft}} for listing featured artists
- {{H4}} for formatting headers for individual discs
- {{Labels}}
- {{tl|Genres))
Multiple languages
- Songs released in more than one language: {{MultipleLanguages}}
- Songs translated by users: {{TranslatedSong}}
- To provide a translation side by side with the original lyrics: {{Translation}}
- Request for translation to English: {{RequestTranslation}}
- Request for romanization of foreign alphabet: {{RequestRomanization}}
- Request to add lyrics written in Kana and Kanji: {{RequestKanaKanji}}
- For pages with Japanese titles to provide reading and translation: {{JaTitle}}
- For pages with Chinese titles to provide reading and translation: {{ChineseTitle}}
User (talk) pages
- Welcome to LyricWiki message: {{Welcome}}
- Welcome to LyricWiki and invitation to register for unregistered users: {{WelcomeIP}}
- Reverted edit: {{Reverted}} (for inappropriate but good-faith edits)
- Vandalism warning: {{WarnUser}} or {{WarnUser/Editing}} (for users who are clearly committing vandalism)
- {{ArchNav}}: for archive talk pages
User pages
Wiki restrictions
- Incorrect title:
- General: {{WrongTitle}}
- Incorrect capitalization: {{Lowercase}}
- Symbols substituted by writing: {{Wtsymbol}}
- {{Pound}}
External linking
- Link to Wikipedia:
- External links section, for
- Songs: {{SongFooter}}
- Albums: {{AlbumFooter}}
- Artists: {{ArtistFooter}}
Administration
- To request administrator intervention, use
- Administrators can use these to tag restricted pages:
- Complicated code: {{Complicated}}
- Protected page: {{ProtectedPage}}
- User block notice: {{BlockUser}}
A template is a special type of page that has been designed so its content can be included in one or more other pages. Since a given template can be included in many pages, templates can help reduce duplication and promote a uniform style between pages.
Templates are usually located in the Template namespace, which means any page name beginning with Template:, such as Template:Name. However, any page can act as a template.
Referencing templates
The content of a template can be added to a page by referencing it using the wiki markup: {{templatename}}. This references the template and includes its output at the point of insertion. Articles will be updated automatically when referenced templates are changed. A page that references templates cannot be edited to change the content of a referenced template, although a list of referenced templates will be displayed at the bottom of the page for convenience while editing it.
Substituting templates
A different way to use a template is to substitute its content into a page. This is done by inserting subst: immediately after the opening braces: {{subst:templatename}}. Once the page is saved, the link to the template is removed and the template output is substituted in its place and can be further edited. Any updates to the template will not affect the content that was substituted into the page.
Benefits of templates
Templates are used to add recurring messages to pages in a consistent way, to add boilerplate messages, to create infoboxes and navigational boxes, and to provide cross-language portability of texts.
Templates can also make it much easier for new and casual editors to use advanced designs, features and extensions by hiding confusing code.
Creating a template
In short, create the text you want to have copied onto the target pages on a page in the Template namespace. Creating Template:Templatename will allow users to insert {{templatename}} into a page to display your text.
See Help:Creating templates for details.
For an overview, see the quick guide to templates on Wikimedia's Meta-Wiki.
Creating an advanced template
To learn how to change the output of the template based on what the user inputs, see Help:Template parameters and Help:Parser functions.
Updating and adding standard templates
Wikia's Starter Pages and Templates wikis occasionally improve some of their documentation as well as adding new templates specifically designed for Wikia sites, and are therefore worth checking from time to time. For sites created before about December 2008, the Starter Pages wiki should be compared and ideally used for upgrading to its standard documentation system similar to that introduced in Wikipedia.
