Template:Cite journal/doc

From The Crowdsourced Resource-Based Economy Knowledgebase
Revision as of 04:46, 30 March 2013 by Ziggy (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


This Citation Style 1 template is used to create citations to articles in magazines and journals and for academic papers.

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

Contents

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.

Day Month Year

Most commonly used parameters in horizontal format
{{cite journal |last1= |first1= |last2= |first2= |year= |title= |journal= |volume= |issue= |pages= |publisher= |doi= |url= |accessdate=22 November 2024}}

Month Day, Year

Most commonly used parameters in horizontal format
{{cite journal |last1= |first1= |last2= |first2= |year= |title= |journal= |volume= |issue= |pages= |publisher= |doi= |url= |accessdate=November 22, 2024}}

Day Month Year for Vancouver system citations

Most commonly used parameters in horizontal format
{{cite journal |author= |year= |title= |journal= |volume= |issue= |pages= |publisher= |doi= |pmid= |pmc= |url= |accessdate=22 November 2024}}

Month Day, Year for Vancouver system citations

Most commonly used parameters in horizontal format
{{cite journal |author= |year= |title= |journal= |volume= |issue= |pages= |publisher= |doi= |pmid= |pmc= |url= |accessdate=November 22, 2024}}


Full parameter set in horizontal format
{{cite journal |last= |first= |author= |authorlink= |last2= |first2= |author2= |authorlink2= |date= |year= |month= |title= |trans_title= |journal= |volume= |series= |issue= |page= |pages= |at= |chapter= |location= |publisher= |editor1-first= |editor1-last= |editor1-link= |language= |format= |type= |arxiv= |id= |isbn= |issn= |oclc= |pmid= |pmc= |bibcode= |doi= |accessdate= |url= |archiveurl= |archivedate= |laysource= |laysummary= |laydate= |quote= |ref= |separator= |postscript= }}


Full parameter set in vertical format
Vertical list Prerequisites Brief instructions / notes 
{{cite journal
 | last1 =
 | first1 =
 | authorlink1 =
 | last2 =
 | first2 =
 | authorlink2 =
 | editor-last =
 | editor-first =
 | editor-link =
 | date =
 | year =
 | month =
 | title =
 | trans_title =
 | journal =
 | volume =
 | issue =
 | series =
 | pages =
 | location =
 | publisher =
 | language =
 | format =
 | type =
 | arxiv =
 | id =
 | isbn =
 | issn =
 | oclc =
 | pmid =
 | pmc =
 | bibcode =
 | doi =
 | accessdate =
 | url =
 | archiveurl =
 | archivedate =
 | laysource =
 | laysummary =
 | laydate =
 | quote =
 | ref =
 | separator =
 | postscript =
}}

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  • If a field name is listed in the Prerequisites column it is a prerequisite for the field to the left.


Examples

Formal citation

  • {{cite journal |last=Smith |first=Joseph III |title=Last Testimony of Sister Emma |journal=The Saints' Herald |volume=26 |year=1879 |month=October |page=289}}
Script error

Vancouver style (common in biomedicine); see Citation Style Vancouver for specific templates

  • {{cite journal |author=Bannen RM, Suresh V, Phillips GN Jr, Wright SJ, Mitchell JC |title=Optimal design of thermally stable proteins |journal=Bioinformatics |volume=24 |issue=20 |pages=2339–43 |year=2008 |pmid=18723523 |pmc=2562006 |doi=10.1093/bioinformatics/btn450 |url=http://bioinformatics.oxfordjournals.org/cgi/content/full/24/20/2339 }}
Script error

Include URL link to free-article, pre-print or abstract; also supply access date unless the URL is known to be stable.

  • {{cite journal |journal=Energy Policy |year=2008 |volume=36 |issue=6 |pages=1858–1866 |title=Effect of daylight saving time on lighting energy use: a literature review |author=Aries, Myriam B. C.; and Newsham, Guy R. |doi=10.1016/j.enpol.2007.05.021 |url=http://www.nrc-cnrc.gc.ca/obj/irc/doc/pubs/nrcc49212/nrcc49212.pdf |format=PDF |accessdate=September 1, 2009 }}
Script error

Specify the DOI to provide a permanent link. Also give the PMID abstract for medical articles, and the URL if the article is free. PubMed Central free full-text repository links may also be supplied and will link the title if URL not specified, else as additional linked PMC value at the end of the citation

  • {{cite journal |author=Viollet, Benoît; Andreelli, Fabrizio; Jørgensen, Sebastian B.; et al. |title=The AMP-activated protein kinase alpha2 catalytic subunit controls whole-body insulin sensitivity |journal=The Journal of Clinical Investigation |volume=111 |issue=1 |pages=91–8 |year=2003 |month=January |pmid=12511592 |pmc=151837 |doi=10.1172/JCI16567 |url=http://www.jci.org/articles/view/16567 }}
Script error

Whereas if the url had not been specified, then the title is linked to PubMed Central's copy of the article and no duplicate PMC link is shown for compactness:

  • {{cite journal |author=Viollet, Benoît; Andreelli, Fabrizio; Jørgensen, Sebastian B.; et al. |title=The AMP-activated protein kinase alpha2 catalytic subunit controls whole-body insulin sensitivity |journal=The Journal of Clinical Investigation |volume=111 |issue=1 |pages=91–8 |year=2003 |month=January |pmid=12511592 |pmc=151837 |doi=10.1172/JCI16567 }}
Script error

If the doi link is broken, then use of doi_brokendate unlinks the doi value, indicates when the doi-problem was first noticed, and will also add the page to "Category:Pages with DOIs broken since YYYY":

  • {{cite journal |author=Viollet, Benoît; Andreelli, Fabrizio; Jørgensen, Sebastian B.; et al. |title=The AMP-activated protein kinase alpha2 catalytic subunit controls whole-body insulin sensitivity |journal=The Journal of Clinical Investigation |volume=111 |issue=1 |pages=91–8 |year=2003 |month=January |pmid=12511592 |pmc=151837 |doi=10.1172/JCI16567 |doi_brokendate=June 18, 2008 }}
Script error

If the article is in a foreign language, and the original title is unknown

  • {{cite journal |author=Huang, Y.; Lu, J.; Shen, Y.; and Lu, J. |trans_title=The protective effects of total flavonoids from ''Lycium barbarum'' L. on lipid peroxidation of liver mitochondria and red blood cell in rats |language=Chinese |journal=Wei Sheng Yan Jiu |volume=28 |issue=2 |pages=115–6 |year=1999 |month=March |pmid=11938998 }}
Script error

Other examples

  • {{cite journal |last=Fowler |first=Martin |authorlink=Martin Fowler |last2=Beck |first2=Kent |authorlink2=Kent Beck |title=Last Testimony of Sister Emma |journal=The Saints' Herald |volume=26 |year=1879 |month=October |page=289}}
Script error
  • {{cite journal |first=W. Hugh |last=Woodin |title=The Continuum Hypothesis, Part I |journal=Notices of the AMS |volume=48 |issue=6 |year=2001 |pages=567–576 |location=Providence, RI, USA |publisher=American Mathematical Society |url=http://www.ams.org/notices/200106/fea-woodin.pdf |format=PDF |issn=1088-9477 |oclc=34550461}}
Script error
  • {{cite journal |title=Disney Releases 10 Titles on Laser Videodisc |year=1982 |journal=Videodisc/Videotex |volume=2 |issue=3 |page=175}}
Script error

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.

This template embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata; see Wikipedia:COinS.

  • Be careful using templates within the citation template, as many will add a lot of extraneous HTML or CSS that will be rendered in the meta-data.
    • Known templates that should not be used: {{smallcaps}}.

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

Deprecated

These parameters are deprecated and will no longer work. Use will place the page in Category:Pages containing cite templates with deprecated parameters.

  • access-date · accessed · accessdaymonth · accessday · accessmonthday · accessmonth · accessyear: Use accessdate to include the full date of access.
  • day: Use date to include the day, month and year.
  • dateformat · doilabel: These parameters are no longer supported.

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.
    • 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.
    • OR: for multiple authors, use last1, first1 through last9, first9 for up to nine authors. By default, if nine authors are defined, then only eight will show and "et al." will show in place of the last author. Aliases: author1 through author9.
  • authorlink: Title of existing Wikipedia article about the author—not the author's website; do not wikilink. Aliases: authorlink1, author-link, author1-link.
  • OR: for multiple authors, use authorlink1 through authorlink9. Aliases: author1-link through author9-link.
  • coauthors: (deprecated) Names of of coauthors. Use the same format as the authors.
  • 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 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 quotes.
    • 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 [ ] |
  • 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; do not use icons or templates.

Periodical

  • work: Name of the source periodical; may be wikilinked if relevant. Displays in italics. Aliases: journal, newspaper, magazine, periodical.
    • issue: When the publication is one of a series that is published periodically.
    • department: Regular department within the periodical. 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 is italicized and is not enclosed in quotes.
location and publisher are enclosed in parentheses.
page and pages do not show p. or pp.
edition does not display.
type does not display.

Date

  • <span id="csdoc_date" />date: Full date of source being referenced in the same format as other publication dates in the citations.[1] Do not wikilink. Displays after the authors and enclosed in parentheses. If there is no author, then displays after publisher.
  • <span id="csdoc_year" />OR: year: Year of source being referenced.
    • <span id="csdoc_month" />month: Name of the month of publication. If you also have the day, use date instead; do not wikilink.
    • <span id="csdoc_origyear" />origyear: Original publication year; displays after the date or year. For clarity, please supply specifics; example: |origyear=First published 1859 or |origyear=Composed 1904.
  1. ↑ Publication dates in references within an article should all have the same format. See MOS:DATEUNIFY.

Publisher

  • <span id="csdoc_publisher" />publisher: Name of publisher; may be wikilinked if relevant. Not normally included for periodicals. Corporate designations such as "Ltd", "Inc" or "GmbH" are not usually included. Displays after title; if work is defined, then publisher and location are enclosed in parentheses.
  • <span id="csdoc_location" />location: 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 preceding publisher.
  • <span id="csdoc_publication-date" />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 in bold after the title and series fields; if bolding is not desired, then include the volume information in the title field.

In-source locations

  • <span id="csdoc_page" />page: Page in the source that supports the content. Displays preceded with p. unless |nopp=y or work is defined.
  • <span id="csdoc_pages" />OR: pages: Pages in the source that supports the content; separate page ranges with 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 with pp. unless |nopp=y or work is defined.
    • <span id="csdoc_nopp" />nopp: Set to y to suppress the p. or pp. notations where this is inappropriate; for example, where |page=Front cover.
  • <span id="csdoc_at" />OR: at: For sources where a page number is inappropriate or insufficient. Overridden by |page= or |pages=.
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

  • <span id="csdoc_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. Do not link to any commercial booksellers such as Amazon.com; see WP:PAGELINKS.If url is not defined but pmc is, then url is set to the pmc link.
    • <span id="csdoc_Embargo" />Embargo: Date that pmc goes live; if this is in the future, then then url is not set to the pmc link until that date.
    • <span id="csdoc_accessdate" />accessdate: Full date when original URL was accessed; use the same format as other access and archive dates in the citations;[1] do not wikilink. Not required for web pages or linked documents that do not change; mainly of use for web pages that change frequently or have no publication date. Can be hidden or styled by registered editors.
    • <span id="csdoc_archiveurl" />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 the Internet Archive (see Wikipedia:Using the Wayback Machine); requires archivedate.
      • <span id="csdoc_archivedate" />archivedate: Date when the original URL was archived; use the same format as other access and archive dates in the citations;[1] do not wikilink. Displays preceded by "archived from the original on".
      • <span id="csdoc_deadurl" />deadurl: When the URL is still live, but preemptively archived, then set |deadurl=no. This changes the display order with the title retaining the original link and the archive linked at the end.
    • <span id="csdoc_template doc demo" />template doc demo: The archive parameters have error checking to ensure that all the required parameters are included, else {{citation error}} is invoked. On 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.
  • <span id="csdoc_format" />format: Format of the work referred to by url; examples: PDF, DOC, XLS; HTML is implied and should not be specified; displayed in parentheses after title. Does not change 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; irc://, ircs://, ftp://, news:, mailto: and gopher:// will require a plugin 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 they will display and link incorrectly. Those characters need to be percent-encoded. For example, a space must be replaced by %20. To encode the URL, replace these characters:
sp " ' < > [ ] | }
 %20  %22  %27  %3c  %3e  %5b  %5d  %7c  %7d
Single apostrophes do not need to be encoded; but unencoded multiples will be parsed as italic or bold markup. Single curly closing braces also do not need to be encoded; but an unencoded pair will be parsed as the double closing braces for the template transclusion.
  1. ↑ 1.0 1.1 Access and archive dates in references should all have the same format – either the format used for publication dates, or YYYY-MM-DD. See MOS:DATEUNIFY.

Anchor

Identifiers

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

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 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."; 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 to set the dash in em spaces; set author-mask to a text value to display a word instead; for example, "with". You must still include the values for all authors for metadata purposes. Primarily intended for use in bibliographies for some styles where multiple works by a single author are listed. Do not use in a list generated by {{reflist}}, <references /> or similar as there is no control as to the order that references will display.
  • author-name-separator: Changes the separator between last and first names; defaults to a comma and space (, ); if the parameter is present, but blank, no separator punctuation will be used; a space must be encoded as &#32; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.
  • author-separator: Changes the separator between authors; defaults to a semicolon and space (; ); if the parameter is present, but blank, no separator punctuation will be used; a space must be encoded as &#32; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.
  • display-authors: By default, the number of authors displayed is limited to 8; if 9 are provided, the ninth is displayed as "et al." This parameter allows display of fewer authors before the "et al."; for example, use |display-authors=2 for only two authors. The "et al." may be suppressed altogether by setting |display-authors=9.
  • lastauthoramp: When set to any value, changes the separator to use between the last two names in lists of authors to an ampersand (&); defaults to a semicolon and space (; ), else author-separator if set.
  • postscript: The closing punctuation for the citation; defaults to a period (.); if the parameter is present, but blank, no terminating punctuation will be used. Ignored if quote is defined.
  • separator: The punctuation used to separate lists of authors, editors, etc. Defaults to a period (.); if the parameter is present but blank, no separator punctuation will be used; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.

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.

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

Retrieved from ‘http://en.rbem.org/w/index.php?title=Template:Cite_journal/doc&oldid=5776’
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox
Share