Template:Citation/core/doc - Revision history

Maintenance script: Remove internal W namespace links

2026-05-22T12:26:49Z

Remove internal W namespace links

WikiHarold: Created page with "{{documentation subpage}} {{esoteric}} == About this template == Template:Citation/core ca..."

2021-07-10T00:40:13Z

Created page with "{{documentation subpage}}  <includeonly>{{esoteric}}</includeonly> == About this template == Template:Citation/core ca..."

New page

{{documentation subpage}}

<includeonly>{{esoteric}}</includeonly>

== About this template ==
[[Template:Citation/core]] can be thought of as an engine producing consistent output for Wikibooks' 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 [[w:COinS|COinS]] metadata. This metadata allows many readers to find cited references more easily, or to extract their details to a [[w:reference manager|reference manager]].

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

== 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 arXiv]]
*[[Template:Cite book]]
*[[Template:Cite conference]]
*[[Template:Cite encyclopedia]]
*[[Template:Cite journal]]
*[[Template:Cite mailing list]]
*[[Template:Cite manual]]
*[[Template:Cite news]]
*[[Template:Cite press release]]
*[[Template:Cite video]]
*[[Template:Cite web]]

== 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 [[w:COinS|COinS]] field.

*{{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 [[w:Web archiving|archived]] copy of a web page, if (or in case) the url becomes unavailable. Typically used to refer to services like [[w:WebCite|WebCite]] and [[w: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|At}} page reference within the source.
*{{para|AuthorBlock}} replaces the first author with a score of length ''AuthorBlock'' em. Metadata is still produced from {{para|Surname}} and {{para|Forename}}.
*{{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|Bibcode}} A [[w:Bibcode|Bibcode]] id
*{{para|DOI}} [[w:Digital object identifier|Digital object identifier]].
*{{para|Date}} date of the authorship, if different from date of publication.
*{{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}} [[w:International Standard Book Number|International Standard Book Number]].
*{{para|ISSN}} [[w:International Standard Serial Number|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}} [[w:Uniform Resource Locator|URL]] of the contribution or chapter, or other included work.
*{{para|Issue}} issue number of the periodical.
*{{para|language}} specifies the language in which the source is written, if not English.
*{{para|laydate}} Date of a lay summary
*{{para|laysummary}} Summary of the source in a [[w:layman|layman]]-friendly journal - for instance a BBC news article about a paper in [[w:Nature (journal)|Nature]].
*{{para|OCLC}}[[w:Online Computer Library Center|Online Computer Library Center]] ID number.
*{{para|Other}} Other details to be inserted in a particular place
*{{para|PMC}} [[w:PubMed Central|PubMed Central]] article number for full-text free repository of an article.
*{{para|PMID}} [[w: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.
*{{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.
*{{para|Ref}} A reference name - if the citation is referred to using the [[Template:Harv|Harvard referencing suite of templates]].
*{{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}}}|;|&#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|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|TitleType}} specific type for a thesis or dissertation. 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|URL}} [[w:Uniform Resource Locator|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.
<includeonly>
[[Category:Template subpages|{{PAGENAME}}]]
</includeonly>

← Older revision		Revision as of 12:26, 22 May 2026
Line 4:		Line 4:

	== About this template ==		== About this template ==
	[[Template:Citation/core]] can be thought of as an engine producing consistent output for Wikibooks' 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 ~~[[w:~~COinS~~\|COinS]]~~ metadata. This metadata allows many readers to find cited references more easily, or to extract their details to a ~~[[w:reference manager\|~~reference manager]].		[[Template:Citation/core]] can be thought of as an engine producing consistent output for Wikibooks' 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 wiki.		The presence of a central template makes individual citation templates simpler to code and amend, and produces a consistent look throughout the wiki.
Line 25:		Line 25:

	== Parameter details ==		== 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 ~~[[w:~~COinS~~\|COinS]]~~ field.		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.

	*{{para\|AccessDate}} date when the {{para\|URL}} was accessed. Should not be wikilinked.		*{{para\|AccessDate}} date when the {{para\|URL}} was accessed. Should not be wikilinked.
	* archive parameters ''(if used, must be used both of them together)''		* archive parameters ''(if used, must be used both of them together)''
	**{{para\|ArchiveURL}} the URL of an ~~[[w:Web archiving\|~~archived]] copy of a web page, if (or in case) the url becomes unavailable. Typically used to refer to services like ~~[[w:~~WebCite~~\|WebCite]]~~ and ~~[[w:Internet Archive\|~~Archive.org]].		**{{para\|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 and Archive.org.
	** {{para\|ArchiveDate}} date when the item was archived. Should not be wikilinked.		** {{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\|OriginalURL}} If an archived URL is provided elsewhere, the original URL should be specified here.
Line 36:		Line 36:
	*{{para\|Authorlink1}} title of an existing Wikipedia article about the first author.		*{{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\|Authorlink2}}, {{para\|Authorlink3}}, ..., {{para\|Authorlink8}} title of an existing Wikipedia article about up to seven additional authors.
	*{{para\|Bibcode}} A ~~[[w:~~Bibcode~~\|Bibcode]]~~ id		*{{para\|Bibcode}} A Bibcode id
	*{{para\|DOI}} ~~[[w:Digital object identifier\|~~Digital object identifier]].		*{{para\|DOI}} Digital object identifier.
	*{{para\|Date}} date of the authorship, if different from date of publication.		*{{para\|Date}} date of the authorship, if different from date of publication.
	*{{para\|DoiBroken}} Date the DOI is broken		*{{para\|DoiBroken}} Date the DOI is broken
Line 51:		Line 51:
	*{{para\|Given2}}, {{para\|Given3}}, ..., {{para\|Given8}} up to seven additional authors' 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\|ID}} miscellaneous identifier, other than {{para\|DOI}}, {{para\|ISBN}}, {{para\|ISSN}}, {{para\|OCLC}}, {{para\|PMID}}, or {{para\|PMC}}.
	*{{para\|ISBN}} ~~[[w:~~International Standard Book Number~~\|International Standard Book Number]]~~.		*{{para\|ISBN}} International Standard Book Number.
	*{{para\|ISSN}} ~~[[w:International Standard Serial Number\|~~International Standard Serial Number]] identifying the periodical.		*{{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\|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}} ~~[[w:Uniform Resource Locator\|~~URL]] of the contribution or chapter, or other included work.		*{{para\|IncludedWorkURL}} URL of the contribution or chapter, or other included work.
	*{{para\|Issue}} issue number of the periodical.		*{{para\|Issue}} issue number of the periodical.
	*{{para\|language}} specifies the language in which the source is written, if not English.		*{{para\|language}} specifies the language in which the source is written, if not English.
	*{{para\|laydate}} Date of a lay summary		*{{para\|laydate}} Date of a lay summary
	*{{para\|laysummary}} Summary of the source in a ~~[[w:~~layman~~\|layman]]~~-friendly journal - for instance a BBC news article about a paper in ~~[[w:Nature (journal)\|~~Nature]].		*{{para\|laysummary}} Summary of the source in a layman-friendly journal - for instance a BBC news article about a paper in Nature.
	*{{para\|OCLC}}~~[[w:Online Computer Library Center\|~~Online Computer Library Center]] ID number.		*{{para\|OCLC}}Online Computer Library Center ID number.
	*{{para\|Other}} Other details to be inserted in a particular place		*{{para\|Other}} Other details to be inserted in a particular place
	*{{para\|PMC}} ~~[[w:~~PubMed Central~~\|PubMed Central]]~~ article number for full-text free repository of an article.		*{{para\|PMC}} PubMed Central article number for full-text free repository of an article.
	*{{para\|PMID}} ~~[[w:PMID\|~~PubMed Unique Identifier]].		*{{para\|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.		*{{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.
	*{{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\|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.
Line 78:		Line 78:
	*{{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\|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\|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\|URL}} ~~[[w:~~Uniform Resource Locator~~\|Uniform Resource Locator]]~~ of an online location where the article can be found.		*{{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\|Volume}} volume number of a multi-volume book or compilation.
	*{{para\|YearNote}} Note to accompany the year. Example: First published 1886		*{{para\|YearNote}} Note to accompany the year. Example: First published 1886