Template:WikiProject Swimming/doc

Project banner

The {{WP Swimming}} 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:

{{WP Swimming
|class=  
|importance=
|water-polo=
|attention=
|needs-infobox=
|needs-photo=
|audio-file=
|listas= 
}}

Optional parameters

• 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:Swimming articles needing attention.
• audio-file – set |audio-file=yes if an audio file has been created of this article.
  • This parameter populates Category:Swimming articles with audio files.
• class – valid values are fa, a, ga, b, c, start, stub, fl, list, category, disambig, draft, file, portal, project, template, 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 Matthew Webb, use |listas=Webb, Matthew so that the talk page will show up in the W's and not the M'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.
• 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:Swimming articles without infoboxes.
• needs-photo – set |needs-photo=yes to mark the page as needing a photograph.
  • This parameter populates Category:Swimming articles needing photographs.
• water-polo – set |water-polo=yes if the article is supported by Water polo work group.
  • This parameter populates Category:Water polo articles, and the relevant subcategory of Category:Water polo articles by quality based upon the |class= parameter.
  • water-polo-importance (only used if |water-polo=yes is set; uses the same values as |importance=) – Importance rating within Water polo work group
    • This importance rating populates the relevant subcategory of Category:Water polo articles by importance.
• 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 swimming 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.

To avoid needlessly cluttering up talk pages, it is usually appropriate to remove any unused parameters from the template.

TemplateData

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:WikiProject Swimming in articles based on its TemplateData. TemplateData for WikiProject Swimming Talk page banner for WikiProject Swimming Template parameters This template prefers inline formatting of parameters. Parameter Description Type Status category 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. Default no Example category=no Auto value no Boolean optional 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 Matthew Webb, use |listas=Webb, Matthew so that the talk page will show up in the W's and not the M'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. Example listas=Smith, John String optional class class Valid values are fa, a, ga, b, c, start, stub, fl, list, category, disambig, draft, file, portal, project, template, 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. Suggested values fa a ga b c start stub fl list category disambig draft file portal project template na Example class=fa String suggested auto auto This parameter is for the use of bots and indicates that the article has been automatically rated. Suggested values length inherit yes stub Example auto=yes Unknown optional importance 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. Suggested values top high mid low na Example importance=top String suggested attention 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. Example attention=yes Boolean optional needs-infobox needs-infobox infobox-needed infobox-requested Set |needs-infobox=yes if the article needs an infobox. Remember that infoboxes are not suitable for all articles, and can overwhelm short articles. Default yes Example needs-infobox=yes Auto value yes Boolean suggested needs-photo needs-photo needs-image photo-needed image-needed Set |needs-photo=yes to mark the page as needing a photograph. Default yes Example needs-photo=yes Auto value yes Boolean suggested water-polo water-polo Set |water-polo=yes if the article is supported by Water polo work group. Example water-polo=yes Boolean optional water-polo-importance water-polo-importance Only used if |water-polo=yes is set; uses the same values as |importance= – Importance rating within Water polo work group Suggested values low mid high top Example water-polo-importance=low String optional audio-file audio-file set |audio-file=yes if an audio file has been created of this article. Boolean optional