Template:Cite AV media/doc

Citation Style 1 templates

{{Cite arXiv}}	arXiv preprint
{{Cite AV media}}	audio and visual
{{Cite AV media notes}}	audio and visual liner notes
{{Cite book}}	books
{{Cite conference}}	conference papers
{{Cite DVD notes}}	DVD liner notes
{{Cite encyclopedia}}	edited collections
{{Cite episode}}	radio or television episodes
{{Cite interview}}	interviews
{{Cite journal}}	magazines, journals, academic papers
{{Cite mailing list}}	public mailing lists
{{Cite map}}	maps
{{Cite music release notes}}	audio and video liner notes
{{Cite news}}	news articles
{{Cite newsgroup}}	online newsgroups
{{Cite podcast}}	audio or video podcast
{{Cite press release}}	press releases
{{Cite serial}}	audio or video serials
{{Cite sign}}	signs, plaques
{{Cite speech}}	speeches
{{Cite techreport}}	technical reports
{{Cite thesis}}	theses
{{Cite web}}	web sources

This Citation Style 1 template is used to create citations for audio and visual works. For media in episodic or serial format, use {{cite episode}} or {{cite serial}}. To cite liner notes and other print media associated with audio or visual media, use {{cite AV media notes}} or {{cite DVD-notes}}.

Usage

Copy a blank version to use. All parameter names must be in lowercase. Use the "|" (pipe) character between each parameter. Delete unused parameters to avoid clutter in the edit window. Some samples may include the current date. If the date is not current, then the page.

Horizontal list:

{{cite AV media |people= |year= |title= |trans_title= |medium= |language= |url= |accessdate= |archiveurl= |archivedate= |format= |time= |location= |publisher= |id= |isbn= |oclc= |quote= |ref= }}

Vertical format:

{{cite AV media
 | people =
 | year =
 | title =
 | trans_title =
 | medium =
 | language =
 | url =
 | accessdate =
 | archiveurl =
 | archivedate =
 | format =
 | time =
 | location =
 | publisher =
 | id =
 | isbn =
 | oclc =
 | quote =
 | ref =
}}

Examples

{{cite AV media | people=Fouladkar, Assad (Director) | date=May 15, 2003 | title=Lamma hikyit Maryam | trans_title = When Maryam Spoke Out | medium=Motion picture | location=Lebanon | publisher=Fouladkar, Assad}}

• Fouladkar, Assad (Director) (May 15, 2003). Lamma hikyit Maryam [When Maryam Spoke Out] (Motion picture). Lebanon: Fouladkar, Assad. 

Parameters

Syntax

Nested parameters rely on their parent parameters:

• parent
• OR: parent2—may be used instead of parent
  • child—may be used with parent (and is ignored if parent is not used)
  • OR: child2—may be used instead of child (and is ignored if parent2 is not used)

Where aliases are listed, only one of the parameters may be defined; if multiple aliased parameters are defined, then only one will show.

By default, sets of fields are terminated with a period (.). This can be an issue when the last field uses an abbreviation or initial that ends with a period, as then two periods will display (..). The only solution is to not include the last period in the value for the set of fields.

COinS

This template embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata. See: Wikipedia:COinS. As a general rule, only one data item per parameter. Do not include explanatory or alternate text:

• Use |date=27 September 2007 not |date=27 September 2007 (print version 25 September)

Use of templates within the citation template, is generally discouraged as many of these templates will add a lot of extraneous HTML or CSS that will be rendered in the metadata. Also, HTML entities, for example  , –, etc, should not be used in parameters that contribute to the metadata.

COinS metadata is created for these parameters:

• |periodical=, |journal=, |newspaper=, |magazine=, |work=, |website=, |encyclopedia=, |encyclopaedia=, |dictionary=
• |chapter=, |contribution=, |entry=, |article=, |section=
• |title=
• |publicationplace=, |publication-place=
• |date=, |year=, |publicationdate=, |publication-date=
• |series=
• |volume=
• |issue=, |number=
• |page=, |pages=, |at=
• |edition=
• |publisher=, |distributor=, |institution=
• |url=
• |chapterurl=, |chapter-url=, |contributionurl=, |contribution-url=, |sectionurl=
• |author#=, |Author#=, |authors#=, |author#-last=, |author-last#=, |last#=, |surname#=
• any of the identifiers (|isbn=, |issn=, |doi=, |pmc=, etc)

Deprecated

The following parameters are deprecated. Their use will place the page into Category:Pages containing cite templates with deprecated parameters:

• day · month: Use date to include the day, month and year.
• coauthor · coauthors: Use last# / first# or author or authors

Description

Authors

• last: Surname of author. Do not wikilink—use authorlink instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use last to include the same format as the source. Aliases: last1, author, authors, author1, people.
  • first: Given or first names of author, including title(s); for example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use authorlink instead. Aliases: first1. Requires last; first name will not display if last is empty.
  • OR: for multiple authors, use last1, first1 through lastn, firstn where n is any consecutive number for an unlimited number of authors (each firstn requires a corresponding lastn). By default, if nine authors are defined, then only eight will show and "et al." will show in place of the last author. See the display parameters to change. Aliases: author1 through authorn.

• authorlink: Title of existing Wikipedia article about the author—not the author's website; do not wikilink. Aliases: authorlink1, author-link, author1-link, author1link.
• OR: for multiple authors, use authorlink1 through authorlinkn. Aliases: author1-link through authorn-link.

• coauthors: (deprecated) Names of coauthors. Requires author, authors, or lastn Include coauthors in author or authors or use separate authorn or lastn/firstn to list coauthors.
• others: To record other contributors to the work, such as Illustrated by John Smith or Translated by John Smith.

When using shortened footnotes or parenthetical referencing styles with templates, do not use multiple names in one field or else the anchor will not match the inline link.

Title

• title: Title of source. Can be wikilinked to an existing Wikipedia article or url may be used to add an external link, but not both. Displays in italics.
  • trans_title: English translation of the title if the source cited is in a foreign language. Displays in square brackets after title; if url is defined, then trans_title is included in the link. Use of the language parameter is recommended.

Titles containing certain characters will display and link incorrectly unless those characters are encoded.

newline	[	]	|
space	[	]	|

• type: Provides additional information about the media type of the source; format in sentence case. Displays in parentheses following the title. Examples: Thesis, Booklet, CD liner, Press release. Use one of the following as applicable: Motion picture, Television production, Videotape, DVD, Trailer, Video game, CD, Radio broadcast, Podcast.

Alias: medium

• chapter: The chapter heading of the source. May be wikilinked or may use chapter-url, but not both. Displays in quotes.
  • trans_chapter: English translation of the chapter heading, if the source cited is in a foreign language. Displays in square brackets after the chapter field; if chapter-url is defined, then trans_chapter is included in the link. Use of the language parameter is recommended.

• language: The language the source is written in, if not English. Displays in parentheses with "in" before the language name. Use the full language name or ISO 639-1 code; use of ISO 639-1 also adds appropriate language categorization; do not use icons or templates.

Date

• date: Date of source being referenced. Can be full date (day, month, and year) or partial date (month and year, season and year, year). Use same format as other publication dates in the citations. Required when year is used to disambiguate {{sfn}} links to multiple-work citations by the same author in the same year.^[more] Do not wikilink. Displays after the authors and is enclosed in parentheses. If there is no author, then displays after publisher.
• OR:
  • year: Year of source being referenced. Required with some types of {{sfn}} citations;^[more] otherwise use date.
  • month: (deprecated) Name of the month or season of publication. Use date instead.
  • origyear: Original publication year; displays after the date or year. For clarity, please supply specifics. For example: |origyear=First published 1859 or |origyear=Composed 1904.

Publisher

• publisher: Name of publisher; may be wikilinked if relevant. The publisher is the company that publishes the work being cited. Do not use the publisher parameter for the name of a work (e.g., a book, encyclopedia, newspaper, magazine, journal, website). Not normally used for periodicals. Corporate designations such as "Ltd", "Inc" or "GmbH" are not usually included. Omit where the publisher's name is substantially the same as the name of the work (for example, The New York Times Co. publishes The New York Times newspaper, so there is no reason to name the publisher). Displays after title; if work is defined, then publisher is enclosed in parentheses.
• place: Geographical place of publication; generally not wikilinked; omit when the name of the work includes the location; examples: The Boston Globe, The Times of India. Displays after the title; if work is defined, then location is enclosed in parentheses. Alias: location
• publication-place: If any one of publication-place, place or location are defined, then the location shows after the title; if publication-place and place or location are defined, then place or location are shown before the title prefixed with "written at" and publication-place is shown after the title.
• publication-date: Date of publication when different from the date the work was written. Displays only if year or date are defined and only if different, else publication-date is used and displayed as date. Use the same format as other dates in the article; do not wikilink. Follows publisher; if work is not defined, then publication-date is preceded by "published" and enclosed in parenthesis.

Edition, series, volume

• edition: When the publication has more than one edition; for example: "2nd", "Revised" etc. Displays " ed." after this field, so |edition=2nd produces "2nd ed." Does not display if a periodical field is defined.

• series or version: When the source is part of a series, such as a book series or a journal where the issue numbering has restarted.

• volume: For one publication published in several volumes. Displays after the title and series fields; displays in bold— if bolding is not desired, then include the volume information in the title field.

In-source locations

• minutes: Time the event occurs in the source; followed by "minutes in".
• OR: time: Time the event occurs in the source; preceded by default text "Event occurs at time".
  • timecaption: Changes the default text displayed before time.

• page: The number of a single page in the source that supports the content. Use either |page= or |pages=, but not both. Displays preceded by p. unless |nopp=y.
• OR: pages: A range of pages in the source that supports the content. Use either |page= or |pages=, but not both. Separate using an en dash (–); separate non-sequential pages with a comma (,); do not use to indicate the total number of pages in the source. Displays preceded by pp. unless |nopp=y. Hyphens are automatically converted to en dashes; if hyphens are appropriate, for example: pp. 3-1–3-15, use |at=.
  • nopp: Set to y to suppress the p. or pp. notations where this is inappropriate; for example, where |page=Front cover.
• OR: at: For sources where a page number is inappropriate or insufficient. Overridden by |page= or |pages=. Use only one of |page=, |pages=, or |at=.

Examples: page (p.) or pages (pp.); section (sec.), column (col.), paragraph (para.); track; hours, minutes and seconds; act, scene, canto, book, part, folio, stanza, back cover, liner notes, indicia, colophon, dust jacket, verse.

URL

• url: URL of an online location where the text of the publication can be found. Cannot be used if title is wikilinked. If applicable, the link may point to the specific page(s) referenced. Remove spurious tracking parameters from URLs, e.g. #ixzz2rBr3aO94 or ?utm_source=google&utm_medium=...&utm_term=...&utm_campaign=.... Do not link to any commercial booksellers, such as Amazon.com. See: WP:PAGELINKS.
  • accessdate: Full date when original URL was accessed; use the same format as other access and archive dates in the citations; requires url. Do not wikilink. Not required for web pages or linked documents that do not change; mainly for use of web pages that change frequently or have no publication date. Can be hidden or styled by registered editors.
  • archiveurl: The URL of an archived copy of a web page, if or in case the url becomes unavailable. Typically used to refer to services like WebCite (see: Wikipedia:Using WebCite) and Internet Archive (see: Wikipedia:Using the Wayback Machine); requires archivedate and url.
    • archivedate: Date when the original URL was archived; preceded by default text "archived from the original on". Use the same format as other access and archive dates in the citations. This does not necessarily have to be the same format that was used for citing publication dates. Do not wikilink.
    • deadurl: When the URL is still live, but pre-emptively archived, then set |deadurl=no. This changes the display order with the title retaining the original link and the archive linked at the end.
  • template doc demo: The archive parameters will be error checked to ensure that all the required parameters are included, or else {{citation error}} is invoked. With errors, main, help and template pages are placed into Category:Articles with incorrect citation syntax. Set |template doc demo=true to disable categorization; mainly used for documentation where the error is demonstrated.
• format: Format of the work referred to by url; for example: PDF, DOC, or XLS; displayed in parentheses after title. HTML is implied and should not be specified. Does not change the external link icon. Note: External link icons do not include alt text; thus, they do not add format information for the visually impaired.

URLs must begin with a supported URI scheme. http:// and https:// will be supported by all browsers; however, ftp://, gopher://, irc://, ircs://, mailto: and news: will require a plug-in or an external application and should normally be avoided. IPv6 host-names are currently not supported.

If URLs in citation template parameters contain certain characters, then they will not display and link correctly. Those characters need to be percent-encoded. For example, a space must be replaced by %20. To encode the URL, replace the following characters with:

sp	"	'	<	>	[	]	|	}
%20	%22	%27	%3c	%3e	%5b	%5d	%7c	%7d

Single apostrophes do not need to be encoded; however, unencoded multiples will be parsed as italic or bold markup. Single curly closing braces also do not need to be encoded; however, an unencoded pair will be parsed as the double closing braces for the template transclusion.

Anchor

• ref: ID for anchor. By default, no anchor is generated. The ordinary nonempty value |ref=ID generates an anchor with the given ID; such a linkable reference can be made the target of wikilinks to full references, especially useful in short citations like shortened notes and parenthetical referencing. The special value |ref=harv generates an anchor suitable for the {{harv}} template. See: Anchors for Harvard referencing templates.

Identifiers

• id: A unique identifier, used where none of the specialized identifiers are applicable; wikilink or use a template as applicable.

These identifiers create links and are designed to accept a single value. Using multiple values or other text will break the link and/or invalidate the identifier.

• arxiv: arXiv identifier; for example: arxiv=hep-th/9205027
• asin: Amazon Standard Identification Number
  • asin-tld: ASIN top-level domain for Amazon sites other than the US; valid values: ca, cn, co.jp, co.uk, de, es, fr, it
• bibcode: Bibcode; used by a number of astronomical data systems; for example: 1974AJ.....79..819H
• doi: Digital object identifier; for example: 10.1038/news070508-7. It is checked to ensure it begins with (10.).
  • doi_brokendate: Date the DOI is broken; use the same format as other dates in the article.
• isbn: International Standard Book Number; for example: 978-0-8126-9593-9. (See: Wikipedia:ISBN and ISBN). Dashes in the ISBN are optional, but preferred. Use the 13-digit ISBN wherever possible; this can normally be found beneath the barcode as a number beginning with 978 or 979 (barcodes beginning with any other numbers are not ISBNs). For sources with the older 9 digit SBN system, prefix the number with a zero; thus, SBN 902888-45-5 should be entered as |isbn=0-902888-45-5. It is checked for length, invalid characters and the proper check digit. Alias: ISBN
• issn: International Standard Serial Number; eight characters may be split into two groups of four using a hyphen, but not an en dash or a space.
• jfm: Jahrbuch über die Fortschritte der Mathematik
• jstor: JSTOR abstract; for example: "jstor=3793107" will generate JSTOR 3793107.
• lccn: Library of Congress Control Number
• mr: Mathematical Reviews
• oclc: OCLC
• ol: Open Library
• osti: Office of Scientific and Technical Information
• pmc: PubMed Central; use article number for full-text free repository of a journal article.
  • embargo: Date that pmc goes live; if this date is in the future, then pmc is not linked until that date.
• pmid: PubMed; use unique identifier.
• rfc: Request for Comments
• ssrn: Social Science Research Network
• zbl: Zentralblatt MATH

Quote

• quote: Relevant text quoted from the source. Displays enclosed in quotes. When supplied, the citation terminator (a period by default) is suppressed, so the quote needs to include terminating punctuation.

Editors

• editor-last: Surname of editor. Do not wikilink—use editor-link instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use editor-last to include the same format as the source. Aliases: editor1-last, editor, editors.
  • editor-first: Given or first names of editor, including title(s); example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use editor-link instead. Aliases: editor1-first.
  • OR: for multiple editors, use editor1-last, editor1-first through editor4-last, editor4-first for up to four editors.

• editor-link: Title of existing Wikipedia article about the editor—not the editor's website; do not wikilink. Aliases: editor1-link.
• OR: for multiple editors, use editor1-link through editor4-link.

Display:

If authors: Authors are first, followed by the editors and the included work, then the main work.

If no authors: Editors appear before the included work; a single editor is followed by "ed."; multiple editors are followed by "eds."; more than three editors will be followed by "et al., eds."

Laysummary

• laysummary: URL link to a non-technical summary or review of the source; the URL title is set to "Lay summary".
  • laysource: Name of the source of the laysummary. Displays in italics and preceded by an endash.
  • laydate: Date of the summary. Displays in parentheses.

Display options

• author-mask: Replaces the name of the first author with em dashes or text. Set author-mask to a numeric value n to set the dash n em spaces wide; set author-mask to a text value to display the text without a trailing author separator; for example, "with". You must still include the values for all authors for metadata purposes. Primarily intended for use with bibliography styles where multiple works by a single author are listed sequentially. Do not use in a list generated by {{reflist}}, <references /> or similar as there is no control of the order in which references are displayed.
• author-name-separator: Controls the separator between last and first names; defaults to a comma and space (, ); if the parameter is present, but blank, separator punctuation is set to the default; a space must be encoded as  .
• author-separator: Controls the separator between authors; defaults to a semicolon and space (; ); if the parameter is present, but blank, separator punctuation is set to the default; a space must be encoded as  .
• display-authors: Controls the number of author names that are displayed when a citation is published. To change the displayed number of authors, set display-authors to the desired number. For example, |display-authors=2 will display only the first two authors in a citation. By default, all authors are displayed except when there are nine authors, then the author list in the citation is truncated to eight authors, followed by "et al." This exception mimics the older version of the template for compatibility. If a citation contains nine author names and one wishes all nine author names to display, "et al." may be suppressed by setting |display-authors=9. Aliases: displayauthors.
• display-editors: Controls the number of editor names that are displayed when a citation is published. To change the displayed number of editors, set display-editors to the desired number. For example, |display-editors=2 will display only the first two editors in a citation. By default, all editors are displayed except when there are four editors, then the editor list in the citation is truncated to three editors, followed by "et al." This exception mimics the older version of the template for compatibility. If a citation contains four editor names and one wishes all four editor names to display, "et al." may be suppressed by setting |display-editors=4. Aliases: displayeditors.
• lastauthoramp: Switches the separator between the last two names of the author list to space ampersand space ( & ) when set to any value. Example: |lastauthoramp=yes
• postscript: Controls the closing punctuation for a citation; defaults to a period (.); for no terminating punctuation, specify |postscript=none – leaving |postscript= empty has the same effect but is ambiguous. Ignored if quote is defined.
• separator: Controls the punctuation used to separate lists of authors, editors, etc. Defaults to a period (.); if the parameter is present, but blank, separator punctuation is set to the default; a space must be encoded as  .

Subscription or registration required

Main article: WP:PAYWALL

These parameters add a link note to the end of the citation:

• registration: For online sources that require registration, set |registration=yes; superseded by subscription if both are set.
• subscription: For online sources that require a subscription, set |subscription=yes; supersedes registration if both are set.

This template produces COinS metadata; see COinS in Wikipedia for background information.