Template:Remoteref/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

Create a one-way link from a superscript, bracketed, footnote indicator (like this one[3] ) from a Talk page (or any page) to any Citeref-addressable CS1 or CS2 citation present in an article. This template should not be used in mainspace.

Usage

  • {{remoteref|Last1|yyyy}}
  • {{remoteref|Last1|Last2|...|yyyy|article=ArticleName|note=number}}

Quickstart

From the Talk page of an article, code it the same way you would code an {{sfn}}, simply changing 'sfn' to 'remoteref'. Specify param |note=n, if you want a different footnote number than '1' every time.

Parameters

One to five positional parameters, exactly matching the params you would use with {{sfn}} to link to the citation, plus several optional named parameters to expand the range of pages which may be accessed, and specify the "footnote" number.

Positional parameters 1–5 are the same as in template {{sfn}}: typically, one to four author surnames, and a YYYY year. The first author surname (positional param |1=) is required; other authors and the year are required if available in the full citation. If present, year must be the last positional parameter. All parameters except the first are optional.

Basic – these are the same as the parameters of sfn:

  • <last1> – surname of first author or corporate author (required)
  • <last2> – <last4> – positional parameters; surnames of next three authors
  • <year> – four-digit year; may have a lowercase disambiguation letter like 2012a

Supplementary – parameters for configuring the superscript link display and extending its range:

  • |note= – the numeric value to display between brackets; can be any value (optional; default = '1')
  • |article= – article or page title; may be used to link to a full citation at another article or page. By default, targets the article or subjectpage with which the Talk page is associated. (restricted; see param notes)
  • |rev=revision id ("oldid"); may be used to link to a full citation in an old revision of an article (restricted; overrides 'article'; see param notes)
  • |lang= - the language code of the foreign language Wikipedia where the citation is located; requires 'rev' or 'article'; (restricted; see param notes)

Parameter notes

By design, positional parameters 1 – 5 and the page params are the same as parameters in template Sfn. In most cases where {{sfn}} generates a false missing key error, it can be resolved simply by changing sfn to sfnlink and leaving everything else alone.

Optional parameter |rev= is not recommended for use in mainspace. If present, the revision id is sufficient to uniquely identify a particular revision of an article, so param |article= is superfluous in that case. You may, if you wish, use |rev= and |article= together just for the documentary value of having the article named in the wikicode for the benefit of other editors, however when both are present, the value of |article= is ignored and only the |rev= is used.

Param |lang= should not be used in mainspace. In tandem with param |article= or |rev=, it provides linkage to citations on foreign Wikipedias, and is designed primarily for use on Talk pages where another Wikipedia has a citation of interest to discuss here. Almost all foreign Wikipedias support the use of short citations with linkage to full citations, however, German and Finnish Wikipedias do not, so codes de fi may not be used as a value for |lang= and will generate an error. You can use |lang= and |rev= together to link to a citation in an old version of a foreign Wikipedia article (use of |article= is optional in this case; if used, it is of documentary value only and does not affect the result).

Examples

Add the call right after the text you want to remotely reference:

  • The sky is blue.{{remoteref|Young|1981|article=Rayleigh scattering}} ⟶ The sky is blue.[1]
  • ...in Lake Chad.{{remoteref|Gumnior|Thiemeyer|2003|note=17|article=Dufuna canoe}} ⟶ ...in Lake Chad.[17]
  • ''E = MC<sup>2</sup>''.{{remoteref|Einstein|1905e|article=Albert Einstein|note=225}}E = MC2.[225]
  • C'est un calque{{remoteref|Giaufret|Rossi|2013|note=5|lang=fr|article=Trou noir}} ⟶ C'est un calque[5]

The examples above use param |article= because this template page is unrelated to those articles. However, you should leave out the param if you are coding the template from the associated Talk page; that is, from Talk:Rayleigh_scattering or Talk:Dufuna_canoe. In that case, they would look like this instead:

  • {{remoteref|Young|1981}}
  • {{remoteref|Gumnior|Thiemeyer|2003|note=17}}
  • {{remoteref|Einstein|1905e|note=225}}
  • {{remoteref|Giaufret|Rossi|2013|note=5|lang=fr|article=Trou noir}}

and produce the same linked footnote output as the first set.

See also