Template:quote-av/documentation

From Wiktionary, the free dictionary
Jump to navigation Jump to search
Documentation for Template:quote-av. [edit]
This page contains usage information, categories, interwiki links and other content describing the template.

Usage[edit]

This template can be used in a dictionary entry to provide a quotation from an audio or video recording, including a film or a radio or television program.

Sample templates[edit]

Most basic parameters for English quotations
#* {{quote-av|1=|year=|author=|actor=|role=|title=|season=|number=|time=|text=}}
Most basic parameters for non-English quotations
#* {{quote-av|1=|year=|author=|actor=|role=|title=|season=|number=|time=|text=|t=}}
Commonly used parameters
#* {{quote-av|1=|author=|authorlink=|actor=|role=|episode=|title=|url=|archiveurl=|archivedate=|season=|number=|writer=|location=|publisher=|year=|isbn=|oclc=|time=|text=|t=|tr=}}
All available parameters
#* {{quote-av|1=|author=|authorlink=|writer=|writers=|director=|directors=|actor=|role=|episode=|trans-episode=|title=|trans-title=|url=|archiveurl=|archivedate=|format=|medium=|worklang=|season=|number=|network=|location=|publisher=|date=|month=|year=|year_published=|accessdate=|isbn=|oclc=|id=|time=|at=|text=|passage=|t=|translation=|lit=|tr=|transliteration=|footer=|brackets=|subst=}}

The following example:

{{quote-av|en|writer={{w|Cameron Crowe}}|actor={{w|Jay Mohr}}|role=Bob Sugar|title={{w|Jerry Maguire}}|location=Culver City, Calif.|publisher={{w|TriStar Pictures}}; distributed by [[w:Sony Pictures Home Entertainment|Columbia TriStar Home Video]]|year=1996|year_published=1997|isbn=978-0-8001-4174-5|text=It's also my job to take care of the '''skanks''' on the road that you bang.}}

produces this:

1996, Cameron Crowe, Jerry Maguire, spoken by Bob Sugar (Jay Mohr), Culver City, Calif.: TriStar Pictures; distributed by Columbia TriStar Home Video, published 1997, →ISBN:
It's also my job to take care of the skanks on the road that you bang.

As there are no specific parameters for quoting multiple lines of a conversation, it is suggested that these be written in the following form, using / as a line separator:

|text=role A (actor A): first line / role B (actor B): second line...

Parameters[edit]

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

Parameter Remarks
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 [language])" (for one language), or "(in [language] and [language])" (for two languages), or "(in [language], [language] ... and [language])" (for three or more languages). The entry page will also be added to a category in the form "Category:[Language] 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 recording is in: see below.

author and authorlink, or writer or writers The author or writer(s) of the episode or program quoted. The parameter |authorlink= can be used to link to an English Wikipedia article about the author.
director or directors The director(s) of the episode or program quoted.
actor The actor quoted.
role or roles or speaker The role played by the actor; or, the person (in a non-acting role) speaking.
episode The title of the episode quoted. If specifying an episode number only, use number.
trans-episode If the title of the episode is not in English, this parameter can be used to provide an English translation of the title.
title Mandatory: the title of the recording.
trans-title If the title of the recording is not in English, this parameter can be used to provide an English translation of the title.
url The URL or web address of the recording. Do not link to any webpage that has content in breach of copyright.
archiveurl and archivedate
or
accessdate
Use archiveurl and archivedate (which must be used together) to indicate 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.

Alternatively, if the webpage cannot be archived, use accessdate to indicate when its URL was accessed.

format The format of the recording, for example, "Betamax" or "VHS" (which are videotape formats).
medium The medium of the recording, for example, "Blu-ray", "CD", "DVD", "motion picture", "podcast", "television production" or "videotape".
season and number The season or series number and episode number of the episode of the program quoted. For example, if quoting from season 3, episode 1, type "season=3 and "number=1". Use episode to specify the name of the episode.
network The television network or radio network on which the recording is broadcast.
location The location(s) where the recording 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 recording. If more than one publisher is stated, separate the names with semicolons.
date
or
year (and month)
Mandatory: the date, or year (and month), that the recording was published. Use either date, or year (and month), not both.
year_published If you use date or year to indicate when the recording was originally released (for example, in cinemas), year_published can be used to indicate a subsequent publication (for example, on DVD).
isbn, oclc or id The International Standard Book Number (ISBN) or Online Computer Library Center (OCLC) number (which can be looked up at the WorldCat website) of the recording.

Use id for an identifier other than the ones listed above.

time The time in hours, minutes and seconds from the start of the recording at which the quoted text occurs. For example, if the quoted text appears 1 hour, 30 minutes and 6 seconds into the recording, type "time=1:30:06".
at Use this parameter to identify where in the recording the quoted text occurs other than by specifying the time from the start of the recording. For example, the parameter can be used to indicate that the text occurs in a particular act and scene of a play.
text or passage The portion of the recording being quoted. Highlight the term defined in bold in the quoted text like this: "'''Thalia'''".
worklang A comma-separated list of language codes indicating the language(s) that the overall recording 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:[Language] 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:[Language] 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).

Examples[edit]

  • Wikitext: {{quote-av|en|writer={{w|Julian Fellowes}}|title={{w|Downton Abbey}}|season=[[w:Downton Abbey (series 2)|2]]|number=1|year=2011|time=26:03|text=Did I tell you I've been given a '''colonelcy''' in the North Riding Volunteers?}}
  • Result:
    • 2011, Julian Fellowes, 26:03 from the start, in Downton Abbey, season 2, episode 1:
      Did I tell you I've been given a colonelcy in the North Riding Volunteers?

TemplateData[edit]

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

TemplateData for quote-av

This template can be used in a dictionary entry to provide a quotation from an audio or video recording, including a film or a radio or television program.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Language1

A comma-separated list of language codes indicating the language(s) of the quoted text.

Example
en
Stringrequired
Titletitle

The title of the recording, film etc.

Example
Citizen Kane
Stringrequired
Year of releaseyear

The year that the recording was published. Use either "date" or "year", not both.

Example
1941
Numbersuggested
Date of releasedate

Use either "year" or "date", not both.

Example
September 5 1941
Stringsuggested
Writer (screenplay)author writer writers

The author or writer(s) of the film, episode or program quoted. Separate multiple names with semicolons.

Example
Herman J. Mankiewicz; Orson Welles
Stringsuggested
Wikipedia author pageauthorlink

English Wikipedia article about the author.

Example
Herman J. Mankiewicz
Stringoptional
Actor (speaker)actor

The actor or speaker quoted.

Example
Joseph Cotten
Stringoptional
Rolerole

The role played by the actor.

Example
Jedediah Leland
Stringoptional
Timecodetime

The time in hours, minutes and seconds from the start of the recording at which the quoted text occurs (HH:MM:SS).

Example
1:30:06
Stringoptional
Contextat

Use this parameter to identify where in the recording the quoted text occurs other than by specifying the time from the start of the recording. For example, the parameter can be used to indicate that the text occurs in a particular act and scene of a play.

Example
act V, scene iii
Stringoptional
Recording mediummedium

The medium of the recording.

Example
"motion picture", "television production", "podcast", "DVD", "Blu-ray", "CD" or "videotape"
Stringoptional
Networknetwork

The television network or radio network on which the recording is broadcast.

Example
20th Century Fox Television
Stringoptional
Quoted linetext passage

The portion of the recording being quoted. Highlight the term defined in bold. As there are no specific parameters for quoting multiple lines of a conversation, it is suggested that these be written using "/" as a line separator.

Example
Bernstein, am I a '''stuffed shirt'''? Am I a horse-faced hypocrite? Am I a New England school marm?
Contentrequired
Translationtranslation t

If the quoted text is not in English, this parameter can be used to provide an English translation of it.

Contentoptional
Season number (series)season

The season number of the episode of the program quoted.

Example
1
Numberoptional
Episode number (series)number

The number of the episode of the program quoted.

Example
10
Numberoptional
Episode title (series)episode

The title of the episode quoted. If specifying an episode number only, use "number".

Example
Homer's Night Out
Stringoptional
Publisherpublisher

The name of one or more publishers of the recording. If more than one publisher is stated, separate the names with semicolons.

Example
RKO Radio Pictures
Stringoptional
URLurl

The URL of the recording. Do not link to any webpage that has content in breach of copyright.

URLoptional
Directordirector directors

The director(s) of the film, episode or program quoted. Separate multiple names with semicolons.

Example
Orson Welles
Stringoptional
Bracketsbrackets

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
Booleanoptional

See also[edit]

  • {{cite-av}} – for citations in reference sections and on talk pages
  • {{cite AV media}} – the corresponding template at the English Wikipedia