Jump to content

Template:WikiProject Sussex/doc

From Wikipedia, the free encyclopedia

Usage

[edit]

The {{WikiProject Sussex}} project banner template should be added (not subst:ed) to the talk page of every article within the scope of the project. While the template does not require any additional parameters, it has a number of optional ones that add various extra features to the banner. The full syntax is as follows:

{{WikiProject Sussex
|class=
|importance=
|unref=
}}

Optional parameters

[edit]
  • class – valid values are fa, a, ga, b, c, start, stub, fl, list, na (case-insensitive). See the project's quality scale for details. Setting an explicit value of NA is rarely necessary; for this, either leave |class= blank or omit the parameter.
  • importance – valid values are: top, high, mid, low, na (case-insensitive). See the project's importance scale for details. Setting an explicit value of NA is rarely necessary; for this, either leave |importance= blank or omit the 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 David Sheppard, use |listas=Sheppard, David so that the talk page will show up in the S's and not the D'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.
  • unref – set |unref=yes if the article lacks sufficient references and/or adequate inline citations
  • 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.

Comments should be added on the linked Talk sub page created by the template.

TemplateData
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:WikiProject Sussex in articles based on its TemplateData.

TemplateData for WikiProject Sussex

Use this template on a talk page to tag it as being within the scope of WikiProject Sussex

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
"Category"category

Set this value to \"no\" if, and only if, a banner is being used for demonstration or testing purposes, to prevent unnecessary or undesirable categorisation. Otherwise, omit this parameter.

Example
no
Stringoptional
"Listas"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 David Sheppard, use \"Sheppard, David\" so that the talk page will show up in the S's and not the D'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. It is not required if another WikiProject template on the same page has its own listas parameter set, since it not only affects categories used by the banner in which it is set, but it also affects the sortkey of all other banners and templates.

Example
Sheppard, David
Stringsuggested
"Class"class

Valid values are: \"start\", \"stub\", \"c\", \"b\" (case-insensitive). Rating an article as \"A\", \"FL\", or \"FA\" requires a peer-review. See the project's quality scale for details

Example
start
Stringsuggested
"Importance"importance

Valid values are: \"top\", \"high\", \"mid\", \"low\", \"na\" (case-insensitive). See the project's importance scale for details.

Example
mid
Stringsuggested
"Unref"unref

Set parameter to \"yes\" if the article lacks sufficient references and/or adequate inline citations.

Example
yes
Stringoptional