Cite Journal

Periodical

• work (required by {{cite journal}} and {{cite magazine}}): Name of the work containing the source; may be wikilinked if relevant. Displays in italics. If the name of the periodical changed over time use the name at the time of the source's publication. If script-work is defined, use work to hold a Romanization (if available) of the title in script-work. Aliases: journal, newspaper, magazine, periodical, website. Use Latin script. For languages written in non-Latin based scripts (Arabic, Chinese, Cyrillic, Greek, Hebrew, Indic, Japanese, Korean, etc.) use a standard Romanization in this field.
  • script-work: Work title in its original, non-Latin script; not italicized, follows italicized Romanization defined in work (if present). Must be prefixed with one of the supported language codes to help browsers properly display the script. Leave empty for Latin-based scripts (Czech, French, Turkish, Vietnamese, etc.). Aliases: script-journal, script-newspaper, script-magazine, script-periodical, script-website.
  • trans-work: English translation of the work title if the source cited is in a foreign language. Displays in square brackets after work or script-work. Aliases: trans-journal, trans-newspaper, trans-magazine, trans-periodical, trans-website.
    ... |work=Zhōngguó piàofáng |script-work=zh:中国票房 |trans-work=China Box Office ...
  • 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''. Please choose either |issue= or |number= depending on what is used in the actual publication. If a publication carries both issue and number designations (typically one being a year-relative and the other an absolute value), provide them both, for example |issue=2 #143. 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 in the same citation:
title is not italicized and is enclosed in quotes.
chapter does not display (and will produce an error message).

Publisher

• publisher: Name of publisher; may be wikilinked if relevant. The publisher is the company, organization or other legal entity that publishes the work being cited. Do not use the publisher parameter for the name of a work (e.g. a website, book, encyclopedia, newspaper, magazine, journal, etc.). If the name of the publisher changed over time, use the name as stated in the publication or used at the time of the source's publication. Corporate designations such as "Ltd", "Inc.", or "GmbH" are not usually included. Not normally used for periodicals. 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.
• place: For news stories with a dateline, the location where the story was written. If the name of the location changed over time, use the name as stated in the publication or used at the time of the source's publication. In earlier versions of the template this was the publication place, and for compatibility, will be treated as the publication place if the publication-place parameter is absent; see that parameter for further information. Alias: location
• publication-place: Geographical place of publication; generally not wikilinked; omit when the name of the work includes the publication place, for example, The Boston Globe, The Times of India. Displays after the title. If the name of the publication place changed over time, use the name as stated in the publication or used at the time of the source's publication. If only one of publication-place, place, or location is defined, it will be treated as the publication place and will show after the title; if publication-place and place or location are defined, then place or location is 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. If date (or year) is also defined and is different, then publication-date displays preceded by "published" and enclosed in parentheses, following publisher. If date (or year) is not defined, publication-date is displayed as date. Use the same format as other dates in the article; do not wikilink.
• 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 (e.g. NewsBank) presents the source in a format different from the original, when the URL provided does not make clear the identity of the deliverer, where no URL or DOI is available (EBSCO), or if the deliverer requests attribution. See the access level parameters to display access restrictions.

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; volume numbers should be entered just as a numeral (e.g. 37). Volume values that are wholly digits, wholly uppercase Roman numerals, or fewer than five characters will appear in bold. Any alphanumeric value of five or more characters will not appear in bold. In rare cases, publications carry both an ongoing volume and a year-related value; if so, provide them both, for example |volume=IV / #10.

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 |no-pp=yes or work (or an alias) is defined. If hyphenated, use {{Hyphen}} to indicate this is intentional (e.g. |page=3{{hyphen}}12), otherwise several editors and semi-automated tools will assume this was a misuse of the parameter to indicate a page range and will convert |page=3-12 to |pages=3{{ndash}}12. Alias: p.
• 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 |no-pp=yes or work (or an alias) is defined.
  Hyphens are automatically converted to en dashes; if hyphens are appropriate because individual page numbers contain hyphens, for example: pp. 3-1–3-15, use double parentheses to tell the template to display the value of |pages= without processing it, and use {{Hyphen}} to indicate to editors that a hyphen is really intended: |pages=((3{{hyphen}}1{{ndash}}3{{hyphen}}15)). Alternatively, use |at=, like this: |at=pp. 3-1–3-15. Alias: pp.
  • no-pp: Set to yes, y, 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.
• For |quote-page= and |quote-pages= used in conjunction with |quote=, see here.

Identifiers

• id: A unique identifier, used where none of the specialized identifiers are applicable; wikilink or use an external link 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.

The following 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 (April 2007 – December 2014) or |arxiv=1501.00001 (since January 2015). Do not include extraneous file extensions like ".pdf" or ".html". Aliases: eprint.
• asin: Amazon Standard Identification Number; if first character of asin value is a digit, use isbn. Because this link favours one specific distributor, include it only if standard identifiers are not available. Example |asin=B00005N5PF. Aliases: ASIN.
  • asin-tld: ASIN top-level domain for Amazon sites other than the US; valid values: ae, au, br, ca, cn, de, es, fr, in, it, jp, mx, nl, pl, sa, se, sg, tr, uk. Aliases: none.
• bibcode: bibcode; used by a number of astronomical data systems; for example: 1974AJ.....79..819H. Aliases: none.
• biorxiv: bioRxiv id, as in the entire DOI (e.g. 10.1101/078733 for http://biorxiv.org/content/early/2016/10/01/078733 or https://doi.org/10.1101/078733; 10.1101/2020.07.24.220400 for https://doi.org/10.1101/2020.07.24.220400). Aliases: none.
• 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). Aliases: none.
• doi: Digital object identifier; for example: 10.1038/news070508-7. It is checked to ensure it begins with (10.). Aliases: DOI.
  • Supports accept-this-as-written markup to indicate valid DOIs using a non-standard format, see below.
  • doi-broken-date: Date a valid DOI was found to be non-working/inactive at https://doi.org. Use the same format as other dates in the article. Aliases: none.
• 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; example |eissn=1557-2986. Aliases: EISSN.
  • Supports accept-this-as-written markup to indicate valid eISSNs using a non-standard format, see below.
• hdl: Handle System identifier for digital objects and other resources on the Internet; example |hdl=20.1000/100. Aliases: HDL.
• isbn: International Standard Book Number; for example: 978-0-8126-9593-9. (See Wikipedia:ISBN and ISBN § Overview.) Hyphens 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, use sbn. 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. Aliases: ISBN.
  • Supports accept-this-as-written markup to indicate valid ISBNs using a non-standard format, see below.
• 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. Aliases: 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; example |issn=2049-3630. Aliases: ISSN.
  • Supports accept-this-as-written markup to indicate valid ISSNs using a non-standard format, see below.
• jfm: Jahrbuch über die Fortschritte der Mathematik; do not include "JFM" in the value; example |jfm=53.0144.01. Aliases: JFM.
• jstor: JSTOR reference number; for example: |jstor=3793107. Aliases: JSTOR.
• lccn: Library of Congress Control Number. When present, alphabetic prefix characters are to be lower case and without a space; example |lccn=79-57364 or |lccn=2004042477 or |lccn=e09001178. Aliases: LCCN.
• mr: Mathematical Reviews; example |mr=630583. Aliases: MR.
• oclc: OCLC Number for looking up publications in the WorldCat union catalog; example |oclc=9355469. Aliases: OCLC.
• ol: Open Library identifier; do not include "OL" in the value; example |ol=7030731M. Aliases: OL.
• osti: Office of Scientific and Technical Information; example |osti=4367507. Aliases: OSTI.
• pmc: PubMed Central; use article number for open repository full-text 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. Aliases: PMC.
  • pmc-embargo-date: Date that pmc goes live; if this date is in the future, then pmc is not linked until that date. Aliases: none.
• pmid: PubMed; use unique identifier; example |pmid=17322060 See also the pmc parameter, above; these are two different identifiers. Aliases: PMID.
• rfc: Request for Comments; example |rfc=3143. Aliases: RFC.
• sbn: Standard Book Number; example |sbn=356-02201-3. Aliases: SBN.
  • Supports accept-this-as-written markup to indicate valid SBNs using a non-standard format, see below.
• ssrn: Social Science Research Network; example |ssrn=1900856. Aliases: SSRN.
• s2cid: Semantic Scholar corpus ID; example |s2cid=37220927. Aliases: S2CID.
• zbl: Zentralblatt MATH; example |zbl=0472.53010 For zbMATH search results like JFM 35.0387.02 use |jfm=35.0387.02. Aliases: ZBL.

In very rare cases, valid identifiers (f.e., as actually printed on publications) do not follow their defined standard format or use non-conforming checksums, which would typically cause an error message to be shown. Do not alter them to match a different checksum. In order to suppress the error message, some identifiers (|doi=, |eissn=, |isbn=, |issn=, and |sbn=) support a special accept-this-as-written markup which can be applied to disable the error-checking (as |<param>=((<value>))). If the problem is down to a mere typographical error in a third-party source, correct the identifier value instead of overriding the error message.

For some identifiers, it is possible to specify the access status using the corresponding |<param>-access= parameter.

For {{Cite journal}}, some identifiers (specifying free resources) will automatically be linked to the title when |url= and |title-link= are not used to specify a different link target. This behaviour can be overridden by one out of a number of special keywords for |title-link= to manually select a specific source (|title-link=pmc or |title-link=doi) for auto-linking or to disable the feature (|title-link=none).

It is not necessary to specify a URL to a link identical to a link also produced by an identifier. The |url= parameter (or |title-link=) can then be used for providing a direct deep link to the corresponding document or a convenience link to a resource that would not otherwise be obviously accessible.

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 should signal restrictions on access to material provided via the external links included in a citation. These levels describe requirements or constraints related to accessing and viewing the cited material; they are not intended to indicate the ability to reuse, or the copyright status, of the material, since that status is not relevant to verifying claims in articles.

Four access levels can be used:

• access indicator for named identifiers:
  • free: the source is free to read for anyone
• access indicators for url-holding parameters:
  • registration: a free registration with the provider is required to access the source, even if a limited preview, abstract or review may still be available without registration
  • limited: there are other constraints (such as a cap on daily views) to freely access this source
  • subscription: the source is only accessible via a paid subscription with the provider of the source ("paywall")

As there are often multiple external links with different access levels in the same citation, each value is attributed to a specific external link.

Access indicators for url-holding parameters

Online sources linked by |url=, |article-url=, |chapter-url=, |contribution-url=, |entry-url=, |map-url=, and |section-url= are presumed to be free-to-read. When they are not free-to-read, editors should mark those sources with the matching access-indicator parameter so that an appropriate icon is included in the rendered citation. Because the sources linked by these url-holding parameters are presumed to be free-to-read, they may not be marked as free.

URL-holding and access-indicator parameters

URL	Access	Allowed keywords
|url=	|url-access=	registration limited subscription
|article-url=	|article-url-access=
|chapter-url=	|chapter-url-access=
|contribution-url=	|contribution-url-access=
|entry-url=	|entry-url-access=
|map-url=	|map-url-access=
|section-url=	|section-url-access=

For example, this cites a web page that requires registration but not subscription:

{{cite web |url=https://example.com/nifty_data.php |url-access=registration |date=2021-04-15 |title=Nifty example data}}

which renders as:

"Nifty example data". 2021-04-15.

Access indicator for named identifiers

Links inserted by named identifiers are presumed to lie behind a paywall or registration barrier – exceptions listed below. When they are free-to-read, editors should mark those sources with the matching access-indicator parameter so that an appropriate icon is included in the rendered citation. When the sources linked by these named-identifier parameters are not presumed to carry a free-to-read full text (for instance because they're just abstracting services), they may not be marked as limited, registration, or subscription.

Named-identifier and access-indicator parameters

Identifier	Access	Allowed keywords
|bibcode=	|bibcode-access=	free
|doi=	|doi-access=
|hdl=	|hdl-access=
|jstor=	|jstor-access=
|ol=	|ol-access=
|osti=	|osti-access=
|s2cid=	|s2cid-access=

Some named-identifiers are always free-to-read. For those named identifiers there are no access-indicator parameters; the access level is automatically indicated by the template. These named identifiers are:

• |arxiv=
• |biorxiv=
• |citeseerx=
• |pmc=
• |rfc=
• |ssrn=

For embargoed pmc that will become available in the future, see pmc-embargo-date.

Laysummary

These parameters are deprecated. If the source that they name is important to the Wikipedia article, create a separate cs1|2 template for that source.

• lay-url: (deprecated) URL link to a non-technical summary or review of the source; the URL title is set to "Lay summary".
  • lay-source: (deprecated) Name of the source of the lay summary. Displays in italics and preceded by a spaced endash.
  • lay-date: (deprecated) Date of the lay summary. Displays in parentheses.
  • lay-format: (deprecated) File format of the work referred to by lay-url; for example: PDF, DOC, or XLS; displayed in parentheses after lay summary. HTML is implied and should not be specified. File format annotation is automatically rendered 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 file format information for the visually impaired. See Using |format=

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. If script-quote is defined, use quote to hold a Romanization (if available) of the text in script-quote.
  • script-quote: Original quotation for languages that do not use a Latin-based script (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc.); not italicized, follows italicized Romanization defined in quote (if available). Alias: none. Must be prefixed with one of the supported language codes to help browsers properly display the script:
    ... |quote=Tōkyō tawā |script-quote=ja:東京タワー |trans-quote=Tokyo Tower ...
  • trans-quote: English translation of the quotation if the source quoted is in a foreign language. Displays in square brackets. Alias: none.
• quote-page: The number of a single page quoted in |quote=. Use either |quote-page= or |quote-pages=, but not both. Should be a subset of the page(s) specified in |page=, |pages= or |at=. Displays preceded by p. unless |no-pp=yes. If hyphenated, use {{Hyphen}} to indicate this is intentional (e.g. |quote-page=3{{hyphen}}12). Alias: none.
• OR: quote-pages: A list or range of pages quoted in |quote=. Use either |quote-page= or |quote-pages=, but not both. Should be a subset of the pages specified in |pages= or |at=. Separate using an en dash (–); separate non-sequential pages with a comma (,). Displays preceded by pp. unless |no-pp=yes is defined. Hyphens are automatically converted to en dashes; if hyphens are appropriate because individual page numbers contain hyphens, for example: pp. 3-1–3-15, use double parentheses to tell the template to display the value of |quote-pages= without processing it, and use {{Hyphen}} to indicate to editors that a hyphen is really intended: |quote-pages=((3{{hyphen}}1{{ndash}}3{{hyphen}}15)). Alias: none.

Anchor

• ref: the citation's HTML anchor identifier, when different from its default. When set, |ref=ID generates an anchor with the given ID (the id= attribute in the citation's ‎ID"> HTML tag). Setting |ref=ID identifies the template as a target and allows wikilinking to full references, especially useful with short-form citations like shortened notes and parenthetical referencing. The default anchor ID is suitable for use with {{Sfn}} and {{Harv}} templates. Since April 2020, the parameter / keyword pair |ref=harv has no special meaning; this deprecated setting should not be used and may be removed from existing cs1|2 templates. To inhibit anchor ID creation, set |ref=none. Aliases: none. See Template:Citation/doc § Anchors for Harvard referencing templates.

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:
• contributor-mask:
• editor-mask:
• interviewer-mask:
• subject-mask:
• translator-mask:
  Replaces the name of the (first) author with em dashes or text. Set <name>-mask to a numeric value n to set the dash n em spaces wide; set <name>-mask to a text value to display the text without a trailing author separator; for example, "with". The numeric value 0 is a special case to be used in conjunction with <name>-link—in this case, the value of <name>-link will be used as (linked) text. In either case, you must still include the values for all names 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}}, ‎ or similar as there is no control of the order in which references are displayed. Mask parameters can take an enumerator in the name of the parameter (e.g. |authorn-mask=) to apply the mask to a specific name.

• display-authors:
• display-contributors:
• display-editors:
• display-interviewers:
• display-subjects:
• display-translators:
  Controls the number of author or editor names that are displayed when a citation is published. To change the displayed number of names, set display-authors and/or display-editors to the desired number. For example, |display-authors=2 will display only the first two authors in a citation (and not affect the display of editors). Likewise, |display-editors=2 will display only the first two editors (and all authors). |display-authors=0 and |display-editors=0 are special cases suppressing the display of all authors or editors including the et al. By default, all authors and editors are displayed. |display-authors=etal displays all authors in the list followed by et al. Aliases: none.
• 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. Additional text, or templates that render more than a single terminating punctuation character, will generate a maintenance message. |postscript= is ignored if quote is defined.

Notes

Although it may appear redundant to include multiple ids for articles, it is helpful for many editors who only have access to a certain resource. If only one ID is to be included, the DOI should be used, as this is the universal standard preferred by professional publications. Specifying a link as a doi, pmid etc. is always preferable to including it as a url parameter, as it makes it clear that the link is accurate and stable, but not necessarily openly accessible.

Template data

Alternate usages

If the work has any of the following identifiers, then one of these specific templates may be used:

• DOI: {{Cite doi}}
• JSTOR: {{Cite jstor}}
• PubMed: {{Cite pmid}}

However, because these templates can be user-filled, they are prone to user error, and they generate a style that may not be compatible with other citations in the article (see WP:CITEVAR), so using the full cite journal template may be preferable, depending on the content area. For medical articles, this citation-filling template can be used to generate a cite journal template from a PubMed identified (PMID).

See also

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