Template:WikiProject Freemasonry/doc

This template {{WikiProject Freemasonry}} adds articles to one or more subcategories of Category:WikiProject Freemasonry articles and is a self-reference. Please add it to talk pages of relevant articles and non-article pages alike. To avoid needlessly cluttering up talk pages, it is usually appropriate to remove any unused parameters from the template. A common initial configuration for the template to copy/paste into the talk page of the article being assessed includes the following basic parameters:

{{WikiProject Freemasonry|class=|importance=|needs-infobox=|needs-image=}}

Usage

This template should be transcluded as {{WikiProject Freemasonry}} (never substituted, using {{subst:}}) because it employs conditional code. Transclusion also allows easy updating of all the WikiProject's talk pages without having to edit thousands of pages individually.

Full syntax

{{WikiProject Freemasonry
 | class              =
 | importance         =
 | auto               =
 | category           =
 | listas             =
 | attention          =
 | needs-infobox      =
 | needs-image        =
 | image-details      =
}}

The template also employs several optional data field parameters as described below. The full template syntax is:

Parameters legend

• class – valid values are: FA, GA, B, C, Start, Stub, FL, List, Category, Disambig, Draft, FM, File, Project, Redirect, Template and NA (case-insensitive); they are further described in the custom class mask.
• importance – valid values are: Top, High, Mid, Low, NA (case-insensitive). See the project's importance scale for details.
• auto – This parameter is for the use of bots and indicates that the article has been automatically rated:
  • |auto=length – based on the length of the article
  • |auto=inherit – because one or more other projects use this class
  • |auto=yes (or |auto=stub), in conjunction with |class=stub – as Stub-Class because it uses a stub template
    • Use of the above values (or value combinations) with this parameter populates Category:Automatically assessed Freemasonry articles.
• category – set |category=no if, and only if, a banner is being used for demonstration or testing purposes, to prevent unnecessary or undesirable categorization. Otherwise, omit this parameter.
• listas – This parameter, which is the equivalent of the DEFAULTSORT sortkey that should be placed on all biographical articles, is a sortkey for the article talk page (e.g. for Hiram Abiff, use |listas=Abiff, Hiram so that the talk page will show up in the A's and not the H's of the various assessment and administrative categories). This is important because it is one source used by those who set DEFAULTSORT on the article; consider also setting the DEFAULTSORT for the article when setting this parameter. For more information about this, please see Wikipedia:Categorization of people § Ordering names in a category.
  If the article is using {{WikiProject banner shell}} then it is preferable to add |listas= to that template instead of a project banner template. Putting the parameter on more than one template is not required.
• attention – set |attention=yes if the article needs immediate attention from experienced editors. Use only if another parameter does not cover the need for attention; this should be used sparingly. It is strongly encouraged to also add a section to the talk page explaining what needs attention.
  • This parameter populates Category:Freemasonry articles needing attention.
• needs-infobox – set |needs-infobox=yes if the article needs an infobox. Remember that infoboxes are not suitable for all articles, and can overwhelm short articles.
  • This parameter populates Category:Freemasonry articles needing infoboxes.
• needs-image – set |needs-image=yes to request that a photograph, map, drawing, diagram, equation, or other image be added to the page. Leave blank or delete if not.
  • This parameter populates Category:Freemasonry articles needing images.
• image-details – This free-form parameter can be used in conjunction with the needs-image parameter (or its aliases) to add specific details about the images being requested. For example, |image-details=Please add a photo taken when these officers were installed will add the following to the template display: "An editor suggests the following: Please add a photo taken when these officers were installed."

Parameter aliases

• The parameter |1= is recognised as an alias for |class=. If both |class= and |1= are present, |1= is ignored.

• The parameters |needs-photo= and |image-needed= are recognised as aliases for |needs-image=. If more than one is present, |needs-photo= has precedence over |image-needed=, and |needs-image= has precedence over both of the others: parameters with lower precedence are ignored.

TemplateData

TemplateData used by TemplateWizard, VisualEditor and other tools

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:WikiProject Freemasonry in articles based on its TemplateData. TemplateData for WikiProject Freemasonry Includes the page in WikiProject Freemasonry Parameter Description Type Status Quality assessment class class 1 An evaluation of the article's quality (or just its page type, if a non-article); see the WikiProject Freemasonry quality scale for more details. Set to one of: ['FA', 'FL', 'FM', 'GA', 'B', 'C', 'Start', 'Stub', 'List', 'Category', 'Disambig', 'File', 'Project', 'Redirect', 'Template', 'NA'] Suggested values FA FL FM GA B C Start Stub List Category Disambig File Project Redirect Template NA Example Stub Line suggested Priority level importance Priority for project members to improve the page, set to one of: ['Top', 'High', 'Mid', 'Low', 'NA'] Suggested values Top High Mid Low NA Example Mid Line suggested Needs urgent attention attention Flags the page as requiring immediate attention when set to: ['yes'] Default no Example yes Auto value yes Boolean optional Infobox needed needs-infobox If the article has no infobox or has an outdated or inappropriate one, set to: ['yes'] Suggested values yes no Default no Example yes Auto value yes Boolean optional Needs image needs-image needs-photo image-needed Adds the page to a list of requested images for project members to photograph or scan and upload for inclusion when set to: ['yes'] Default no Example yes Auto value yes Boolean optional Image request description image-details Details the desired image in the requested images list, in the event the need could be ambiguous Example A recent photo of the lodge room's interior from the West looking East String optional Sort as listas The equivalent of the DEFAULTSORT sortkey, it allows the page to be listed in categories as though its title was this value and not its actual name Example Abiff, Hiram Line optional Quality auto-assessment method auto Determines the method to be used when the quality class is set by a bot, set to one of: ['inherit', 'length', 'stub', 'yes', 'no'] Suggested values inherit length stub yes no Example yes Line optional Category inclusion category Set to no if this banner is being used for demonstration or testing purposes to prevent unnecessary or undesirable categorization, otherwise omit. Set to one of: ['yes', 'no'] Default yes Example no Auto value yes Boolean optional Format: inline

See also

• {{User WikiProject Freemasonry}}
• {{The Freemasonry Barnstar}}