Template:R/doc
This template is used on CZ:Related Articles pages.
Example of use
{{r|Biology}} produces:
- Biology [r]: The science of life — of complex, self-organizing, information-processing systems living in the past, present or future. [e]
Adjusting name (variable 2)
The name does not have to be identical to the articles name. This might be useful when the context of the word is not in doubt. For example, on the Biology/Related Articles page it would be better to use the word Cell rather than Cell (biology).
{{r|Cell (biology)}} is seen as:
- Cell (biology) [r]: The basic unit of life, consisting of biochemical networks enclosed by a membrane. [e]
{{r|Cell (biology)|Cell}} is seen as:
Formatting (variable3)
The default formatting is a single non-numbered list element, but this can be overridden using a third variable, which contains a different style. Note that you don't have to give a second argument, to be able to specify the third - just set the second argument to blank, by typing "||", and the name shown will be the same as the link. Some examples include:
| Code | Example |
|---|---|
{{r|Biology}}
{{r|Zoology||**}}
{{r|Cell (biology)|Cell|*::}}
{{r|Ecology||**}}
|
Numbering could also be used:
| Code | Example |
|---|---|
{{r|Biology||#}}
{{r|Genetics||:#}}
{{r|Zoology||:#}}
{{r|Ecology||:#}}
|
In fact, any text you wish can be prepended to the line, using the third argument - or even nothing at all, if that's what you need:
| Code | Example |
|---|---|
{{r|Biology||''See also: ''}}
|
See also: Biology [r]: The science of life — of complex, self-organizing, information-processing systems living in the past, present or future. [e] |
{{r|Biology||}}
|
Biology [r]: The science of life — of complex, self-organizing, information-processing systems living in the past, present or future. [e] |
{{r|Biology}}
**{{r|Zoology||}}
**{{r|Ecology||}}
|
No article or definition
If used on an entry that does not exist or have a definition (e.g. Foobar),
{{r|Foobar}} produces:
Notice that there are four links in the above output:
- "Foobar" is a link to a blank article to be titled "Foobar".
- Add definition is a link to start a definition subpage for "Foobar". You would click on that link and write a definition, and save it, and then it would appear here. To learn what to write there, please see CZ:Definitions. Once you have written a definition, this link will disappear and the definition will appear in its place, as you can see above with the definition of "Biology".
- "e" is another link to a (blank) definition page for "Foobar". But this link will not disappear. (See the "Biology" line above again; you can click the blue "e" on that line and from there, edit the definition of "Biology".
- "r" is a link to the Related Articles page for "Foobar". If no such page exists yet, the link will be red.
No article but has a definition
If used on an entry that does not exist but does have a definition:
{{r|Botany}} produces:
Redirects
If used on an entry that is a redirect, or an article without a metadata template, the link will appear as a purple color.
If used on a redirect that does have a definition:
{{r|Supernova}} produces:
- Supernova [r]: An astronomical object exploding to a brightness similar to that of an entire galaxy. Caused by a catastrophic explosion of either a white dwarf system or an aged star about five times the size of the sun, which occurs when the star collapses; a neutron star or a black hole may be formed as a result, or the explosion results in no remaining compact object. [e]
Or for a redirect without a definition:
{{r|fMRI}} produces:
Ambiguous terms
If it is used on a term which is ambiguous (formally, there is a "{Name} (disambiguation)" page), it instructs that one should not use that term, but pick one of the specific meanings to link to. For example:
{{r|Cell}} gives
- Cell [r]: Please do not use this term in your topic list, because there is no single article for it. Please substitute a more precise term. See Cell (disambiguation) for a list of available, more precise, topics. Please add a new usage if needed.
Any term that you think should have a disambiguation page can be written in the format of {{r|Cell|D}} to see the status of the disambiguation page and if there is a definitions already at the undisambiguated term. {{r|Cell|D}} gives:
- D [r]: Please do not use this term in your topic list, because there is no single article for it. Please substitute a more precise term. See Cell (disambiguation) for a list of available, more precise, topics. Please add a new usage if needed..
To advertise the fact that a disambiguation page is required for the term (in this case cell), the best practice is to add the {{dabdef}} template to the terms definition subpage in the the format of {{dabdef|cell}}. In this way, any related article subpage that links to the cell term with the {{R}} template will display the need for a disambiguation page for the term (as seen above for {{r|Cell}}).