View source for Template:Wikicite/doc

{{Documentation subpage}}
{{High-use}}
{{Uses TemplateStyles|Template:Citation/styles.css}}

For some atypical citations, {{tl|Wikicite}} can create an [[HTML anchor]]. When used in manually written, non-templated full citations, it allows [[H:SFN|shortened footnotes]] to link to the full citation on the same page. The link anchor can work with [[Wikipedia:Citing sources#Short citations|short-citation]] templates, such as {{tlx|sfn}}, {{tlx|harvnb}}, {{tlx|sfnp}}, {{tlx|harvp}}, and others. 

'''This template is only needed for a ''handwritten'' citation or for a citation using non-standard citation templates, that is linked to by a [[WP:CITESHORT|shortened footnote]]'''. The anchor serves no purpose if nothing links to it, and full citations created with the common {{cite xxx}} templates will either automatically create the anchor or offer the {{para|ref}} parameter for custom link anchors. In most cases, this template is expected to be used {{em|temporarily}}, in cases where an editor is not certain how to format the full citation data into a template, does not have time to do it, where there is a dispute on the talk page about which citation format should be used, or where a specific citation template does not yet support the {{para|ref}} parameter.  In a handful of cases, however, there remain some articles with local consensus to use entirely manually formatted citations, to exactly mirror some off-site citation style. This is rare but permitted by the [[WP:CITESTYLE]] guideline. 

== Usage ==
Copy and paste:
<syntaxhighlight lang="wikitext" copy="1">{{wikicite |ref={{sfnref|}} |reference= }}</syntaxhighlight>
or
<syntaxhighlight lang="wikitext" copy="1">{{wikicite |ref= |reference= }}</syntaxhighlight>

;ref
:This creates the invisible HTML anchor. It can be used with the anchor template {{tl|sfnref}} or its alias {{tl|harvid}}. Both of those templates accept the same parameters as shortened footnote templates. The parameter can also be used with a freeform anchor and manually written [[WP:ANCHOR|anchor links]]. {{pb}}Compared to [[HELP:CS1|citation style 1]] templates, such as {{tl|cite web}} or {{tl|cite book}}, the anchor is rather arbitrary, but {{em|it is best if the parameters match the citation data exactly}} (including precise author name spellings and order), since someone might template the manually formatted citation, which would auto-generate citation anchor data that could then be used with the same short-citation templates without them having to be updated.{{pb}}The anchor can be enclosed in quotation marks, but these are optional unless the anchor contains any character other than a number, letter, or hyphen. For example, with a space, a ref anchor of ''Von Autor-2006'' must be specified as {{para|ref|"Von Autor-2006"}}.
;reference
:The actual reference text. It may be plain text, formatted text, or one of the citation templates.

== Examples ==
In the following examples from the [[Bengal famine of 1943]], an unpublished but publicly available manuscript by the Indian Government's Regional Food Commissioner is used as a primary source. As there are few acceptable places on Wikipedia to use an unpublished memoir as a source, no citation template directly matches the document:

{{markup
|<nowiki>Government sources privately admitted the shortfall was 2 million tons.{{sfn|Braund|1944|p=50}}

==Notes==
{{reflist}}

==References==
* {{wikicite | ref = {{sfnref|Braund|1944}} | reference = Braund, H. B. L. (1944). ''Famine in Bengal'', typescript. British Library Doc D792.}}</nowiki>
|Government sources privately admitted the shortfall was 2 million tons.{{sfn|Braund|1944|p=50}}

{{fake heading|sub=3|Notes}}
{{reflist}}

{{fake heading|sub=3|References}}
* {{wikicite | ref = {{sfnref|Braund|1944}} | reference = Braund, H. B. L. (1944). ''Famine in Bengal'', typescript. British Library Doc D792.}}
}}

You can also provide the {{para|ref}} parameter with a free-form anchor. The anchor can contain letters, numbers, and hyphens. To link to a free-form anchor, use a wikitext anchor link. For example, link to <code><nowiki>{{wikicite |ref=Doe-1999 |reference=... }}</nowiki></code> with <code><nowiki><ref>[[#Doe-1999|Doe 1999]], p. x.</ref></nowiki></code>. Below, the previous example has been rewritten with a free-form anchor:

{{markup
|<nowiki>Government sources privately admitted the shortfall was 2 million tons.<ref>[[#Braund-1944|Braund (1944)]], p. 50</ref>

==Notes==
{{reflist}}

==References==
* {{wikicite | ref = Braund-1944 | reference = Braund, H. B. L. (1944). ''Famine in Bengal'', typescript. British Library Doc D792.}}</nowiki>
|Government sources privately admitted the shortfall was 2 million tons.<ref>[[#Braund-1944|Braund (1944)]], p. 50</ref>

{{fake heading|sub=3|Notes}}
{{reflist}}

{{fake heading|sub=3|References}}
* {{wikicite | ref = Braund-1944 | reference = Braund, H. B. L. (1944). ''Famine in Bengal'', typescript. British Library Doc D792.}}
}}

==Non-standard templates==
Most citation templates have a {{para|ref}} parameter that can accept any anchor, similar to the {{para|ref}} parameter in this template. Templates that don't support this can be placed into this template's {{para|reference}} parameter:

<syntaxhighlight lang="wikitext">
* {{wikicite |ref={{Harvid|Australian Recording Industry Association A}} |reference= {{cite certification|region=Australia|certyear=2006|access-date=1 July 2019}} }}
</syntaxhighlight>

When the citation template is updated to generate its own anchor, the custom anchor can be moved from {{tl|wikicite}} to the citation template:

<syntaxhighlight lang="wikitext">
* {{cite certification|region=Australia|certyear=2006|access-date=1 July 2019 |ref={{Harvid|Australian Recording Industry Association A}} }}
</syntaxhighlight>


==Backward compatibility with id==
The {{para|id}} parameter can also be used to create an HTML anchor in a full citation. It has the same role as the {{para|ref}} parameter but they work in slightly different ways. If both {{para|id}} and {{para|ref}} are provided, {{para|id}} is ignored. There are two differences:
* {{para|id}} automatically prefixes the link anchor with "Reference-", whereas {{para|ref}} does not.
* {{para|id}} encloses the link anchor in double quotes, so these must not be provided by the editor.

Thus, these two forms produce identical results:

 <syntaxhighlight lang="wikitext">{{wikicite | id = Anchor 1 | reference = Reference text }}</syntaxhighlight>
 <syntaxhighlight lang="wikitext">{{wikicite | ref = "Reference-Anchor 1" | reference = Reference text }}</syntaxhighlight>
 
The {{para|id}} parameter can only be used with manual anchor links:

{{markup|<nowiki>
According to Atwood, blah blah.<ref>[[#Reference-Atwood-2003|Atwood (2003)]], p. 29.</ref>

== Notes ==
{{reflist}}

== References ==
* {{wikicite | id = Atwood-2003 | reference = Atwood, Margaret (2003). ''Oryx and Crake'', Toronto: McClelland & Stewart. {{ISBN|978-0-7710-0868-9}}. }}
</nowiki>|
According to Atwood, blah blah.<ref>[[#Reference-Atwood-2003|Atwood (2003)]], p. 29.</ref>

{{fake heading|Notes}}
{{reflist}}

{{fake heading|References}}
* {{wikicite | id = Atwood-2003 | reference = Atwood, Margaret (2003). ''Oryx and Crake'', Toronto: McClelland & Stewart. {{ISBN|978-0-7710-0868-9}}. }}
}}


== SfnRef formatting ==
This template can be used with the same unnamed parameters as other short citation template like {{tlx|sfn}} and {{tlx|SfnRef}}. If no {{para|ref}} or {{para|id}} parameter is given, then the unnamed parameters are 1 to 4 author surnames (in the same order as found in the citation) and the year as the last parameter, each with its own <code>{{!}}</code>.

;Examples:
:{{tnull|SfnRef inline|Smith|2022}}<br />
:{{tnull|SfnRef inline|Garcia|Chiang|1975}}<br />
:{{tnull|SfnRef inline|Banh|van Doren|Lytton-St. John|O'Brien|2009}}

{{markup
|<nowiki>Some article text.{{sfnp|Buchanan|2023|loc=para. 7}}

==Notes==
{{reflist}}

==References==
* {{wikicite|Buchanan|2023|reference=Buchanan, Abigail. (14 November 2023). "[https://en.wikipedia.org/wiki/Template:SfnRef_inline 'We are making bagpipes sexy again': Inside the late Queen's beloved Scottish music school]". ''[[The Daily Telegraph]]'') {{Webarchive |url= https://web.archive.org/web/20240102130411/https://www.telegraph.co.uk/christmas/2023/11/14/inside-the-late-queens-beloved-scottish-music-school/ |date=2 January 2024}} }}</nowiki>
|Some article text.{{sfnp|Buchanan|2023|loc=para. 7}}

{{fake heading|sub=3|Notes}}
{{reflist}}

{{fake heading|sub=3|References}}
* {{wikicite|Buchanan|2023|reference=Buchanan, Abigail. (14 November 2023). "[https://en.wikipedia.org/wiki/Template:SfnRef_inline 'We are making bagpipes sexy again': Inside the late Queen's beloved Scottish music school]". ''[[The Daily Telegraph]]'') {{Webarchive |url= https://web.archive.org/web/20240102130411/https://www.telegraph.co.uk/christmas/2023/11/14/inside-the-late-queens-beloved-scottish-music-school/ |date=2 January 2024}} }}
}}

== Template data ==
{{template data header}}
<templatedata>
{
	"params": {
		"1": {},
		"2": {},
		"3": {},
		"4": {},
		"5": {},
		"ref": {
			"label": "Anchor",
			"description": "HTML anchor id used by links (not visible to readers)",
			"suggestedvalues": [
				"{{sfnref|...}}"
			],
			"suggested": true
		},
		"id": {
			"description": "alternative HTML anchor id used by links (ignored when the 'ref' parameter is also used)"
		},
		"reference": {
			"label": "Visible reference text",
			"description": "The entire visible reference. Can include links and templates.",
			"suggested": true
		}
	},
	"paramOrder": [
		"reference",
		"ref",
		"1",
		"2",
		"3",
		"4",
		"5",
		"id"
	]
}
</templatedata>

== See also ==
* {{tl|Citation}}
* {{tl|Harvnb}}
* {{tl|Sfn}}, an alternative method for creating shortened footnotes
* {{tl|Citeref}}, alternative method to create links to citations
* [[Wikipedia:Citation templates]]
* [[Wikipedia:Citing sources]]
* [[Wikipedia:Citing sources/Further considerations#Using Wikicite]]
* [[T-34#References]], example of usage

<includeonly>{{Sandbox other||
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Inline templates|{{PAGENAME}}]]
[[Category:Citation templates|{{PAGENAME}}]]

<!-- ADD INTERWIKIS BELOW THIS LINE -->
[[ja:Template:Wikicite]]
[[sl:Predloga:Wikisklic]]
}}</includeonly>