Template:Subpages test/doc

=Documentation of all templates called by the Subpages template=

Core function

 * Subpages
 * Specific task for this template include:
 * Adds a comment at the top of any page that cannot use the subpages template. It also places a comment at the top of subpage and subsubpage talk pages encouraging the use of the clusters primary talk page (at either Talk:Article or Talk:Article/Draft depending on the status of approval.
 * Adds error templates to the top of pages. Errors caught include, no metadata page, a misspelled pagename field or a mismatch between the status and approving editor fields (Must have a status of "0" if an approving editor is shown). The tree below resolves such that the 'no metadata template' is only placed on subpages, the article and its talk page and the metadata page. If there is no metadata AND a 'definition only' page the Lemma template is used on the article page.
 * Establishes parameters for the ‘subpage style’ template on all pages except subsubpages and their talk pages.
 * Establishes parameters for the ‘subpage style’ template on subsubpages.
 * The following categories are specifically placed by this template when appropriate:
 * Category:Dabdef Subpages
 * Category:Definition Only
 * Category:All Content
 * Category:Related Articles Only
 * Category:Masterlist Only


 * Subpage style
 * Adds the status bar on the article and all subpages.
 * Adds the MAIN ARTICLE tab
 * Adds the TALK tab and ensures it always links to the correct talk page from all the different cluster pages. Also indicates if on a talk page or not.
 * Adds the Definition tab
 * Adds the DRAFT tab but only if the article is approved.
 * Adds the DEFAULT subpage tabs.
 * Adds the OPTIONAL subpage tabs if the page exists.
 * These final categories add the All Content and Workgroup Content categories as well as the Workgroup and subgroup tags categories.
 * Button off2
 * Button on2
 * Optional3
 * Button off2
 * Button on2
 * Default3
 * Button off2
 * Button on2
 * Subpage list


 * move
 * Every page
 * Every page below
 * Lemma

Error related

 * Editor error catch In place to identify a discrepancy between the approval status of the article and the placement of approving editors. Useful reminder for constables who forget to change the status during approval.


 * No metadata template Placed on subpages that have an associated article but no metadata page.


 * metadata error catch Placed on pages in which the metadata pages pagename field has no known article despite the fact that the basepagename does have an article. Possibly due to an error in the pagename or if the basepagename leads to a redirect there was an error while moving the article.


 * Orphan subpage Placed on subpages with no article or metadata page. Also on subpages or templates with no article on the basepagename or the pagename from the metadata page.


 * Metadata to finish Create a todo list on the talk page with an aim to get the metadata templates fully filled out with respect to the status, variant, abc and workgroup. Also used to remind authors to add the definition if needed. Uses the Talk Checklist  to check for the absense of information and place the template. The To-Do list will disappear when all four and the definition are completed.


 * Category:Metadata to finish
 * Category:Misplaced subpage
 * Category:Unexpected subsubpage
 * Category:Incompatible editor status
 * Category:No metadata template
 * Category:Incorrect metadata pagename
 * Category:Articles_with_Ambiguous_Status
 * Category: No talk page
 * Category: Orphan subpage

Color
These four colours are coded for in by fields in the subpage list template. These colors are all variable to allow changes that might be needed with the skin upgrade.

Subpages template hierarchy

 * Bulleted templates indicate those that can be used for content. Content can be added to specific pages in a given cluster or added to various combinations of pages. See the usage chart below to determine which template is most suitable.
 * Subpages Does preliminary error check and places appropriate messages on page if there is a problem such as incorrect pagename or no metadata template.

Places content above subpage template

 * Subpages
 * Currently empty
 * Subpage style
 * Currently empty

Places content inside subpage template

 * Subpage style
 * Subsubpages IN
 * Currently empty
 * Signed Article Header
 * Catalog Header
 * Timeline Header
 * Tutorial Header
 * Recipe Header
 * Code Header
 * Related Articles Header
 * Other subsubpage Header
 * Currently empty
 * Currently empty
 * To Approve Inner This template controls whether the draft page is populated or not. It is only populated when the article is approved.  Likewise the article talk page is only populated when the article is unapproved.
 * Checklist22 Unused
 * Checklist22 Adds checklist to the talk page; reads the info from the metadata template. Also adds the maintenance and definition categories to the talk page.
 * Unused subpage list Adds a list of subpages that have not been used in any particular cluster.
 * article approved IN
 * Currently empty
 * Approved Article In Contains the approved article disclaimer and brief details with respect to the approving editor/s.
 * draft approved IN
 * Currently empty
 * Draft header Containers header text.
 * Currently empty
 * subpages not draft IN
 * Currently empty
 * Approval header Containers header text.
 * subpage approved IN
 * Currently empty
 * Tab header Generic header for any article specific subpage designated by the fields tab1, tab2 or tab3 in the metadata.
 * Currently empty
 * article not approved IN
 * Currently empty
 * Not Approved Article In Adds the following text. "This is a draft article, under development. These unapproved articles are subject to a disclaimer."
 * Currently empty
 * Currently empty

Places content below template

 * Subpage style
 * Subsubpages
 * All Subsubpages
 * Signed Article Subsubpage
 * Catalog Subsubpage
 * Timeline Subsubpage
 * Tutorial Subsubpage
 * Recipe Subsubpage
 * Code Subsubpage
 * Related Articles Subsubpage
 * Other Subsubpage
 * metadata2 Allows the metadata to be viewed without entering edit mode. Also add the Please create the "Talk page" link if talk page is absent.
 * Currently empty
 * To Approve Info This template controls whether the draft page is populated or not. It is only populated when the article is approved.  Likewise the article talk page is only populated when the article is unapproved.
 * Talk Always Added to the approved article talk page. Adds some of the subpage categories so they are listed by article name only.
 * Talk Checklist Not Approved Article
 * Talk Always Added to the regular (not approved) article talk page. Adds some of the subpage categories so they are listed by article name only.
 * Talk Checklist Controls the addition of the "To Do" list on the talk page and adds the "no approval page" reminder if needed.
 * Metadata to finish adds content to the "To Do" list for finishing the checklist and/or the definition. Adds categories for def needed and metadata to finish as appropriate.
 * currently empty
 * Talk_Checklist_Approved_Article
 * Talk Checklist See above.
 * Currently empty
 * article approved
 * Article Specific This template adds the CZ live category to the article page. It also adds Approved article workgroup and subgroup categories when article is approved. If the talk page is absent it gives a hyperlink and requests Please create the "Talk page". If a recipe subpage exists it will add a comment at the top of the page. See below:

See the tab above for Recipes of .
 * Approved Article added  to this
 * draft approved
 * Currently empty
 * Draft footer Adds the workgroup and subgroup category links at the top of the draft page.
 * TOAPPROVE stuff Contains the To Approve template.
 * subpages not draft
 * Currently empty
 * Approval footer If the talk page is absent it gives a hyperlink and requests Please create the "Talk page". Added following
 * subpage approved
 * All Subpage Content  and the categories for the workgroup specific extra/optional subpages.
 * Tab footer Generic footer for any article specific subpage designated by the fields tab1, tab2 or tab3 in the metadata. This template adds categories to an article specific subpage.
 * TOAPPROVE stuff Contains the To Approve template. As above
 * article not approved
 * Article Specific See above.
 * Not Approved Article added to this
 * TOAPPROVE stuff Contains the To Approve template. As above.
 * TOAPPROVE stuff Contains the To Approve template. As above.

inner
All headers used by the Subpages template are also used by Subpages3 template.
 * Related Articles header
 * Bibliography header
 * External Links header
 * Works header
 * Discography header
 * Filmography header
 * Catalogs header
 * Timelines header
 * Gallery header
 * Audio header
 * Video header
 * Code header
 * Tutorials header
 * Student_Level header
 * Signed Articles header
 * Function header
 * Addendum header
 * Debate Guide header
 * Isotopes header
 * Recipes header

outer
Three different templates for adding text or categories immediately below the subpages template.
 * All Subpage Content only on subpages with content, omits the approval page and the draft page. Added


 * All Subpages, includes draft and approval page. Currently empty
 * All Subpage Talk Currently empty


 * Draft footer
 * Draft page only. Adds the workgroup and subgroup category links at the top of the draft page.


 * Related Articles footer
 * Adds the "what links here" links to the top of the related articles page. And the Related Articles specific categories.
 * Bibliography footer
 * Adds the "Please sort and annotate in a user-friendly manner" text. And the bibliography specific categories.
 * External Links footer Currently empty
 * Works footer Currently empty
 * Discography footer Currently empty
 * Filmography footer Currently empty
 * Catalogs footer Currently empty
 * Timelines footer Currently empty
 * Gallery footer Currently empty
 * Audio footer Currently empty
 * Video footer Currently empty
 * Code footer Currently empty
 * Tutorials footer Currently empty
 * Student_Level footer Currently empty
 * Signed Articles footer Currently empty
 * Function footer Currently empty
 * Addendum footer Currently empty
 * Debate Guide footer Currently empty
 * Isotopes footer Currently empty
 * Recipes footer

Approval

 * Approval header
 * Approval footer added following

Metadata view

 * Metadata2 allows the metadata to be viewed without entering edit mode.
 * Metadata header Currently empty

Inner

 * Tutorial Header
 * Recipe Header
 * Timeline Header
 * Signed Article Header
 * Catalog Header
 * Code Header
 * Related Articles Header
 * Other subsubpage Header, a generic version subsubpages not hardwired into the subpages template. Currently empty

Outer

 * Other Subsubpage Generic one for any subsubpage created outside of the hardwired current three. See error category above to monitor for such instances. If there is a need we can hard wire more of the subpages for subsubpage functionality.
 * Signed Article Subsubpage
 * All Subsubpages
 * Timeline Subsubpage
 * Catalog Subsubpage
 * Code Subsubpage
 * Tutorial Subsubpage
 * Recipe Subsubpage
 * Related Articles Subsubpage

General (used elsewhere)

 * Archive list long
 * Tl
 * X0
 * Yes-or-no
 * Click
 * Clickurl
 * Editintro