View source for Template:Efn/doc

{{Documentation subpage}}
<!-- Categories and interwikis go at the bottom of this page. -->
There are several predefined groups that can have a styled reference list such that the footnote label of an explanatory footnote or citation matches between the note marker in the prose and the note itself in the footnotes list. These predefined note groups and footnote lists have templates that make the markup simpler and also allow a standard reference to be inserted, so that an explanatory note can have a reference, or citations can be nested.
<section begin=pregrouptable />
{| class="wikitable"
|- style="vertical-align:top;"
! Group name !! Footnote marker template<br/>or markup !! Reference list template !! Sample labels
|-
| ''none'' || {{tag|ref}} || {{tlx|reflist}} || 1 2 3 4 5 6 7 8 9 10
|-
| ''none'' || {{tlx|refn}} for nested references || {{tlx|reflist}} || 1 2 3 4 5 6 7 8 9 10
|-
| lower-alpha || {{tlx|efn}}  || {{tlx|notelist}} || a b c d e f g h i j
|-
| upper-alpha || {{tlx|efn-ua}} || {{tlx|notelist-ua}} || A B C D E F G H I J
|-
| lower-roman || {{tlx|efn-lr}} || {{tlx|notelist-lr}} || i ii iii iv v vi vii viii ix x
|-
| upper-roman || {{tlx|efn-ur}} || {{tlx|notelist-ur}} || I II III IV V VI VII VIII IX X
|-
| lower-greek{{efn|Not supported by Internet Explorer 7 and below}} || {{tlx|efn-lg}} || {{tlx|notelist-lg}} || α β γ δ ε ζ η θ ι κ
|}
{{notelist}}<section end=pregrouptable />

* {{tlx|efn}} supports {{para|name}} and {{para|group}}, which work the same as the parameters in {{tag|ref|o}}. Do not enclose values in quotes.
* {{tlx|notelist}} supports the column parameter, {{para|refs}} and {{para|group}} which work the same as the parameters in {{tlx|reflist}}. Do not enclose values in quotes.

In these examples, the footnote labels match between the footnote marker and the reference list:

{{markup|title=With lower-alpha labels
|<nowiki>Lorem ipsum dolor sit amet.{{efn|Footnote 1}} Consectetur adipisicing elit.{{efn|Footnote 2}} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{{efn|Footnote 3}}

{{notelist}}
</nowiki>
|Lorem ipsum dolor sit amet.{{efn|Footnote 1}} Consectetur adipisicing elit.{{efn|Footnote 2}} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{{efn|Footnote 3}}

{{notelist}}
}}

{{markup|title=With lower-roman labels
|<nowiki>Lorem ipsum dolor sit amet.{{efn-lr|Footnote 1}} Consectetur adipisicing elit.{{efn-lr|Footnote 2}} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{{efn-lr|Footnote 3}}

{{notelist-lr}}
</nowiki>
|Lorem ipsum dolor sit amet.{{efn-lr|Footnote 1}} Consectetur adipisicing elit.{{efn-lr|Footnote 2}} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{{efn-lr|Footnote 3}}
{{notelist-lr}}
}}

{{markup|title=With named references
|<nowiki>Lorem ipsum dolor sit amet.{{efn|name=fn1|Footnote 1}} Consectetur adipisicing elit.{{efn|Footnote 2}} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{{efn|name=fn1}}

{{notelist}}
</nowiki>
|Lorem ipsum dolor sit amet.{{efn|name=fn1|Footnote 1}} Consectetur adipisicing elit.{{efn|Footnote 2}} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{{efn|name=fn1}}
{{notelist}}
}}

{{markup|title=With named references, the references are defined in the notelist
|<nowiki>Lorem ipsum dolor sit amet.{{efn|name=fn1}} Consectetur adipisicing elit.{{efn|name=fn2}} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{{efn|name=fn1}}

{{notelist|refs=
{{efn|name=fn1|Very long footnote 1}}
{{efn|name=fn2|Very long footnote 2}}
}}
</nowiki>
|Lorem ipsum dolor sit amet.{{efn|name=fn1}} Consectetur adipisicing elit.{{efn|name=fn2}} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{{efn|name=fn1}}
{{notelist|refs=
{{efn|name=fn1|Very long footnote 1}}
{{efn|name=fn2|Very long footnote 2}}
}}
}}

'''Issues'''
* Multiple backlink labels are always styled as lower-alpha. This can be confusing when {{tlx|efn}} is used.
* The entries in the reference list will show the default decimal styling if:
** The value for {{para|group}} in {{tlx|reflist}} or {{tag|references|s}} does not exactly match one of the predefined values; use {{tlx|efn}} or variant as {{para|group}} will not be needed.
** The value for {{para|group}} in {{tlx|reflist}} or {{tag|references|s}} is enclosed by quotes; use {{tlx|efn}} or variant as {{para|group}} will not be needed.
** {{tlx|reflist}} is indented with the {{code|:}} markup.
** {{tag|references|s}} is used instead of {{tlx|reflist}}
* The entries in the reference list will have no styling if:
** A reference is included in {{tlx|navbox}} or one of the variants and the style is set to <code>bodyclass=hlist</code>; to resolve this, replace the style with <code>listclass=hlist</code>.
*Including external link markup will result in an error. Use the {{tlx|URL}} template instead: <code><nowiki>{{URL|</nowiki>1=''url name''<nowiki>|</nowiki>2=''optional display text''<nowiki>}}</nowiki></code>.<section end=pregroup />

<includeonly>
<!-- Categories and interwikis go here: -->
[[Category:Footnote templates]]
[[Category:Explanatory footnote templates]]
</includeonly>