Template:R/doc

From Citizendium
< Template:R
Revision as of 18:03, 23 February 2009 by imported>Chris Day (→‎Has an article and a definition only)
Jump to navigation Jump to search

This template is used on CZ:Related Articles pages.

Examples of use

{{r|Biology}} produces:

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:

  • Cell [r]: The basic unit of life, consisting of biochemical networks enclosed by a membrane. [e]

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||:#}}
  1. Biology [r]: The science of life — of complex, self-organizing, information-processing systems living in the past, present or future. [e]
  1. Genetics [r]: The study of the inheritance of characteristics, genes and DNA. [e]
  2. Zoology [r]: The scientific study of animals. [e]
  3. Ecology [r]: The study of the distribution and abundance of organisms and how they are affected by the environment. [e]

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]
Which means you can also do this, if you think it's preferable:
{{r|Biology}}
**{{r|Zoology||}}
**{{r|Ecology||}}
  • Biology [r]: The science of life — of complex, self-organizing, information-processing systems living in the past, present or future. [e]
    • Zoology [r]: The scientific study of animals. [e]
    • Ecology [r]: The study of the distribution and abundance of organisms and how they are affected by the environment. [e]

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.

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.

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-->

A lemma article is an advantage since the definition can be used in the R template. With a "definition only" the article link will be red, by creating a lemma that article can exist (hence no red link) and share the same text as the definition (the lemma article transcludes text from the definition subpage), hence, 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]

Redirects

If used on an entry that is a redirect, or an article without a metadata template, the link will appear as a bold italicized blue style.

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:

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:

Or a different definition can be written if the terms are distinct enough, such as supernova above. In the latter case, the bold italicized blue style will remain and is an indication to authors that a new article on that topic can/should be written.

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.

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 definition already at the basename 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..

Action1 (less work)

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

Action2 (more work)

If you intend to solve the problem yourself then the color and pictograms given by the {{R}} template when used in the {{r|basename|D}} format are an indication of the current state of the basename:

  • The color of the basename link can be blue, tan or red and is meaningful:
    • If basename is blue a cluster exists, the article should be moved to a new disambiguated basename and the basename redirected to the diambiguation page.
    • If basename is a bold italicized blue style there are three possible reasons:
      1. A redirect exists, although not necessarily to the disambiguated term.
      2. It is already a disambiguation page and needs to be moved to the the correct location of "basename (disambiguation)"
      3. It is an article without subpages (rarer). This page needs to be moved to a new disambiguated basename and the basename should be redirected to the diambiguation page.
    • If basename is red the page does not exist. This page needs to be redirected to the diambiguation page.
  • Level0.jpg indicates that a disambiguation page has been set up and the old definition page has been deleted.
  • A red "Definition" (and italicised too) below is a link to add a {{speedydelete}} template to the old definition, assuming it has been moved to the new disambiguated location first.

The goal is to have a bold italicized blue style basename (a redirect to the disambiguation page) followed by a green check (indicates the old definition page has been deleted). For example, {{r|Band|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 Band (disambiguation) for a list of available, more precise, topics. Please add a new usage if needed.

Code

{{ {{#ifeq:{{{2|}}}|D
|{{#ifexist: Image:Level{{Template:{{{1|}}}/Metadata|info=status}}.jpg
          |r style2
          |rpl style4}}
|{{#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}}} 
                       |<font color=#111111>[[{{{1|}}}{{!}}{{{2|}}}]]</font>
                       |<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|}}}]]}} }} }}

Rpl style4

{{#ifexist:{{{1|}}}
                 |[[{{{1|}}}{{!}}'''''{{{1|}}}''''']]
                 |[[{{{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.

{{ {{#ifeq:{{{2|}}}|D
      |Rpl def2
      |{{#ifexist: {{{1|}}} (disambiguation)
          |dabdef
          |{{#ifexist: {{{1|}}}/Definition
              |Rpl def1
              |Rpl def3}} }} }}|1={{{1|}}}|2={{{2|}}} }}

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 def2

{{#ifexist: {{{1|}}}/Definition
             |{{#ifexist: {{{1|}}} (disambiguation)
                      |''[http://en.citizendium.org/wiki?title={{urlencode:{{{1|}}}}}/
Definition&action=edit&section=new&preload=Template:Preload-disambig-speedydelete <font 
color="darkred">Definition</font>]'' and disambiguation exist at [[{{{1|}}}/Definition]] and [[{{{1|}}} 
(disambiguation)]]
::''Current definition is:'' {{def|{{{1}}}}}
                      |Definition exists at [[{{{1|}}}/Definition]]; [http://en.citizendium.org/wiki?
action=edit&preload=Template%3APreload-disambig&title={{urlencode:{{{1}}}}}_(disambiguation) ''<font 
color=#666666>please add a disambiguation page</font>''].
::''Current definition is:'' {{def|{{{1}}}}} }}
             |{{#ifexist: {{{1|}}} (disambiguation)
                      |[[Image:Level0.jpg|15px]] Disambiguation exists at [[{{{1|}}} (disambiguation)]]
                      |[http://en.citizendium.org/wiki?action=edit&preload=Template%3APreload-
disambig&title={{urlencode:{{{1}}}}}_(disambiguation) ''<font color=#666666>Please add a disambiguation 
page.</font>''] }} }}

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

''<font color=#666666>Please do not use this term in your topic list, because we do not have a single article for it. 
Please substitute a more precise term. See </font> [[{{{1}}} (disambiguation)]] <font color=#666666>for a list of 
available, more precise, topics.</font>''
Retrieved from "https://citizendium.org/wiki/index.php?title=Template:R/doc&oldid=468727"