Latest revision as of 08:31, 18 October 2024

Citizendium makes use of subpage article clusters, where a behind-the-scenes Metadata subpage (in the Template: namespace) is used to hold information about all pages in the cluster. The Metadata page for the "Saint Helena" article has its URL made like this: '''https://en.citizendium.org/wiki/''' + Template: + Saint_Helena + /Metadata (see it here). The standard pages in the cluster for an article named "My_Article" would be:

My_Article - required, and its first line must be {{subpages}}
Talk:My_Article - required, and its first line must be {{subpages}}
Template:My_Article/Metadata - contents described below
My_Article/Related_Articles - optional, and its first line must be {{subpages}}
My_Article/External_Links - optional, and its first line must be {{subpages}}
My_Article/Bibliography - optional, and its first line must be {{subpages}}

Note that four of the above pages are in the (main) namespace, aka "mainspace", whereas the second one is in the Talk: namespace and the third one is in the Template: namespace. Each page in the cluster (except the Metadata page) must have {{subpages}} on its first line. A well-formed cluster of articles displays like this on Citizendium:

How the "Saint Helena" article looks in the wiki, with its subpages listed in the gray tabbed area.

Warnings and caching

If you follow these instructions, because of caching on the wiki, display of the article cluster will not catch up immediately, so you are likely to see warnings, and the subpages header may show red (missing) links for pages you have already created. Ignore these. Carefully follow all the steps, then log off of Citizendium and completely close your browser. When you open the browser again and log back in, things will likely have settled down. If not, wait a couple of hours before decided it didn't work.

Creating an article cluster

Create a new article and add {{subpages}} as its first line
Use the form on the CZ:Templates page to create Template:My_Article/Metadata; populate this page as shown in NOTE 1 and NOTE 2 below.
create Talk:My_Article as a blank page and add {{subpages}} as its first line
create My_Article/Definition and place a one-line definition in it

Step 4 is recommended, but not required. Once you have created the article cluster, you can optionally create the following pages in any order (but do NOT try to create them by clicking the links in the gray subpages bar on the article--those links do not work at present):

My_Article/Related_Articles, and add the {{subpages}} as its first line
My_Article/Bibliography, and add the {{subpages}} as its first line
My_Article/External_Links, and add the {{subpages}} as its first line

NOTE 1: Below is the contents of the Template:Doggie/Metadata page. Copy and paste it directly into your Metadata page, then change the two lines with "Doggie" to your own article's exact name (with no underscores; we use spaces here!). Change the workgroup name on the cat1 line to the name of the workgroup you want your article to be in (scroll down on Welcome_to_Citizendium to see all the workgroups). And see NOTE 3 at the very bottom of this article. You can optionally add two more workgroup names on the cat2 and cat3 line. Save the file. That's it! This information will be shared to each of the subpages in your new article cluster.

{{#switch: {{{info}}}
<!--general article properties-->
|       pagename = Doggie
|        variant = AE
<!--Required for checklist-->
|            abc = Doggie
|      cat_check = no
|         status = 2
|    underlinked = yes
|        cleanup = no
|             by = 
|           cat1 = Literature
|           cat2 = 
|           cat3 = 
|           sub1 = 
|           sub2 = 
|           sub3 = 
|           tab1 = 
|           tab2 = 
|           tab3 = 
<!--required for ToApprove template-->
|    article url = 
|    subpage url = 
|        cluster = 
|            now = 
|     ToA editor = 
|    ToA editor2 = 
|    ToA editor3 = 
|           date = 
<!--required for Approved template-->
|       A editor = 
|      A editor2 = 
|      A editor3 = 
}}<noinclude>{{subpages}}</noinclude>

NOTE 2: Although its format is important, don't worry too much about the contents of the metadata page. As long as you get the article title correct, we can always edit the page later to make things right.

Here is a key to the lines you need to fill out:

pagename - the exact name of the page (see CZ:Naming_conventions)
variant - which English dialect (AE for American English, or BE for British English, or CE for Canadian English)
abc - a comma-delimited sort order for words within the article name; for example, for "Gerald Ford", the sort order might be "Ford, Gerald"
cat1 - the first workgroup this article should be long to (and optionally, cat2 and cat3 can be set to other workgroups); the names for all the workgroups are available at Welcome to Citizendium (at the bottom of the left-hand column)

Normally, a newly created article will has status = 2 (which means it's "developing", more than a stub, but not done either). But if you want to set the status to something else, here are the other valid values:

status = 1 (Developed, display shows 4 red dots)
status = 2 (Developing, display shows 3 red dots)
status = 3 (Stub, display shows 2 red dots)

Tutorial for complete beginners

Creating a basic article

To create a new article in this wiki, all you need to do is type the complete URL for the article into your browser. When you type the URL of any article in the browser's URL line, Citizendium will display the article for you (if it exists) or allow you to create such an article (if it doesn't exist yet).

The URL for an article is https://citizendium.org/wiki/ + article_name Note that any spaces in the article_name must be represented by an underscore.

The URL for an article named "Saint Helena" would be https://citizendium.org/wiki/Saint_Helena.

Namespace

All pages in the wiki are assigned a namespace when they are created.

(main) space is implicit on articles

Articles do not have an explicit namespace in their URL, and are thus said to be in the main space. Search engines are allowed to index articles.

Talk:

The Discussion pages for each article are in the "Talk" namespace. When you click on a discussion page, you'll see that its URL has Talk: in it. The Discussion page for the "Saint Helena" article has three parts: https://citizendium.org/wiki/ + Talk: + Saint_Helena. Discussion pages are excluded from search engines.

Template:

Pages in the Template namespace contain contents intended to be transcluded (fetched and inserted) into multiple other pages.

User:

Each member of Citizendium has a User page which is in the "User" namespace. User pages are not sent to search engines.

Subpages

Articles may have subpages. A subpage name looks like this: (article name)/(subpage name). And example of a subpage is Amaryllis/Related Articles (URL https://citizendium.org/ + Amaryllis + /Related Articles.

@@ Line 1: / Line 1: @@
-To create a new page, first type type the complete URL for the page into your browser.  The URL for any page is '''https://citizendium.org/wiki/''' + page_name   (and any spaces in the page_name are represented by an underscore).  Thus, the URL for an article named "Saint Helena" would be https://citizendium.org/wiki/Saint_Helena.  When you type this URL in the browser's URL space, Citizendium will display the article for you (if it exists) or allow you to create such an article (if it doesn't exist yet).
+{{TOC|right}}
+Citizendium makes use of '''[[CZ:Subpages|subpage article]] ''' ''clusters'', where a behind-the-scenes Metadata subpage (in the Template: namespace) is used to hold information about all pages in the cluster.  The Metadata page for the "Saint Helena" article has its URL made like this: <nowiki>'''https://en.citizendium.org/wiki/'''</nowiki> + '''Template:''' + '''Saint_Helena''' + '''/Metadata''' (see it [[Template:Saint_Helena/Metadata|here]]).  The standard pages in the cluster for an article named "My_Article" would be:
-The URL needed to perform Step 1 below would be: '''https://citizendium.org/wiki/Template:My_Article'''.
+# '''My_Article''' - required, and its first line must be <nowiki>{{subpages}}</nowiki>
+# '''Talk:My_Article''' - required, and its first line must be <nowiki>{{subpages}}</nowiki>
+# '''Template:My_Article/Metadata''' - contents described below
+# '''My_Article/Related_Articles''' - optional, and its first line must be <nowiki>{{subpages}}</nowiki>
+# '''My_Article/External_Links''' - optional, and its first line must be <nowiki>{{subpages}}</nowiki>
+# '''My_Article/Bibliography''' - optional, and its first line must be <nowiki>{{subpages}}</nowiki>
-To create a CZ subpages article called "My Article", do things ''in exactly this order'':
+Note that four of the above pages are in the (main) namespace, aka "mainspace", whereas the second one is in the Talk: namespace and the third one is in the Template: namespace.  Each page in the cluster (except the Metadata page) must have ''<nowiki>{{subpages}}</nowiki>'' on its first line.  A well-formed cluster of articles displays like this on Citizendium:
+{{Image|Subpages_display.jpg|center|750px|How the "Saint Helena" article looks in the wiki, with its subpages listed in the gray tabbed area.}}
-# create '''Template:My_Article''' and populate it with metadata (get contents from an existing article and edit it). See NOTE 1 and NOTE 2 below.
+= Warnings and caching =
-# move '''Template:My_Article''' to '''Template:My_Article/Metadata'''
+If you follow these instructions, because of caching on the wiki, display of the article cluster will not catch up immediately, so you are likely to see warnings, and the subpages header may show red (missing) links for pages you have already created.  Ignore these.  Carefully follow all the steps, then log off of Citizendium and completely close your browser.  When you open the browser again and log back in, things will likely have settled down.  If not, wait a couple of hours before decided it didn't work.
-# create '''My_Article'''; add the ''<nowiki>{{subpages}}</nowiki>'' template to its top
-# create '''My_Article/Definition'''
-# create '''Talk:My_Article'''; add the ''<nowiki>{{subpages}}</nowiki>'' template to its top
-Once you have created the article cluster, you can explicitly create these in any order (but do NOT click
+= Creating an article cluster =
-# (optionally) create '''My_Article/Related_Articles'''; add the ''<nowiki>{{subpages}}</nowiki>''template  to its top
-# (optionally) create '''My_Article/Bibliography'''; add the ''<nowiki>{{subpages}}</nowiki>'' template to its top
-# (optionally) create '''My_Article/External_Links'''; add the ''<nowiki>{{subpages}}</nowiki>'' template to its top
-<big>NOTE 1:</big> Do not just create '''Template:MyArticle/Metadata''' directly, because that will create an article in the so-called "mainspace", and the title of the article will happen to contain a colon, as in "Template:MyArticle".  But here, we need a template, which means, an article in the Template: namespace.  So by first creating"Template:MyArticle" and then renaming it, you assure that '''Template:MyArticle/Metadata''' is in the Template namespace (with title "MyArticle/Metadata").  Otherwise, you'll have created an article in the mainspace whose name happens to be '''Template:MyArticle/Metadata''', but the subpages template may not work correctly.
+# Create a new article and add ''<nowiki>{{subpages}}</nowiki>'' as its first line
+# ''Use the form'' on the [[CZ:Templates]] page to create '''Template:My_Article/Metadata'''; populate this page as shown in NOTE 1 and NOTE 2 below.
+# create '''Talk:My_Article''' as a blank page and add ''<nowiki>{{subpages}}</nowiki>'' as its first line
+# create '''My_Article/Definition''' and place a one-line definition in it
-<big>NOTE 2:</big> To look at the existing metadata page for any article, click on the round "M" icon in the upper right hand portion of the gray subpages bar.  Or you can start with the contents of the [[Template:Walt_Whitman/Metadata]] page, which looks like this:
+Step 4 is recommended, but not required.  Once you have created the article cluster, you can optionally create the following pages in any order (but do NOT try to create them by clicking the links in the gray subpages bar on the article--those links do not work at present):
+* '''My_Article/Related_Articles''', and add the ''<nowiki>{{subpages}}</nowiki>'' as its first line
+* '''My_Article/Bibliography''', and add the ''<nowiki>{{subpages}}</nowiki>'' as its first line
+* '''My_Article/External_Links''', and add the ''<nowiki>{{subpages}}</nowiki>'' as its first line
-<block>
+<big>NOTE 1:</big> Below is the contents of the [[Template:Doggie/Metadata]] page.  Copy and paste it directly into your Metadata page, then change the two lines with "Doggie" to your own article's exact name (with no underscores; we use spaces here!).  Change the workgroup name on the cat1 line to the name of the workgroup you want your article to be in (scroll down on [[Welcome_to_Citizendium]] to see all the workgroups).  And see NOTE 3 at the very bottom of this article.  You can optionally add two more workgroup names on the cat2 and cat3 line.  Save the file.  That's it!  This information will be shared to each of the subpages in your new article cluster.
+<pre>
 {{#switch: {{{info}}}
 <!--general article properties-->
@@ Line 30: / Line 39: @@
 |         status = 2
 |    underlinked = yes
-|        cleanup = yes
+|        cleanup = no
 |             by =
 |           cat1 = Literature
@@ Line 55: / Line 64: @@
 |      A editor3 =
 }}<noinclude>{{subpages}}</noinclude>
-</block>
+</pre>
+<big>NOTE 2</big>: Although its format is important, don't worry too much about the contents of the metadata page.  As long as you get the article title correct, we can always edit the page later to make things right.
+Here is a key to the lines you need to fill out:
+* pagename - the exact name of the page (see [[CZ:Naming_conventions]])
+* variant - which English dialect (AE for American English, or BE for British English, or CE for Canadian English)
+* abc - a comma-delimited sort order for words within the article name; for example, for "Gerald  Ford", the sort order might be "Ford, Gerald"
+* cat1 - the first workgroup this article should be long to (and optionally, cat2 and cat3 can be set to other workgroups); the names for all the workgroups are available at [[Welcome to Citizendium]] (at the bottom of the left-hand column)
+Normally, a newly created article will has status = 2 (which means it's "developing", more than a stub, but not done either).  But if you want to set the status to something else, here are the other valid values:
+* status = 1 (Developed, display shows 4 red dots)
+* status = 2 (Developing, display shows 3 red dots)
+* status = 3 (Stub, display shows 2 red dots)
+= Tutorial for complete beginners =
+== Creating a basic article ==
+To create a new article in this wiki, all you need to do is type the complete URL for the article into your browser.  When you type the URL of any article in the browser's URL line, Citizendium will display the article for you (if it exists) or allow you to create such an article (if it doesn't exist yet).
+The URL for an article is '''<nowiki>https://citizendium.org/wiki/</nowiki>''' + '''article_name'''  Note that any spaces in the article_name must be represented by an underscore.
+The URL for an article named "Saint Helena" would be '''[https://citizendium.org/wiki/Saint_Helena https://citizendium.org/wiki/Saint_Helena]'''.
+== Namespace ==
+All pages in the wiki are assigned a ''namespace'' when they are created.
+=== ''(main)'' space is implicit on articles ===
+Articles do not have an explicit namespace in their URL, and are thus said to be in the ''main'' space.  Search engines are allowed to index articles.
+=== '''Talk:''' ===
+The Discussion pages for each article are in the "Talk" namespace.  When you click on a discussion page, you'll see that its URL has '''Talk:''' in it.   The [[Talk:Saint_Helena|Discussion page for the "Saint Helena" article]] has three parts: '''<nowiki>https://citizendium.org/wiki/</nowiki>''' + '''Talk:''' + '''Saint_Helena'''.  Discussion pages are excluded from search engines.
+=== '''Template:''' ===
+Pages in the '''Template''' namespace contain contents intended to be ''transcluded'' (fetched and inserted) into multiple other pages.
+=== '''User:''' ===
+Each member of Citizendium has a User page which is in the "User" namespace.  User pages are not sent to search engines.
+== Subpages ==
+Articles may have subpages.  A subpage name looks like this: ''(article name)'''''/'''''(subpage name)''.  And example of a subpage is [[Amaryllis/Related Articles]] (URL '''<nowiki>https://citizendium.org/ + Amaryllis + /Related Articles</nowiki>'''.
+== See also ==
+{{seealso|CZ:Article_structure}}
+{{seealso|CZ:Article mechanics}}

CZ:Creating an article with subpages: Difference between revisions