Template:WPBannerDoc/sandbox
- WPBannerDoc error: required first parameter missing
 | __EXPECTUNUSEDTEMPLATE__This is the template sandbox page for Template:WPBannerDoc (diff). See also the companion subpage for test cases. |
Usage
This template generates standardised parameter documentation for various parameters commonly used with WikiProject banner templates. For example output, see Template:WPBannerDoc/testcases.
Parameters
The first parameter is the name of the parameter for which documentation is required; some parameters are shared, as follows:
|PROJECT=– this should be the same as the|PROJECT=parameter passed into{{WPBannerMeta}}on the main template page
Other parameters vary according to the first one:
attention|ATTENTION_CAT=– the category populated by the use of|attention=yes, if different from Category:{{{PROJECT}}} articles needing attention. Do not specify the 'Category:' prefix.
Attention– variant capitalisation of the above.auto|AUTO_ASSESS_CAT=– the category populated by the use of the|auto=parameter, if different from Category:Automatically assessed {{{PROJECT}}} articles. Do not specify the 'Category:' prefix.
category(no additional parameters)class|ASSESSMENT_LINK=|BANNER_NAME=|PROJECT=|PROJECT_LINK=|QUALITY_SCALE=– these five should be the same as the corresponding parameters passed into{{WPBannerMeta}}on the main template page. If any are omitted from the{{WPBannerMeta}}, omit the same ones from{{WPBannerDoc}}also.|bpara=– set this to the name of the B-Class yes/no parameters, omitting the digit, e.g.|bpara=B-Class-|bmax=– if|bpara=is set, set this to either 5 or 6 to show how many of the B-Class criteria are recognised|class_values=– when|QUALITY_SCALE=inlineis set, this parameter should be a list of valid class values, e.g.|class_values=fa, ga, b, c, start, stub, fl, list, draft, category, template, naAlternatively, the{{WPBannerDoc/class mask}}template may be used, e.g. <syntaxhighlight lang="wikitext">|class_values=fa, a, ga, b, c, start, stub, fl, list, category, template, na</syntaxhighlight> which is equivalent to|class_values=fa, a, ga, b, c, start, stub, fl, list, category, template, na
importance|ASSESSMENT_LINK=|BANNER_NAME=|PROJECT=|PROJECT_LINK=|IMPORTANCE_SCALE=– these five should be the same as the corresponding parameters passed into{{WPBannerMeta}}on the main template page. If any are omitted from the{{WPBannerMeta}}, omit the same ones from{{WPBannerDoc}}also.|importance_values=– when|IMPORTANCE_SCALE=inlineis set, this parameter should be a list of valid importance values, e.g.|importance_values=high, mid, low, bottom, na
infobox– variant of needs-infobox.listasneeds-infobox|INFOBOX_CAT=– the category populated by the use of|needs-infobox=yes, if different from Category:{{{PROJECT}}} articles needing infoboxes. Do not specify the 'Category:' prefix.
priority(the parameters are the same as for importance)
Examples
<syntaxhighlight lang="wikitext">
- attention – set
|attention=yesif 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:Rock music articles needing attention.
- 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:|Category:]].WPBannerDoc error: either
|PROJECT=or|AUTO_ASSESS_CAT=must be specified withauto
- Use of the above values (or value combinations) with this parameter populates [[:Category:|Category:]].WPBannerDoc error: either
- category – set
|category=noif, and only if, a banner is being used for demonstration or testing purposes, to prevent unnecessary or undesirable categorization. Otherwise, omit this parameter. - 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 John Doe, use
|listas=Doe, Johnso that the talk page will show up in the D's and not the J'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=yesif the article needs an infobox. Remember that infoboxes are not suitable for all articles, and can overwhelm short articles.- This parameter populates Category:Rock music articles needing infoboxes.
</syntaxhighlight>
See also
{{WPBannerDoc/addcat}}– used to create documentation for additional categories used with note parameters{{WPBannerDoc/alias}}– used to show which parameters have identical meanings{{WPBannerDoc/assessment}}– used only in{{WPBannerDoc}}; not for use elsewhere{{WPBannerDoc/class mask}}– used to show variations in class values{{WPBannerDoc/collaboration}}– used to create documentation for collaboration parameters{{WPBannerDoc/image needed}}– used to create documentation for{{WPBannerMeta/hooks/image needed}}{{WPBannerDoc/note}}– used to create documentation for note parameters{{WPBannerDoc/peerreview}}– used to create documentation for peer review parameters{{WPBannerDoc/tf}}– used to create documentation for taskforce parameters{{WPBannerMeta}}– the meta-template for WikiProject banners- Wikipedia:Template documentation – how-to guide