Permanently protected template

Template:Cite report

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Template documentation[view] [edit] [history] [purge]
Citation Style 1 templates
{{Cite arXiv}} arXiv preprints
{{Cite AV media}} audio and visual
{{Cite AV media notes}} audio and visual liner notes
{{Cite bioRxiv}} bioRxiv preprints
{{Cite book}} books
{{Cite conference}} conference papers
{{Cite encyclopedia}} edited collections
{{Cite episode}} radio or television episodes
{{Cite interview}} interviews
{{Cite journal}} academic journals and papers
{{Cite magazine}} magazines, periodicals
{{Cite mailing list}} public mailing lists
{{Cite map}} maps
{{Cite news}} news articles
{{Cite newsgroup}} online newsgroups
{{Cite podcast}} audio or video podcast
{{Cite press release}} press releases
{{Cite report}} reports
{{Cite serial}} audio or video serials
{{Cite sign}} signs, plaques
{{Cite speech}} speeches
{{Cite techreport}} technical reports
{{Cite thesis}} theses
{{Cite web}} any resource accessible through a URL
See also:

This Citation Style 1 template is used to create citations for unpublished reports by government departments, instrumentalities, operated companies, etc..

These reports are to be published in the Wikipedia sense of verifiability: a responsible organisation must have fact checked them; and the selection process for publication must not have been automatic.
Examples include: government printed reports which lack ISSN or ISBN numbers, and reports from major semi-governmental instrumentalities that are freely circulating and available for verification, but which lack a formal ISBN / ISSN publication process.

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 purge the page.


Full parameter set in horizontal format
{{cite report |author= |author-link= |authors= |date= |title= |url= |publisher= |page= |docket= |access-date= |quote= }}


Full parameter set in vertical format
Vertical list Prerequisites Brief instructions / notes
{{cite report
 | author      = <!-- or |last= and |first= -->
 | author-link =
 | authors     =
 | date        = <!-- or |month= and |year= -->
 | title       = 
 | url         = 
 | publisher   = 
 | format      =
 | others      =
 | edition     =
 | location    =
 | chapter     =
 | section     =
 | page        =
 | pages       =
 | docket      =
 | access-date = 
 | quote       =
}}
  • If a field name is listed in the Prerequisites column, it is a prerequisite for the field to the left.

Example

  • {{cite report |title=Rhode Island Roads |publisher=Rhode Island Department of Public Works |date=1956}}
Rhode Island Roads (Report). Rhode Island Department of Public Works. 1956. 

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 (.).

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 discouraged because many of these templates will add extraneous HTML or CSS that will be included raw in the metadata. Also, HTML entities, for example &nbsp;, &ndash;, etc, should not be used in parameters that contribute to the metadata. Do not include Wiki markup '' (italic font) or ''' (bold font) because these markup characters will contaminate the metadata.

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

Deprecated

The coauthor and coauthors parameters are deprecated. Their use will place the page into Category:Pages containing cite templates with deprecated parameters. Use last# / first# or author or authors. If coauthor · coauthors are used for et al, then use display-authors=etal instead.

Description

Authors

  • last: Surname of a single author. Do not wikilink—use author-link instead. For corporate authors or authors for whom only one name is listed by the source, use last or one of its aliases (e.g. |author=Bono). Aliases: surname, author, last1, surname1, author1.
    • author: this parameter is used to hold the complete name of a single author (first and last) or to hold the name of a corporate author. This parameter should never hold the names of more than one author.
    • first: Given or first names of author; for example: Firstname Middlename or Firstname M. or Firstname M., Sr. Do not wikilink—use author-link instead. Aliases: given, first1, given1. 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). See the display parameters to change how many authors are displayed. Aliases: surname1, given1 through surnamen, givenn, or author1 through authorn. For an individual author plus an institutional author, you can use |first1=...|last1=...|author2=....
    • author-link: Title of existing Wikipedia article about the author—not the author's website; do not wikilink. Aliases: author-link1, authorlink, authorlink1, author1-link, author1link.
    • OR: for multiple authors, use author-link1 through author-linkn. Aliases: authorlink1 through authorlinkn, or author1-link through authorn-link, or author1link through authornlink.
    • name-list-format: displays authors and editors in Vancouver style when set to vanc and when the list uses last/first parameters for the name list(s).
  • vauthors: comma-separated list of author names in Vancouver style; enclose corporate or institutional author names in doubled parentheses:
    |vauthors=Smythe JB, ((Megabux Corporation))
    • author-link and author-mask may be used for the individual names in |vauthors= as described above
  • authors: Free-form list of author names; use of this parameter is discouraged because it does not contribute to a citation's metadata; not an alias of last.
  • 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.
  • translator-last: Surname of translator. Do not wikilink—use translator-link instead. Aliases: translator-surname, translator1, translator1-last, translator-last1.
    • translator-first: Given or first names of translator. Do not wikilink—use translator-link instead. Aliases: translator-given, translator1-first, translator-first1.
    • OR: for multiple translators, use translator-last1, translator-first1 through translator-lastn, translator-firstn, where n is any consecutive number for an unlimited number of translators (each translator-firstn requires a corresponding translator-lastn). Aliases: translator1-last, translator1-first through translatorn-last, translatorn-first, or translator1 through translatorn.
    • translator-link: Title of existing Wikipedia article about the translator—not the translator's website; do not wikilink. Aliases: translator-link1, translator1-link.
    • OR: for multiple translators, use translator-link1 through translator-linkn. Aliases: translator1-link through translatorn-link.
  • collaboration: Name of a group of authors or collaborators; requires author, last, or vauthors listing one or more primary authors; follows author name-list; appends "et al." to author name-list.
  • others: To record other contributors to the work, including illustrators. For the parameter value, write Illustrated by John Smith.
  • Note: 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.

Date

  • date: Date of source being referenced. Can be full date (day, month, and year) or partial date (month and year, season and year, or year). Use same format as other publication dates in the citations.[date 1] 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. For acceptable date formats, see Help:Citation Style 1 § Dates.
For approximate year, precede with "c. ", like this: |date=c. 1900.

For no date, or "undated", add as |date=n.d.
  • year: Year of source being referenced. Use of |date= is recommended unless all of the following conditions are met:
    1. The template uses |ref=harv, or the template is {{citation}}, or |mode=cs2
    2. The |date= format is YYYY-MM-DD.
    3. The citation requires a CITEREF disambiguator.
  • orig-year: Original publication year; displays after the date or year. For clarity, please supply specifics. For example: |orig-year=First published 1859 or |orig-year=Composed 1904. Alias: origyear
  • df: date format; sets rendered dates to the specified format; does not support date ranges or seasonal dates. Accepts one value which may be one of these:
    dmy – set publication dates to day month year format; access- and archive-dates are not modified;
    mdy – as above for month day, year format
    ymd – as above for year initial numeric format YYYY-MM-DD
    dmy-all – set publication, access-, and archive-dates to day month year format;
    mdy-all – as above for month day, year format
    ymd-all – as above for year initial numeric format YYYY-MM-DD
  1. ^ Publication dates in references within an article should all have the same format. This may be a different format from that used for archive and access dates. See MOS:DATEUNIFY.

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: editor-last1, editor1-last, editor-surname, editor-surname1, editor1-surname, editor, editor1.
    • editor: this parameter is used to hold the complete name of a single editor (first and last). This parameter should never hold the names of more than one editor.
    • 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: editor-first1, editor1-first, editor-given, editor-given1, editor1-given.
    • OR: for multiple editors, use editor-last1, editor-first1 through editor-lastn, editor-firstn (Aliases: editorn-last, editor-surnamen or editorn-surname; editorn-first, editor-givenn or editorn-given; editorn). For an individual editor plus an institutional editor, you can use |editor-first1=...|editor-last1=...|editor2=....
  • editor-link: Title of existing Wikipedia article about the editor—not the editor's website; do not wikilink. Aliases: editor-link1.
  • OR: for multiple editors, use editor-link1 through editor-linkn (alias editorn-link).
  • name-list-format: displays authors and editors in Vancouver style when set to vanc and when the list uses last/first parameters for the name list(s)
  • veditors: comma separated list of editor names in Vancouver style; enclose corporate or institutional names in doubled parentheses:
    |veditors=Smythe JB, ((Megabux Corporation))
  • editor-linkn and editor-maskn may be used for the individual names in |veditors=, as described above
  • editors: Free-form list of editor names; use of this parameter is discouraged; not an alias of editor-last
Display:
Use display-editors to control the length of the displayed editor name list and to specify when "et al." is included.
If authors: Authors are first, followed by the included work, then "In" and the editors, 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."

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 unformatted, without italics or quotes. If script-title is defined, title holds romanized transliteration of title in script-title.
    • script-title: Original title for languages that do not use a Latin-based alphabet (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, Vietnamese, etc); not italicized, follows italicized transliteration defined in title. May be prefixed with an ISO 639-1 two-character code to help browsers properly display the script:
      ... |title=Tōkyō tawā |script-title=ja:東京タワー |trans-title=Tokyo Tower ...
    • 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 &#91; &#93; {{!}} (preferred)
{{bracket|text}} &#124; or {{pipe}}see also Help:Table § Rendering the pipe
  • title-link: Title of existing Wikipedia article about the source named in title – do not use a web address; do not wikilink. Alias: titlelink.
  • language: The language in which the source is written. Displays in parentheses with "in" before the language name or names. Use the full language name or ISO 639-1 code. When the source uses more than one language, list them individually, separated by commas, e.g. |language=French, German. The use of language names or language codes recognized by Wikimedia adds the page to the appropriate subcategory of Category:CS1 foreign language sources; do not use templates or wikilinks. Note: When the language is "English" (or "en"), no language is displayed in the citation. Note: When two or more languages are listed there is no need to include "and" before the last language. "and" is inserted automatically by the template.

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 tracking parameters from URLs, e.g. #ixzz2rBr3aO94 or ?utm_source=google&utm_medium=...&utm_term=...&utm_campaign=.... See WP:PAGELINKS. Do not link to any commercial booksellers, such as Amazon.com. Invalid URLs, including those containing spaces, will result in an error message.
    • access-date: Full date when the content pointed to by url was last verified to support the text in the article; do not wikilink; requires url; use the same format as other access and archive dates in the citations.[date 1] Not required for linked documents that do not change. For example, access-date is not required for links to copies of published research papers accessed via DOI or a published book, but should be used for links to news articles on commercial websites (these can change from time to time, even if they are also published in a physical medium). Note that access-date is the date that the URL was checked to not just be working, but to support the assertion being cited (which the current version of the page may not do). Can be hidden or styled by registered editors. Alias: accessdate.
    • archive-url: The URL of an archived copy of a web page if the original URL is no longer available. Typically used to refer to services such as WebCite (see Wikipedia:Using WebCite) and Internet Archive (see Wikipedia:Using the Wayback Machine); requires archive-date and url. By default (overridden by |dead-url=no) the archived link is displayed first, with the original link at the end. Alias: archiveurl.
      • archive-date: Date when the original URL was archived; preceded in display 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.[date 1] Do not wikilink. Alias: archivedate.
      • dead-url: the default value of this optional parameter, if omitted, is |dead-url=yes. Equivalent values are y or true. When the URL is still live, but pre-emptively archived, then set |dead-url=no; this changes the display order, with the title retaining the original link and the archive linked at the end. When the original URL has been usurped for the purposes of spam, advertising, or is otherwise unsuitable, setting |dead-url=unfit or |dead-url=usurped suppresses display of the original URL (but |url= is still required). Alias: deadurl.
    • 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 one of the subcategories of 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. (For media format, use type.) HTML is implied and should not be specified. Automatically added when a PDF icon is displayed. 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: may 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  %7b  %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.
  1. ^ a b Access-date and archive-date in references should all have the same format – either the format used for publication dates, or YYYY-MM-DD. See MOS:DATEUNIFY.

Periodical

  • work: Name of the source periodical; may be wikilinked if relevant. Displays in italics. Aliases: journal, newspaper, magazine, periodical, website.
    • issue: When the publication is one of a series that is published periodically. Alias: number. When the issue has a special title of its own, this may be given, in italics, along with the issue number, e.g. |issue=2, ''Modern Canadian Literature''. Displayed in parentheses following volume.
    • department: Title of a regular department, column, or section within the periodical or journal. Examples include "Communication", "Editorial", "Letter to the Editor", and "Review". Displays after title and is in plain text.
When set, work changes the formatting of other parameters:
title is not italicized and is enclosed in quotes.
chapter does not display in this citation template (and will produce an error message).
location and publisher are enclosed in parentheses.
page and pages do not show p. or pp.
edition does not display.

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.
  • via: Name of the content deliverer (if different from publisher). via is not a replacement for publisher, but provides additional detail. It may be used when the content deliverer presents the source in a format other than the original (e.g. NewsBank), when the URL provided does not make clear the identity of the deliverer, where no URL or DOI is available (EBSCO), if the deliverer requests attribution, or as requested in WP:The Wikipedia Library (e.g. Credo, HighBeam). See also registration and subscription parameters.

Edition, series, volume

  • edition: When the publication has more than one edition; for example: "2nd", "Revised", and so forth. Appends the string " ed." after the 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; volumes of four characters or less display in bold.

In-source locations

  • 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 work (or an alias) is defined.
  • 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 or work (or an alias) is defined. Hyphens are automatically converted to en dashes; if hyphens are appropriate, for example: pp. 3-1–3-15, use |at=.
    • nopp: Set to y, yes, or true to suppress the p. or pp. notations where this is inappropriate; for example, where |page=Front cover or |pages=passim.
  • 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.

Identifiers

  • id: A unique identifier, used where none of the specialized identifiers are applicable; wikilink or use a template as applicable. For example, |id=NCJ 122967 will append "NCJ 122967" at the end of the citation. You can use templates such as |id={{NCJ|122967}} to append NCJ 122967 instead.
  • docket: Docket number.

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. In general, the parameters should include only the variable part of the identifier, e.g. rfc=822 or pmc=345678.

  • arxiv: arXiv identifier; for example: arxiv=hep-th/9205027 (before April 2007) or arxiv=0706.0001 or arxiv=1501.00001 (since April 2007). Do not include extraneous file extensions like ".pdf" or ".html".
  • asin: Amazon Standard Identification Number; if first character of asin value is a digit, use isbn. Because this link favours one specific distributor, only include it if standard identifiers aren't available.
    • asin-tld: ASIN top-level domain for Amazon sites other than the US; valid values: au, br, ca, cn, co.jp, co.uk, de, es, fr, it, mx
  • bibcode: Bibcode; used by a number of astronomical data systems; for example: 1974AJ.....79..819H
  • biorxiv: bioRxiv id, a 6-digit number at the end of the biorXiv URL (e.g. 078733 for http://biorxiv.org/content/early/2016/10/01/078733 or http://dx.doi.org/10.1101/078733)
  • citeseerx: CiteSeerX id, a string of digits and dots found in a CiteSeerX URL (e.g. 10.1.1.176.341 for http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.176.341 )
  • doi: Digital object identifier; for example: 10.1038/news070508-7. It is checked to ensure it begins with (10.).
    • doi-broken-date: Date the DOI was found to be non-working at http://dx.doi.org. Use the same format as other dates in the article. Alias: doi_brokendate, doi-inactive-date
  • eissn: International Standard Serial Number for the electronic media of a serial publication; eight characters may be split into two groups of four using a hyphen, but not an en dash or a space. Alias: EISSN
  • hdl: Handle System identifier for digital objects and other resources on the Internet. Alias: HDL
  • isbn: International Standard Book Number; for example: 978-0-8126-9593-9. (See Wikipedia:ISBN and ISBN § Overview.) Dashes in the ISBN are optional, but preferred. Use the ISBN actually printed on or in the book. Use the 13-digit ISBN – beginning with 978 or 979 – when it is available. If only a 10-digit ISBN is printed on or in the book, use it. ISBNs can be found on the page with the publisher's information – usually the back of the title page – or 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. Do not convert a 10-digit ISBN to 13-digit by just adding the 978 prefix; the last digit is a calculated check digit and just making changes to the numbers will make the ISBN invalid. This parameter should hold only the ISBN without any additional characters. It is checked for length, invalid characters – anything other than numbers, spaces, and hyphens, with "X" permitted as the last character in a 10-digit ISBN – and the proper check digit. Alias: ISBN
  • ismn: International Standard Music Number; for example: 979-0-9016791-7-7. Hyphens or spaces in the ISMN are optional. Use the ISMN actually printed on or in the work. This parameter should hold only the ISMN without any additional characters. It is checked for length, invalid characters – anything other than numbers, spaces, and hyphens – and the proper check digit. Alias: ISMN
  • 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. Alias: ISSN
  • jfm: Jahrbuch über die Fortschritte der Mathematik
  • jstor: JSTOR reference number; for example: jstor=3793107 will generate JSTOR 3793107.
  • lccn: Library of Congress Control Number. When present, alphabetic prefix characters are to be lower case.
  • mr: Mathematical Reviews
  • oclc: OCLC; WorldCat's Online Computer Library Center
  • ol: Open Library identifier; do not include "OL" in the value.
  • osti: Office of Scientific and Technical Information
  • pmc: PubMed Central; use article number for full-text free repository of a journal article, e.g. pmc=345678. Do not include "PMC" in the value. See also the pmid parameter, below; these are two different identifiers.
    • 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. See also the pmc parameter, above; these are two different identifiers.
  • rfc: Request for Comments
  • ssrn: Social Science Research Network
  • zbl: Zentralblatt MATH

Subscription or registration required

Citations of online sources that require registration or a subscription are acceptable in Wikipedia as documented in Verifiability – Access to sources. As a courtesy to readers and other editors, editors can signal the access restrictions of the external links included in a citation.

Four access levels can be used:

  • Freely accessible free: the source is free to read for anyone (this applies in particular to articles in open access)
  • Free registration required registration: a free registration is required to access the source
  • Free access subject to limited trial, subscription normally required limited: there are other constraints (such as a cap on daily views) to freely access this source
  • Paid subscription required subscription: the source is only accessible via a paid subscription

As there are often multiple external links with different access levels in the same citation, these values are attributed to a particular external link.

Access level of |url=

Links inserted with |url= are expected to be free to read by default. If not, editors can use one of

  • |url-access=subscription
  • |url-access=registration
  • |url-access=limited

to indicate the relevant access restriction.

Access level of identifiers

Links inserted by identifiers such as |doi= are not expected to offer a free full text by default. If they do, editors can use |doi-access=free (in the case of |doi=) to indicate the relevant access level. The following identifiers are supported:

  • |bibcode= with |bibcode-access=free
  • |doi= with |doi-access=free
  • |hdl= with |hdl-access=free
  • |jstor= with |jstor-access=free
  • |ol= with |ol-access=free
  • |osti= with |osti-access=free

Some identifiers always link to free full texts. In this case, the access level is automatically indicated by the template. This is the case for |arxiv=, |biorxiv=, |citeseerx=, |pmc=, |rfc= and |ssrn=.

Ambiguous access parameters

The parameters |registration=yes and |subscription=yes can also be used to indicate the access level of a citation. However, they do not indicate which link they apply to, so editors are encouraged to use |url-access=registration and |url-access=subscription instead, when the restriction applies to |url=. If the restriction applies to an identifier, these parameters should be omitted.

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

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

Setting |registration= or |subscription= to any value other than y, yes, or true will generate an error message.

Lay summary

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

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 must include terminating punctuation.

Anchor

Display options

  • mode: Sets element separator, default terminal punctuation, and certain capitalization according to the value provided. For |mode=cs1, element separator and terminal punctuation is a period (.); where appropriate, initial letters of certain words are capitalized ('Retrieved...'). For |mode=cs2, element separator is a comma (,); terminal punctuation is omitted; where appropriate, initial letters of certain words are not capitalized ('retrieved...'). To override default terminal punctuation use postscript.
  • 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 bibliographies or bibliography styles where multiple works by a single author are listed sequentially such as shortened footnotes. 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. You can also use editor-mask and translator-mask in the same way.
  • 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. |display-authors=etal displays all authors in the list followed by et al. 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. |display-editors=etal displays all editors in the list followed by et al. Aliases: displayeditors.
  • last-author-amp: Switches the separator between the last two names of the author list to space ampersand space ( & ) when set to y, yes, or true. Example: |last-author-amp=yes
  • postscript: Controls the closing punctuation for a citation; defaults to a period (.); for no terminating punctuation, specify |postscript=none – leaving |postscript= empty is the same as omitting it, but is ambiguous. Ignored if quote is defined.

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

TemplateData

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

See the monthly error report for this template.

TemplateData for Cite report

This template formats a citation to an article in a magazine or journal, using the provided source information (e.g. journal name, author, title, issue, URL) and various formatting options.

Template parameters

Parameter Description Type Status
URL urlURL

The URL of the online location where the text of the publication can be found

Default
empty
Example
empty
Auto value
empty
Line suggested
Title title

The title of the article; can be wikilinked to an existing Wikipedia article or url may be used to add an external link, but not both. Displays in quotes.

Default
empty
Example
empty
Auto value
empty
Content required
Last name lastauthorauthor1authorslast1

The surname of the author; don't wikilink, use 'authorlink'; can suffix with a numeral to add additional authors

Default
empty
Example
empty
Auto value
empty
Line suggested
First name firstfirst1

Given or first name, middle names, or initials of the author; don't wikilink, use 'authorlink'; can suffix with a numeral to add additional authors

Default
empty
Example
empty
Auto value
empty
Line suggested
Last name 2 last2author2

The surname of the second author; don't wikilink, use 'authorlink2'.

Default
empty
Example
empty
Auto value
empty
Line optional
First name 2 first2

Given or first name, middle names, or initials of the second author; don't wikilink.

Default
empty
Example
empty
Auto value
empty
Line optional
Source date date

Full date of the source; do not wikilink

Default
empty
Example
empty
Auto value
empty
Date required
Publisher publisher

Name of the publisher; displays after title

Default
empty
Example
empty
Auto value
empty
Content optional
Issue issue

Issue identifier when the source is part of a series that is published periodically

Default
empty
Example
empty
Auto value
empty
Line suggested
DOI doi

Digital Object Identifier; begins with '10.'

Default
empty
Example
empty
Auto value
empty
String suggested
DOI broken date doi-broken-date

The date that the DOI was determined to be broken

Default
empty
Example
empty
Auto value
empty
Date optional
Location of publication location

Geographical place of publication; usually not wikilinked.

Default
empty
Example
empty
Auto value
empty
String optional
Publication date publication-date

Date of publication when different from the date the work was written; do not wikilink

Default
empty
Example
empty
Auto value
empty
Date optional
Edition edition

When the publication has more than one edition; for example: '2nd', 'Revised' etc.; suffixed with ' ed.'

Default
empty
Example
empty
Auto value
empty
Line optional
Volume volume

For one publication published in several volumes

Default
empty
Example
empty
Auto value
empty
Line suggested
Page page

Page in the source that supports the content; displays after 'p.'

Default
empty
Example
empty
Auto value
empty
Line optional
Pages pages

Pages in the source that support the content (not an indication of the number of pages in the source; displays after 'pp.'

Default
empty
Example
empty
Auto value
empty
Line optional
Language language

The language in which the source is written, if not English; use the full language name; do not use icons or templates

Default
empty
Example
empty
Auto value
empty
Content optional
arXiv identifier arxiv

An identifier for arXive electronic preprints of scientific papers

Default
empty
Example
empty
Auto value
empty
Line optional
ASIN asin

Amazon Standard Identification Number; 10 characters

Default
empty
Example
empty
Auto value
empty
Line optional
ASIN TLD asin-tld

ASIN top-level domain for Amazon sites other than the US

Default
empty
Example
empty
Auto value
empty
Line optional
Bibcode bibcode

Bibliographic Reference Code (REFCODE); 19 characters

Default
empty
Example
empty
Auto value
empty
Line optional
biorXiv biorxiv

biorXiv identifier; 6 digits

Default
empty
Example
empty
Auto value
empty
Line optional
CiteSeerX citeseerx

CiteSeerX identifier; found after the 'doi=' query parameter

Default
empty
Example
empty
Auto value
empty
Line optional
ISBN isbn

International Standard Book Number; use the 13-digit ISBN where possible

Default
empty
Example
empty
Auto value
empty
Line optional
ISSN issn

International Standard Serial Number; 8 characters; may be split into two groups of four using a hyphen

Default
empty
Example
empty
Auto value
empty
Line optional
jfm code jfm

Jahrbuch über die Fortschritte der Mathematik classification code

Default
empty
Example
empty
Auto value
empty
Line optional
JSTOR jstor

JSTOR identifier

Default
empty
Example
empty
Auto value
empty
Line optional
LCCN lccn

Library of Congress Control Number

Default
empty
Example
empty
Auto value
empty
Line optional
MR mr

Mathematical Reviews identifier

Default
empty
Example
empty
Auto value
empty
Line optional
OCLC oclc

Online Computer Library Center number

Default
empty
Example
empty
Auto value
empty
Number optional
OL ol

Open Library identifier

Default
empty
Example
empty
Auto value
empty
Line optional
OSTI osti

Office of Scientific and Technical Information identifier

Default
empty
Example
empty
Auto value
empty
Line optional
PMC pmc

PubMed Center article number

Default
empty
Example
empty
Auto value
empty
Number optional
PMID pmid

PubMed Unique Identifier

Default
empty
Example
empty
Auto value
empty
Line suggested
id id

A unique identifier used where none of the specialized ones are applicable

Default
empty
Example
empty
Auto value
empty
Line optional
docket docket

Docket number

Default
empty
Example
empty
Auto value
empty
Line optional
Quote quote

Relevant text quoted from the source; displays last, enclosed in quotes; needs to include terminating punctuation

Default
empty
Example
empty
Auto value
empty
Content optional
Last name 3 last3author3

The surname of the third author; don't wikilink, use 'authorlink3'.

Default
empty
Example
empty
Auto value
empty
Line optional
First name 3 first3

Given or first name, middle names, or initials of the third author; don't wikilink.

Default
empty
Example
empty
Auto value
empty
Line optional
Last name 4 last4author4

The surname of the forth author; don't wikilink, use 'authorlink4'.

Default
empty
Example
empty
Auto value
empty
Line optional
First name 4 first4

Given or first name, middle names, or initials of the forth author; don't wikilink.

Default
empty
Example
empty
Auto value
empty
Line optional
Last name 5 last5author5

The surname of the fifth author; don't wikilink, use 'authorlink5'.

Default
empty
Example
empty
Auto value
empty
Line optional
First name 5 first5

Given or first name, middle names, or initials of the fifth author; don't wikilink.

Default
empty
Example
empty
Auto value
empty
Line optional
Last name 6 last6author6

The surname of the sixth author; don't wikilink, use 'authorlink6'.

Default
empty
Example
empty
Auto value
empty
Line optional
First name 6 first6

Given or first name, middle names, or initials of the sixth author; don't wikilink.

Default
empty
Example
empty
Auto value
empty
Line optional
Last name 7 last7author7

The surname of the seventh author; don't wikilink, use 'authorlink7'.

Default
empty
Example
empty
Auto value
empty
Line optional
First name 7 first7

Given or first name, middle names, or initials of the seventh author; don't wikilink.

Default
empty
Example
empty
Auto value
empty
Line optional
Last name 8 last8author8

The surname of the eighth author; don't wikilink, use 'authorlink8'.

Default
empty
Example
empty
Auto value
empty
Line optional
First name 8 first8

Given or first name, middle names, or initials of the eighth author; don't wikilink.

Default
empty
Example
empty
Auto value
empty
Line optional
Last name 9 last9author9

The surname of the ninth author; don't wikilink, use 'authorlink9'. If nine authors are defined, then only eight will show and 'et al.' will show in place of the last author.

Default
empty
Example
empty
Auto value
empty
Line optional
First name 9 first9

Given or first name, middle names, or initials of the ninth author; don't wikilink.

Default
empty
Example
empty
Auto value
empty
Line optional
Author link author-linkauthorlink

Title of existing Wikipedia article about the author; can suffix with a numeral to add additional authors

Default
empty
Example
empty
Auto value
empty
Page optional
Author link 2 author-link2author2-linkauthorlink2

Title of existing Wikipedia article about the second author.

Default
empty
Example
empty
Auto value
empty
Page optional
URL access date access-dateaccessdate

The full date when the original URL was accessed; do not wikilink

Default
empty
Example
empty
Auto value
empty
Date suggested
Archive URL archive-urlarchiveurl

The URL of an archived copy of a web page, if or in case the URL becomes unavailable; requires 'archivedate'

Default
empty
Example
empty
Auto value
empty
Line optional
Author link 3 author-link3author3-linkauthorlink3

Title of existing Wikipedia article about the third author.

Default
empty
Example
empty
Auto value
empty
Page optional
Author link 4 author-link4author4-linkauthorlink4

Title of existing Wikipedia article about the forth author.

Default
empty
Example
empty
Auto value
empty
Page optional
Author link 5 author-link5author5-linkauthorlink5

Title of existing Wikipedia article about the sixth author.

Default
empty
Example
empty
Auto value
empty
Page optional
Author link 6 author-link6author6-linkauthorlink6

Title of existing Wikipedia article about the sixth author.

Default
empty
Example
empty
Auto value
empty
Page optional
Author link 7 author-link7author7-linkauthorlink7

Title of existing Wikipedia article about the seventh author.

Default
empty
Example
empty
Auto value
empty
Page optional
Author link 8 author-link8author8-linkauthorlink8

Title of existing Wikipedia article about the eighth author.

Default
empty
Example
empty
Auto value
empty
Page optional
Author link 9 author-link9author9-linkauthorlink9

Title of existing Wikipedia article about the ninth author.

Default
empty
Example
empty
Auto value
empty
Page optional
Format format

Format of the work referred to by 'url' ('url' is required when using 'format'); examples: PDF, DOC, XLS; do not specify HTML

Default
empty
Example
empty
Auto value
empty
Content optional
URL access level url-access

Classification of the access restrictions on the URL ('registration', 'subscription' or 'limited')

Default
empty
Example
empty
Auto value
empty
String optional
Bibcode access level bibcode-access

If the full text is available from ADS via this Bibcode, type 'free'.

Default
empty
Example
empty
Auto value
empty
String optional
DOI access level doi-access

If the full text is free to read via the DOI, type 'free'.

Default
empty
Example
empty
Auto value
empty
String optional
HDL access level hdl-access

If the full text is free to read via the HDL, type 'free'.

Default
empty
Example
empty
Auto value
empty
String optional
Jstor access level jstor-access

If the full text is free to read on Jstor, type 'free'.

Default
empty
Example
empty
Auto value
empty
String optional
OpenLibrary access level ol-access

If the full text is free to read on OpenLibrary, type 'free'.

Default
empty
Example
empty
Auto value
empty
String optional
HDL access level osti-access

If the full text is free to read on OSTI, type 'free'.

Default
empty
Example
empty
Auto value
empty
String optional