Template:Citation parameter legend

From LIMSWiki
Jump to navigationJump to search
  • author: Author. Use to specify a single author of the paper, or alternatively, to specify all the authors of the paper in whatever format desired. If you use author to specify all the authors, do not specify the following author-related parameters.
    • last works with first to produce last, first;. These parameters produce the maximum metadata and should be used if possible.
    • author2, last2, first2 and subsequent should be used for co-authors (up to 8 will be displayed before truncation with "et al".
    • author-link name of an existing LIMSwiki article about the author. If present, either author or last & first become a link to the appropriate article.
    • author-link2 to author-link9 may similarly be used when there is an article on coauthors specified using author2 or last2, first2 etc.
    • coauthors: Full name of additional author or authors. Please use 'author2', 'author3', etc instead.
    • author-mask – This parameter is primarily intended for use in bibliographies where multiple works by a single author are listed. It replaces the name of the first author (which must still be provided to garner metadata) with a strike-thru dash (—) author-mask em in length. So if |author-mask=1 then the dash will be one em in length, if |author-mask=2 it will be two em long and so on. Set author-mask to a text value to display a word instead – for example, 'with'. You must still include |last= and |first= for metadata purposes.
    • display-authors: Specify a digit to only display the first n authors (followed by "et al"). The first 9 authors should still be included in the template; these will be included in the metadata to assist users with browser plugins, etc.
  • date: January 1, 2006. Full date of publication.
    • year: 2006. Year of publication (ignored if the date field is used).
      • month: January. Month of publication (ignored if the date field is used, or if the year field is not used).
  • title: Title of article.
  • journal or periodical or newspaper or magazine: Name of the journal or periodical.
  • volume: Volume number of the journal in which the article is found
  • series or version: At most one of these may be entered. In either case the value will be displayed in plaintext after the title.
    • series: According to the 14th edition of Chicago Manual of Style p. 576, "As in the case of book series, some journals have attained such longevity that they have begun a new series of volumes or issues. Identification of the series (n.s., 2d ser., 3d ser., ser. b) must be made in citations to these journals."
    • version: Use when citing a paper. It may be used, for example, for standards documents, which retain the same title and document number (e.g. ISO nnnnn) but may have many revisions (e.g. ISO nnnnn-xxxx).
  • issue: Journal's issue number, or issue name.
  • page or pages: 45–47: first page, and optional last page (separated by an en dash –). If you need to refer to a specific page within a cited source, use Template:Rp or shortened footnotes.
  • at: Position within the resource when |page=/|pages= is inappropriate or insufficient. This parameter is ignored if |page=/|pages= is specified. Examples of usage of |at=: |at=para. 14 (when citing a source without page numbers), |at=02:56 (a film or audio timestamp), |at=no. 456 (something in a numbered list), |at=p. 6, col. 2 (for a page and a column because "column" is not a Citation template parameter), or |at=sec. F pp. 4–6 (for a section and a page within the section, "section" not being a parameter).
  • publisher: Publisher of journal or periodical; should not include corporate designation such as "Ltd" or "Inc". Only include if ISSN and DOI are unavailable.
    • location: Place of publication for journal or periodical.
  • language: Language, e.g. Finnish. (English is assumed and should not be specified.)
    • trans_title: Translated (English) title, when the title is in a foreign language. Can be used without source title when the source title is unknown.
  • id: A unique identifier, used if none of the below are applicable. In this case, you need to specify the kind of identifier you are using, preferably with a template like {{US patent}}, {{MR}} / {{MathSciNet}}, {{Zbl}}, {{arXiv}}, {{JSTOR}} or {{JFM}}. (Use one of the more specialized parameters if possible; they are linked automatically. In other words, don't use id = PMID 15128012 anymore. Use pmid = 15128012.)
    • asin: The Amazon Standard Identification Number; if first character of asin value is a digit, use isbn. Because this link favors one specific distributor, include it only if standard identifiers are not available.
    • bibcode: The document's bibcode in the Astrophysics Data System, e.g., 1924MNRAS..84..308E
    • biorxiv: The bioRxiv id, as in the entire DOI (e.g., 10.1101/078733 for http://biorxiv.org/content/early/2016/10/01/078733)
    • citeseerx: The CiteSeerX id, a string of digits and dots found in a CiteSeerX URL (e.g., for http://citeseerx.ist.psu.edu/viewdoc/summary?doi=
    • doi: A digital object identifier for the document, such as 10.1130/0091-7613(1990)018<1153:TAFSIA>2.3.CO;2.
      • doi_inactivedate: Sometimes the doi target link might not function (e.g. it is awaiting entry to the CrossRef database). Use this parameter, which takes a date argument, to de-link the DOI. The parameter will be removed when the DOI becomes active again. Must not be wikilinked.
        The doi value is still shown, but without a link, and the mainspace article is added to "Category:Pages with DOIs inactive since YYYY".
    • issn: The publication's International Standard Serial Number such as 1111-2220. The eight-figure ISSN may be split into two groups of four using a hyphen; but neither an N-dash nor a space are valid for use as separator between the groups.
    • oclc: The periodical's Online Computer Library Center ID number, such as 3185581
    • pmc: The document's PubMed Central article number (PMCID) for full-text free repository of an article, such as 246835
      • pmc-embargo-date: The date that an article will be freely accessible at PubMed central. After this date, the title will automatically link to the free full text at PubMed Central (and the parameter will be removed by a bot).
    • pmid: The document's PubMed Unique Identifier, such as 15128012
  • url: This should point to, in descending order of preference:
  1. A free online version of the full text
  2. An online version of the full text, for which subscription is required
  3. An abstract or information page, if no DOI or PMID record is available
If a DOI or PMID is available, the URL should only be specified if it would point to a different page to that which a DOI or PMID would redirect to.
Note: the URL must be properly encoded, especially replacing any double quote (") with %22. See Percent-encoding for more information.
  • accessdate: Full date when URL/DOI was last checked. Should use the same format as the other full dates in the references. Must not be wikilinked.
  • format: Format of the document at its URL (e.g., PDF, xls, etc.) Don't specify for HTML (implied as default). This parameter is sometimes used for completely different purposes, with values such as "fee required" and "reprint", but its original intent was to warn readers of file formats that their browsers might have trouble with.
  • laysummary: URL of a lay summary, which could be in a popular science magazine or newspaper.
    • laysource: Name of the source, e.g. The Guardian (UK newspaper) or New Scientist.
    • laydate: Date of publication or, where this is not available, date of retrieval of the lay summary.
An alternative method of adding one or more references to common media (preferably in Layman's terms) from the related journal citation can be specified within a single <ref>...</ref> tag using other citation templates; for example:
Text in the article.<ref>{{cite journal | ... }}<br/>
'''Related news articles:'''
*{{cite news | ... }}
*{{cite web | ... }}</ref>
  • quote: Relevant excerpt from the journal.
  • ref: ID for anchor. By default, no anchor is generated. The ordinary nonempty value |ref=ID generates an anchor with the given ID; such a linkable reference can be made the target of wikilinks to full references, especially useful in short citations like shortened notes and parenthetical referencing. The special value |ref=harv generates an anchor suitable for the {{harv}} template; see anchors for Harvard referencing templates.
  • postscript: