Template:SfnRef

CITEREF

Template documentation follows
Note: the template above may sometimes be partially or fully invisible.
Visit "Template:SfnRef/doc" to edit its documentation if it is available. (How does this work?)

This template creates an identifier that is used as a link anchor for short citations. Many articles are cited with shortened footnotes, which usually link to full citations at the bottom of the page. {{SfnRef}} accepts the same parameters as most short citation templates and create matching anchors when used in the |ref= parameter of the full citation. Most {{cite xxx}} templates will automatically generate the anchor, or landing point, for links. The anchor can be created manually in situations where the automatic anchors would cause issues including:

• Multiple authors with the same last name
• No known last name for the author
• Unusual characters in the author field
• Multiple works in the same year by the same author
• Year of publication unknown

Additionally some less commonly used citation templates, and all full citations written by hand can only be linked to with a manually created anchor.

Examples

When citing an article published in the December 2004 edition of Rolling Stone where the author is unknown, you might create a short footnote as follows:

{{Sfn|Rolling Stone|2004}}

You may code the value for the |ref= parameter manually, or you can use {{SfnRef}} and specify the same parameters as used with {{Sfn}}:

{{SfnRef|Rolling Stone|2004}}

The full footnote:

{{Cite news |work=[[Rolling Stone]] |title=The RS 500 Greatest Songs of All Time |ref={{SfnRef|Rolling Stone|2004}} |date=December 2004}}

You can copy and paste the {{Sfn}} template code and change the name of the template from "Sfn" to "SfnRef". If your short footnote includes page numbers such as {{Sfn|Rolling Stone|2004|p=48}}, you can copy and paste it to create {{SfnRef|Rolling Stone|2004|p=48}}; the |p=48 parameter is not necessary but will do no harm.

Usage

{{SfnRef|Name|Year}}
{{SfnRef|Name 1|Name 2|Name 3|Name 4|Year}}

The template accepts up to four names and a year of publication. If there are more than four authors, list only the first four. The last parameter is the year of publication, optionally with a letter suffixed if there are multiple citations by the same set of authors in the same year. All named parameters, such as |p= are ignored.

Reference	Sfnref anchor markup	Full citation	Short citation
Author and date are present	{{SfnRef|Smith|2024}}	Smith (2024). Title. Publisher.	Smith 2024
Many authors and date are present	{{SfnRef |Doe |Pérez |Kowalski |Al-Fulani |2024}}	Doe, John; Pérez, Juan; Kowalski, Jan; Al-Fulani, Fulan; Horvat, Ivan; Hudjefa (2024). Title. Publisher.	Doe et al. 2024
Author is publisher	{{SfnRef|Museum of Modern Art|2024}}	Title. Museum of Modern Art. 2024.	Museum of Modern Art 2024
	{{SfnRef|MoMA|2024}}	MoMA (2024). Title. Museum of Modern Art. 2024.	MoMA 2024
Author is anonymous	{{SfnRef|Anonymous|2024}}	Anonymous (2024). Title. Publisher.	Anonymous 2024
Author is missing	{{SfnRef|''Title''|2024}}	Title. Publisher. 2024.	Title 2024
	{{SfnRef|"Title"|2024}}	"Title". Work. Publisher. 2024.	"Title" 2024
Authors with the same name	{{SfnRef|F. Beauregard|2024}} {{SfnRef|P. Beauregard |2024}}	Beauregard, Fred (2024). Title. Publisher. Beauregard, Paul (2024). Title. Publisher.	F. Beauregard 2024 P. Beauregard 2024
Date is missing	{{SfnRef|Smith|n.d.}}	Smith (n.d.). Title. Publisher.	Smith n.d.
	{{SfnRef|Smith}}	Smith. Title. Publisher.	Smith
Date and author are missing	{{SfnRef|[Description]|n.d.}}	[Description]. Publisher. n.d.	[Description] n.d.

Purpose

This template creates the proper value for the |ref= parameter of Citation Style 1 templates ({{Cite journal}}, {{Cite book}}, {{Cite web}}, etc.) and the generic Citation Style 2 template {{Citation}}. It is intended to be paired with {{Sfnp}}, {{Sfn}}, {{Harvp}}, {{Harvnb}}, and related templates, and uses the same arguments. As explained above, {{SfnRef}} is only necessary in a subset of the cases where those are used.

{{Sfnp}} and its variants create a short footnote that is linked to a full footnote. The templates create the link automatically, but the full footnote must be assigned the proper ID value to be a valid target for that link. This usually happens automatically using the full-citation template's author/editor and date/year parameters, but some cases need a custom anchor, and that is what {{SfnRef}} is for.

When using the Citation Style 1 and 2 family of citation templates, a default ID is generated from the last names of the first four authors (or editors if there are no authors specified). However, if none of |last=, |author=, |editor-last=, or their equivalents are present, use {{SfnRef}} inside the CS1/CS2 template's |ref= parameter to create a link anchor (perhaps using the publisher name or work title or an abbreviation thereof) without having to know the rules for how {{Sfnp}}, etc., interpret the anchor ID string which is normally auto-generated.

Consistent output: For use with CS1/CS2 templates, {{Sfnp}} and its {{Harvp}} companion produce the most consistent citation formatting. For other citation styles that do not put dates in parentheses or brackets, matching short-footnote templates include {{Sfn}} and {{Harvnb}}.

See also

• {{sfnref inline}} – a <span>-based version for use with manually formatted, non-templated citations
• {{citeref}} – a wrapper for {{SfnRef}} to create wikilinks with either superscript ^[n] or plain-text labels to other citations from inside a citation

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:SfnRef in articles based on its TemplateData.

TemplateData for SfnRef

Template:SfnRef invokes Module:Navbox using Lua.

Usage

This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.

Syntax

{{navbox
|state      = uncollapsed, collapsed, plain, autocollapse (default)
|name       = mandatory - name of the template
|style      = optional - style for the whole table
|title      = mandatory - navbox header
|gtitleN    = optional - title of N-th group of items
|styleN     = optional - style for groupN; i.e. text-align
|groupN     = mandatory - list of groups of items
|fstyle     = optional - style for footer ; i.e. text-align
|footer     = optional - navbox footer
}}

• Groups: Currently there is no technical limit to the maximum number of groups.
  • Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
• Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
• Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
  • Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
• Line breaks: Line-breaks (<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN.
• Bullets: Create unordered lists with lines beginning with *.
• Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! ({{!}}).

States

• Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
  • Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
• Uncollapsed: Forces the navbox to be displayed.
  • All of the navboxes in this documentation are in the uncollapsed state.
• Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
  • Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
• Plain: Removes the "show/hide" link.

Sub-groups

• For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
• To create sub-groups within {{navbox}}, certain parameters are to be included:
  • The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
  • The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.

{{navbox
|name    =
|title   =
|gtitle1 =
|group1  =
|gtitle2 =  
|gtype2  = Subgroup (mandatory)
|group2  = 
  {{navbox
  |subgroup = yes (mandatory)
  |gtitle1  = 
  |group1   =
  |gtitle2  = 
  |group2   = 
  }}
}}

Collapsible sub-groups

• For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
• To create collapsible sub-groups within {{navbox}}, these parameters need to be included:
  • The parent navbox is almost always uncollapsed (state=uncollapsed).
  • The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
  • The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
  • The nested collapsible navbox is forcefully collapsed (state=collapsed).

{{navbox
|state  = uncollapsed
|name   = 
|gtype1 = Subgroup
|group1 = 
  {{navbox
  |collapsible = yes
  |state   = collapsed
  |title   = 
  |gtitle1 = 
  |group1  = 
  |gtitle2 = 
  |group2  = 
  }}
}}

Use of images

• The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
• Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.

Link and file share the same name

{{plink|Item}}

File name differs from the link

{{plink|Item|File}}

Link and file share the same name, but different text is desired to display

{{plink|Item|alt=Text}}

File name differs from the link and different text is desired to display

{{plink|Item|File|alt=Text}}

Categorising

Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.

There are 2 methods of categorising pages with navboxes:

The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.

Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.

Examples

To see the following navboxes in action, see Template:Navbox.

Single line navbox with centered list

{{navbox
|name    = 
|title   = 
|style1  = text-align:center
|group1  =
}}

Navbox with standard footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|footer  = Centered footer
}}

Navbox with styled footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|fstyle  = text-align:right
|footer  = Right-aligned footer
}}

Multiple line navbox

{{navbox
|name    = 
|title   = 
|gtitle1 = Group title 1
|group1  = 
|gtitle2 = Group title 2
|group2  = 
|gtitle3 = Group title 3
|group3  = 
}}

Collapsed navbox

{{navbox
|state   = collapsed
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox with Tnavbar

{{navbox
|state   = plain
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox without Tnavbar

{{navbox
|state   = plain
|title   = 
|style1  = text-align:center
|group1  = 
}}

Complicated navbox

{{navbox
|state   = uncollapsed
|name    = 
|title   = 
|gtitle1 = Level 1 Title 1
|group1  = 
|gtitle2 = Level 1 Title 2
|group2  = 
|gtitle3 = Level 1 Title 3
|group3  = 
|gtitle4 = Level 1 Title 4
|group4  = 
|gtitle5 = Level 1 Title 5
|gtype5  = Subgroup
|group5  = 
  {{navbox
  |subgroup = Yes
  |gtitle1  = Level 2 Title 1
  |group1   =
  |gtitle2  = Level 2 Title 2
  |group2   =
  |gtitle3  = Level 2 Title 3
  |gtype3   = Subgroup
  |group3   = 
    {{navbox
    |subgroup = Yes
    |gtitle1  = Level 3 Title 1
    |group1   =
    |gtitle2  = Level 3 Title 2
    |group2   =
    }}
  |gtitle4  = Level 2 Title 4
  |group4   = 
  }}
|gtitle6 = Level 1 Title 6
|group6  = 
|gtitle7 = Level 1 Title 7
|group7  = 
|fstyle  = 
|footer  = 
}}

Preventing unwanted documentation

The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).

Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.