Difference between revisions of "Template:Citation/core/doc"

Latest revision as of 12:00, 9 March 2009

About this template

Template:Citation/core can be thought of as an engine producing consistent output for Wikipedia's citations. Templates such as {{citation}} provide this core template with a list of parameters, which it uses to produce a formatted text (HTML) output, which contains embedded COinS metadata. This metadata allows many readers to find cited references more easily, or to extract their details to a reference manager.

The presence of a central template makes individual citation templates simpler to code and amend, and produces a consistent look throughout the encyclopaedia.

Templates using this 'engine'

Changes to this central template can affect the output of several 'upstream' templates. A list of templates using citation/core is provided below for testing purposes.

• Template:Citation
• Template:Cite book
• Template:Cite journal
• Template:Cite web
• Template:Cite encyclopedia
• Template:Cite mailing list
• Template:Cite news
• Template:Cite arXiv

Parameter details

Note that the examples below are common uses of each parameter, intended to help editors understand the functioning of this template. In the most part, there is nothing wrong with passing different data to any of the parameters below if it produces the output that is desired. The exception is in parameters which are associated with a COinS field.

• |AccessDate= date when the |URL= was accessed.
• |Archive= depreciated in favour of OriginalURL & ArchiveDate. Archive should contain details of an archived copy of the source; the calling template will pass on a string such as "archived from the original on 02-02-2002". The URL passed as |IncludedWorkURL= may therefore end up being the URL of the source, or the URL of the archive copy, as determined by the calling template.
• |ArchiveDate= Date of the archived URL
• |OriginalURL= If an archived URL is provided elsewhere, the original URL should be specified here.
• |At= page reference within the source.
• |Authorlink1= title of an existing Wikipedia article about the first author.
• |Authorlink2=, |Authorlink3=, ..., |Authorlink9= title of an existing Wikipedia article about up to eight additional authors.
• |Bibcode= A Bibcode id
• |DOI= Digital object identifier.
• |Date= date of the authorship, if different from date of publication.
• |DoiBroken= Date the DOI is broken
• |Edition= number or name of the edition, if not the first; for example: |Edition=2nd.
• |EditorGiven1= first editor's first or given name(s).
• |EditorGiven2=, |EditorGiven3=, |EditorGiven4= second, third, and fourth editors' first or given name(s).
• |EditorSurname1= first editor's surname or last name.
• |EditorSurname2=, |EditorSurname3=, |EditorSurname4= second, third, and fourth editor' surname or last name.
• |Editorlink1= title of an existing Wikipedia article about the first editor.
• |Editorlink2=, |Editorlink3=, |Editorlink4= title of an existing Wikipedia article about the second, third, and fourth editor.
• |format= file format of the source, if not the common format. Or; "Free full text", "abstract", or similar descriptor
• |Given1= first author's first or given name(s).
• |Given2=, |Given3=, ..., |Given9= up to eight additional authors' first or given name(s).
• |ID= miscellaneous identifier, other than |DOI=, |ISBN=, |ISSN=, |OCLC=, |PMID=, or |PMC=.
• |ISBN= International Standard Book Number.
• |ISSN= International Standard Serial Number identifying the periodical.
• |IncludedWorkTitle= Specific title, to be displayed in quotation marks. Contrast with |Title=, which is displayed in italics. In some cases (e.g. Template:Cite web) it may be desirable to use IncludedWorkTitle for the title, and not use the Title parameter at all.
• |IncludedWorkURL= URL of the contribution or chapter, or other included work.
• |Issue= issue number of the periodical.
• |language= specifies the language in which the source is written, if not English.
• |laydate= Date of a lay summary
• |laysummary= Summary of the source in a layman-friendly journal - for instance a BBC news article about a paper in Nature.
• |OCLC=Online Computer Library Center ID number.
• |Other= Other details to be inserted in a particular place
• |PMC= PubMed Central article number for full-text free repository of an article.
• |PMID= PubMed Unique Identifier.
• |Periodical= name of the periodical, journal, or magazine. This parameter controls whether or not the template will generate a citation in the style appropriate to a periodical, journal, magazine, or other serial publication.
• |Place= place where the item was created.
• |PublicationDate= date of publication.
• |PublicationPlace= city of publication.
• |Publisher= name of the publisher.
• |quote= text to be quoted from the source.
• |Ref= A reference name - if the citation is referred to using the Havard referencing suite of templates (LINK!)
• |Sep= specifies the punctuation mark used to separate fields. This usually defaults to a period, but may occasionally be a comma.
• |Series= series of which this periodical is a part.
• |Surname1= first author's surname or last name.
• |Surname2=, |Surname3=, ..., |Surname9= up to eight additional authors' surname or last name.
• |Title= Title, to be displayed in italics after |IncludedWorkTitle=. Used, for example, when citing the title of a book; the chapter title would be passed to IncludedWorkTitle
• |URL= Uniform Resource Locator of an online location where the article can be found.
• |Volume= volume number of a multi-volume book or compilation.
• |YearNote= Note to accompany the year. Example: First published 1886
• |Year= year of authorship or publication.