Template:R/doc
This template is used on CZ:Related Articles pages.
Examples 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]
Two different links (r and e) are present between the brackets.
- [r] links to the Related Articles subpage for the "basename". If no such page exists yet, the link will be red.
- [e] links to the definition subpage for the "basename". You can click the "e" to edit the definition of "Biology".
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|Animal||*::}}
{{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||}}
|
Other features
This template uses color and pictogram indicators to convey other information about the basename that might be useful for an author wishing to know the state of the potential article or cluster. These are described in the following sections.
Ready for Approval
If an article is being recommended for approval this will be noted in the R template by the addition of a green approval logo at the start of the article name. For example, {{r|James Clerk Maxwell}} would look similar to the following if it was up for approval:
James Clerk Maxwell [r]: (1831 – 1879) Scottish physicist best known for his formulation of electromagnetic theory and the statistical theory of gases. [e]
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 three links in the above output:
- "Foobar" is a link to a blank article to be titled "Foobar".
- The r link will preload a page formated to start a Related Articles subpage. To learn what to write there, please see CZ:Related Articles.
- Add brief definition or description 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".
No article but has a definition
If used on an entry that does not exist but does have a definition:
{{r|Dundee}} produces:
- Dundee [r]: A seaport (est. 1995 pop. 168,000) situated on the Firth of Tay, an inlet of the North Sea, in Scotland. [e]
The red link gives the following preload text to allow the creation of a lemma article (see next section).
{{subpages}}
<!-- Text is transcluded from the BASEPAGENAME/Definition subpage-->
With a "definition only" the article link will be red, but by creating a lemma article (article with the preloaded text above) the link does exist and hence no red link. The article actually uses the same text as the definition (the lemma article transcludes text from the definition subpage), consequently, the article does not have to be developed beyond a glossary entry.
Only an article page and a definition exist
This is known as a lemma article, basically nothing more than a definition is expected to be written.
{{r|Foo lemma}} produces:
- Foo lemma [r]: This example of a lemma has only a definition page and an article page with the subpages template. The article transcludes the text from the definition page. The link to the article, when using the R template is shown in black to indicate it has no more content that the definition which can already be seen. [e]
{{r|Foo lemma|Lemma}} produces:
- Lemma [r]: This example of a lemma has only a definition page and an article page with the subpages template. The article transcludes the text from the definition page. The link to the article, when using the R template is shown in black to indicate it has no more content that the definition which can already be seen. [e]
The black text link to the lemma article will remain as an indication to authors that a new article on that topic can/could/should be written if appropriate.
Redirects
If the R template is used on an entry that is a redirect, or a lemma article without a metadata template, the link will appear as black text.
If used on a redirect that does have a definition:
- In this case:-
- 1) the supernova article is a redirect as follows #Redirect [[Nova (astronomy)#Supernova]]:
- 2) and a definition does exist at Supernova/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:
For such an example the normal blue link can be made to appear by using the second variable.
{{r|Functional magnetic resonance imaging|fMRI}} will give:
- FMRI [r]: A neuroimaging technique used to monitor task-specific blood oxygenation, primarily in the brain. [e]
Or a different definition can be written if the terms are distinct enough, such as supernova above. In the latter case, the black text link style will remain as an indication to authors that a new article on that topic can/could/should be written.
On own Related Articles subpage
When this template is used for an article name and is placed on that article, or one of its subpages, it will not show hyperlinks or a definition but just show the term in plain text.
Ambiguous terms
If it is used on a term which is ambiguous (formally, there is a "{Basename} (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.
Thus, one would edit to a more precise link:
{{r|Cell (biology)|Cell}} gives
Code
{{{{3|* }}}{{#ifeq:{{BASEPAGENAME}}|{{{1}}}
|{{#if: {{{2|}}}
|{{{2}}}
|{{{1}}}}}
|{{ {{#ifexist: Image:Level{{Template:{{{1|}}}/Metadata|info=status}}.jpg
|{{#if: {{{2|}}}
|r style1
|r style2 }}
|rpl style3}} |1={{{1|}}} |2={{{2|}}} }} <span class="plainlinks"
style="font-size:0.8em;">{{#ifexist:{{{1}}}/Related Articles|[<nowiki
></nowiki >[[{{{1}}}/Related Articles|r]]<nowiki ></nowiki >]|[<nowiki >
</nowiki >[http://en.citizendium.org/wiki?action=edit&preload=
Template%3ARelated_Articles_start&title={{urlencode:{{{1}}}}}/Related_Articles
<font color=#8B0541>r</font>]<nowiki ></nowiki >]}}</span>: {{ {{#ifexist:
{{{1|}}} (disambiguation)
|dabdef
|{{#ifexist: {{{1|}}}/Definition
|Rpl def1
|Rpl def3}} }}|1={{{1|}}} }} }}
Control color of basename link, pipelink and ToApprove logo
{{ {{#ifexist: Image:Level{{Template:{{{1|}}}/Metadata|info=status}}.jpg
|{{#if: {{{2|}}}
|r style1
|r style2 }}
|rpl style3}} |1={{{1|}}}|2={{{2|}}} }}
R style1
{{ {{#ifexist: Image:Level{{Template:{{{1|}}}/Metadata|info=status}}.jpg
|{{#if:{{Template:{{{1|}}}/Metadata|info=ToA editor}}
|Approval button
|x0 }}
| x0}} }}[[{{{1|}}}|{{{2|}}}]]
R style2
{{ {{#ifexist: Image:Level{{Template:{{{1|}}}/Metadata|info=status}}.jpg
|{{#if:{{Template:{{{1|}}}/Metadata|info=ToA editor}}
|Approval button
|x0 }}
| x0}} }}[[{{{1|}}}]]
Rpl style3
{{#ifexist:{{{1|}}}
|{{#if: {{{2}}}
|[[{{{1|}}}{{!}}<font color=#111111>{{{2|}}}</font>]]
|[[{{{1|}}}{{!}}<font color=#111111>{{{1|}}}</font>]]}}
|{{#ifexist:{{{1|}}}/Definition
|{{#if: {{{2}}}
|[http://en.citizendium.org/wiki?action=edit&
preload=Template%3APreload_Article&title={{urlencode:{{{1}}}}} <font color=#8B0541>{{{2}}}</font>]
|[http://en.citizendium.org/wiki?action=edit&
preload=Template%3APreload_Article&title={{urlencode:{{{1}}}}} <font color=#8B0541>{{{1}}}</font>] }}
|{{#if: {{{2}}}
|[[{{{1|}}}{{!}}{{{2|}}}]]
|[[{{{1|}}}]]}} }} }}
Approval button
[[Image:Approval button.png|14px]]
To add the [r] link to the Related Articles subpage
<span class="plainlinks" style="font-size:0.8em;">{{#ifexist:{{{1}}}/Related Articles|[
[[{{{1}}}/Related Articles|r]]]|[
[http://en.citizendium.org/wiki?action=edit&preload=
Template%3ARelated_Articles_start&title={{urlencode:{{{1}}}}}/Related_Articles
<font color=#8B0541>r</font>]]}}</span>}}
To add definition.
{{ {{#ifexist: {{{1|}}} (disambiguation)
|dabdef
|{{#ifexist: {{{1|}}}/Definition
|Rpl def1
|Rpl def3}} }}|1={{{1|}}} }}
Rpl def1
{{:{{{1}}}/Definition}} <span class="plainlinks" style="font-size:0.8em;">[
[http://en.citizendium.org/wiki?title={{urlencode:{{{1}}}}}/Definition&action=edit e]]</span>}}
Rpl def3
[http://en.citizendium.org/wiki?action=edit&preload=Template%3ADef_preload&title=
{{urlencode:{{{1}}}}}/Definition ''<font color=#666666>Add brief definition or description</font>'']
dabdef
{{#ifexist: Image:Level{{Template:{{{1|}}}/Metadata|info=status}}.jpg
|{{ {{#ifexist: {{{1|}}}/Definition
|Rpl def1
|Rpl def3}}|{{{1|}}} }}
|''<font color=#666666>Please do not use this term in your topic list, because there is no single article
for it. Please substitute a more precise </font>{{#ifexist:{{{1|{{BASEPAGENAME}}}}} (disambiguation)
|<font color=#666666>term. See</font> [[{{{1|{{BASEPAGENAME}}}}} (disambiguation)]]
<font color=#666666>for a list of available, more precise, topics. Please add a new usage if needed.</font>''
|<font color=#666666>term from the disambiguation page. </font>
::Note: currently there is no disambiguation page for '''{{{1|{{BASEPAGENAME}}}}}''',
[http://en.citizendium.org/wiki?action=edit&preload=Template%3APreload-disambig&title=
{{urlencode:{{{1|{{BASEPAGENAME}}}}}}}_(disambiguation) please create one.]''}} }}