Template:quote-song/documentation

	Documentation for Template:quote-song. ^[edit]
	This page contains usage information, categories, interwiki links and other content describing the template.

Uses Lua:

Module:quote

Usage

This template can be used in a dictionary entry to provide a quotation of lyrics from a song. If the lyrics are subject to copyright, do not quote a portion of them that is excessively long.

Sample template

Most basic parameters for English quotations

#* {{quote-song|1=|year=|author=|title=|url=|album=|text=}}

Most basic parameters for non-English quotations

#* {{quote-song|1=|year=|author=|title=|url=|album=|text=|t=}}

Commonly used parameters

{{quote-song|1=|lyricist=|composer=|title=|url=|album=|artist=|year=|text=|t=|tr=}}

All available parameters

{{quote-song|1=|lyricist=|composer=|author=|authorlink=|authorlabel=|title=|trans-title=|url=|archiveurl=|archivedate=|album=|trans-album=|format=|location=|publisher=|year=|year_published=|date=|oclc=|id=|artist=|note=|page=|pages=|pageurl=|text=|passage=|brackets=|t=|translation=|lit=|tr=|transliteration=|lang=|subst=}}

The following example:

{{quote-song|en|author=]; {{w|Stephen Bray}}; {{w|Patrick Leonard}}|artist=Madonna|title=Where’s the Party|album=]|year=1986|note=track 5|text=Don't want to grow old too fast / Don't want to let the '''system''' get me down / I've got to find a way to make the good times last / And if you'll show me how, I'm ready now}}

produces this:

1986, Madonna, Stephen Bray, Patrick Leonard (lyrics and music), “Where's the Party”, in True Blue, performed by Madonna, track 5:

Don't want to grow old too fast / Don't want to let the system get me down / I've got to find a way to make the good times last / And if you'll show me how, I'm ready now

Parameters

All parameters are optional except those marked "Mandatory", and may contain inline interwiki or external links as needed.

Parameter	Description
`1`	A comma-separated list of language codes indicating the language(s) of the quoted text; for a list of the codes, see Wiktionary:List of languages. If the language is other than English, the template will indicate this fact by displaying "(in )" (for one language), or "(in and )" (for two languages), or "(in , ... and )" (for three or more languages). The entry page will also be added to a category in the form "Category: terms with quotations" for the first listed language (unless `termlang` is specified, in which case that language is used for the category, or `nocat` is specified, in which case the page will not be added to any category). The first listed language also determines the font to use and the appropriate transliteration to display, if the text is in a non-Latin script. Use `\|worklang=` to specify the language(s) that the overall song is written in: see below.
`lyricist`	The person(s) who wrote the lyrics of the song. The word "`(lyrics)`" is displayed after the name(s).
`composer`	The person(s) who composed the music of the song. The word "`(music)`" is displayed after the name(s).
`author` (and `authorlabel`)	The person(s) who wrote the lyrics and composed the music of the song. The phrase "`(lyrics and music)`" is displayed after the name(s). To suppress the phrase, use "`authorlabel=no`".
`authorlink`	The name of an English Wikipedia article about the person(s) who wrote the lyrics and composed the music of the song, which will be linked to the name(s) specified using `author`. (Alternatively, link each person's name directly, like this: "`author=]`" or "`author={{w\|Woody Guthrie}}`".)
`title`	Mandatory: the title of the song.
`trans-title`	If the title of the song is not in English, this parameter can be used to provide an English translation of the title.
`url`	The URL or web address of a relevant external website, such as a website containing a score of the song. Add such a link only if the score is no longer copyrighted – do not link to a website that has content in breach of copyright.
`archiveurl` and `archivedate`	The URL or web address of a webpage on a website such as the Internet Archive or Perma.cc at which the webpage has been archived, and the date on which the webpage was archived. Both `archiveurl` and `archivedate` must be used together.
`album`	The title of the album in which the song first appeared.
`trans-album`	If the title of the album is not in English, this parameter can be used to provide an English translation of the name.
`format`	The format in which the song was released, for example, "`]`", "`]`", "`]`", "`]`", "`]`".
`location`	The location(s) where the song or album was published. If more than one location is stated, separate the locations with semicolons, like this: "`London; New York, N.Y.`".
`publisher`	The name of one or more publishers of the song or album. If more than one publisher is stated, separate the names with semicolons.
`year` or `date`	The year or date that the song was released. Use either `year` or `date`, not both.
`year_published`	If `year` is used to state the year when the original version of the song was published, `year_published` can be used to state the year in which the version quoted from was published, for example, "`\|year=1965\|year_published=2005`".
`oclc` and/or `id`	The Online Computer Library Center (OCLC) number of the song or album, which can be looked up at the WorldCat website. Use `id` for an identifier other than an OCLC number.
`artist`	The artist (an individual or ensemble) who performed the song, if different from the lyricist(s) and/or composer(s).
`feat`	A featuring artist who appears as a secondary or guest performer on the song.
`note`	Brief notes about the song.
`page` or `pages`	The page number or range of page numbers of a score, etc., referred to. Use `page` to indicate a single page, and `pages` to indicate a range of pages. For example, "`pages=1–2`" will display "`pages 1–2`". Use an en dash to separate the page numbers in the range.
`pageurl`	The URL or web address of the webpage containing the page of the score, etc., referred to. The page number(s) will be linked to this webpage.
`text` or `passage`	The lyrics of the song being quoted. Highlight the term defined in bold in the quoted text like this: "`'''music'''`".
`worklang`	A comma-separated list of language codes indicating the language(s) that the overall song is written in, if different from the quoted text; for a list of the codes, see Wiktionary:List of languages.
`termlang`	A language code indicating the language of the term being illustrated, if different from the quoted text; for a list of the codes, see Wiktionary:List of languages. If specified, this language is the one used when adding the page to a category of the form "Category: terms with quotations"; otherwise, the first listed language specified using `1` is used. Only specify this parameter if the language of the quotation is different from the term's language, e.g. a Middle English quotation used to illustrate a modern English term or an English definition of a Vietnamese term in a Vietnamese-English dictionary.
`nocat`	Use `nocat=y` or `nocat=1` or `nocat=on` to suppress adding the page to a category of the form "Category: terms with quotations". This should not normally be done.
`brackets`	Use "`brackets=on`" to surround a quotation with brackets. This indicates that the quotation either contains a mere mention of a term (for example, "some people find the word manoeuvre hard to spell") rather than an actual use of it (for example, "we need to manoeuvre carefully to avoid causing upset"), or does not provide an actual instance of a term but provides information about related terms.
`t` or `translation`	If the quoted text is not in English, this parameter can be used to provide an English translation of it.
`lit`	If the quoted text is not in English and the translation supplied using `t` or `translation` is idiomatic, this parameter can be used to provide a literal English translation.
`footer`	This parameter can be used to specify arbitrary text to insert in a separate line at the bottom, to specify a comment, footnote, etc.
`tr` or `transliteration`	If the quoted text uses a different writing system from the Latin alphabet (the usual alphabet used in English), this parameter can be used to provide a transliteration of it into the Latin alphabet. Note that many languages provide an automatic transliteration if this argument is not specified.
`subst`	Phonetic substitutions to be applied to handle irregular transliterations in certain languages with a non-Latin writing system and automatic transliteration (e.g. Russian and Yiddish). If specified, should be one or more substitution expressions separated by commas, where each substitution expression is of the form `FROM//TO` (`FROM/TO` is also accepted), where `FROM` specifies the source text in the source script (e.g. Cyrillic or Hebrew) and `TO` is the corresponding replacement text, also in the source script. The intent is to respell irregularly-pronounced words phonetically prior to transliteration, so that the transliteration reflects the pronunciation rather than the spelling. The substitutions are applied in order. Note that Lua patterns can be used in `FROM` and `TO` in lieu of literal text; see WT:LUA. See also `{{ux}}` for an example of using `subst` (the usage is identical to that template).

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for quote-song

This template can be used in a dictionary entry to provide a quotation of lyrics from a song. If the lyrics are subject to copyright, do not quote a portion of them that is excessively long.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Language	`1`	A comma-separated list of language codes indicating the language(s) of the quoted text Example en	String	required
Song title	`title`	The title of the song. Example Billie Jean	String	required
Year of release	`year`	The year or date the song was released. Example 1982	Number	suggested
Songwriter	`author`	The person(s) who wrote the lyrics and composed the music of the song. Example Michael Jackson	String	suggested
Wikipedia songwriter page	`authorlink`	English Wikipedia article about the songwriter. Example Michael Jackson	String	optional
Lyricist	`lyricist`	The person(s) who wrote the lyrics of the song. If more than one person is stated, separate the names with semicolons. Example Stephen Sondheim	String	optional
Composer	`composer`	The person(s) who composed the music of the song. If more than one person is stated, separate the names with semicolons. Example Leonard Bernstein	String	optional
Performer	`artist`	The artist (an individual or ensemble) who performed the song, if different from the lyricist(s) and/or composer(s).	String	suggested
Featuring artist	`feat`	A featuring artist who appears as a secondary or guest performer on the song.	String	optional
Album name	`album`	The title of the album in which the song first appeared. Example Thriller	String	suggested
Lyrics	`text` `passage`	The portion of the lyrics of the song being quoted. Highlight the term defined in bold, use a slash (/) to indicate line breaks. Example People always told me, ‘Be careful of what you do / And don't go around '''breaking young girls' hearts'''’	Content	required
Translation	`translation` `t`	If the quoted text is not in English, this parameter can be used to provide an English translation of it.	Content	optional
Transliteration	`transliteration` `tr`	If the quoted text uses a different writing system from the Latin alphabet (the usual alphabet used in English), this parameter can be used to provide a transliteration of it into the Latin alphabet. Note that many languages provide an automatic transliteration if this argument is not specified.	Content	optional
Label	`publisher`	The name of one or more publishers of the song or album. If more than one publisher is stated, separate the names with semicolons. Example Epic Records	String	optional
URL	`url`	The URL of a relevant external website, such as a website containing the lyrics of the song. Add such a link only if the score is no longer copyrighted—do not link to a website that has content in breach of copyright.	URL	optional
OCLC	`oclc`	Online Computer Library Center number Example 221787791	Number	optional
Brackets	`brackets`	Use "on" to surround a quotation with brackets. This indicates that the quotation contains a mere mention of a term or does not provide an actual instance of a term but provides information about related terms. Example on	Boolean	optional
Notes	`note`	Brief notes about the song. Example track 6	String	optional
Format	`format`	The format in which the song was released. Example "cassette", "CD", "EP record", "LP record"	String	optional

Template:quote-song/documentation

Contents

Usage

Sample template

Parameters

TemplateData

See also

Wikious

Boobota

Sagapedia