View source for Template:Citation/core/doc

{{documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{esoteric}}
{{Mbox
| demospace = {{{demospace|}}}
| type = style
| image = [[File:Ambox important.svg|40px|alt=|link=]]
| text = Do not modify.  '''{{PAGENAME}}''' is preserved as an historical reference against which current Lua-based cs1{{!}}2 templates may be compared.
}}
== About this template ==

[[Template:Citation/core]] can be thought of as an engine producing consistent output for Wikipedia's citations.  Templates such as {{tl|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 some templates directly using citation/core is provided below for testing purposes. 

*[[Template:Cite IETF]]
*[[Template:Cite wikisource]]

Almost all templates that previously used Citation/core have been converted to use [[Module:Citation/CS1]].

== 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— these parameters are indicated by ⊗.

*{{para|AccessDate}} date when the {{para|URL}} was accessed. Should not be wikilinked.
* archive parameters ''(if used, must be used both of them together)''
**{{para|ArchiveURL}} the URL of an [[Web archiving|archived]] copy of a web page, if (or in case) the url becomes unavailable.  Typically used to refer to services like [[WebCite]] and [[Internet Archive|Archive.org]].
** {{para|ArchiveDate}} date when the item was archived. Should not be wikilinked.
*{{para|OriginalURL}} If an archived URL is provided elsewhere, the original URL should be specified here.
*{{para|amp}} When set to any value, changes the separator between the last two names in lists of authors to an ampersand (&). Defaults to a semicolon and space(; ), else {{para|AuthorSep}} if set.
* ⊗ {{para|ARXIV}} [[ArXiv]] ID.
* ⊗ {{para|ASIN}} [[Amazon Standard Identification Number]].
* ⊗ {{para|At}} page reference within the source.
*{{para|Authorlink1}} title of an existing Wikipedia article about the first author.
*{{para|Authorlink2}}, {{para|Authorlink3}}, ..., {{para|Authorlink8}} title of an existing Wikipedia article about up to seven additional authors.
*{{para|AuthorMask}} Primarily intended for use in bibliographies for some styles where multiple works by a single author are listed. It replaces the name of the first author with a strike-thru dash (—) AuthorMask em in length enclosed in {{tag|del|o}} tags. If {{para|AuthorMask|1}} then the dash will be one em in length and so on. Set AuthorMask to a text value to display a word instead:– for example, 'with'. You must still include the parameters for all authors for metadata purposes. Do not use in a list generated by {{tl|reflist}} or {{tag|references|s}} as there is no control as to the order that references will display.
*{{para|AuthorSep}} Separator between author names; defaults to semicolon (;).
* ⊗ {{para|BIBCODE}} A [[Bibcode]] ID.
*{{para|Citation class}} adds the specified HTML class to the span that encloses the citation. The name must be one word (separate words are separate classes) and must meet the name rules.<ref>{{Cite web|title=HTML class Attribute |url=http://www.w3schools.com/tags/att_global_class.asp |work=w3schools.com}}</ref>
* ⊗ {{para|DOI}} [[Digital object identifier]].
* ⊗ {{para|Date}} date of the authorship, if different from date of publication.
*{{para|DeadURL}} indicates if the original link is [[WP:LINKROT|dead]] or live ({{para|DeadURL|no}}). Used to change the main citation link when {{para|ArchiveURL}} is set.
*{{para|DoiBroken}} Date the DOI is broken
* ⊗ {{para|Edition}} number or name of the edition, if not the first; for example: {{para|Edition|2nd.}}
*{{para|EditorGiven1}} first editor's first or given name(s).
*{{para|EditorGiven2}}, {{para|EditorGiven3}} second and third editors’ first or given name(s).
*{{para|EditorSurname1}} first editor's surname or last name.
*{{para|EditorSurname2}}, {{para|EditorSurname3}}, {{para|EditorSurname4}} second, third, and fourth editors’ surname or last name. The fourth is not actually used, but causes 'et al.' to be generated.
*{{para|Editorlink1}} title of an existing Wikipedia article about the first editor.
*{{para|Editorlink2}}, {{para|Editorlink3}} title of existing Wikipedia articles about the second and third editors.
*{{para|format}} file format of the source, if not the common format. Or; "Free full text", "abstract", or similar descriptor
* ⊗ {{para|Given1}} first author's first or given name(s).
* ⊗ {{para|Given2}}, {{para|Given3}}, ..., {{para|Given8}} up to seven additional authors' first or given name(s).
*{{para|ID}} miscellaneous identifier, other than {{para|DOI}}, {{para|ISBN}}, {{para|ISSN}}, {{para|OCLC}}, {{para|PMID}}, or {{para|PMC}}.
* ⊗ {{para|ISBN}}  [[International Standard Book Number]].
* ⊗ {{para|ISSN}} [[International Standard Serial Number]] identifying the periodical.
* ⊗ {{para|IncludedWorkTitle}} Specific title, to be displayed in quotation marks.  Contrast with {{para|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.
* ⊗ {{para|IncludedWorkURL}} [[Uniform Resource Locator|URL]] of the contribution or chapter, or other included work.
* ⊗ {{para|Issue}} issue number of the periodical.
* ⊗ {{para|JFM}} [[Jahrbuch über die Fortschritte der Mathematik]]
* ⊗ {{para|JSTOR}} [[JSTOR]] ID.
*{{para|language}} specifies the language in which the source is written, if not English.
* {{para|laysummary}} Summary of the source in a [[layman]]-friendly journal - for instance a BBC news article about a paper in [[Nature (journal)|Nature]].
** {{para|laydate}} Date of a lay summary.
** {{para|laysource}} Name of the source, such as the magazine or journal.
* ⊗ {{para|LCCN}} [[Library of Congress Control Number]] ID.
* ⊗ {{para|MR}} [[Mathematical Reviews]] ID.
*{{para|NameSep}} Separator between last and first names; defaults to a comma and space (, ).
* ⊗ {{para|OCLC}}[[Online Computer Library Center]] ID number.
* ⊗ {{para|OL}} [[Open Library]] ID.
* ⊗ {{para|OSTI}} [[Office of Scientific and Technical Information]] ID.
*{{para|Other}} Other details to be inserted in a particular place.
* ⊗ {{para|PMC}} [[PubMed Central]] article number for full-text free repository of an article.
* ⊗ {{para|PMID}} [[PMID|PubMed Unique Identifier]].
*{{para|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. When set, {{para|Publisher}} and {{para|PublicationPlace}} are formatted in parentheses.
*{{para|Place}} place where the item was created (outputs "written at <var>location</var>"); this parameter should not be used for location of publication; see {{para|PublicationPlace}}, below.
*{{para|PublicationDate}} date of publication.
* ⊗ {{para|PublicationPlace}} city of publication.
* ⊗ {{para|Publisher}} name of the publisher.
*{{para|quote}} text to be quoted from the source. If supplied, this is enclosed in double-quotes.
*{{para|PS}} postscript terminating the citation. This is empty by default.
*{{para|Ref}} A reference name - if the citation is referred to using the [[Template:Harv|Harvard referencing suite of templates]].
* ⊗ {{para|RFC}} [[Request for Comments]] ID.
*{{para|Sep}} specifies the punctuation mark used to separate fields. This usually defaults to a period, but may occasionally be a comma.  For technical reasons, the template will malfunction if a semicolon is passed as a separator.  To circumvent this, the calling template should encode semicolons:<br/><code><nowiki>|Sep = {{#ifeq:{{{separator}}}|;|&amp;#059;|{{{separator|!}}}}}</nowiki></code><br/>Replace the exclamation mark with a default separator, if one different to a period is desired.
* ⊗ {{para|Series}} series of which this periodical is a part.
* ⊗ {{para|SSRN}} [[Social Science Research Network]] ID.
* ⊗ {{para|Surname1}} first author's surname or last name.
* ⊗ {{para|Surname2}}, {{para|Surname3}}, ..., {{para|Surname9}} up to eight additional authors’ surnames or last names. The ninth is not actually used, but causes ''et al.'' to be generated.
* ⊗ {{para|Title}} Title, to be displayed in italics after {{para|IncludedWorkTitle}}.  Used, for example, when citing the title of a book; the chapter title would be passed to IncludedWorkTitle
* {{para|template doc demo}} The archive parameters have error checking to ensure that all the required parameters are included, else {{tl|citation error}} is invoked. On errors, main, help and template pages are placed into [[:Category:Articles with incorrect citation syntax]]. Set {{para|template doc demo|true}} to disable categorization.
*{{para|TitleNote}} appears after Title; shows only if Title and Periodical are defined.
*{{para|TitleType}} specific type of item cited. Example: PhD thesis. Appears in parentheses immediately after Title or TransTitle.
*{{para|TransItalic}} Translated italicized title, in case the original title is in a foreign language. Can be used in conjunction with TransTitle, e.g. for book and chapter title, respectively. This translated string will appear in square brackets, following the italicized book title, with the same URL link.
*{{para|TransTitle}} Translated title, in case the original title is in a foreign language. The translated title will appear inside square brackets, enclosed within the quotation marks of the IncludedWorkTitle.
*{{para|Trunc}} Sets the number of authors to display before ''et al.'' is shown.
* ⊗ {{para|URL}} [[Uniform Resource Locator]] of an online location where the article can be found.
* ⊗ {{para|Volume}} volume number of a multi-volume book or compilation.
*{{para|YearNote}} Note to accompany the year.  Example: First published 1886.
*{{para|Year}} year of authorship or publication.
* ⊗ {{para|ZBL}} [[Zentralblatt MATH]] ID.

== Supporting CSS ==

Rules are defined in [[MediaWiki:Common.css]] to control the appearance of citations.

The raw URL is rendered at the end of the citation, but is hidden except when printed.
<syntaxhighlight lang="css">
/* For linked citation numbers and document IDs, where
   the number need not be shown on a screen or a handheld,
   but should be included in the printed version */
@media screen, handheld {
    .citation .printonly {
        display: none;
    }
}
</syntaxhighlight>

== See also ==
* {{tl|Citation/author}}

== References ==
{{reflist}}

<includeonly>{{sandbox other||
[[Category:Citation templates]]
}}</includeonly>