Editing Template:Ref/doc

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 20: Line 20:
 
Identifier for a note and its back link (mandatory). This is the only mandatory parameter for {{t|ref}} and {{t|note}} couple, which can be used to add simple footnotes.
 
Identifier for a note and its back link (mandatory). This is the only mandatory parameter for {{t|ref}} and {{t|note}} couple, which can be used to add simple footnotes.
  
Every pair of {{t|ref}} and {{t|note}}, as well as every pair of {{t|ref label}} and {{t|note label}}, should have unique identifiers. This applies even if two references pointing to the same footnote are desired. (Correct method of implementing this feature is illustrated further below.) Duplicate identifiers generate invalid code, to which web browsers react differently. Some browsers report errors, while others may randomly keep one ''id'' and discard others silently. In all cases, however, navigation between some footnote marks and their body texts does not work as desired.
+
Every pair of {{t|ref}} and {{t|note}}, as well as every pair of {{t|ref label}} and {{t|note label}}, should have unique identifiers. This applies even if two references pointing to the same footnote are desired. (Correct method of implementing this feature is illustrated further below.) Duplicate identifiers generate invalid code, to which web browsers react differently. Some browsers report errors, while others may randomly keep one ''id'' and discard others silently. In all cases, however, navigation between some footnote marks and their body texts does not work as desired. See [[Help:Markup validation]].
  
 
{| class=wikitable
 
{| class=wikitable
Line 67: Line 67:
 
This parameter is optional in {{t|ref}} and {{t|note}}, therefore:
 
This parameter is optional in {{t|ref}} and {{t|note}}, therefore:
 
*{{t|Ref}} displays a unique number in square brackets if this parameter is omitted. (See example above.)
 
*{{t|Ref}} displays a unique number in square brackets if this parameter is omitted. (See example above.)
*{{t|Note}} appends this label to a back linked caret (^), so if omitted, only a caret is displayed. (See example above.)
+
*{{t|Note}} appends this label to a back linked [[caret]] (^), so if omitted, only a caret is displayed. (See example above.)
  
 
There is no mandate to include this parameter in both ref and note portion at the same time. In fact, there may be the need to do the opposite. This example shows how to use {{t|ref}} and {{t|note}} to link multiple footnote markers of the same appearance to the same footnote.
 
There is no mandate to include this parameter in both ref and note portion at the same time. In fact, there may be the need to do the opposite. This example shows how to use {{t|ref}} and {{t|note}} to link multiple footnote markers of the same appearance to the same footnote.
Line 191: Line 191:
 
|}
 
|}
  
Since the footnote body text starts without a delimiter after this string, there is a caveat: If the footnote body text start with a lowercase letter, the first word may be attached to the back link.  
+
Since the footnote body text starts without a delimiter after this string, there is a caveat: If the footnote body text start with a lowercase letter, the first word may be attached to the back link. (For more info, see [[Help:Wikilinks]].)
 
{| class=wikitable
 
{| class=wikitable
 
|+ Example of ''backlink'' bug
 
|+ Example of ''backlink'' bug
Line 280: Line 280:
  
 
=== Table footnotes ===
 
=== Table footnotes ===
One common application for ref and note templates is in placing footnotes below tables, as in the following example:
+
One common application for ref and note templates is in placing footnotes below tables, as in the following example taken from the [[Kent#Economy]] article:
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 309: Line 309:
  
 
== Alternative referencing style ==
 
== Alternative referencing style ==
Using ref/note tags is not the only way to create footnotes. [[mw:Extension:Cite/Cite.php|Cite.php]] is currently the preferred method of creating footnotes, especially when the number of footnotes increases and the size of the article (or the area in which footnotes are used) grows.
+
Using ref/note tags is not the only way to create [[Help:Footnotes|footnotes]]. [[mw:Extension:Cite/Cite.php|Cite.php]] is currently the preferred method of creating footnotes, especially when the number of footnotes increases and the size of the article (or the area in which footnotes are used) grows. [[User:Cyde/Ref converter|Ref converter]] can convert ref/note tags to the newer Cite.php style.
  
 
The following examples compares two method and also shows how they can be combined:
 
The following examples compares two method and also shows how they can be combined:
Line 346: Line 346:
 
== See also ==
 
== See also ==
 
* [[Wikipedia:Footnote3]] — An essay on this footnote-creation method
 
* [[Wikipedia:Footnote3]] — An essay on this footnote-creation method
 +
* [[Help:Footnotes]]
 
* [[Wikipedia:Template messages/Sources of articles]]
 
* [[Wikipedia:Template messages/Sources of articles]]
 +
* [[:Category:Citation templates]] — More citation templates, some of which are not part of the Ref/Note Label system
 +
 +
{{Wikipedia referencing}}
  
 
<includeonly>
 
<includeonly>

Please note that all contributions to RimWorld Wiki are considered to be released under the CC BY-SA 3.0 (see RimWorld Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)