CZ:Subpages: Difference between revisions

From Citizendium
Jump to navigation Jump to search
imported>Roger A. Lohmann
imported>Gareth Leng
 
(24 intermediate revisions by 5 users not shown)
Line 1: Line 1:
== Introduction ==
{{editintro}}


A full ''Citizendium'' entry  includes a main article and a cluster  of standard and optional  "subpages".  Some pages, such as Talk, Bibliography or Related Articles, are  attached to a main (encyclopedia) page automatically when it is created. Other optional subpages can be added by authors or editors as appropriate.  A main article together with its subpages is called a  "article cluster."  You might look at the [[Biology]] article and its subpages--our "biology cluster"--as an example. The [[Civil society]] article also includes many subpages, including [[CZ:Timelines|Timelines]] in recently (2008) revised format.
A full [[Citizendium]] [[CZ:Article structure|article]] includes a main article [[MediaWiki page|page]] and standard and optional [[MediaWiki subpage|subpages]]; the entire group is called a ''cluster''.


The purpose of subpages is to provide supplementary and background information to allow people to find all different ''types'' of information about a topic. In a distinctive way, Citizendium subpage capabilities transcend the linearity of traditional printed encyclopedias and illustrate and operationalize [[hypertext]] capabilities.
Some subpages contain additional content on the subject of the article. Others are used for a variety of functions, such as discussing the article content, recording information about ''[[CZ:Approval Process|approved]]'' versions of articles (stable versions which have been checked and approved by an [[CZ:Editor|Editor]]), etc.


See [http://en.citizendium.org/wiki/CZ:Using_the_Subpages_template#Instructions_for_placing_the_Subpages_template instructions for placing the Subpages template] on your article page. They are currently a work in progress, so do report any problems to the Talk page.
The subpage mechanism provides a header on every page or subpage of a cluster which allows easy navigation among the pages of the cluster. In addition, the header on the ''Talk'' subpage provides access to additional subpage-related functions.
 
You might look at the [[Biology]] article and its subpages--our "biology cluster"--as an example. The [[Civil society]] article also includes many subpages, including [[CZ:Timelines|Timelines]] in recently (2008) revised format.
 
Some of the standard subpages, such as the Talk page, and the [[CZ:Approval|Approval]] subpage, are attached to a main (encyclopedia) page semi-automatically when the main article page is set up to use the [[CZ:Article Checklist|article checklist]]. Other standard and optional subpages can be added by authors or editors.


== Basic guidelines ==
== Basic guidelines ==


'''Note:''' We are still in the early states of fully implementing the subpages functionality.  The subpage template has been established and  ''the'' basic guideline for subpages are now included in the text <code><nowiki>{{subpages}}</nowiki></code> at the top of every article page and subpage, and to create a corresponding "metadata" page.  This is enough to turn on the subpage functionality.
===Setting up subpages===
 
To enable the full subpage functionality:


There are four subpage types that are created for ''every'' article, so they are the "default" subpage types:
* Include the string <code><nowiki>{{subpages}}</nowiki></code> (which is a [[MediaWiki template]] which invokes the Citizendium subpage functions) at the top of the main article page - and later, all of its subpages, and:
* Create a ''[[CZ:Metadata|Metadata]]'' page for the cluster; the Citizendium subpage system will automatically prompt to do this after the first page or subpage with <code><nowiki>{{subpages}}</nowiki></code> on it has been saved. You will need to fill in some basic information in the Metadata, such as the article name. ''Note:'' the Citizendium subpage mechanisms will not work properly unless the article name is entered correctly.


* Talk
This is enough to turn on the subpage functionality; the system will also prompt to create the Talk and Approval subpages, if they do not exist, and will provide default contents for them which only have to be saved (although they can be modified first, if desired).
* Related Articles
* Bibliography
* External Links


When articles are approved, a fifth basic type is added to enable future revisions:
Don't forget that it is desirable to install the <code><nowiki>{{subpages}}</nowiki></code> statement on all individual subpages. Basic information about subpages is now included in the text in the subpage header on the Talk subpage.
See the [[CZ:Using the Subpages template#Instructions for placing the Subpages template|instructions]] for more details on how to set up an article page to use subpages.


* Draft
=== Default content subpages===


A number of authors have yet to fully incorporate subpages into their articles and bibliographic references and external links remain on a number of main pages, but authors and editors are working on this.
In addition to the Metadata, Talk, and Approval subpages, there are three "default" subpages for ''every'' article:


Many other subpage types are available to create.  See below.
* [[CZ:Related Articles|Related Articles]]
* [[CZ:Bibliography|Bibliography]]
* [[CZ:External Links|External Links]]


== How the subpage template works ==
When articles are approved, another basic type is added, to allow Citizendium [[CZ:Author|authors]] and editors to  work on a future revision of the article, alongside the stable, approved, version:


The Subpages template is automatically added to main article pages when those pages are properly created (with metadata, talk and article pages). A special initiative during 2007 added subpage capacilities to all previously created main pages that lacked them.
* Draft


Activation of individual article subpages must be done manually. It is done by clicking on the appropriate subpage tab on the main page and saving the subpage (with appropriate added text and the Subpages command at the top). This is done by adding the command <code><nowiki>{{Subpages}} </nowiki></code>. CZ will then display the standard Subpages menu on that subpage as well as the top page.
<!-- A special initiative during 2007 added subpage capacilities to all previously created main pages that lacked them. @@Ancient history, now...@@ -->
Activation of individual article subpages must be done manually. It is done by clicking on the appropriate subpage tab either on the main page, or in the ''Unused subpages'' area of the header on the Talk subpage, and saving the subpage, with appropriate contents - not forgetting the <code><nowiki>{{subpages}}</nowiki></code> at the top of the new subpage. CZ will then display the standard Subpages menu on that subpage, and include it in the navigation tabs in the cluster navigation header.


For more technical pointers about how the subpage template works, see [[CZ:Using the Subpages template]].
For more technical pointers about how the subpage template works, see [[CZ:Using the Subpages template]].
Line 38: Line 47:
For various reasons, we will want to keep a canonical list of subpage types, and ask people to create subpages only of the types listed.
For various reasons, we will want to keep a canonical list of subpage types, and ask people to create subpages only of the types listed.


We'll also distinguish between ''default'' (required) subpages and ''optional'' subpages.  Links to the default subpages will appear even if they have not yet been created, while links to optional subpages will be created only if they exist.
We'll also distinguish between ''default'' (required) subpages and ''optional'' subpages.   
Links to the default subpages will appear (on the subpages template) even if they have not yet been created, while links to optional subpages will be created only if they exist.
 
If nevertheless an additional subpage is required then you may consult:
* [[CZ:How to add a new subpage type]]
* [[CZ:Article-specific subpages]]
'''Removal''' of a link from the subpages template:
<br> The link to an optional subpage is inserted whenever the file exists, i.e., it will still be displayed if the page is empty (has been blanked).
In order to remove the link from the list (and again insert it into the list of unused subpages on the talk page template) the page has to be deleted.
Alternatively, in order to save the history, it can be moved to a talk page archive (e.g., of the talk page of this subpage). Then the redirect created by the move has to be deleted.


=== Default subpages ===
=== Default subpages ===
Line 48: Line 67:
=== Optional subpages ===
=== Optional subpages ===


You can see a complete list of the currently-supported subpages at [[Template:Subpage list]].
You can see a complete list of the currently-supported subpages at [[Template:Subpage list]]. (To add a new one, see [[CZ:How to add a new subpage type]].)
<br>
For subpages that are not (yet) fully supported, but are used for some topics see [[CZ:Article-specific subpages]].


==== Further bibliographic material ====
==== Further bibliographic material ====
Line 65: Line 86:
* '''[[CZ:Code|Code]]:''' a collection of code samples related to the topic
* '''[[CZ:Code|Code]]:''' a collection of code samples related to the topic


==== Simplified presentations of the topic ====
==== Presentations of the topic at various levels ====
* '''[[CZ:Tutorials|Tutorials]]:''' one or more pages that introduce a topic specifically for students; would be focused on more "practical" aspects of the topic, have more examples, and even perhaps some problems at the bottom of the page; some topics may lend themselves to more explicit "how to" type instructions (how to change your oil); main content may or may not exist on the "Tutorials" page itself
* '''[[CZ:Tutorials|Tutorials]]:''' one or more pages that introduce a topic specifically for students; would be focused on more "practical" aspects of the topic, have more examples, and even perhaps some problems at the bottom of the page; some topics may lend themselves to more explicit "how to" type instructions (how to change your oil); main content may or may not exist on the "Tutorials" page itself
* '''[[CZ:Student Level |Student Level]]:''' a simplified and entertaining version of the encyclopedia article for younger students
* '''[[CZ:Student Level|Student Level]]:''' a simplified and entertaining version of the encyclopedia article for younger students
* '''[[CZ:Advanced|Advanced]]:''' a subpage with content that will really only be useful for, or possibly even only intelligible to, specialists in the field
* '''[[CZ:Debate Guide|Debate Guide]]:''' one or more pages giving a "map of the dialectical landscape," an account of the arguments on all sides of a controversial issue about the topic; if important to read "map", give dates arguments introduced, a timeline


==== Complementary texts ====
==== Complementary texts ====
* '''[[CZ:Addendum|Addendum]]:''' supplementary text, specifically serving as a continuation of the main encyclopedia article
* '''[[CZ:Addendum|Addendum]]:''' supplementary text, specifically serving as a continuation of the main encyclopedia article
* '''[[CZ:Signed Articles|Signed Articles]]:''' one or more possibly "biased" articles written exclusively by real experts, and signed; note that the "Signed" subpage is a ''list'' of articles, which are placed on sub-sub-pages
* '''[[CZ:Signed Articles|Signed Articles]]:''' one or more possibly "biased" articles written exclusively by real experts, and signed; note that the "Signed" subpage is a ''list'' of articles, which are placed on sub-sub-pages
* '''[[CZ:Function|Function]]:''' Used to describes the known and postulated function of different proteins and genes. It will be used primarily by the Biology workgroup.
* '''[[CZ:Recipes|Recipes]]:''' Each Recipe subpage will have a basic, but comprehensive and representative recipe as a supplement to our culinary articles.


=== Planned subpage projects ===
=== Planned subpage projects ===
The following projects will not be included in the initial subpage pilot:
The following projects will not be included in the initial subpage pilot:
<!--
* '''[[CZ:Debate Guide|Debate Guide]]:''' one or more pages giving a "map of the dialectical landscape," an account of the arguments on all sides of a controversial issue about the topic; if important to read "map", give dates arguments introduced, a timeline
* '''[[CZ:Debate Guide|Debate Guide]]:''' one or more pages giving a "map of the dialectical landscape," an account of the arguments on all sides of a controversial issue about the topic; if important to read "map", give dates arguments introduced, a timeline
-->
* '''[[CZ:News Guide|News Guide]]:''' one or more pages summarizing of ongoing stories about the topic (such that a story itself will probably not become its own encyclopedia article!)
* '''[[CZ:News Guide|News Guide]]:''' one or more pages summarizing of ongoing stories about the topic (such that a story itself will probably not become its own encyclopedia article!)
== How to add subpage types ==
For the sake of uniformity, we have a list of recognized subpage types, and only subpages on this list can be included in the subpage template.  The list on this page should be identical to the list on this "master template": {{Tl|subpage list 2}}
The process we use to add subpage types to this list will no doubt develop over time, but we may begin with the following.
* First, settle on a name for the new subpage type--i.e., something that will appear both at the top of the page and in the URL.  For example, "Gallery".
* Create a sample.
* Then go to [subpage forum board, will be set up after Council approval] and post a link to the sample and a description of the subpage type, and ask for feedback.
* By way of elaborating your proposal, create a home for the subpage type, like [[CZ:Related Articles]].  This should be in the CZ: namespace and named using the subpage type name you've chosen.  There are four required sections for that home page, which may have various subsections.  Here are the sections and what to put in them:
:* '''What are ___?''' or '''What are ___ pages?'''  For example, "What are Bibliographies?" and "What are Related Articles pages?"  This should be a brief, general description of what someone sees when visiting a subpage of this type.
:* '''Purpose.'''  A broad, even philosophical, explanation of why such a page are useful, both in general and in the context of the ''Citizendium,'' i.e., how such pages help the end user with research.
:* '''Heading and format standards''' or, if there are no prescribed headings, just '''Format standards.'''  Lists any standards, or recommendations, for what headings the subpage should contain; template types used; display-related information about style, fonts, wording, etc.  This may and probably should have two or more subsections.
:* '''Guidelines for editing.'''  This explains to contributors exactly ''how'' to go about creating this type of subpage.  If there are special instructions about how to fill out a template, they go here.  All other types of instructions go here as well.  Again, this may and probably should have two or more subsections.
* The Editor-in-Chief will decide whether the subpage type is important or contentious enough to warrant debate before the Editorial Council.  If so, a resolution must be created.  If not, the Editor-in-Chief will inform the Council and ask the Council whether discussion and vote is requested (by any member).  Again, if so, a resolution must be created.
* Once the new subpage type has been adopted, the relevant templates, and this page, must be updated.


== Approval of subpages ==
== Approval of subpages ==


Provisionally, we will say that individual subpages cannot be approved.  Instead, an entire cluster (or infoset) is approved at the same time.
Individual subpages cannot be approved.  Instead, an entire cluster (or infoset) is approved at the same time.


Note that once an article is approved, all new edits to subpages will edit the ''approved'' version of the subpages.  Such edits must be aimed, therefore, always at improving the article, and editors should pay special attention to such edits.  We do not want to ''forbid'' or even ''discourage'' editing of subpages of approved articles, but we want to apply a higher standard in responding to such edits.  In particular, "rough drafts" of new sections, paragraphs, columns, etc., or entire new subpages are discouraged; each saved draft should be presentable to the public.
Note that once an article is approved, all new edits to subpages will edit the ''approved'' version of the subpages.  Such edits must be aimed, therefore, always at improving the article, and editors should pay special attention to such edits.  We do not want to ''discourage'' editing of subpages of approved articles, but want to apply a higher standard in responding to such edits.


== A plan for The Big Subpagination ==
==See also==


Actually switching from the current system to a system with subpages is not a logistically trivial task.  Here are the steps remaining for making the transition:
* {{tl|Subpage style}} - Works with {{tl|Subpage list}}
# <s>Finish designing and testing the subpage template(s).</s>
# <s>Put it up to a community vote which template design we will use.</s>
# <s>Get approval from the Editorial Council. (continuing below if this proposal passes)</s>
# <s>Create process for the Big Subpagination.  The ''basic'' task that the bot has to accomplish is to convert existing, unsubpaged articles to subpaged articles.  This can be done without actually creating any subpages, per se, at all.  All that's ''really'' required is:</s>
#* <s>Place {{tl|subpages}} on the main article (only if the page really is an article and neither a disambiguation page nor a redirection page).</s>
#* <s>Place {{tl|subpages}} on the talk page; if it exists, copy (and delete) the checklist.</s>
#* <s>Create [[Template:X/Metadata]].</s>
#* <s>Paste X into the ''pagename'' field and ''abc'' field. Other fields can be left blank. Although if the article was checklisted, paste the data from the checklist in the proper place on that page.</s>
#* <s>Create [[X/Approval]] and [[X/Unused]] (each with just {{tl|subpages}} on it).</s>
#* <s>However, to accomplish this cleanly, consider: once the subpage template is on the page, ''if'' the page is checklisted, then the categories on the article page (including "CZ Live") become redundant--and should be deleted.  But since most articles should be checklisted by now, the script needn't attempt to construct metadata out of (very hit-and-miss) category information.  Instead, it's like this: subpagify an article ''only'' if it is checklisted.  If checklisted, then delete ''both'' all categories from the article page ''and'' the checklist from the talk page.  Then Aleksander Stos' script can identify all the checklisted articles--actually, his script should then check for all ''unsubpaged'' articles, and might in fact double as a bot that creates the subpage apparatus.</s>
#* The foregoing was started and is now on hiatus; we need to finish, first.
#* I'm inclined to do the above ''first,'' and then, if all goes well, we can create a subsection of a certain description (e.g., titled "See also"), auto-create the corresponding subpage and move contents to that subpage.  Put {{tl|subpages}} on the new subpage.  Do not move if a subpage already exists.  Autocompile a list of such pagename conflicts.  For Related Articles pages, autocreate the canonical headings and move all links to "Other related topics".
#* Again, if all goes well, then we can expand the checklists (per [http://forum.citizendium.org/index.php/topic,1201.0.html]) using a different bot.
# The Big Subpagination Part II: revenge of the human beings:
#* Create homepage, process notes, and sign-up sheet for the human-run Big Subpagination.
#* Go through all pages in the namespace.  Move (by hand) all pages that should be living on subpages, like the various catalogs, lists, galleries, etc.  ('''Actually, do this before the bots run.''')
#* Go through all subpages systematically.  Divide work up by Workgroups, ''then'' alphabetically.  Note that this plan requires that the subpage template makes categories out of all WORKGROUP + SUBPAGE TYPE combinations.
#* For Related Articles pages, move links to appropriate categories, and define words.
#* For Bibliographies, format entries properly and add categories if possible.
#* For External Links, format entries properly and add categories if possible.
# The Big Relate (trust me, this is cool).  Again, divide work up by Workgroups, ''then'' alphabetically.
#* Create homepage, process notes, and sign-up sheet for the Big Relate.
#* Part I, create and define: systematically go through all clusters either with or without Related Articles (RA) pages, and create (or improve) all RA pages.  A minimally acceptable RA page lists, say, ten topics, all defined, and at least one parent topic.
#* Part II, de-orphan: again systematically go through all RA pages. For each RA page, examine the ''parent topics.''  If a parent topic has no RA page (if the small [r] link next to it is still red), then create one (and make sure it is minimally acceptable according to the above definition).  Then examine the parent topics of the ''new'' RA page; check that ''they'' have RA pages; and so forth, until one reaches RA pages that have no parents.
#* Part III, stubify: now, presumably, there is a path "downward" from the "topmost" topics to all CZ articles.  The next task is to create stubs, at least, for all articles that have RA pages but no articles.
#* The result is a completely integrated outline of knowledge.
# Done?


{{Content Policy}}
{{Content Policy}}

Latest revision as of 12:22, 9 December 2010

[edit intro]

A full Citizendium article includes a main article page and standard and optional subpages; the entire group is called a cluster.

Some subpages contain additional content on the subject of the article. Others are used for a variety of functions, such as discussing the article content, recording information about approved versions of articles (stable versions which have been checked and approved by an Editor), etc.

The subpage mechanism provides a header on every page or subpage of a cluster which allows easy navigation among the pages of the cluster. In addition, the header on the Talk subpage provides access to additional subpage-related functions.

You might look at the Biology article and its subpages--our "biology cluster"--as an example. The Civil society article also includes many subpages, including Timelines in recently (2008) revised format.

Some of the standard subpages, such as the Talk page, and the Approval subpage, are attached to a main (encyclopedia) page semi-automatically when the main article page is set up to use the article checklist. Other standard and optional subpages can be added by authors or editors.

Basic guidelines

Setting up subpages

To enable the full subpage functionality:

  • Include the string {{subpages}} (which is a MediaWiki template which invokes the Citizendium subpage functions) at the top of the main article page - and later, all of its subpages, and:
  • Create a Metadata page for the cluster; the Citizendium subpage system will automatically prompt to do this after the first page or subpage with {{subpages}} on it has been saved. You will need to fill in some basic information in the Metadata, such as the article name. Note: the Citizendium subpage mechanisms will not work properly unless the article name is entered correctly.

This is enough to turn on the subpage functionality; the system will also prompt to create the Talk and Approval subpages, if they do not exist, and will provide default contents for them which only have to be saved (although they can be modified first, if desired).

Don't forget that it is desirable to install the {{subpages}} statement on all individual subpages. Basic information about subpages is now included in the text in the subpage header on the Talk subpage.

See the instructions for more details on how to set up an article page to use subpages.

Default content subpages

In addition to the Metadata, Talk, and Approval subpages, there are three "default" subpages for every article:

When articles are approved, another basic type is added, to allow Citizendium authors and editors to work on a future revision of the article, alongside the stable, approved, version:

  • Draft

Activation of individual article subpages must be done manually. It is done by clicking on the appropriate subpage tab either on the main page, or in the Unused subpages area of the header on the Talk subpage, and saving the subpage, with appropriate contents - not forgetting the {{subpages}} at the top of the new subpage. CZ will then display the standard Subpages menu on that subpage, and include it in the navigation tabs in the cluster navigation header.

For more technical pointers about how the subpage template works, see CZ:Using the Subpages template.

List of subpage types

For various reasons, we will want to keep a canonical list of subpage types, and ask people to create subpages only of the types listed.

We'll also distinguish between default (required) subpages and optional subpages. Links to the default subpages will appear (on the subpages template) even if they have not yet been created, while links to optional subpages will be created only if they exist.

If nevertheless an additional subpage is required then you may consult:

Removal of a link from the subpages template:
The link to an optional subpage is inserted whenever the file exists, i.e., it will still be displayed if the page is empty (has been blanked). In order to remove the link from the list (and again insert it into the list of unused subpages on the talk page template) the page has to be deleted. Alternatively, in order to save the history, it can be moved to a talk page archive (e.g., of the talk page of this subpage). Then the redirect created by the move has to be deleted.

Default subpages

  • Talk: The first tab to the right of Main Page on every subpages menu bar, Talk is a page for authors and editors to discuss the contents and composition of the main page and subpages.
  • Related Articles: a list of subtopics, parent topics, and other related topics, augmented by definitions
  • Bibliography: a substantial list of the most important published books and articles on the topic; with links to online sources for them, if available
  • External Links: a lengthy, categorized, annotated list of Web links about the topic

Optional subpages

You can see a complete list of the currently-supported subpages at Template:Subpage list. (To add a new one, see CZ:How to add a new subpage type.)
For subpages that are not (yet) fully supported, but are used for some topics see CZ:Article-specific subpages.

Further bibliographic material

  • Works: a list of books, articles, artworks, etc., authored by a person
  • Discography: a list of recorded works
  • Filmography: a list of films, television shows, etc., directed, performed in, etc.

Summary presentations of information

  • Catalogs: one or more pages containing almanac-type information about some aspect of the topic, in tabular form; see, e.g., catalog of religions)
  • Timelines: one or more pages giving a timeline about some aspect of the topic; main content may or may not exist on the "Tutorials" page itself

Non-text media

  • Gallery: an image gallery
  • Audio: a collection of Citizendium-hosted audio recordings related to the topic
  • Video: a collection of Citizendium-hosted videos related to the topic
  • Code: a collection of code samples related to the topic

Presentations of the topic at various levels

  • Tutorials: one or more pages that introduce a topic specifically for students; would be focused on more "practical" aspects of the topic, have more examples, and even perhaps some problems at the bottom of the page; some topics may lend themselves to more explicit "how to" type instructions (how to change your oil); main content may or may not exist on the "Tutorials" page itself
  • Student Level: a simplified and entertaining version of the encyclopedia article for younger students
  • Advanced: a subpage with content that will really only be useful for, or possibly even only intelligible to, specialists in the field
  • Debate Guide: one or more pages giving a "map of the dialectical landscape," an account of the arguments on all sides of a controversial issue about the topic; if important to read "map", give dates arguments introduced, a timeline

Complementary texts

  • Addendum: supplementary text, specifically serving as a continuation of the main encyclopedia article
  • Signed Articles: one or more possibly "biased" articles written exclusively by real experts, and signed; note that the "Signed" subpage is a list of articles, which are placed on sub-sub-pages
  • Function: Used to describes the known and postulated function of different proteins and genes. It will be used primarily by the Biology workgroup.
  • Recipes: Each Recipe subpage will have a basic, but comprehensive and representative recipe as a supplement to our culinary articles.

Planned subpage projects

The following projects will not be included in the initial subpage pilot:

  • News Guide: one or more pages summarizing of ongoing stories about the topic (such that a story itself will probably not become its own encyclopedia article!)

Approval of subpages

Individual subpages cannot be approved. Instead, an entire cluster (or infoset) is approved at the same time.

Note that once an article is approved, all new edits to subpages will edit the approved version of the subpages. Such edits must be aimed, therefore, always at improving the article, and editors should pay special attention to such edits. We do not want to discourage editing of subpages of approved articles, but want to apply a higher standard in responding to such edits.

See also


Citizendium Content Policy
Approval Standards | Article Mechanics | Subpages | Importing material from other sources | Citable articles

|width=10% align=center style="background:#F5F5F5"|  |}

Retrieved from "https://citizendium.org/wiki/index.php?title=CZ:Subpages&oldid=29632"