CZ:Related Articles: Difference between revisions

From Citizendium
Jump to navigation Jump to search
imported>Larry Sanger
imported>Larry Sanger
Line 27: Line 27:


== Subpage-specific procedures ==
== Subpage-specific procedures ==
=== Use of the {{Tl|r}} template ===
=== The {{Tl|r}} template ===


You could, but should not, write links like this:
You could, but should not, write links like this:
Line 33: Line 33:
:<code><nowiki>* [[Philosophy]]: The study of the meaning and justification of beliefs about the most general, or universal, aspects of things.</nowiki></code>
:<code><nowiki>* [[Philosophy]]: The study of the meaning and justification of beliefs about the most general, or universal, aspects of things.</nowiki></code>


Instead, write links using the {{Tl|r}} template, like this:
Instead, write links using the {{Tl|r}} (for "related") template, like this:


:<code><nowiki>{{r|Philosophy}}</nowiki></code>
:<code><nowiki>{{r|Philosophy}}</nowiki></code>
Line 40: Line 40:


{{r|Philosophy}}
{{r|Philosophy}}
The {{tl|r}} template is a little template that does a lot:
* First, it automatically produces a bullet point.
* Next, it grabs the term's definition from--in the example in question--the {{tl|def philosophy}} template.  The reason the definition is grabbed from a separate template is so that the same definition can be conveniently reused and updated from a single predictable location.  Don't worry, though: you won't have to remember anything but {{tl|r}}.
Following that there are two tiny links, [r] and [e]:
* The [r] link takes the user to the Related Articles page of the topic in question.  In the example above, while the main link points to [[Philosophy]], the [r] link points to [[Philosophy/Related]].  This will be handy for people working on Related Articles subpages systematically; see below.
* The [e] link takes one to the definition template for the topic in question.  In the example above, the [e] link points to {{tl|def philosophy}}.
=== How to use the {{Tl|r}} template ===
Here's how to fill out a list of related articles (with definitions).
The first step is to write out the links as follows (flush left):
:...
:<code><nowiki>{{r|Topic1}}</nowiki></code>
:<code><nowiki>{{r|Topic2}}</nowiki></code>
:<code><nowiki>{{r|Topic3}}</nowiki></code>
:...
This will initially produce the following (if no definitions exist for the topics in question):
{{r|Topic1}}
{{r|Topic2}}
{{r|Topic3}}
Note the link, [[Template:Def Topic1]].  ''Click on that link to write a definition for 'Topic1'.''


=== Suggestion for contributors ===
=== Suggestion for contributors ===

Revision as of 06:29, 18 July 2007

What are Related Articles pages?

"Related Articles" pages, such as Biology/Related, link to a hand-picked set of other Citizendium articles. These pages list subtopics, parent topics, and other related topics. They also list, or should list, definitions of each linked-to article.

Purpose

Taken together, "Related Articles" pages will compose a hand-created category scheme. This could be of great help not only to Citizendium users who are looking for more general or more specific information, but also to designers of taxonomies and other tools for search and artificial intelligence.

Moreover, with definitions listed with each topic, the list of "related topics" serves double duty as a glossary of related terms.

Heading and format standards

Canonical headings for Related Articles lists

The following is a canonical list of "related articles" headings. Please either use a heading from this list or, f you do not see an appropriate heading, please add to the list.

  • Parent topics
  • Subtopics
    • Subdisciplines
  • Other related topics

How to link to articles

Links should be created using bulleted lists and, where there are more than a dozen entries or so, two columns, created using {{col-begin}}, {{col-break}}, and {{col-end}}.

Links should also be created using the {{r}} template. See "subpage-specific procedures" below for usage notes.

Subpage-specific procedures

The {{r}} template

You could, but should not, write links like this:

* [[Philosophy]]: The study of the meaning and justification of beliefs about the most general, or universal, aspects of things.

Instead, write links using the {{r}} (for "related") template, like this:

{{r|Philosophy}}

This then displays as follows:

  • Philosophy [r]: The study of the meaning and justification of beliefs about the most general, or universal, aspects of things. [e]

The {{r}} template is a little template that does a lot:

  • First, it automatically produces a bullet point.
  • Next, it grabs the term's definition from--in the example in question--the {{def philosophy}} template. The reason the definition is grabbed from a separate template is so that the same definition can be conveniently reused and updated from a single predictable location. Don't worry, though: you won't have to remember anything but {{r}}.

Following that there are two tiny links, [r] and [e]:

  • The [r] link takes the user to the Related Articles page of the topic in question. In the example above, while the main link points to Philosophy, the [r] link points to Philosophy/Related. This will be handy for people working on Related Articles subpages systematically; see below.
  • The [e] link takes one to the definition template for the topic in question. In the example above, the [e] link points to {{def philosophy}}.

How to use the {{r}} template

Here's how to fill out a list of related articles (with definitions).

The first step is to write out the links as follows (flush left):

...
{{r|Topic1}}
{{r|Topic2}}
{{r|Topic3}}
...

This will initially produce the following (if no definitions exist for the topics in question):

Note the link, Template:Def Topic1. Click on that link to write a definition for 'Topic1'.

Suggestion for contributors

Boundaries of included content

Back to Subpage Pilot