imported>Redrose64: /* See also */ image needed

2023-03-01T20:45:21Z

Richardpruen: 1 revision imported

2021-12-05T15:59:11Z

1 revision imported

← Older revision	Revision as of 16:59, 5 December 2021
(No difference)

Wikipedia>Funandtrvl: /* See also */ add

2021-03-07T23:40:54Z

See also: add

New page

{{Documentation subpage}}


== 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:
*{{para|PROJECT}} – this should be the same as the {{para|PROJECT}} parameter passed into {{tlx|WPBannerMeta}} on the main template page
Other parameters vary according to the first one:
*'''<code>attention</code>'''
**{{para|ATTENTION_CAT}} – the category populated by the use of {{para|attention|yes}}, if different from Category:{{{PROJECT}}} articles needing attention. Do not specify the 'Category:' prefix.
*'''<code>Attention</code>''' – variant capitalisation of the above.
*'''<code>auto</code>'''
**{{para|AUTO_ASSESS_CAT}} – the category populated by the use of the {{para|auto}} parameter, if different from Category:Automatically assessed {{{PROJECT}}} articles. Do not specify the 'Category:' prefix.
*'''<code>category</code>''' (no additional parameters)
*'''<code>class</code>'''
**{{para|ASSESSMENT_LINK}}
**{{para|BANNER_NAME}}
**{{para|PROJECT}}
**{{para|PROJECT_LINK}}
**{{para|QUALITY_SCALE}} – these five should be the same as the corresponding parameters passed into {{tlx|WPBannerMeta}} on the main template page. If any are omitted from the {{tlx|WPBannerMeta}}, omit the same ones from {{tlx|WPBannerDoc}} also.
**{{para|bpara}} – set this to the name of the B-Class yes/no parameters, omitting the digit, e.g. {{para|bpara|B-Class-}}
**{{para|bmax}} – if {{para|bpara}} is set, set this to either 5 or 6 to show how many of the B-Class criteria are recognised
**{{para|class_values}} – when {{para|QUALITY_SCALE|inline}} is set, this parameter should be a list of valid class values, e.g. {{para|class_values|fa, ga, b, c, start, stub, fl, list, draft, category, template, na}} Alternatively, the {{tlx|WPBannerDoc/class mask}} template may be used, e.g. <syntaxhighlight lang=moin>|class_values={{WPBannerDoc/class mask
|category=yes
|template=yes
}}</syntaxhighlight> which is equivalent to {{para|class_values|fa, a, ga, b, c, start, stub, fl, list, category, template, na}}
*'''<code>importance</code>'''
**{{para|ASSESSMENT_LINK}}
**{{para|BANNER_NAME}}
**{{para|PROJECT}}
**{{para|PROJECT_LINK}}
**{{para|IMPORTANCE_SCALE}} – these five should be the same as the corresponding parameters passed into {{tlx|WPBannerMeta}} on the main template page. If any are omitted from the {{tlx|WPBannerMeta}}, omit the same ones from {{tlx|WPBannerDoc}} also.
**{{para|importance_values}} – when {{para|IMPORTANCE_SCALE|inline}} is set, this parameter should be a list of valid importance values, e.g. {{para|importance_values|high, mid, low, bottom, na}}
*'''<code>infobox</code>''' – variant of '''needs-infobox'''.
*'''<code>listas</code>'''
**{{para|last}} – last portion of the example name (the primary sort key)
**{{para|first}} – first portion of the example name (the secondary sort key)
**{{para|last2}} – the secondary example name, omitting the [[article (grammar)|article]]
**{{para|first2}} – the [[article (grammar)|article]] of the secondary example name
*'''<code>needs-infobox</code>'''
**{{para|INFOBOX_CAT}} – the category populated by the use of {{para|needs-infobox|yes}}, if different from Category:{{{PROJECT}}} articles needing infoboxes. Do not specify the 'Category:' prefix.
*'''<code>priority</code>''' (the parameters are the same as for '''importance''')

==Examples==
<pre style="overflow:auto;">
{{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=}}
</pre>

==See also==
*{{tlx|WPBannerDoc/addcat}} – used to create documentation for additional categories used with note parameters
*{{tlx|WPBannerDoc/alias}} – used to show which parameters have identical meanings
*{{tlx|WPBannerDoc/assessment}} – used only in {{tlx|WPBannerDoc}}; not for use elsewhere
*{{tlx|WPBannerDoc/class mask}} – used to show variations in class values
*{{tlx|WPBannerDoc/collaboration}} – used to create documentation for collaboration parameters
*{{tlx|WPBannerDoc/note}} – used to create documentation for note parameters
*{{tlx|WPBannerDoc/peerreview}} – used to create documentation for peer review parameters
*{{tlx|WPBannerDoc/tf}} – used to create documentation for taskforce parameters
*{{tlx|WPBannerMeta}} – the meta-template for WikiProject banners
*[[Wikipedia:Template documentation]] – how-to guide

<includeonly>{{Sandbox other||

[[Category:Generic WikiProject templates]]
[[Category:WikiProject banner documentation templates| ]]
}}</includeonly>

← Older revision		Revision as of 21:45, 1 March 2023
Line 62:		Line 62:
	*{{tlx\|WPBannerDoc/class mask}} – used to show variations in class values		*{{tlx\|WPBannerDoc/class mask}} – used to show variations in class values
	*{{tlx\|WPBannerDoc/collaboration}} – used to create documentation for collaboration parameters		*{{tlx\|WPBannerDoc/collaboration}} – used to create documentation for collaboration parameters
			*{{tlx\|WPBannerDoc/image needed}} – used to create documentation for {{tlx\|WPBannerMeta/hooks/image needed}}
	*{{tlx\|WPBannerDoc/note}} – used to create documentation for note parameters		*{{tlx\|WPBannerDoc/note}} – used to create documentation for note parameters
	*{{tlx\|WPBannerDoc/peerreview}} – used to create documentation for peer review parameters		*{{tlx\|WPBannerDoc/peerreview}} – used to create documentation for peer review parameters

Template:WPBannerDoc/doc - Revision history

imported>Redrose64: /* See also */ image needed

Richardpruen: 1 revision imported

Wikipedia>Funandtrvl: /* See also */ add