CZ:Using the subpages template

|width=10% align=center style="background:#F5F5F5"|  |} The current active template is now {{subpages}}.

Why use the Subpages template?

At first glance the subpages template adds the navigation tabs at the top of the page, and while this is useful, the real power of the template is not as obvious. The short version is that when this template is used on every page in an article cluster it saves time and makes the categorisation and look of the pages consistent.

Adds subpage navigation box

Requires that each subpage is a recognised name; see the current list of available subpage types at Template:Subpage list 2

The template adds a subpage navigation box at the top of each page in the article cluster. It can automatically identify each subpage in an article cluster and automatically adds a tab to the navigation box for each one present.

Automatic placement of categories

Requires that each cluster has a metadata template; see an example at Template:Biology/Metadata

Using the information about each article, that is stored on a specific metadata template, the subpages template manages the placement of categories and approval templates in a cluster. For example, if one new workgroup is added, or one removed, from the metadata template this has an immediate global effect on the categories in the whole cluster. This saves a lot of time since the manual placement or removal of categories is no longer required. This has the added advantage that all the pages in a cluster are consistent at all times.

Automatic placement of headers

Headers for each subpage are added automatically and in the future this one template will allow us to modify the design or wording of ALL the articles in the citizendium with a minimal number of edits. The checklist table also "magically" appears on the talk page of the article after the checklist fields are completed on the metadata template.

Automatic placement of approval templates

Requires that each cluster has an approval subpage; see an example at Biology/Approval

Constables and editors who manage the approval process will only have to edit the metadata template. Just the addition of an editors name in the ToApprove section of the metadata template will cause the {{ToApprove}} template to appear on all subpages in a cluster and add the article to the ToApprove category. This more simple approach to managing the approval process should help make the approval process easier. With similar ease the {{Approved}} template is correctly placed on an approved article by correctly updating the metadata template.

A consistent look

A final aesthetic touch is that the subpages template controls the background colours for the navigation tabs of approved (green) and unapproved (blue) articles. This has the advantage that the approved articles are move obvious when browsing between the different subpages. The consistent placement of all the navigation tools, notices and categories will make browsing CZ articles much more predicatable for a new user.

How to use the Subpages template

Note: For brand new pages, all you need to fill out is "pagename" (the exact title of the article) and "abc" (same as the pagename, but if a biography: last name, first) and preferably "cat1" too (see our workgroup list). If you want to complete the whole checklist section, which would be nice, see The Article Checklist. Don't fill out the "required for ToApprove template" and "required for Approved template" sections.

1) Place {{subpages}} at the top of every page in a cluster, including all talk pages and subpages. Don't worry that the page looks messy. It is now necessary to fillin the 'metadata' page:

2) For the subpages template to function correctly it is important to set up an additonal Metadata template for each article. This is easily done by clicking on the 'M' on the blue bar that the subpages template put on the top of the page. Cut and paste the following code to a generic template named Template:ARTICLENAME/Metadata. Don't forget to at least fill in the pagename.

{{#switch: {{{info}}}
<!--Pagename must be filled out for template to work correctly-->
|       pagename =
|        dialect =
<!--required for checklist -->
|            abc = 
|      cat_check = 
|         status = 
|    underlinked = 
|        cleanup = 
|             by = 
|           cat1 = 
|           cat2 = 
|           cat3 = 
<!--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>

The checklist parameters should be filled out in the usual way (see instructions below for a description of usage for all the fields in the metadata template.) Converting a current article is easily achived by cutting and pasting the parameters from the current checklist, that already exists on the talk page, to the new Metadata template for the article.

3) In addition to the checklist parameters it is also important to complete the pagename parameter. A warning note will pop up on the navigation template if this is not done.

4) Two other pages need to be created to complete the new cluster. An approval subpage and a Unused subpages list. A {{subpages}} template should be placed at the top of both these pages. Neither of these pages are as important as the metadata template page and they could be created at a later date.

Parameters

General parameters

pagename = The exact pagename is used. It is required for navigation back to the home page on subpages.

dialect = will be used to designate the spelling and grammar, primarily whether the article is written in American or English English.

Checklist parameters

abc = used to categorise based on last names. For example, the Barbara McClintock approval template is written as abc = McClintock, Barbara so she is categorised under M, or List of Biologists would be abc = Biologists, List of so it is categorised under B.

cat_check = put "yes" if you want someone to check over the categories

status = 0 for approved articles; 1 developed, 2 developing, 3 stub, 4 external

underlinked = put "yes" if not enough other articles link to it (click "What links here" at left)

cleanup = put "yes" if basic cleanup has been done.

by = Names of anyone editing the checklist, in reverse chronological order.

cat1 = must be an existing workgroup

cat2 = second workgroup (optional but must use before group3 if only two workgroups)

cat3 = third workgroup (optional)

ToApprove parameters

Type of approval:

Whole cluster use the article url and the cluster field.

Article only use the article url and leave the cluster field blank.

Subpage only us the subpage url field and leave the cluster field blank.

Article and ONE subpage use both the article and subpage url fields but leave the cluster field blank.

article url = the location in the page history where the version-to-approve lives.

subpage url = the location in the page history where the version-to-approve lives.

cluster = add text here if the whole cluster needs to be approved, otherwise leave blank.

now = the date and time when the template is added. Use ~~~~~ (five tildes) to let the computer generate it automatically.

ToA editor = the username of the person who did the approval (or who nominated the article on behalf of a group of people)

ToA editor2 = second editor (optional field but must use before editor3 if only two editors approved)

ToA editor3 = third editor (optional field)

date = format yyyymmdd (typically three days after "now", to allow copyedits and suggestions)

Approved template

A editor = the username of the person who initiated the approval (or who nominated the article on behalf of a group of people)

A editor2 = second editor (optional field but must use before editor3 if only two editors approved)

A editor3 = third editor (optional field)