CapybaraKiller: 1 revision imported from :Wikipedia:Template:Sfnlink/doc

2025-05-27T07:12:13Z

1 revision imported from Wikipedia:Template:Sfnlink/doc

← Older revision	Revision as of 00:12, 27 May 2025
(No difference)

Wikipedia>Mathglot: Regarding non-use in articles: use stronger language, and link the Sept. 2020 discussion that deprecated {{harvnb}} outside tags.

2025-04-15T18:55:30Z

Regarding non-use in articles: use stronger language, and link the Sept. 2020 discussion that deprecated {{harvnb}} outside <re> tags.

New page

{{documentation subpage}}
{{tlr|clear=right|sfnl|Sfn link|Citelink|Cite link}}
<noinclude>{{Template rating|beta}}</noinclude>
Creates a one-directional wikilink to the first matching citation template of the article. Unlike {{tl|sfn}}, it does not create a [[WP:Citing sources#Short citations|short citation]]; it creates only the outgoing link.
This could be used to link two references; for example, to link a translated work to the original work in a list of references that contains both of them. It may also be used as a [[#workaround|workaround]] for certain false positive errors such as "[[Help:Cite errors/Cite error references missing key|missing key]]" errors when [[Help:Footnotes#Footnotes: embedding references|short citations]] are [[Template:Sfn#Sfn embedded in list-defined ref does not work|embedded within list-defined references]], or as linkage from a Talk page discussion to a citation in an article.

== Usage ==
{{tlc|sfnlink|''lastname''|''year''|pp{{=}}12–15}} – typical usage.{{br}}

{{tlc|sfnlink|''last1''|''last2''|...|''year''|p{{=}}91|loc{{=}}{{nobr|...}}|text{{=}}''Link text''|article{{=}}''Article name''|rev{{=}}''oldid''|lang{{=}}''xx''<noinclude>|nb{{=}}yes</noinclude>}}

=== Quick start ===

If you want to create a one-way link to a full citation in the Bibliography section of your article which already has a working {{tl|sfn}} that links to it, just copy the sfn invocation out of the [[wikicode]], change {{kbd|sfn}} to {{kbd|sfnlink}}, and it should just work. You can add param {{para|text}} if you want to change the display text underlying the link, and if you are linking from the Talk page, add {{para|article | *}} to the invocation to link to the article (mainspace) citation (or use {{tl|sfnlinka}} instead).

Sfnlink works equally well in an article that has no {{tl|sfn}} tags and has only <ref> tags, as long as the tag contains a [[Help:CS1|CS1 templates]] that generates a [[WP:CITEREF|CITEREF]], like like {{tl|cite book}}, {{tl|cite web}} and so on. See {{slink||example-6}} for a sample use that links via a ref tag to its expanded citation.

== Parameters ==

Positional parameters 1–5 are the same as in template {{tl|sfn}}: typically, one to four author surnames, and a YYYY year. The first author surname (positional param {{para|1}}) is required; other authors and the year are required if available in the full citation. If present, year must be the last positional parameter. All parameters except the first are optional.

=== Basic ===
These parameters are the same as the [[Template:Sfn#Usage|parameters of sfn]]:
* <{{var|last1}}> – surname of first author or corporate author (required)
* <{{var|last2}}> – <{{var|last4}}> – positional parameters; surnames of next three authors
* <{{var|year}}> – four-digit year; may have a lowercase disambiguation letter like ''2012a''
* {{para|p}} – specific page referenced in the source (alias: {{para|page}}{{thinspace}})
* {{para|pp}} – comma-separated list of [[Template:Csdoc#pages|individual pages and / or range(s) of pages]] referenced in the source (alias: {{para|pages}}{{thinspace}})
* {{para|loc}} – in-source location: information such as a section or figure number; usually used when {{para|p}} and {{para|pp}} are inappropriate, but may be used to supplement them.

=== Supplementary ===
Parameters for configuring the link, how it is displayed, and extending its range:
* {{para|nb|yes}} – removes parentheses ('nb' = 'no brackets') from around the year. Default: year is displayed in parens.
* {{para|text}} – display text for the link. (default: <{{var|last1}}>{{snd}}<{{var|last4}}> in comma series, plus the <noinclude>parenthesized</noinclude> year)<noinclude>(interacts with 'nb'; see {{slink||Details}})</noinclude>
* {{para|article}} – article or page title; may be used to link to a short footnote's full citation destination on another article or page. Use an asterisk (i.e., {{para|article|*}}) to target the article or subjectpage with which the Talk page is associated. (restricted; see {{slink||Details}})
* {{para|rev}} – [[Help:Permanent link|revision id]] ("oldid"); may be used to link to a full citation in an old revision of an article (restricted; overrides 'article'; see {{slink||Details}})
* {{para|lang}} – the [[ISO-639|language code]] of the [[List of Wikipedias|foreign language Wikipedia]] where the citation is located; requires 'rev' or 'article'; (restricted; see {{slink||Details}})

=== Details ===
By design, positional parameters 1 – 5<includeonly> and the page params</includeonly><noinclude>, the page params, and param 'loc'</noinclude> are the same as [[Template:Sfn#Usage|parameters in template Sfn]]. In most cases where {{tl|sfn}} generates a false [[H:CERMK|missing key]] error, it can be resolved simply by changing <code>sfn</code> to <code>sfnlink</code> and leaving everything else alone.

<noinclude>You can specify any value for {{para|nb}} to remove parentheses from around the year, such as {{para|nb|yes}}, {{para|nb|1}} etc. (Even {{para|nb|no}} does it.) Param {{para|text}} overrides any value for {{para|nb}}; if you want parens while using 'text', just supply them in the param value.

</noinclude>Optional parameter {{para|article}} is not recommended for mainspace, but it may be useful in Talk page discussions to link to citations in related discussions on other pages, or to link directly to a mainspace article citation without having to resolve it with a local references section on a Talk page. Use {{para|article|*}} as a shortcut to indicate that your target citation is on the page associated with the Talk page you are on (i.e., at {{tlc|ARTICLEPAGENAME}}{{hairspace}}). See wrapper [[Template:Sfnlinka]] for a convenient way of linking from a Talk page to its article a without using the {{para|article|*}} param.

Optional parameter {{para|rev}} is not recommended for use in mainspace. If present, the [[Help:Permanent link|revision id]] is sufficient to uniquely identify a particular revision of an article, so param {{para|article}} is superfluous in that case. You may, if you wish, use {{para|rev}} and {{para|article}} together just for the documentary value of having the article named in the wikicode for the benefit of other editors, however when both are present, the value of {{para|article}} is ignored and only the {{para|rev}} is used.

Param {{para|lang}} should not be used in mainspace. In tandem with param {{para|article}} or {{para|rev}}, it provides linkage to citations on foreign Wikipedias, and is designed primarily for use on Talk pages where another Wikipedia has a citation of interest to discuss here. Almost all foreign Wikipedias [[d:Q6535844#sitelinks-wikipedia|support the use of short citations]] with linkage to full citations, however, {{sfnlink/prefix|unsupported languages}} Wikipedias do not, so codes <code>{{sfnlink/prefix|unsupported}}</code> may not be used as a value for {{para|lang}} and will generate an error. You can use {{para|lang}} and {{para|rev}} together to link to a citation in an old version of a foreign Wikipedia article (use of {{para|article}} is optional in this case; if used, it is of documentary value only and does not affect the result).

== Examples ==

{{cot|bg=cornsilk|align=left|{{anchor|example-1}}Example 1: Connect the citation of a translated work to the citation of the original}}
{{hatnote|The use of sfnlink in this example links the value of {{para|orig-date}} in the Smith citation (the English translation) to the Dupont citation (the original French version):}}
{{markup
| <nowiki>The sun is a star.{{sfn|Smith|2015|pp=251–254}} It is hot.{{sfn|Dupont|2012|p=19}}

=== Citations ===
{{reflist}}

=== Works cited ===
* {{cite book |last=Dupont |first=Yves |date=2012 |title=Les étoiles |publisher=Gallimard |location=Paris |lang=fr}}
*: ''other citations here...''
* {{cite book |last=Smith |first=Stan |date=2015 |title=Stars |translator=G. Forest |orig-date=1st pub. {{citelink|Dupont|2012|text=Gallimard:2012}} |publisher=MacMillan |location=New York}}</nowiki>
| The sun is a star.{{sfn|Smith|2015|pp=251–254}} It is hot.{{sfn|Dupont|2012|p=19}}

{{fake header|level=3|Citations}}
{{reflist}}

{{fake header|level=3|Works cited}}
* {{cite book |last=Dupont |first=Yves |date=2012 |title=Les étoiles |publisher=Gallimard |location=Paris |lang=fr}}
*: ''other citations here...''
* {{cite book |last=Smith |first=Stan |date=2015 |title=Stars |translator=G. Forest |orig-date=1st pub. {{citelink|Dupont|2012|text=Gallimard:2012}} |publisher=MacMillan |location=New York}}
}}
{{cob}}

{{cot|bg=cornsilk|align=left|{{anchor|example-2}}Example 2: Add a link in a Talk page discussion targeting a particular citation in the article }}
{{hatnote|From a discussion at the talk page for an article, we could refer to a particular citation in the article like this:}}
{{markup
| <nowiki>
=== Some discussion ===

The reference that is now listed there ({{sfnlink|Campbell|2004|article=Bede}}) is only accessible with a subscription... [[User:Example1]]</nowiki>
| {{fake header|level=3|Some discussion}}

The reference that is now listed there ({{sfnlink|Campbell|2004|article=Bede}}) is only accessible with a subscription... [[User:Example1]]
}}

'''Note:''' if discussion "Some discussion" is taking place at the associated Talk page (i.e., 'Talk:Bede' in this case), then the following code using the asterisk shortcut is equivalent to the above: {{tlc|sfnlink|Campbell|2004|article{{=}}*}}.
{{cob}}

{{cot|bg=cornsilk|align=left|{{anchor|example-3}}Example 3: Use list-defined references with nested sfnlinks (workaround for sfn [[H:CERMK|missing-key]] error [[#Template notes|bug]])}}
{{hatnote|The use of sfnlinks embedded within the [[WP:EXPLNOTE|efn]]'s in this example simply provide links to the full citations, (half of) the role that would normally be taken by {{tl|sfn}}. However, if this code appeared in mainspace with {{tl|sfn}} instead of sfnlink, a false-positive [[H:CERMK|missing-key]]" error would be emitted.}}
{{markup
|<nowiki>The sun is a star.{{sfn|Smith|1993|p=25}}{{efn|name="disc"}} It is hot.{{efn|name="how-hot"}}

=== Notes ===
{{notelist |refs=
{{efn|name="disc"|The only star close enough to appear larger than a point of light. {{sfnlink|Jones|2008|p=4}}}}
{{efn|name="how-hot"|About 5,500° Kelvin at the surface. {{sfnlink|Smith|1993|p=32}}}}
}}
=== Citations ===
{{reflist}}

=== Works cited ===
* {{cite book |last=Smith |first=Karen |date=1993 |title=The Sun |publisher=Dunlap}}
* {{cite book |last=Jones |first=Allen |date=2008 |title=Astronomy |publisher=Scribners}}</nowiki>
|The sun is a star.{{sfn|Smith|1993|p=25}}{{efn|name="disc"}} It is hot.{{efn|name="how-hot"}}

{{fake header|level=3|Notes}}
{{notelist |refs=
{{efn|name="disc"|The only star close enough to appear larger than a point of light. {{sfnlink|Jones|2008|p=4}}}}
{{efn|name="how-hot"|About 5,500° Kelvin at the surface. {{sfnlink|Smith|1993|p=32}}}}
}}
{{fake header|level=3|Citations}}
{{reflist}}

{{fake header|level=3|Works cited}}
* {{cite book |last=Smith |first=Karen |date=1993 |title=The Sun |publisher=Dunlap}}
* {{cite book |last=Jones |first=Allen |date=2008 |title=Astronomy |publisher=Scribners}}
}}
{{cob}}

{{anchor|example-4}}'''Example 4:''' Link a citation in an old, 2016 rev of [[Darshan (Indian religions)]]:{{br}}
* {{tlg|sfnlink|Flood|2011|p{{=}}194|nb{{=}}yes|rev{{=}}701715751|code=yes|_show_result=yes}} — <small>''Note: no parens around the year, per param 'nb'''</small>

{{anchor|example-5}}'''Example 5:''' Link to a citation in the French Wikipedia article ''[[:fr:Cinéma|Cinéma]]'':
* {{tlg|sfnlink|Briselance|Morin|2010|p{{=}}16|lang{{=}}fr|article{{=}}Cinéma|code=yes|_show_result=yes}}

{{anchor|example-6}}'''Example 6:''' Link to a citation embedded within <code><nowiki><ref>...</ref></nowiki></code> tags in the body of article ''[[Agnes Grey]]'':
* {{tlg|sfnlink|Fraser|2008|article{{=}}Agnes Grey|code=yes|_show_result=yes}}

== Template notes ==

Sfnlink creates only a wikilink, namely, the same link as the [[Template:Harvard citation documentation#Harvard citation wikilink|Harvard citation templates]]; compare {{tl|harvnb}} and {{tl|harvid}}. In contradistinction to template sfn, sfnlink [[Template:Sfn#%7B%7Bsfn%7D%7D's_ref_name|does not create a named footnote]], and two identical sfnlinks are not combined, they are like two on-page wikilinks that happen to point to the same destination. [[Template:Harvard citation documentation#Using CITEREF directly|Using CITEREF directly]] is equivalent to the wikilink portion of sfnlink.

{{anchor|workaround}}
Sfnlink may be helpful for avoiding false-positive [[Help:Cite errors/Cite error references missing key|"missing key" citation errors]] when using [[Help:Footnotes#List-defined references|list-defined references]] which contain embedded citations. For example, if you have list-defined refs or {{tl|efn}}s that contain [[WP:SFN|short footnotes]] ({{thinspace}}{{tl|Sfn}}, {{tl|harv}}, etc.) in them, you will get a false-positive [[H:CERMK]] error due to known bug {{phab|T22707}}. Replacing the embedded short footnotes with Sfnlink is a [[#example-3|workaround]] that will avoid the error.

=== When to use ===

This template may be useful for various situations in which you need a unidirectional link to an existing citation. Here are some possible use cases:
* to discuss an existing article citation from the Talk page of the article, and link to it (but see {{tl|sfnlinka}}{{hairspace}});
* to add a unidirectional link to a citation within the article itself, where {{tl|harvnb}} isn't apt, such as when you need to change the link text; for example:
** to link a citation of a translated work, to an another citation representing the original language work
** to link one author crediting another: when the author of source A refers to source B in their work, and you have citations to both A and B in your article, you can link words in the {{para|quote}} param of A directly to your B citation.
* to avoid certain bugs, such as <span class=plainlinks>[https://phabricator.wikimedia.org/T22707 false positive errors]</span> when an [[Template:Sfn#Sfn embedded in list-defined ref does not work|sfn template is embedded in a list-defined reference]].
* to discuss an existing article citation located in a different article, or in a [[List of Wikipedias|page on another Wikipedia]].
An alternative to this template is {{tl|citeref}}; when used from mainspace, they are functionally equivalent. From talk space, an alternative is {{tl|sfnt}}.

=== When not to use ===

Do not use this template:
* to create a short citation in an article; use {{tl|sfn}} instead. The use of parenthetical citations inline outside of <ref>...</ref> tags [[Wikipedia:Village pump (proposals)/Archive 171#Deprecate parenthetical citations|was deprecated in September 2020]].
* to create a link from a chapter of a book to the full {{tl|cite book}} citation; use {{tl|citec}} / {{tl|harvc}} instead;
* to create a unidirectional link from an article to a citation within the article, if one of the templates implemented by [[Module:Footnotes]] will do what you need, such as {{tl|harvnb}}.

== See also ==
{{div col|colwidth=24em}}
* {{tl|sfnlinka}}
* {{tl|sfn}}
* {{tl|sfnt}}
* {{tl|efn}}
* {{tl|harv}}
* {{tl|harvtxtt}}
* {{tl|sfnref}}
* {{tl|citeref}}
* {{tl|remoteref}}
* [[WP:LDR]]
{{div col end}}

{{Wikipedia referencing|state=collapsed}}
<includeonly>{{Sandbox other||

[[Category:Footnote templates]]
[[Category:Author–date citation templates]]

}}</includeonly>

Template:Sfnlink/doc - Revision history

CapybaraKiller: 1 revision imported from :Wikipedia:Template:Sfnlink/doc

Wikipedia>Mathglot: Regarding non-use in articles: use stronger language, and link the Sept. 2020 discussion that deprecated {{harvnb}} outside tags.