View source for Template:Sfn/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

=Shortened footnote template=
__TOC__
==Purpose==

Creates a short [[WP:Harvard reference|author-date citation]] in a footnote. To read a full description of how these shortened footnotes are used in Wikipedia, see  [[Wikipedia:Citing sources#Shortened footnotes|"Shortened footnotes"]] in [[Wikipedia:Citing sources]]. Features:
*Automatically combines identical footnotes.
*Automatically creates a one-way link to a citation template at the bottom of the page. The anchor is created only if you add the parameter {{para|ref|harv}} to the citation template. The link only operates if the parameters {{para|last}}, {{para|last2}}...  and {{para|year}} of that citation template match the first arguments to {{tl|sfn}}. (It is also possible to use the citation template's {{para|ref}} parameter to create an anchor that this template will link to. See {{tl|sfnRef}})

==Usage==

: <code><nowiki>{{</nowiki>Sfn |''Last name of author(s)''|''Year''| loc = ''Location in the text''}}</code>

Instead of using the optional loc parameter, you may also use one of the following parameters:

*{{para|p|page}}
*{{para|pp|pages}}

; Notes
*The first parameter is the author's last name.
*Up to four authors can be given as parameters (see the examples). If there are more than 4 authors only the first 4 should be listed; listing more will cause odd things to happen.
*The next parameter is the year of publication.
*The "loc = " parameter is the location of the cited material within the reference. This parameter is optional.
*The parameter ''p'' is an optional page parameter; thus "<code><nowiki>{{sfn|Smith|2006| p=25}}</nowiki></code>" yields "{{Harvnb|Smith|2006|p=25}}".
*The parameter ''pp'' is an optional page range parameter; thus "<code><nowiki>{{sfn|Smith|2006| pp=25&amp;ndash;26}}</nowiki></code>" yields "{{Harvnb|Smith|2006|pp=25–26}}".
*For authors who have published more than one work in the same year, the standard way to differentiate such works is to put a lowercase letter after the year (e.g. year=2006a and year=2006b).
*If multiple references are made to the same location of the same work, only one footnote is generated.
*If additional comments are needed, use {{tl|Harvnb}} or {{tl|Harvtxt}} in <nowiki><ref></nowiki> tags to achieve a similar effect. E.g. <pre>Jones writes "blah blah".<ref>Quoted in {{Harvnb|Smith|2006|p=25}}.</ref></pre>


Editors editing this template are requested to consider making parallel changes to {{tl|Harv}}, {{tl|Harvnb}} and {{tl|Harvs}}.

==Examples==

:{| class="wikitable"
|-
! Markup !! Result
|-
| <code><nowiki>Article text.{{sfn |Smith|2006| p=25}}</nowiki></code>
| Article text.{{sfn |Smith|2006 |p=25}}
|-
| <code><nowiki>Article text.{{sfn |Smith|2006| pp=25&amp;ndash;26}}</nowiki></code>
| Article text.{{sfn |Smith|2006| pp=25–26}} ''Citing multiple pages.''
|-
| <code><nowiki>Article text.{{sfn |Smith|2006| loc=&amp;sect;8.5}}</nowiki></code>
| Article text.{{sfn |Smith|2006| loc=§8.5}} ''A location, rather than a page number.''
|-
| <code><nowiki>Article text.{{sfn |Smith|2006| p=25}}</nowiki></code>
| Article text.{{sfn |Smith|2006 |p=25}} ''A second citation of the same page.''
|-
| <code><nowiki>Article text.{{sfn |Smith|Jones|2006| p=25}}</nowiki></code>
| Article text.{{sfn |Smith|Jones|2006| p=25}} ''Two authors.''
|-
| <code><nowiki>Article text.{{sfn |Smith|Jones|Brown|2009| p=25}}</nowiki></code>
| Article text.{{sfn |Smith|Jones|Brown|2009| p=25}} ''Three authors.''
|-
| <code><nowiki>Article text.{{sfn |Smith|Jones|Brown|Black|2006| p=25}}</nowiki></code>
| Article text.{{sfn |Smith|Jones|Brown|Black|2006| p=25}} ''Large numbers of authors.''
|-
| <code><nowiki>Article text.{{sfn |Smith|1993a| p=25}} More text.{{sfn |Smith|1993b| p=32}}</nowiki></code>
| Article text.{{sfn |Smith|1993a| p=25}} More text.{{sfn |Smith|1993b| p=32}} ''Two papers in the same year.''
|-
| <code><nowiki>Article text.{{sfn |Solo}}</nowiki></code>
| Article text.{{sfn |Solo}} ''One author, no year, no page.''
|-
| <code><nowiki>Article text.{{sfn |Popular Magazine|1973}}</nowiki></code>
| Article text.{{sfn |Popular Magazine|1973}} ''Corporate author (no author in citation template).''
|-
| <code><nowiki>Article text.{{sfn |A particularly unusual citation}}</nowiki></code>
| Article text.{{sfn |A particularly unusual citation}} ''A particularly unusual citation''
|-
| <code><nowiki>
Article text.<ref>{{harvnb|Smith|2006|p=25}}, {{harvnb|Smith|Brown|2006}}.</ref> 
More article text.<ref>Quoted in {{harvnb|Smith|2006|p=25}}.</ref>
</nowiki></code>
| Article text.<ref>
{{Harvnb|Smith|2006|p=25}}, {{Harvnb|Smith|Brown|2006}}.</ref> More article text.<ref>Quoted in {{harvnb|Smith|2006|p=25}}.</ref>
''Combined footnotes and other situations where this template is inappropriate.
|-
|<pre>==Notes==
{{reflist}}

==References==
* {{cite book
| last = Smith | first = John
| year = 2006
| title = Smith's Book
| ref = harv
}}
* {{cite web
| last = Smith | first = John
| last2 = Jones | first2 = Sam
| title = Smith & Jones website
| url = http://en.wikipedia.org
| year = 2006
| ref = harv
}}
* {{cite news
| last = Smith | first = John
| last2 = Jones | first2 = Sam
| last3 = Brown | first3 = Tom
| title = Article by Smith, Jones and Brown
| year = 2009
| newspaper = Big Urban Newspaper
| ref = harv
}}
* {{cite journal
| last = Smith
| last2 = Jones
| last3 = Brown
| last4 = Black
| year= 2006
| title= Smith, Jones, Brown and Black's Paper
| journal = Important Journal
| ref = harv
}}
* {{cite journal
| last = Smith | first = Karen
| year = 1993a
| title = Smythe's first paper
| journal= Important Journal
| ref = harv
}}
* {{cite journal
| last = Smith | first = Karen
| year = 1993b
| title = Smythe's second paper
| journal= Another Important Journal
| ref = harv
}}
* {{cite web
| last = Solo
| first = Han
| title = Freeze-Dried: My Story
| url = http://en.wikipedia.org/
| ref = harv
}}
* {{cite magazine
| magazine = Popular Magazine
| title = An Article by an Anonymous Author
| year = 1970
| ref = {{sfnRef|Popular Magazine|1970}}
}}
* {{wikicite 
| reference = A source that can't be described 
using our citation templates at all.
| ref = {{sfnRef|A particularly unusual citation}} 
}}

</pre>
|
{{fake heading|Notes}}
{{reflist}}

{{fake heading|References}}
* {{cite book
| last = Smith | first = John
| year = 2006
| title = Smith's Book
| ref = harv
}}
* {{cite web
| last = Smith | first = John
| last2 = Jones | first2 = Sam
| title = Smith & Jones website
| url = http://en.wikipedia.org
| year = 2006
| ref = harv
}}
* {{cite news
| last = Smith | first = John
| last2 = Jones | first2 = Sam
| last3 = Brown | first3 = Tom
| title = Article by Smith, Jones and Brown
| year = 2009
| newspaper = Big Urban Newspaper
| ref = harv
}}
* {{cite journal
| last = Smith
| last2 = Jones
| last3 = Brown
| last4 = Black
| year= 2006
| title= Smith, Jones, Brown and Black's Paper
| journal = Important Journal
| ref = harv
}}
* {{cite journal
| last = Smith | first = Karen
| year = 1993a
| title = Smythe's first paper
| journal= Important Journal
| ref = harv
}}
* {{cite journal
| last = Smith | first = Karen
| year = 1993b
| title = Smythe's second paper
| journal= Another Important Journal
| ref = harv
}}
* {{cite web
| last = Solo
| first = Han
| title = Freeze-Dried: My Story
| url = http://en.wikipedia.org/
| ref = harv
}}
* {{cite magazine
| magazine = Popular Magazine
| title = An Article by an Anonymous Author
| year = 1970
| ref = {{sfnRef|Popular Magazine|1970}}
}}
* {{wikicite 
| reference = A source that can't be described using our citation templates at all.
| ref = {{sfnRef|A particularly unusual citation}} 
}}

|}

==Anchor IDs==
This template generates an HTML IDd as an anchor to link the short citation to the full citation.. The {{para|ref|harv}} field is necessary in each of the <code><nowiki>{{cite ...}}</nowiki></code> templates to enable the id. The {{tl|citation}} template always generates an id.

If the article cites multiple works by the same author in the same year, then duplicate IDs will be generated. One method to resolve this is to add an alpha suffix to the year. Example: 2009a, 2009b, 2009c.

If works are cited where the author or year is unknown— such as for a web page —then an invalid ID will be generated. To resolve this, create a custom ID:

: <code><nowiki>{{sfn|</nowiki>''cite name''|''year''<nowiki>}}</nowiki></code>
: <code><nowiki>{{cite ... |ref=CITEREF</nowiki>''cite_nameyear''<nowiki> }}</nowiki></code>

Where ''cite_name'' is a name such as the publisher, and must follow these rules:
*  Must begin with a letter A-Z or a-z
* Can be followed by: letters (A-Za-z), digits (0-9), hyphens ("-"), underscores ("_"), colons (":"), and periods (".")
* Spaces in the {{para|ref}} field must be replaced with underscores
* Case-sensitive

===SfnRef===
You may use the {{tl|SfnRef}} template to generate the proper value for the {{para|ref}} parameter. Pass the same parameters used with {{tl|sfn}} to {{tl|SfnRef}}:
: <code><nowiki>{{sfn|</nowiki>''cite name''|''year''<nowiki>}}</nowiki></code>
: <code><nowiki>{{cite ... |ref={{SfnRef|</nowiki>''cite name''|''year''<nowiki>}} }}</nowiki></code>

Articles using {{tlx|sfn}} should be checked for duplicate IDs with the [http://validator.w3.org/ W3C Markup Validation Service].

==Implementation notes==

This template call <pre>{{sfn|Smith|2006|p=26}}</pre> should have exactly the same functionality as <pre><ref name=Smith200626>{{Harvnb|Smith|2006|p=26}}</ref></pre>

<includeonly>
[[Category:Citation templates]]
[[Category:Inline templates]]
</includeonly>