View source for Template:R/doc

This template is used on [[CZ:Related Articles]] pages.

==Examples of use==
<code><nowiki>{{r|Biology}}</nowiki></code> produces: {{r|Biology}}

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)]].

<code><nowiki>{{r|Cell (biology)}}</nowiki></code> is seen as: {{r|Cell (biology)}}

<code><nowiki>{{r|Cell (biology)|Cell}}</nowiki></code> is seen as: {{r|Cell (biology)|Cell}}

===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:
{| Class="wikitable"
!Code
!Example
|-
|width=250px|<pre>
{{r|Biology}}
{{r|Zoology||**}}
{{r|Animal||*::}}
{{r|Ecology||**}}
</pre>
|{{r|Biology}}
{{r|Zoology||**}}
{{r|Animal||*::}}
{{r|Ecology||**}}
|}
Numbering could also be used:
{| Class="wikitable"
!Code
!Example
|-
|width=250px|<pre>
{{r|Biology||#}}
{{r|Genetics||:#}}
{{r|Zoology||:#}}
{{r|Ecology||:#}}
</pre>
|{{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:

{| Class="wikitable"
!Code
!Example
|-
|width=250px|<pre>
{{r|Biology||''See also: ''}}
</pre>
|{{r|Biology||''See also: ''}}
|-
|<pre>
{{r|Biology||}}
</pre>
|{{r|Biology||}}
|-
|
:''<code>Which means you can also do this, if you think it's preferable:</code>''
<pre>
{{r|Biology}}
**{{r|Zoology||}}
**{{r|Ecology||}}
</pre>
|
{{r|Biology}}
**{{r|Zoology||}}
**{{r|Ecology||}}
|}
<!-- We'll stop now, we promise! :-) -->

==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, <nowiki>{{r|James Clerk Maxwell}}</nowiki> would look similar to the following if it was up for approval:

* [[Image:Approval button.png|13px]] [[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]]),  

<code><nowiki>{{r|Foobar}}</nowiki></code> produces: {{r|Foobar}} .

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]].
*  ''<font color=#666666>Add brief definition or description</font>'' 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:

<code><nowiki>{{r|Dundee}}</nowiki></code> produces: {{r|Dundee}}

The red link gives the following preload text to allow the creation of a lemma article (see next section).  
<pre>
{{subpages}}
<!-- Text is transcluded from the BASEPAGENAME/Definition subpage-->
</pre>
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.

<code><nowiki>{{r|Foo lemma}}</nowiki></code> produces: {{r|Foo lemma}}

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 ''<nowiki>#Redirect [[Nova (astronomy)#Supernova]]</nowiki>'':
::2) and a definition does exist at [[Supernova/Definition]].

<code><nowiki>{{r|Supernova}}</nowiki></code> produces: {{r|Supernova}} 

Or for a redirect without a definition:

<code><nowiki>{{r|fMRI}}</nowiki></code> produces: {{r|fMRI}} .

For such an example the normal blue link can be made to appear by using the second variable.

<nowiki>{{r|Functional magnetic resonance imaging|fMRI}}</nowiki> will give: {{r|Functional magnetic resonance imaging|fMRI}}

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:

<nowiki>{{r|Cell}}</nowiki> gives {{r|Cell}}

Thus, one would edit to a more precise link:

<nowiki>{{r|Cell (biology)|Cell}}</nowiki> gives {{r|Cell (biology)|Cell}}

==Code==
<pre>
{{{3|* }}}{{#ifeq:{{BASEPAGENAME}}|{{{1}}}
             |{{{1}}}
             |{{ {{#ifexist: Image:Level{{Template:{{{1|}}}/Metadata|info=status}}.jpg
          |{{#if: {{{2|}}} 
                 |r style1
                 |r style2 }}
          |rpl style3}} |{{{1|}}} |{{{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|}}} }} }}
</pre>
===Control color of basename link, pipelink and ToApprove logo===
<pre>
{{ {{#ifexist: Image:Level{{Template:{{{1|}}}/Metadata|info=status}}.jpg
          |{{#if: {{{2|}}} 
                 |r style1
                 |r style2 }}
          |rpl style3}} |{{{1|}}}|{{{2|}}} }}
</pre>

====[[Template:R style1|R style1]]====
<pre>
{{ {{#ifexist: Image:Level{{Template:{{{1|}}}/Metadata|info=status}}.jpg
          |{{#if:{{Template:{{{1|}}}/Metadata|info=ToA editor}}
                  |Approval button
                  |x0 }}
          | x0}} }}[[{{{1|}}}|{{{2|}}}]]
</pre>

====[[Template:R style2|R style2]]====
<pre>
{{ {{#ifexist: Image:Level{{Template:{{{1|}}}/Metadata|info=status}}.jpg
          |{{#if:{{Template:{{{1|}}}/Metadata|info=ToA editor}}
                  |Approval button
                  |x0 }}
          | x0}} }}[[{{{1|}}}]]
</pre>

====[[Template:Rpl style3|Rpl style3]]====
<pre>
{{#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|}}}]]}} }} }}

</pre>

====[[Template:Approval button|Approval button]]====
<pre>
[[Image:Approval button.png|14px]]&nbsp;
</pre>

===To add the [r] link to the Related Articles subpage===
<pre>
<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>}}
</pre>

===To add definition.===
<pre>
{{ {{#ifexist: {{{1|}}} (disambiguation)
        |dabdef
        |{{#ifexist: {{{1|}}}/Definition
             |Rpl def1
             |Rpl def3}} }}|{{{1|}}} }}
</pre>
====[[Template:Rpl def1|Rpl def1]]====
<pre>
{{:{{{1}}}/Definition}} <span class="plainlinks" style="font-size:0.8em;">[<nowiki></nowiki>
[http://en.citizendium.org/wiki?title={{urlencode:{{{1}}}}}/Definition&action=edit e]<nowiki></nowiki>]</span>}}
</pre>

====[[Template:Rpl def3|Rpl def3]]====
<pre>
[http://en.citizendium.org/wiki?action=edit&preload=Template%3ADef_preload&title=
{{urlencode:{{{1}}}}}/Definition ''<font color=#666666>Add brief definition or description</font>'']
</pre>

====[[Template:dabdef|dabdef]]====
<pre>
{{#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.]''}} }}
</pre>