CZ:Related Articles: Difference between revisions

From Citizendium
Jump to navigation Jump to search
imported>D. Matt Innis
imported>Gareth Leng
No edit summary
 
(38 intermediate revisions by 6 users not shown)
Line 1: Line 1:
== What are Related Articles pages? ==
This page contains standards and regulations related to Related Articles [[CZ:Subpages|subpages]].


"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.
"Related Articles" pages, such as [[Biology/Related Articles]], link to a hand-picked set of other ''Citizendium'' articles.  These pages list articles under three standard headings: ''Parent topics,'' ''Subtopics,'' and ''Other related topics.'' They also list, or should list, [[CZ:Definitions|definitions]] of each linked-to article.


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


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.  For a good example of this use, see [[Civil society/Related Articles]].
 
=== What links to include ===
"Be bold" when compiling lists of Related Articles.  We have no firm rules.


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 ==
== Heading and format standards ==
 
All Related Articles pages have three "default" headings.   
=== 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, if you do not see an appropriate heading, please add to the list.


* Parent topics
* Parent topics
* Subtopics
* Subtopics
** Subdisciplines
* Other related topics
* Other related topics
These of course can be altered if inapproriate or extended. When there is a group of topics greater than five or so that share some useful classification, a subheading (i.e., a heading that further classifies Subtopics and Other Related Topics) is probably in order.  Subheadings should be used liberally--they are very useful information--but chosen carefully and edited aggressively.  In particular, topics should be chosen so as not to overlap too much.


=== How to link to articles ===
=== 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 {{Tl|col-begin}}, {{Tl|col-break}}, and {{Tl|col-end}}.
Links should be created using bulleted lists and, where there are more than a dozen entries or so, two columns, created using {{Tl|col-begin}}, {{Tl|col-break}}, and {{Tl|col-end}}.


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


== Subpage-specific procedures ==
=== The {{Tl|r}} template ===
=== The {{Tl|r}} template ===
''See also [[CZ:Definitions|Definitions]].''


You could, but should not, write links like this:
You could, but should not, write links like this:
Line 42: Line 41:
The {{tl|r}} template is a little template that does a lot:
The {{tl|r}} template is a little template that does a lot:
* First, it automatically produces a bullet point.
* 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}}.
* Next, it grabs the term's definition from--in the example in question--[[Philosophy/Definition]].   
Following that, there are two tiny links, [r] and [e]:
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 [r] link takes the user to the Related Articles page of the topic in question.  .
* 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}}.
* The [e] link takes one to the definition template for the topic in question.   
 
Note: use the ''singular'' form of the topic name, i.e., the same as the article title.  For example, when constructing the Related Articles page for the "Cat" article, or [[Cat/Related Articles]], you should list "lion" rather than "lions".
 
== Guidelines for editing ==


=== How to use the {{Tl|r}} template ===
=== How to use the {{Tl|r}} template ===
''See also [[CZ:Definitions|Definitions]] for our definition policy, and [[Template:R]] for technical notes.''


Here's how to fill out a list of related articles (with definitions).
Here's how to fill out a list of related articles (with definitions).
Line 63: Line 67:
{{r|Topic2}}
{{r|Topic2}}
{{r|Topic3}}
{{r|Topic3}}
The [[Topic1]] link is to the article titled 'Topic1'.  (It will be red if it doesn't exist yet.)  Following that is the link to [[Template:Def Topic1]].  ''To write a definition for 'Topic1','' simply click on that link, write out a brief definition according to our standards (see above), save, and return to the page (refresh if necessary).  Then you'll see the definition you wrote out displayed as in these examples:
The [[Topic1]] link is to the article titled 'Topic1'.  (It will be red if it doesn't exist yet.)  Following that is the link to [[Topic1/Definition]].  ''To write a definition for 'Topic1','' simply click on that link, write out a brief definition according to our standards (see [[CZ:Definitions|Definitions]]), save, and return to the page (refresh if necessary).  Then you'll see the definition you wrote out displayed as in these examples:
:{{r|Ecology}}
{{r|Ecology}}
:{{r|Endocrinology}}
{{r|Endocrinology}}
:{{r|Ethology}}
{{r|Ethology}}
Finished!
Finished!


=== How to build out the ''Citizendium''<nowiki></nowiki>'s category scheme  ===
The aforementioned [r] links are a handy way to help build out the ''Citizendium'' category scheme, which will be made up of "Related Articles" pages containing lists of topics and definitions.  While the ''Citizendium'' is first and foremost an encyclopedia project, we would certainly like to have a full complement of links connecting our articles, and useful supplementary glossaries.  If you are interested in developing our category scheme, please do so.  Here's how.
Before we begin, please bear in mind that an article on a topic need not exist in order for us to link to it "in advance," as it were.  Also, we can write a definition for the topic without a whole article.
Suppose you want to develop a set of Related Articles pages for the top-level topics in your discipline.  Then you would proceed as follows.
First, go to the article about your discipline, the one that has "subtopic" links to all the other articles; e.g., [[Physics]].
Next, if there is no subpage template on the article yet, add one.  Type {{tl|subpages}} at the very top of the page.
Then click on the "Related" link.  This will bring you to, for example, [[Physics/Related]].
After that, go to town creating a Related Articles page: write the headings, the topics belonging under the headings, and the definitions associated with the topics.
Finally, click on the [r] links following the definitions, as you can again see here:
:{{r|Philosophy}}
This will take you to new Related Articles pages, and you can then repeat the process.
If we get enough people doing this systematically, we might rather quickly build out a full complement of prospective topics, their interrelationships, and definitions.


== Boundaries of included content ==
''Back to [[CZ:Subpages|Subpages]]''


Back to [[CZ:Subpage Pilot|Subpage Pilot]]
{{Content Policy}}

Latest revision as of 13:37, 7 December 2010

This page contains standards and regulations related to Related Articles subpages.

"Related Articles" pages, such as Biology/Related Articles, link to a hand-picked set of other Citizendium articles. These pages list articles under three standard headings: Parent topics, Subtopics, and Other related topics. They also list, or should list, definitions of each linked-to article.

Taken together, "Related Articles" pages will compose a hand-created category scheme. This could be help not only to Citizendium users who are looking for more 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. For a good example of this use, see Civil society/Related Articles.

What links to include

"Be bold" when compiling lists of Related Articles. We have no firm rules.


Heading and format standards

All Related Articles pages have three "default" headings.

  • Parent topics
  • Subtopics
  • Other related topics

These of course can be altered if inapproriate or extended. When there is a group of topics greater than five or so that share some useful classification, a subheading (i.e., a heading that further classifies Subtopics and Other Related Topics) is probably in order. Subheadings should be used liberally--they are very useful information--but chosen carefully and edited aggressively. In particular, topics should be chosen so as not to overlap too much.

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 the next section for usage notes.

The {{r}} template

See also Definitions.

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--Philosophy/Definition.

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. .
  • The [e] link takes one to the definition template for the topic in question.

Note: use the singular form of the topic name, i.e., the same as the article title. For example, when constructing the Related Articles page for the "Cat" article, or Cat/Related Articles, you should list "lion" rather than "lions".

Guidelines for editing

How to use the {{r}} template

See also Definitions for our definition policy, and Template:R for technical notes.

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

The Topic1 link is to the article titled 'Topic1'. (It will be red if it doesn't exist yet.) Following that is the link to Topic1/Definition. To write a definition for 'Topic1', simply click on that link, write out a brief definition according to our standards (see Definitions), save, and return to the page (refresh if necessary). Then you'll see the definition you wrote out displayed as in these examples:

  • Ecology [r]: The study of the distribution and abundance of organisms and how they are affected by the environment. [e]
  • Endocrinology [r]: Generically, the study of glands and the hormonal regulation of physiology; also the subspecialty of internal medicine concerned with diseases of the endocrine system [e]
  • Ethology [r]: The scientific study of animal behavior. [e]

Finished!


Back to Subpages


Citizendium Content Policy
Approval Standards | Article Mechanics | Subpages | Importing material from other sources | Citable articles
How to Edit
Getting Started Organization Technical Help
Policies Content Policy
Welcome Page
Retrieved from "https://citizendium.org/wiki/index.php?title=CZ:Related_Articles&oldid=29688"