Draft:Footnotes - Revision history

Tungstenchan: Text replacement - "BattleTechWiki" to "BattleIntelligence"

2025-05-01T01:59:14Z

Text replacement - "BattleTechWiki" to "BattleIntelligence"

imported>Deadfire: Deadfire moved page Help:Footnotes/Draft to Draft:Footnotes without leaving a redirect: Moving to the correct place for this draft

2024-01-23T03:11:16Z

Deadfire moved page Help:Footnotes/Draft to Draft:Footnotes without leaving a redirect: Moving to the correct place for this draft

New page

<noinclude>{{pp-semi-indef}}</noinclude>
{{For|the official guideline on citing sources|BattleTechWiki:Citing sources}}
{{For|help with citation templates|Help:Citation Style 1}}
{{Redirect|BTW:NOTES|hatnotes|BattleTechWiki:Hatnote|article layout of footnotes|MOS:NOTES}}
{{How to|H:FOOT|BTW:FOOTNOTES|H:FN}}

This page explains how to create the '''Footnotes''' section for BattleTechWiki articles. In this context, the word "Footnotes" refers to the BattleTechWiki-specific manner of documenting an article's sources and providing tangential information, and should not be confused with the general concept of [[Note (typography)|footnotes]]. This how-to does not cover the formatting of citations within the Footnotes section, which is reviewed in [[BattleTechWiki:Citing sources|Citing sources]].

Footnotes are used most commonly to provide:
* [[BattleTechWiki:Citing sources|references (bibliographic citations) to reliable sources]],
* [[Help:explanatory notes|explanatory information]], or
* source information for tables and other elements.

Footnotes or [[Help:Shortened footnotes|shortened footnotes]] may be used at the editor's discretion in accordance with the guideline on [[BTW:CITEVAR|Variation in citation methods]].

Only certain types of material on the English BattleTechWiki are required to have an inline citation. There is [[BattleTechWiki:Inline citation#Citation density|no requirement to provide a citation for every sentence]], because multiple sentences may be supported by the same footnote. For advice on which material should be cited, see the guidelines on [[BTW:MINREF|When you must use inline citations]], the [[BattleTechWiki:Good article criteria|Good article criteria]] and [[BattleTechWiki:when to cite|When to cite]]. For advice on how to organize and format bibliographic citations, see the guideline on [[BattleTechWiki:Citing sources|Citing sources]] and examples of [[BattleTechWiki:Citation templates#Examples|Citation templates]].

Footnotes are created using the [[mw:Extension:Cite|Cite]] software extension. This extension adds the HTML-like elements {{tag|ref}}, {{tag|references|s}} and {{tag|references}}. The elements are also used in a number of templates; for example, it is becoming more common to use {{tl|reflist}} rather than {{tag|references|s}} as it can style the reference list.

==Overview==
The Footnotes system shows two elements on the page:
* A '''Footnote marker''' is displayed in the article's content as a bracketed, superscripted number, letter, or word. Examples shown respectively are: {{dummy ref}}{{dummy ref|a}}{{dummy ref|Note 1}}. This footnote label is linked to the full footnote. Clicking on the footnote marker jumps the page down to the footnote and highlights the citation. If you are using the desktop site and have Javascript enabled, then hovering your cursor over a footnote marker (or touching it on touch devices) will show a pop-up box containing the footnote.
* A '''Footnote''' displays the full citation for the source. Together the footnotes are displayed in an ordered list wherever the reference list markup {{tl|reflist}} is placed. Each entry begins with the footnote label in plain text. The entire reference list is formatted in a slightly smaller font.

:Each successive footnote label is automatically incremented. Thus the first footnote marker would be {{dummy ref}}, the second would be {{dummy ref|2}} and so on. Custom labels are also incremented: {{dummy ref|a}}{{dummy ref|b}}{{dummy ref|c}}, {{dummy ref|Note 1}} {{dummy ref|Note 2}} {{dummy ref|Note 3}}.
:For a single-use footnote, the label is followed by a caret (^) that is a backlink to the matching footnote marker. For example:
{{dummy footnote|margin=5em}}
:If a named footnote is used in the text multiple times, then the footnote has multiple backlinks shown as letters:
{{dummy footnote|2|a b c|margin=5em}}
:Clicking on the backlink or pressing {{keypress|Alt|←}} returns to the footnote marker.

===Footnotes in action===
The superscript numeral "1" in square brackets at the end of this sentence is an example of a footnote marker.<ref>This is a footnote that contains a citation or note.</ref>

{{reflist}}
{{anchor|Footnote markers: the basics}}

==Footnotes: the basics==

{{See also|Help:Reftags}}

To create the footnote marker, determine the point in the page content where the marker is desired and enter the markup with the citation or note inside the {{tag|ref}} tags. For example:

{{markup
|<nowiki>This is page content.<ref>''LibreOffice For Starters'', First Edition, Flexible Minds, Manchester, 2002, p. 18</ref>
{{reflist}}</nowiki>
|This is page content.<ref>''LibreOffice For Starters'', First Edition, Flexible Minds, Manchester, 2002, p. 18</ref>
{{reflist}}
}}

The {{tl|reflist}} template will be explained in the next section.

The content inside the {{tag|ref}} will show in the reference list. The ref tags can be added anywhere a citation or note is needed. There must be content inside the tags, else an error will show.

===Where to place ref tags===
Ref tags should follow any punctuation (usually a period), not precede it; see [[BTW:REFPUNC]]. There should be no space between the punctuation and the tag:

{{markup
|<nowiki>...text.<ref>Content of the reference</ref>
{{reflist}}</nowiki>
|...text.<ref>Content of the reference</ref>     {{xt|Right}}
{{reflist}}
|<nowiki>...text<ref>Content of the reference</ref>.
{{reflist}}</nowiki>
|...text<ref>Content of the reference</ref>.     {{!xt|Wrong (tag before punctuation)}}
{{reflist}}
|<nowiki>...text. <ref>Content of the reference</ref>
{{reflist}}</nowiki>
|...text. <ref>Content of the reference</ref>     {{!xt|Wrong (space before tag)}}
{{reflist}}
}}

===Formatting ref tags===
The content of the ref tags can be formatted using most wiki markup or HTML markup, although techniques such as the [[Help:Pipe trick|pipe trick]] and [[Help:Substitution|template substitution]] will not work in footnotes. For example:

{{markup
|<nowiki>This is page content.<ref>''LibreOffice For Starters'', First Edition, Flexible Minds, Manchester, 2002, p. 18</ref>
{{reflist}}</nowiki>
|This is page content.<ref>''LibreOffice For Starters'', First Edition, Flexible Minds, Manchester, 2002, p. 18</ref>
{{reflist}}
}}

The ref tag content may also contain an internal or external link:

{{markup
|<nowiki>This is page content.<ref>''[http://www.example.org LibreOffice For Starters]'', First Edition, Flexible Minds, Manchester, 2002, p. 18</ref>
{{reflist}}</nowiki>
|This is page content.<ref>''[http://www.example.org LibreOffice For Starters]'', First Edition, Flexible Minds, Manchester, 2002, p. 18</ref>
{{reflist}}
}}

{{MediaWiki URL rules}}

==Reference lists: the basics==
Once any number of footnotes have been inserted into the content, the reference list must be generated. For the basic reference list, add {{tl|reflist}} wherever the list is desired. Once the page is published and viewed, the footnotes will be automatically generated and numbered and the reference list will be generated. The main reference list is placed in a separate section, usually titled "References", "Notes" or the like.

{{markup
|<nowiki>This is page content.<ref>''LibreOffice For Starters'', First Edition, Flexible Minds, Manchester, 2002, p. 18</ref>

==References==
{{reflist}}</nowiki>
|This is page content.<ref>''LibreOffice For Starters'', First Edition, Flexible Minds, Manchester, 2002, p. 18</ref>

{{fake heading|sub=2|References}}
{{reflist}}
}}

'''Notes'''
{{shortcut|HELP:MULTIREF}}
* In some cases, a page has more than one reference list. Until 2014, multiple uses of {{tl|reflist}} on the same page required use of a {{para|close}} parameter; that bug has been fixed and the{{para|close}} parameter may safely be removed.
*When editing, {{tag|references|s}} may be seen instead of {{tl|reflist}}. This will automatically display the references in multiple columns, but {{tag|references|s}} does not offer the other advanced features of {{tl|reflist}}.

{{anchor|Naming a ref tag so it can be used more than once|Footnote markers: using a source more than once}}

==Footnotes: using a source more than once==
{{Shortcut|BTW:REFNAME|BTW:NAMEDREFS}}
{{Anchor|Reference name (naming a ref tag so it can be used more than once)}}
{{Anchor|BTW:NAMEDREF}} 
{{See also|BattleTechWiki:Citing sources#Citing multiple pages of the same source}}
You can cite the same source more than once on a page by using '''named references''', also called named footnotes. The syntax to define a named footnote is:
:{{tag|ref|params=name="<var>name</var>"|content=<var>content</var>}}

To invoke the named footnote:
:{{tag|ref|s|params=name="<var>name</var>"}}

{{refname rules}}

Note that the colon-followed-by-numeral names, like <code>":0"</code>, are currently [[BattleTechWiki:Village_pump_(technical)/Archive_173#VisualEditor_creating_bad_ref_names|generated by default]] in [[BTW:VE|VisualEditor]].

{{markup
|<nowiki>This is page content.<ref name="manchester2002">{{cite book|title=LibreOffice for Starters|edition=First|publisher=Flexible Minds|location=Manchester|year=2002|p=18}}</ref> This is more content.<ref name="manchester2002" />
{{reflist}}</nowiki>
|This is page content.<ref name="manchester2002">{{cite book|title=LibreOffice for Starters|edition=First|publisher=Flexible Minds|location=Manchester|year=2002|p=18}}</ref> This is more content.<ref name="manchester2002" />
{{reflist}}
}}

The actual name used can be almost anything, but it is recommended that it have a connection to the citation or note. A common practice is to use the author-year or publisher-year for the reference name. This helps editors remember the name, by associating it with the information that is visible to the reader.

Note that the footnote labels are incremented in the order they are used, and that they use the same label when reused, thus the labels can seem out of order:
{{markup
|<nowiki>This is starter content.<ref name="manchester2002">{{cite book|title=LibreOffice for Starters|edition=First|publisher=Flexible Minds|location=Manchester|year=2002|p=18}}</ref> This is expert content.<ref name="lexington2004">{{cite book|title=OpenOffice for Experts|publisher=Lexington|year=2004|p=18}}</ref> And more starter content.<ref name="manchester2002" /> And more expert content.<ref name="lexington2004" />
{{reflist}}</nowiki>
|This is starter content.<ref name="manchester2002">{{cite book|title=LibreOffice for Starters|edition=First|publisher=Flexible Minds|location=Manchester|year=2002|p=18}}</ref> This is expert content.<ref name="lexington2004">{{cite book|title=OpenOffice for Experts|publisher=Lexington|year=2004|p=18}}</ref> And more starter content.<ref name="manchester2002" /> And more expert content.<ref name="lexington2004" />
{{reflist}}
}}

When using both names and [[#Footnotes:_groups|groups]], the syntax is:
:{{tag|ref|params=group="<var>groupname</var>" name="<var>name</var>"|content=Content}}
Care should be taken when deleting references to avoid creating a cite error. See [[BattleTechWiki:Avoiding common mistakes#Deleting...|Avoiding common mistakes]].

==Reference lists: columns==
{{shortcut|H:REFCOLS}}
{{hatnote|Columns are not supported by Internet Explorer 9 and below; see {{tl|reflist}} for technical details}}
When using {{tag|references|s}} or {{tl|reflist}}, the list can be split into columns. The {{tag|references|s}} tag provides a default column width of 30 [[em (typography)|em]]. {{tl|Reflist}} can be used to set a different column width:
:{{tlx|reflist|<var>xx</var>em}}, where <var>xx</var> is the column width in em.
The number of columns will automatically be adjusted to the width of the display. It should be used only when necessary, as both the tag and the template have built-in auto-formatting capabilities providing a useful default display in most scenarios.

The [[Template:Reflist#Columns|set columns feature]] is now [[deprecated]] in favor of the option described above, which is better suited to flexible formatting for a variety of display screen sizes, ranging from mobile phones and tablets to wide-screen "cinema" displays. Forcing a fixed number of columns has been disabled in mobile view.

The number of columns to use is up to the editor, but some major practices include:
* {{tlx|Reflist|30em}}: Where there are many footnotes plus a page-width Bibliography subsection
* {{tlx|Reflist|20em}}: Where {{sfnote}} are used

For example:
Using {{tlx|Reflist|30em}} will create columns with a minimum width of 30 em,
{{markup|title=30em wide columns
|<nowiki>Lorem ipsum.<ref>Source name, access date, etc.</ref>

Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>

==References==
{{Reflist|30em}}</nowiki>
|Lorem ipsum.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>

{{fake heading|sub=3|References}}
{{Reflist|30em}}
}}

==List-defined references==
{{shortcut|BTW:LDR}}
{{main|Help:List-defined references}}
Some or all of the footnotes can also be defined within the reference section/list, and invoked in the page content. This keeps those citations in one central location for easier maintenance and avoids cluttering the text. This is purely a source code change{{snd}}the actual display of the citation in the text to a reader is unaffected. For a more detailed evaluation of this method, see [[BTW:LDRHOW]]. The syntax is:

<syntaxhighlight lang="xml">
{{reflist|refs=
<ref name="name1">Content</ref>
<ref name="name2">Content</ref>
<ref name="name...n">Content</ref>
}}
</syntaxhighlight>

or, alternatively,

<syntaxhighlight lang="xml">
<references>
<ref name="name1">Content</ref>
<ref name="name2">Content</ref>
<ref name="name...n">Content</ref>
</references>
</syntaxhighlight>

The footnote markers are included as usual for a named footnote. For example:

{{markup
|<nowiki>The quick brown fox jumps over the lazy dog.<ref name="LazyDog"/>
Amazingly few discotheques provide jukeboxes.<ref name="Jukeboxes"/>
How razorback-jumping frogs can level six piqued gymnasts.<ref name="JumpingFrogs"/>

==References==
{{reflist|refs=
<ref name="Jukeboxes">This is the jukeboxes reference.</ref>
<ref name="LazyDog">This is the lazy dog reference.</ref>
<ref name="JumpingFrogs">This is the jumping frogs reference.</ref>
}}</nowiki>
|The quick brown fox jumps over the lazy dog.<ref name="LazyDog"/>
Amazingly few discotheques provide jukeboxes.<ref name="Jukeboxes"/>
How razorback-jumping frogs can level six piqued gymnasts.<ref name="JumpingFrogs"/>

{{fake heading|sub=3|References}}
{{reflist|refs=
<ref name="LazyDog">This is the lazy dog reference.</ref>
<ref name="Jukeboxes">This is the jukeboxes reference.</ref>
<ref name="JumpingFrogs">This is the jumping frogs reference.</ref>
}}}}

The references will be numbered, and appear in the output, ''in the order that they are first referred to in the content,'' regardless of their order within the list. All references in reference list must be referenced in the content, otherwise an error message will be shown.

Note that when you use the visual editor, you will not be able to add, remove, or change list-defined references.

{{anchor|Embedding references within footnotes}}

==Footnotes: embedding references==
{{shortcut|BTW:REFNEST}}

{{See also|BTW:Nesting footnotes}}

[[Help:Explanatory notes|Explanatory notes]] may need to be referenced. Because of limitations in the [[mw:Extension:Cite|Cite]] software, reference tags cannot be nested; that is, a set of {{tag|ref}} tags cannot be placed inside another pair of {{tag|ref}} tags. Attempting to do so will result in a cite error.

The templates {{tl|r}} and {{tl|refn}} can be used to nest references. The markup is:

:{{tlx|refn|2=group=''group''|3=name=''name''|4=''content''}} or
:{{tlx|r|2=group=''group''|3=name=''name''|4=refn=''content''}} or
:{{tlx|r|2=g=''group''|3=n=''name''|4=r=''content''}} (shorter)
''name'' and ''group'' being optional parameters. The ''content'' may include {{tag|ref|o}} tags or another {{tl|r}} template.

The other templates listed below in [[#Footnotes: predefined groups|Predefined groups]] are variants of {{tl|refn}} that include a styled group and have a matching styled reference list template.

Examples:

===Using {{tl|refn}}===
{{markup
|<nowiki>The quick brown fox jumps over the lazy dog.{{refn|group=nb|A footnote.<ref>A reference for the footnote.</ref>}}

==Notes==
{{reflist|group=nb}}

==References==
{{reflist}}
</nowiki>
|The quick brown fox jumps over the lazy dog.{{refn|group=nb|A footnote.<ref>A reference for the footnote.</ref>}}

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

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

===Using {{tl|r}}===
{{markup
|<nowiki>The quick brown fox jumps over the lazy dog.{{r|g=nb|r=A footnote.{{r|r=A reference for the footnote.}}}}

==Notes==
{{reflist|group=nb}}

==References==
{{reflist}}
</nowiki>
|The quick brown fox jumps over the lazy dog.{{r|g=nb|r=A footnote.{{r|r=A reference for the footnote.}}}}

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

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

The use of the magic word <code>#tag:ref</code> is valid, but the sequence of parameters is invariant and nonintuitive. {{tl|r}} as well as {{tl|refn}} and its variants use this markup internally.

:<code>{{#tag:ref|<var>refcontent</var>|group=<var>groupname</var>|name=<var>name</var>}}</code>
{{anchor|Grouping footnotes}}

==Footnotes: groups==
{{shortcut|BTW:REFGROUP|BTW:CITELABEL}}

Sometimes it is useful to group the footnotes into separate lists, for example to separate explanatory notes from references, or to list references for tables, image captions, infoboxes and navboxes. The sequence of footnote labels is independent in each group.

The syntax to define a footnote with a group is:
:{{tag|ref|params=group=<var>groupname</var>|content=Content}}

The footnote marker group name ''must'' be enclosed in quotes if the group name includes a space, else a cite error will occur, otherwise quotes are optional.

The syntax for the reference list with a group is:
:{{tlx|reflist|2=group=<var>groupname</var>}}

The reference list group name does not need to be enclosed in quotes.

Example:
{{markup
|<nowiki>This part of the text requires clarification,<ref group=note>Listed separately from the citation</ref> whereas the entire text is cited.<ref>Citation.</ref> And this needs even more clarification.<ref group=note>Another note</ref>

==Notes==
{{reflist|group=note}}

==References==
{{reflist}}</nowiki>
|This part of the text requires clarification,<ref group=note>Listed separately from the citation</ref> whereas the entire text is cited.<ref>Citation</ref> And this needs even more clarification.<ref group=note>Another note</ref>

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

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

Note that the footnote labels in the reference list show only the numbers and not the group name.

When using both names and groups, the syntax is:

:{{tag|ref|params=group="<var>groupname</var>" name="<var>name</var>"|content=Content}}

For the repeated note:

:{{tag|ref|s|params=group="<var>groupname</var>" name="<var>name</var>"}}

==Footnotes: predefined groups==
{{shortcut|H:PREGROUP|BTW:EXPLNOTE}}
{{for|technical details|Help:Cite link labels}}
{{for|Shortened footnotes with explanatory footnotes|Help:Shortened footnotes#Explanatory notes}}
{{See also|BattleTechWiki:Citing sources#Variation in citation methods|BattleTechWiki:Manual of Style/Layout#Notes and references}}
<section begin=pregroup />{{anchor|footnotes_predefined_groups}}
There are several predefined groups that can have a reference list styled so that the label (a superscripted character within square brackets, e.g., {{dummy ref|1}}) of an [[Help:Explanatory notes|explanatory note]] or citation ({{aka}} footnote, reference) matches and links to the note marker label located in the main text and the label in front of the note's text in the appropriate group's list. There can be [[BattleTechWiki:Citing sources#Separating citations from explanatory footnotes|more than one of these groups' lists]] in the Notes, References and other similarly purposed sections.

These predefined note and citation groups have templates that make the [[wikitext]] markup simpler. These templates also allow a standard reference to be inserted, so that an explanatory note can have a reference, or citations can be nested.

'''Note:''' If the note's text has a reference name that is used more than once, the labels will still match, but the clickable alpha characters that toggle the note's display will be ''next to'' the note's label, with links to the multiple locations of its marker in the main text. See [[Help:Footnotes#Footnotes: using a source more than once|BTW:REFNAME]] and the first point below in [[#Issues|§ Issues]].

===Template use by reference group type===
<section begin=pregrouptable />
{| class="wikitable"
|- style="vertical-align:top;"
! Group type !! Footnote marker template<br/>or markup !! Reference list<br/> template !! Sample labels
|-
|rowspan=3|''none by default, but optionally any'' || {{tag|ref}}
|rowspan=3| {{tlx|reflist}}
|rowspan=3| 1 2 3 4 5 6 7 8 9 10
|-
| {{tlx|r}} (for nested references)
|-
| {{tlx|refn}} (for nested references)
|-
| lower-alpha || {{tlx|efn}}<br />{{tlx|efn-la}} || {{tlx|notelist}}<br />{{tlx|notelist-la}} || 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 || {{tlx|efn-lg}} || {{tlx|notelist-lg}} || α β γ δ ε ζ η θ ι κ
|-
|note || {{tlx|NoteTag}} || {{tlx|NoteFoot}} || note 1 note 2 note 3
|}<section end=pregrouptable />

* {{tlx|efn}} supports {{para|name}} and {{para|group}}, which work the same as the parameters in {{tag|ref|o}} (see, for instance, the 3rd and 4th examples below). Do not enclose values in quotes.
* {{tlx|notelist}} supports the {{para|colwidth}}, {{para|refs}}, and {{para|group}} parameters, 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}}
}}
'''Note''': With named references you only need to add the details once. For each use after the first you just need to re-use the reference name. Doing this will not cause the inline superscript to display a custom name.

{{markup|title=Named references can also be 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}}
}}
}}
'''Note''': Due to limitations in the MediaWiki software, do not use list defined footnotes that contain references.

==Footnotes: page numbers==
{{main|Help:References and page numbers}}

Suppose you would like to cite one book, but different facts appear on different pages. You would like to cite the book again and again, but point each fact to the proper page. Suppose one fact is on page 8, a different fact on page 12, a third fact on page 18, a fourth fact on page 241. You could put a line in the "pages" parameter saying "see pages 8, 12, 18, 241" but a fact-checker might have to check all of them before figuring out the right one. Or, you could duplicate the entire citation for the book in each instance, but that would be redundant.

One common approach is to use [[Help:Shortened footnotes|shortened citations]]. The long citation to support the shortened citations can either be placed as a bullet point in a separate ''References section'' after the ''Footnotes section''; or it can be placed in the first footnote to cite the source (with the initial relevant page number[s]). The remaining footnotes will use shortened citations (these usually contain the author's last name, the date of publication, and the relevant page number[s]).

A less common approach is to attach a {{tlx|rp|8}} right after the footnote marker and replace the "8" with the appropriate page number. For example:

{{markup
|<nowiki>Schudson said the Constitution shaped citizenship in fundamental ways.<ref name="Schudson">{{Cite book |last=Schudson |first=Michael |title=The Good Citizen: A Brief History of American Civic Life |publisher=Simon & Schuster |date=1998 |url=https://books.google.com/books?id=aawMAQAAMAAJ |isbn=0-684-82729-8}}</ref>{{rp|8}} But elections in early American politics did not generate much interest<ref name="Schudson"/>{{rp|12}} while "open discussion of differences" was generally avoided.<ref name="Schudson"/>{{rp|18}} Citizenship later shifted to a polity of essentially "self-absorbed citizens", according to his analysis.<ref name="Schudson"/>{{rp|241}}</nowiki>
|Schudson said the Constitution shaped citizenship in fundamental ways.<ref name="Schudson">{{Cite book |last=Schudson |first=Michael |title=The Good Citizen: A Brief History of American Civic Life |publisher=Simon & Schuster |date=1998 |url=https://books.google.com/books?id=aawMAQAAMAAJ |isbn=0-684-82729-8}}</ref>{{rp|8}} But elections in early American politics did not generate much interest<ref name="Schudson"/>{{rp|12}} while "open discussion of differences" was generally avoided.<ref name="Schudson"/>{{rp|18}} Citizenship later shifted to a polity of essentially "self-absorbed citizens", according to his analysis.<ref name="Schudson"/>{{rp|241}}
{{fake heading|sub=3|References}}
{{reflist}}
}}

{{tlx|r}} compactly combines the functions of <code><nowiki><ref></nowiki></code> and {{t|rp}}: <code><nowiki>{{r|Schudson}}</nowiki></code> is equivalent to <code><nowiki><ref name="Schudson"/></nowiki></code> and <code><nowiki>{{r|Schudson|p=241}}</nowiki></code> is equivalent to <code><nowiki><ref name="Schudson"/>{{rp|241}}</nowiki></code>.

==Previewing edits==
When you [[Help:Section#Section editing|edit a single section]] of a page, the footnotes list will be visible when you [[Help:Show preview|preview your edits]] under the heading "Preview of references", although you will still not be able to see named references whose definition is outside the section you are editing.

Tools that can be used are the [[user:js/ajaxPreview]] or [[User:Anomie/ajaxpreview.js]] scripts or the [[User:Cacycle/wikEd|wikEd]] gadget.

== Flagging inadequate referencing ==
{{See also | Template: Unreferenced/doc#Usage|Template:Citation style}}
* The template {{Tlx|Refimprove}} should be added to articles where there are '''some, but insufficient, inline citations to support the material''' currently in the article.
* The template {{Tlx|Unreferenced}} should be added to articles with '''no references at all'''.
* The template {{Tlx|Unreferenced section}} is for '''individual sections that have no citations''' in articles that have at least one citation somewhere else.
* The template {{Tlx|Medref}} is specifically for articles '''needing additional ''medical'' references'''.

==See also==
* [[BattleTechWiki:Requests for comment]]—to ask questions about using footnotes in articles if you were not able to find the information you need on this help page.
{{BattleTechWiki referencing}}

← Older revision		Revision as of 21:59, 30 April 2025
Line 1:		Line 1:
	<noinclude>{{pp-semi-indef}}</noinclude>		<noinclude>{{pp-semi-indef}}</noinclude>
	{{For\|the official guideline on citing sources\|~~BattleTechWiki~~:Citing sources}}		{{For\|the official guideline on citing sources\|BattleIntelligence:Citing sources}}
	{{For\|help with citation templates\|Help:Citation Style 1}}		{{For\|help with citation templates\|Help:Citation Style 1}}
	{{Redirect\|BTW:NOTES\|hatnotes\|~~BattleTechWiki~~:Hatnote\|article layout of footnotes\|MOS:NOTES}}		{{Redirect\|BTW:NOTES\|hatnotes\|BattleIntelligence:Hatnote\|article layout of footnotes\|MOS:NOTES}}
	{{How to\|H:FOOT\|BTW:FOOTNOTES\|H:FN}}		{{How to\|H:FOOT\|BTW:FOOTNOTES\|H:FN}}

	This page explains how to create the '''Footnotes''' section for ~~BattleTechWiki~~ articles. In this context, the word "Footnotes" refers to the ~~BattleTechWiki~~-specific manner of documenting an article's sources and providing tangential information, and should not be confused with the general concept of [[Note (typography)\|footnotes]]. This how-to does not cover the formatting of citations within the Footnotes section, which is reviewed in [[~~BattleTechWiki~~:Citing sources\|Citing sources]].		This page explains how to create the '''Footnotes''' section for BattleIntelligence articles. In this context, the word "Footnotes" refers to the BattleIntelligence-specific manner of documenting an article's sources and providing tangential information, and should not be confused with the general concept of [[Note (typography)\|footnotes]]. This how-to does not cover the formatting of citations within the Footnotes section, which is reviewed in [[BattleIntelligence:Citing sources\|Citing sources]].

	Footnotes are used most commonly to provide:		Footnotes are used most commonly to provide:
	* [[~~BattleTechWiki~~:Citing sources\|references (bibliographic citations) to reliable sources]],		* [[BattleIntelligence:Citing sources\|references (bibliographic citations) to reliable sources]],
	* [[Help:explanatory notes\|explanatory information]], or		* [[Help:explanatory notes\|explanatory information]], or
	* source information for tables and other elements.		* source information for tables and other elements.
Line 14:		Line 14:
	Footnotes or [[Help:Shortened footnotes\|shortened footnotes]] may be used at the editor's discretion in accordance with the guideline on [[BTW:CITEVAR\|Variation in citation methods]].		Footnotes or [[Help:Shortened footnotes\|shortened footnotes]] may be used at the editor's discretion in accordance with the guideline on [[BTW:CITEVAR\|Variation in citation methods]].

	Only certain types of material on the English ~~BattleTechWiki~~ are required to have an inline citation. There is [[~~BattleTechWiki~~:Inline citation#Citation density\|no requirement to provide a citation for every sentence]], because multiple sentences may be supported by the same footnote. For advice on which material should be cited, see the guidelines on [[BTW:MINREF\|When you must use inline citations]], the [[~~BattleTechWiki~~:Good article criteria\|Good article criteria]] and [[~~BattleTechWiki~~:when to cite\|When to cite]]. For advice on how to organize and format bibliographic citations, see the guideline on [[~~BattleTechWiki~~:Citing sources\|Citing sources]] and examples of [[~~BattleTechWiki~~:Citation templates#Examples\|Citation templates]].		Only certain types of material on the English BattleIntelligence are required to have an inline citation. There is [[BattleIntelligence:Inline citation#Citation density\|no requirement to provide a citation for every sentence]], because multiple sentences may be supported by the same footnote. For advice on which material should be cited, see the guidelines on [[BTW:MINREF\|When you must use inline citations]], the [[BattleIntelligence:Good article criteria\|Good article criteria]] and [[BattleIntelligence:when to cite\|When to cite]]. For advice on how to organize and format bibliographic citations, see the guideline on [[BattleIntelligence:Citing sources\|Citing sources]] and examples of [[BattleIntelligence:Citation templates#Examples\|Citation templates]].

	Footnotes are created using the [[mw:Extension:Cite\|Cite]] software extension. This extension adds the HTML-like elements {{tag\|ref}}, {{tag\|references\|s}} and {{tag\|references}}. The elements are also used in a number of templates; for example, it is becoming more common to use {{tl\|reflist}} rather than {{tag\|references\|s}} as it can style the reference list.		Footnotes are created using the [[mw:Extension:Cite\|Cite]] software extension. This extension adds the HTML-like elements {{tag\|ref}}, {{tag\|references\|s}} and {{tag\|references}}. The elements are also used in a number of templates; for example, it is becoming more common to use {{tl\|reflist}} rather than {{tag\|references\|s}} as it can style the reference list.
Line 117:		Line 117:
	{{Anchor\|Reference name (naming a ref tag so it can be used more than once)}}		{{Anchor\|Reference name (naming a ref tag so it can be used more than once)}}
	{{Anchor\|BTW:NAMEDREF}} <!-- from BTW:NAMEDREFS redirect -->		{{Anchor\|BTW:NAMEDREF}} <!-- from BTW:NAMEDREFS redirect -->
	{{See also\|~~BattleTechWiki~~:Citing sources#Citing multiple pages of the same source}}		{{See also\|BattleIntelligence:Citing sources#Citing multiple pages of the same source}}
	You can cite the same source more than once on a page by using '''named references''', also called named footnotes. The syntax to define a named footnote is:		You can cite the same source more than once on a page by using '''named references''', also called named footnotes. The syntax to define a named footnote is:
	:{{tag\|ref\|params=name="<var>name</var>"\|content=<var>content</var>}}		:{{tag\|ref\|params=name="<var>name</var>"\|content=<var>content</var>}}
Line 126:		Line 126:
	{{refname rules}}		{{refname rules}}

	Note that the colon-followed-by-numeral names, like <code>":0"</code>, are currently [[~~BattleTechWiki~~:Village_pump_(technical)/Archive_173#VisualEditor_creating_bad_ref_names\|generated by default]] in [[BTW:VE\|VisualEditor]].		Note that the colon-followed-by-numeral names, like <code>":0"</code>, are currently [[BattleIntelligence:Village_pump_(technical)/Archive_173#VisualEditor_creating_bad_ref_names\|generated by default]] in [[BTW:VE\|VisualEditor]].

	{{markup		{{markup
Line 147:		Line 147:
	When using both names and [[#Footnotes:_groups\|groups]], the syntax is:		When using both names and [[#Footnotes:_groups\|groups]], the syntax is:
	:{{tag\|ref\|params=group="<var>groupname</var>" name="<var>name</var>"\|content=Content}}		:{{tag\|ref\|params=group="<var>groupname</var>" name="<var>name</var>"\|content=Content}}
	Care should be taken when deleting references to avoid creating a cite error. See [[~~BattleTechWiki~~:Avoiding common mistakes#Deleting...\|Avoiding common mistakes]].		Care should be taken when deleting references to avoid creating a cite error. See [[BattleIntelligence:Avoiding common mistakes#Deleting...\|Avoiding common mistakes]].

	==Reference lists: columns==		==Reference lists: columns==
Line 339:		Line 339:
	{{for\|technical details\|Help:Cite link labels}}		{{for\|technical details\|Help:Cite link labels}}
	{{for\|Shortened footnotes with explanatory footnotes\|Help:Shortened footnotes#Explanatory notes}}		{{for\|Shortened footnotes with explanatory footnotes\|Help:Shortened footnotes#Explanatory notes}}
	{{See also\|~~BattleTechWiki~~:Citing sources#Variation in citation methods\|~~BattleTechWiki~~:Manual of Style/Layout#Notes and references}}		{{See also\|BattleIntelligence:Citing sources#Variation in citation methods\|BattleIntelligence:Manual of Style/Layout#Notes and references}}
	<section begin=pregroup /><!--this section is used as the documentation for the efn/notelist templates-->{{anchor\|footnotes_predefined_groups}}		<section begin=pregroup /><!--this section is used as the documentation for the efn/notelist templates-->{{anchor\|footnotes_predefined_groups}}
	There are several predefined groups that can have a reference list styled so that the label (a superscripted character within square brackets, e.g., {{dummy ref\|1}}) of an [[Help:Explanatory notes\|explanatory note]] or citation ({{aka}} footnote, reference) matches and links to the note marker label located in the main text and the label in front of the note's text in the appropriate group's list. There can be [[~~BattleTechWiki~~:Citing sources#Separating citations from explanatory footnotes\|more than one of these groups' lists]] in the Notes, References and other similarly purposed sections.		There are several predefined groups that can have a reference list styled so that the label (a superscripted character within square brackets, e.g., {{dummy ref\|1}}) of an [[Help:Explanatory notes\|explanatory note]] or citation ({{aka}} footnote, reference) matches and links to the note marker label located in the main text and the label in front of the note's text in the appropriate group's list. There can be [[BattleIntelligence:Citing sources#Separating citations from explanatory footnotes\|more than one of these groups' lists]] in the Notes, References and other similarly purposed sections.

	These predefined note and citation groups have templates that make the [[wikitext]] markup simpler. These templates also allow a standard reference to be inserted, so that an explanatory note can have a reference, or citations can be nested.		These predefined note and citation groups have templates that make the [[wikitext]] markup simpler. These templates also allow a standard reference to be inserted, so that an explanatory note can have a reference, or citations can be nested.
Line 455:		Line 455:

	==See also==		==See also==
	* [[~~BattleTechWiki~~:Requests for comment]]—to ask questions about using footnotes in articles if you were not able to find the information you need on this help page.		* [[BattleIntelligence:Requests for comment]]—to ask questions about using footnotes in articles if you were not able to find the information you need on this help page.
	{{~~BattleTechWiki~~ referencing}}		{{BattleIntelligence referencing}}