แม่แบบ:Ref/doc

This documentation is for the ref, note, ref label and note label templates. The note templates place notes into an article, and the ref templates place labeled references to the notes, with the labels normally hyperlinks for navigating from a ref to a corresponding note and back from the note to the ref. The label pair of templates are similar to the pair without the label name, but with more features.
The links and backlinks are identified internally by combining the specified parameters. The templates accepts a number of unnamed parameters identified by their position. It also accepts a named parameter (named noid) which is deprecated since its introduction.
The first parameter of ref is a label that has to be used for the parameter of the corresponding note. The label is used to form the fragment identifier for the footnote link and back link. The second parameter of ref is the footnote reference marker, shown as a superscript. The easiest choice is to make these two the same, but this is not a requirement. If the second parameter is not supplied, the marker is a superscripted external link of the form n.

**Syntax**
The following illustrates the general syntax of each template:- text- text
Description of each parameter is as follows:

**id**
Identifier for a note and its back link (mandatory). This is the only mandatory parameter for a ref and note couple, which can be used to add simple footnotes.
Important note: Every pair of ref and note, as well as every pair of ref label and note label, should have unique identifiers. This applies even if multiple references pointing to the same footnote are desired. (Correct method of implementing this feature – using the label parameter – 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.

**label**
Label text displayed where these templates are inserted (mandatory for ref label and note label). The following explains template specific behavior:
*In ref, ref label and note label, the label appears in superscript; in note, the label appears as standard-sized baseline bold text.
*In ref, ref label and note, the label is also hyperlinked and helps navigating back and forth between the inline footnote marker (in the prose) and its body text. note label, however, does not attach a hyperlink to the label but disregards this parameter when the backlink parameter (explained later) is present.
*In ref label, the label is always enclosed in brackets.
This parameter is optional in ref and note, therefore:
*ref displays a unique number in square brackets if this parameter is omitted. (See example above.)
*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 ref and note to link multiple footnote markers of the same appearance to the same footnote.

**backlink**
As explained above, note label does not generate a back link from label parameter. A unique parameter of ref label – note label, backlink is a complementary parameter that is part id and part label:
*"Complementary parameter" means a ref label – note label pair may either forgo this parameter or must both have it.
*"Part id" means in a ref label – note label pair, both ends must have the same backlink value. In addition, in any ref label – note label pair, the combination of id and backlink must be unique.
*"Part label" means in note label, this parameter completely overrides label parameter.
A ref label with a backlink cannot connect to a note. Likewise, a note label with a backlink cannot connect to a ref.
Example:
This parameter (backlink) also accepts the special value "none" (without quotation marks), which causes a caret to appear where note label is placed.

**text**
In all previous examples, the body text of a piece of footnote was inserted outside note or note label template. However, it is possible to insert the body text inside the template, in place of text parameter. Everything put inside text parameter glows when the user clicks on the footnote mark. In the example below, try clicking on S and T and see the difference.
Since the footnote body text starts without a delimiter after this string, there is a caveat: If the footnote body text starts with a lowercase letter, the first word may be attached to the back link. (For more info, see Help:Wikilinks.)

**noid=noid**
Deprecated parameter – Suppresses back linking from note component to ref. In case of note, an active hyperlink still appears, although it is broken.
This parameter was originally meant to alleviate the problem of connecting many ref tags with the same ID to one note tag with that ID. However, it only replaces one form of broken code with another. Consider using note label instead, which does not generate any back link unless configured to do so. There must always be one and only one note template for every ref template with the same id.

**Additional examples**
} more text2 more text3 more text4 more textnone more text more text.8- intervening text- 1Text of note for ref a.- 2Text of note for ref b.- ABCDEText of note for ref c.- FGHIJText of note for ref d.- noneText of note for ref e.- fText of note for ref f.
Article text1 more text more text2 more text3 more text4 more textnone more text more text.8
*intervening text
*1Text of note for ref a.
*2Text of note for ref b.
*ABCDEText of note for ref c.
*FGHIJText of note for ref d.
*noneText of note for ref e.
*fText of note for ref f.

**Unique ID issue**
As explained earlier, the id parameter for every ref – note pair should be unique. The following example shows what happens when two refs use the same id. Try navigating from bulleted text to footnotes and back.

**Table footnotes**
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 section:
Components may not sum to totals due to rounding
Includes energy and construction
Includes financial intermediation services indirectly measured

**Alternative referencing style**
The Reference Tooltips gadget does not work with these templates. Using ref/note tags is not the only way to create footnotes. Cite.php (with which Reference Tooltips does work) 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. 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:
Also see examples and explanation in Wikipedia:Footnote3.

**See also**
 Wikipedia:Footnote3, an essay on this method of creating footnotes- Help:Footnotes- Wikipedia:Template messages/Sources of articles- :Category:Citation templates, including those not part of the ref–note label system- Rp- Template:Ref/examples