Template:WPBannerDoc/sandbox
- WPBannerDoc error: required first parameter missing
 | This is the template sandbox page for Template:WPBannerDoc (diff). See also the companion subpage for test cases. |
Usage
[edit]This template generates standardised parameter documentation for various parameters commonly used with WikiProject banner templates. For example output, see Template:WPBannerDoc/testcases.
Parameters
[edit]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.which is equivalent to|class_values={{WPBannerDoc/class mask |category=yes |template=yes }}
|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
[edit]{{WPBannerDoc|attention|PROJECT=Rock music|ATTENTION_CAT=}}
{{WPBannerDoc|auto|AUTO_ASSESS_CAT=}}
{{WPBannerDoc|category}}
{{WPBannerDoc|class|PROJECT=Rock music|ASSESSMENT_LINK=Wikipedia:WikiProject Rock music/Assessment}}
{{WPBannerDoc|importance|PROJECT=Rock music|ASSESSMENT_LINK=Wikipedia:WikiProject Rock music/Assessment}}
{{WPBannerDoc|listas|first=John|last=Doe}}
{{WPBannerDoc|needs-infobox|PROJECT=Rock music|INFOBOX_CAT=}}
See also
[edit]{{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