Template harvnb creates a short author–date citation with a one-directional link to the first matching citation template on the same page.
{{harvnb}} is designed to be used to create shortened footnotes, a citation style which pairs a short, author-date citation in a footnote with a complete citation in the references section at the end of the article (see example below). This citation style is used to reduce clutter in the edit window and to combine multiple citations to the same source.
Common problems and known workarounds are given in the section possible issues section below.
There are several other templates that are designed for use with shortened footnotes. They differ slightly in the way they format the author-date citation and how much of their functionality is automated. A full list of these related templates is below.
Note that the use (or even non-use) of these templates is an element of citation "style", and adding or removing them in articles with an established style should be consistent with that style. See WP:CITEVAR.
Also note that inline use of these templates, i.e. use of {{harv}} without <ref>...</ref> tags around it, was deprecated in September 2020. See also WP:PAREN.
harvnb generates an "author-date" style short-cite from the following parameters:
.svg/1280px-Test_Template_Info-Icon_-_Version_(2).svg.png){kind=icon}
<ref>{{harvnb | <last1*> | <last2> | <last3> | <last4> | <year*> | p= <page> | loc= <location> }}</ref>with
2012a|p= – specific page referenced in the source (alias: |page= )|pp= – comma-separated list of individual pages and / or range(s) of pages referenced in the source (alias: |pages= )|loc= – in-source location when |p= and |pp= are inappropriate; may be used to supplement |p= and |pp=; information such as a section or figure number.Typical usage is shown in the example below. The text and the footnote are connected by a bi-directional link – clicking on the superscript takes the reader to the footnote, clicking on the footnote number takes them back to the superscript. The clicking on the short citation takes them to the full citation in the references section.
Template harvnb is placed inside <ref>...</ref> tags to create shortened footnotes. (Using harvnb outside of <ref>...</ref> tags was deprecated in September 2020).
The first four author surnames (or all authors if fewer than four; use the values from |lastN= or |authorN= ) are required, followed by the year of publication (from |year= or |date=). Authors past the fourth must be omitted or an error will result.
The possible issues section below describes workarounds for various common problems, such as large number of authors, no author name, multiple works in the same year, multiple authors with same last name and others.
The optional parameters |p=, |pp= and |loc= can be used to indicate the location in the source, such as page numbers. For single pages, use |p=; for multiple pages (such as ranges), use |pp=. Use of |p= for multiple pages or |pp= for single pages can cause cite errors. |loc= can be used to specify a location in the source in another way, such as section numbers or chapters. The parameters |page= and |pages= exist as aliases for |p= and |pp=, respectively.
The optional parameter |postscript= or |ps= can be used to change the text which appears at the end of the note in the reference list. (See § Adding additional comments or quotes and § No closing period, below.) The postscript is only effective the first time {{sfn}} is used for a particular author, year and location.
Not available in {{sfn}} and similar templates.
The optional parameter |ref= is used to create an unusually named link from the short citation to the full citation. This parameter is usually not necessary, and it is more common to use {{sfnRef}} or {{harvid}} in the reference section. If you specify |ref=none, no hyperlink is created. However, if one does not want the link, it is always possible to simply use plain text instead of the template. The parameter |Ref= is an alias for |ref=.
The templates {{harvnb}} or {{harvtxt}} can be used to add quotes or additional comments into the footnote. Examples are below.
Nota bene: In the past, the use of |ps= has been advised to hold this additional information, but it is not suitable for this purpose. Two or more {{sfn}} templates with the same authors, same year, and same page, but different |ps= will result in a Cite error: The named reference ... was defined multiple times with different content message. This message happens because the reference names that {{sfn}} creates will be the same, but the content between the <ref name="FOOTNOTE..."> tag and the </ref> tag will be different. A workaround is to convert one or some of the {{sfn}} templates to {{harvnb}} wrapped in <ref>...</ref> tags.
If a specific link to the page or section is available, a URL can be added to the location or page number.
Sometimes an explanatory footnote requires a citation. Templates like {{sfn}} can't be directly imbedded between <ref>...</ref> tags, because the following message will be produced: Cite error references missing group.
The templates {{efn}} and {{notelist}} can be used to create separate explanatory footnotes from short citations, as shown in the first example. An article that uses this technique extensively is Chinese Room.
It is also possible to use the magic word {{#tag:ref|...}} and the {{sfn}} template will work correctly inside the footnote, as shown in the second example.
Sometimes there is a need to create two or more separate lists of inline footnotes. For example some family trees are contained in templates, they are transluded into several biographies, and they have their own self contained citations (see Template:Houston family tree and the article Margaret Lea Houston).
To facilitate this, while the main page uses the standard 1,2,3 footnote counting, it is common for family trees to use the efn template with a group parameter set—for example {{efn-lg}} (lower-greek). The efn templates are text templates, to link some or all of the content of the efn template to a long citation template such as {{cite book}} place {{harvnb}} or {{harv}} within the efn template.
Where there is a need to cite more than one work by the same author published in the same year, the standard way to disambiguate such works is to add a letter suffix after the year element of the {{sfn}} template (e.g. {{sfn|Smith|2006a}} and {{sfn|Smith|2006b}}). Make sure to add the disambiguation letter to the matching full citation, (e.g. {{cite book|...|last=Smith|date=2006b}}).
When {{sfn}} is used with {{citation}} or Citation Style 1 templates, a year-suffix letter may be added to |date= for all accepted date formats except year-initial numeric (YYYY-MM-DD). It is not necessary to include both |date= and |year= (see exception below). If both are included, |year= is used for the CITEREF anchor to be compliant with legacy citations.
|date=2013a: simple year only dates|date=Jan 2013b or |date=Winter 2013b: month or season and year dates|date=9 November 2013b or |date=November 9, 2013b: full dates|date=June–July 2013c or |date=Winter–Spring 2013c: month or season ranges and year dates|date=c. 2013d: circa year dates|date=2024–2025e or |date=Summer 2024–25e: year ranges|date=n.d.f: no date (n.d.)|date=2013g-11-09|year=2013g. If month and day should be part of the citation as well, both parameters need to be given: |date=2013-11-09 |year=2013x. In this case, |date= is used for citation display and metadata purposes, and |year= for link disambiguation.The above solution to add a letter suffix after the year element also works for multiple authors with the same last name. For example, both Richard Bushman and Claudia Lauper Bushman published books in 2006. To differentiate between the two books, the first one can be given the year "2006a" and the second one "2006b".
If there are more than four authors, the first four authors' surnames (the value in |last= or |author=) are required by the template. Listing more authors is not supported. It is also possible to use the |ref={{harvid}} in the citation template, which allows a more concise citation in the article text.
Some sources do not have a single author with a last name, such as a magazine article or a report from a government institution. There is no consensus (in Wikipedia or among citation styles) about how to format author–date citations for works that do not have a specific author. Several choices are:
An article should adopt one of these styles consistently. Using |ref={{harvid}} in the citation template can handle these cases.
Either the |date= or |year= of a citation template can be matched—the template logic can extract the year from a full date. If the date parameter is not a full date, then the extraction will fail. If the link does not seem to work, it also possible to set both |date= and |year= parameters. The template will display the date and use the year for the anchor. These two examples show a year being successfully extracted from full date.
The {{cite comic}} template uses the parameter |ref= to create an anchor for the Harvard citation templates. This can be set with {{sfnRef}}, {{harvid}}, or using CITEREF directly with a concatenation of #CITEREF plus the parameters passed to the Harvard citation template.
The Citation Style Vancouver family of templates use parameter |harvid= to create an anchor for the Harvard citation templates. This must be set to a concatenation of the parameters passed to the Harvard citation template.
In a few very rare cases, it may be impossible for the citation templates to create an anchor. Either (1) the citation is formatted with a template that does not support the |ref= parameter or (2) the source can't be described using our citation templates at all. In these cases, it is possible to use {{wikicite}} to make the anchor. (As of November 2010, there are only approximately 100 articles that require this technique.) It is also possible that (3) local editors would prefer not to use citation templates. In this case, it is important to discuss what the local editors would like to do about the bad links. It is always possible to simply remove {{harv}} or {{sfn}}, leaving plain text without links.
It is also possible to use <cite> to achieve the same effect, but this may not be compatible with HTML 5.
Using |ps=none in {{sfn}} removes the final period. Compare the two examples. Suppressing the default period (full stop) ensures consistency with Citation style 2, as produced by {{Citation}}, which does not use a trailing period (full stop) when rendering full citations. The postscript is only effective the first time {{sfn}} is used for a particular author, year, and location. An empty |ps= will also suppress terminal punctuation, but |ps=none is recommended in order to make it clear that an editor intended there to be no terminal punctuation.
If an article is using this template, and nothing happens when you click on the highlighted wikilink from a Harvard style citation to a full citation at the bottom of the page, there are several possible solutions. If:
{{citation not found}}.{{sfn}} or {{harv}}):|date= field and no |year= field, but the format of the |date= field is unusual. Solution: Try to fix the date. If the link still does not work, add |year= to the citation template. (It's okay if it has both.)|ref={{harvid}} is set correctly (see below).|harvid= is set correctly (see below).|ref= (See Wikipedia:Citation templates and reference anchors). Solution: Consider modifying the template to support |ref=. Alternatively, an anchor can be created using {{wikicite|id={{harvid|args}}|reference={{citation}}}}.{{cite *}} citation templates are used liberally throughout the article, then reformat the full citation with the appropriate {{cite *}} template (and set the |ref= appropriately, if necessary). Otherwise consult with local editors on the talk page about how to proceed. Either add {{cite *}} templates and {{harv}} templates, or remove all templates, depending on what local editors prefer. A few articles use {{wikicite}} to create an anchor as an alternative to standard templates.<cite>...</cite> span to create an anchor. Solution: remove the cite span (these are deprecated) and proceed following the recommendation immediately above.{{wikicite}}. Solution: Check that the text in |id={{harvid}} matches the text in {{wikicite}}.[[#Reference-Smith2006|Smith (2006)]]:|ref= (See Wikipedia:Citation templates and reference anchors). Solution: Check that |ref= is set to a matching id.{{wikicite|ref=id|reference=citation}} with a matching id.Templates that have broken wikilinks using these templates are added to the category Category:All articles with broken links to citations.
When a short-cite template links to a full citation that is rendered by a template that wraps a CS1 template, like {{cite DNB}} (which wraps {{cite encyclopedia}}), a no target error may be displayed even when the short-cite template is valid and the link works. That is a "false positive" error. The error message can be suppressed by adding |ignore-err=yes to the template, or by adding the template {{Sfn whitelist}} with the anchor ID(s) to the article. If you are testing changes in Special:ExpandTemplates and the error message cannot be suppressed, try testing in a sandbox or user subpage instead.
If you embed an Harvnb template in a list-defined reference, you may get a false-positive "missing key" error which looks like this:
This is a false-positive: list-defined references do not work correctly when references are nested. It is due to a long-standing bug in mediawiki software (see phab:T22707). A workaround is possible using {{sfnlink}}.
Additional bugs associated with embedding footnotes in list-defined references are known. One of them is that the reference name given in the error message will identify the wrong list-defined reference in the first false-positive error message on the page; this is tracked in T26600.
There are several templates used to create short citations; they differ in the use and placement of parentheses, in the separator before the page or location, and in whether a terminal full stop (period) is present:
Full citations can be created manually or by templates:
{{citation}}All of these templates have the same parameters and basic functionality. This page describes all of them except the parameters of {{sfnm}} and {{harvs}}; please see their documentation pages. Editors editing one of these templates are requested to make parallel changes to the other versions.
{{sfn}} or {{harvnb}}Template {{harvnb}} inside a <ref> span can be used to create a shortened footnote that is linked to the full citation at the bottom of the article. Template {{sfn}} (without the use of <ref>) has the same effect, automatically adds a period (full stop) after the page number, and combines identical footnotes automatically.
{{harvtxt}}Template {{harvtxt}} can be used to link an in-text attribution to the full citation at the bottom of the page.
{{harvnb}} or {{sfnm}}Template {{harvnb}} can be used to bundle citations. {{sfnm}} also produces bundled citations.
Note that {{sfn}} is inappropriate for bundled citations; use {{harvnb}} or {{sfnm}}.
{{harv}}Template {{harv}} creates a parenthetical reference with a link to the full citation. It should only be used within footnotes or on internal pages. Use of inline parenthetical referencing within the body text of articles has been deprecated by the Wikipedia community since 2022. This usage has not been deprecated within internal pages such as Wikipedia documentation, user pages, or wikiprojects, though there is rarely a practical use for it instead of just using normal citation footnotes.
{{harvid}} or {{harvs}}More exotic Harvard citations can be constructed using the {{harvs}} template, such as multiple papers by the same author, using both the first and last names, links to articles about the author, and others. Any kind of unusual link can also be constructed using the idiom [[#{{harvid|parameters}}|link name]]. ({{citeref}} is a wrapper for {{harvid}} making it easier to consistently create such internal links in small superscript[n] or plain-text label styles.)
Some articles use this idiom [[#CITEREFid | link name ]]. See notes on implementation details below.
{{harvcol}}, {{harvcolnb}}, {{harvcoltxt}}Templates {{harvcol}}, {{harvcolnb}}, and {{harvcoltxt}} use a colon to indicate the page number(s) or location.
Template {{sfnp}} puts parentheses around the year. Compare the two examples.
Similarly, in order to mimic Citation Style 1 citations, template {{harvp}} puts parentheses around the year.
These templates use two elements: a wikilink in the body of the article, and an anchor in the reference section of the article. Clicking on the wikilink repositions the page at the anchor.
The most common citation templates are Citation Style 1 or Citation Style 2. By default, Module:Citation/CS1 creates an anchor <a name="CITEREF"> followed by the concatenation of the following parameters:
This covers the most common templates. Information about all of the templates is available at Wikipedia:Citation templates and reference anchors.
Use of the date parameter in place of the year parameter in citation templates is preferred.
The Harvard citation templates create a wikilink to the anchor. For example {{Harv|Smith|2006|p=25}} produces the link #CITEREFSmith2006 and {{Citation|last=Smith|first=John|date=27 January 2006|title=My Life}} produces the anchor CITEREFSmith2006.
A few articles create a custom ID using CITEREF, either in place of the Harvard citation template (e.g. [[#CITEREFSmith2006|(2006)]]) or as a value for |ref= in the citation template.
A custom ID must follow these rules:
":31337" (which is punctuation plus a number), but it will ignore "31337" (purely numeric)."Nguyen 2010" are preferred to names like ":31337".":0" or "NYT".A–Z, a–z, digits 0–9, and the symbols !$%&()*,-.:;<@[]^_`{|}~. That is, all printable ASCII characters except #"'/=<>?\ and space.name="John Smith". But quote-enclosed reference names may not include a less-than sign (<) or a double straight quote symbol ("), which may however be included by escaping as < and " respectively.|ref= field must be replaced with underscores"); curly or other quotes will be parsed as part of the reference name.Examples:
Where cite_name is a name such as the publisher.
To avoid the sometimes difficult to remember syntax for links to CITEREF anchors, {{citeref}} can be used to create internal wikilinks with either small superscript-style labels (like this[n]) or plain free-text labels to such anchors. It can be used inside of other citations.
Note that the CITEREF prefix is necessary for the reference tooltips gadget (MediaWiki:Gadget-ReferenceTooltips.js) to detect that a link goes to a citation.
Template {{sfn}} creates a named footnote, so that identical footnotes are combined automatically. The footnote name begins with FOOTNOTE followed by a concatenation of the arguments to {{sfn}}. E.g.: this template call {{sfn|Smith|2006|p=26}} should have exactly the same functionality as <ref name="FOOTNOTESmith200626">{{Harvnb}}</ref> which, in turn, has the same functionality as <ref name="FOOTNOTESmith200626">[[#CITEREFSmith2006|Smith (2006)]], p. 26</ref>.
The ref name becomes more complicated when the page (p) parameter includes a URL, e.g. {{sfn|Joyce|1903|p=213}}, which, once defined, can be called by <ref name="FOOTNOTEJoyce1903[httpsarchiveorgdetailsaconcisehistory00joycgoogpagen226 213]" />. The "p=" and the characters |,:,.,/,?,=; are therefore stripped out of the URL.
The call to {{harvnb}} has been subst'ed for quicker load times.
Category:Pages using sfn with unknown parameters (4)
This template creates a short author–date citation with a one-directional link to the first matching citation template on the same page.