Template:WPBannerDoc: Difference between revisions
Appearance
imported>Deadfire m updating |
Tungstenchan (talk | contribs) m Text replacement - "BattleTechWiki" to "BattleIntelligence" |
||
| Line 2: | Line 2: | ||
|Attention|attention=set {{para|{{{1}}}|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. | |Attention|attention=set {{para|{{{1}}}|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. | ||
**<small>This parameter populates {{cl|{{#if:{{{ATTENTION_CAT|}}}|{{{ATTENTION_CAT}}}|{{{PROJECT|}}} articles needing attention}}}}.</small>{{#if:{{{ATTENTION_CAT|}}}{{{PROJECT|}}}||<span class=error>WPBannerDoc error: either {{para|PROJECT}} or {{para|ATTENTION_CAT}} must be specified with <code>{{{1}}}</code></span>}} | **<small>This parameter populates {{cl|{{#if:{{{ATTENTION_CAT|}}}|{{{ATTENTION_CAT}}}|{{{PROJECT|}}} articles needing attention}}}}.</small>{{#if:{{{ATTENTION_CAT|}}}{{{PROJECT|}}}||<span class=error>WPBannerDoc error: either {{para|PROJECT}} or {{para|ATTENTION_CAT}} must be specified with <code>{{{1}}}</code></span>}} | ||
|auto=This parameter is for the use of [[ | |auto=This parameter is for the use of [[BattleIntelligence:Bots|bots]] and indicates that the article has been [[BattleIntelligence:Types of bots#WikiProject tagging and auto-assessment bots|automatically rated]]: | ||
**{{para|auto|length}} – based on the length of the article | **{{para|auto|length}} – based on the length of the article | ||
**{{para|auto|inherit}} – because one or more other projects use this class | **{{para|auto|inherit}} – because one or more other projects use this class | ||
**{{para|auto|yes}} (or {{para|auto|stub}}), in conjunction with {{para|class|stub}} – as Stub-Class because it uses a [[ | **{{para|auto|yes}} (or {{para|auto|stub}}), in conjunction with {{para|class|stub}} – as Stub-Class because it uses a [[BattleIntelligence:Stub|stub template]]{{#ifeq:{{{AUTO_ASSESS_CAT|}}}|none|| | ||
***<small>Use of the above values (or value combinations) with this parameter populates {{cl|{{{AUTO_ASSESS_CAT|Automatically assessed {{{PROJECT|}}} articles}}}}}.</small>{{#if:{{{AUTO_ASSESS_CAT|}}}{{{PROJECT|}}}||<span class=error>WPBannerDoc error: either {{para|PROJECT}} or {{para|AUTO_ASSESS_CAT}} must be specified with <code>{{{1}}}</code></span>}}}} | ***<small>Use of the above values (or value combinations) with this parameter populates {{cl|{{{AUTO_ASSESS_CAT|Automatically assessed {{{PROJECT|}}} articles}}}}}.</small>{{#if:{{{AUTO_ASSESS_CAT|}}}{{{PROJECT|}}}||<span class=error>WPBannerDoc error: either {{para|PROJECT}} or {{para|AUTO_ASSESS_CAT}} must be specified with <code>{{{1}}}</code></span>}}}} | ||
|category=set {{para|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. | |category=set {{para|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. | ||
| Line 11: | Line 11: | ||
|<!--NULL--> = {{#ifexist:{{#if:{{{PROJECT_LINK|}}} | |<!--NULL--> = {{#ifexist:{{#if:{{{PROJECT_LINK|}}} | ||
|{{{PROJECT_LINK}}} | |{{{PROJECT_LINK}}} | ||
| | |BattleIntelligence:WikiProject {{{PROJECT}}} | ||
}}/Assessment | }}/Assessment | ||
|{{#if:{{{PROJECT_LINK|}}} | |{{#if:{{{PROJECT_LINK|}}} | ||
|{{{PROJECT_LINK}}} | |{{{PROJECT_LINK}}} | ||
| | |BattleIntelligence:WikiProject {{{PROJECT}}} | ||
}}/Assessment | }}/Assessment | ||
|<!--NULL--> | |<!--NULL--> | ||
| Line 23: | Line 23: | ||
}} |bpara={{{bpara|}}} |bmax={{{bmax|}}} |QUALITY_SCALE={{{QUALITY_SCALE|}}} |class_values={{{class_values|}}} |IMPORTANCE_SCALE={{{IMPORTANCE_SCALE|}}} |importance_values={{{importance_values|}}} |BANNER_NAME={{#if:{{{BANNER_NAME|}}}|{{{BANNER_NAME}}}|Template:WikiProject {{{PROJECT}}}}} }} | }} |bpara={{{bpara|}}} |bmax={{{bmax|}}} |QUALITY_SCALE={{{QUALITY_SCALE|}}} |class_values={{{class_values|}}} |IMPORTANCE_SCALE={{{IMPORTANCE_SCALE|}}} |importance_values={{{importance_values|}}} |BANNER_NAME={{#if:{{{BANNER_NAME|}}}|{{{BANNER_NAME}}}|Template:WikiProject {{{PROJECT}}}}} }} | ||
|listas=This parameter, which is the equivalent of the [[Help:Category#Default sort key|DEFAULTSORT sortkey]] that should be placed on all biographical articles, is a sortkey for the article talk page (e.g. for {{{first}}} {{{last}}}, use {{para|listas|{{ucfirst:{{{last}}}}}, {{{first}}}}} so that the talk page will show up in the {{uc:{{str index|{{{last}}}|1}}}}'s and not the {{str index|{{{first}}}|1}}'s of the various assessment and administrative categories{{#if:{{{last2|}}}|; similarly, for topics with titles beginning with an [[article (grammar)|article]] such as "the" or "a" - e.g. for {{{first2}}} {{{last2}}}, use {{para|listas|{{ucfirst:{{{last2}}}}}, {{{first2}}}}} so that the talk page will show up in the {{uc:{{str index|{{{last2}}}|1}}}}'s}}). 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.<br />If the article is using {{tl|WikiProject banner shell}} then it is preferable to add {{para|listas}} to that template instead of a project banner template. Putting the parameter on more than one template is not required. {{#if:{{{last|}}}||<span class=error>WPBannerDoc error: {{para|last}} must be specified with <code>{{{1}}}</code></span>}} {{#if:{{{first|}}}||<span class=error>WPBannerDoc error: {{para|first}} must be specified with <code>{{{1}}}</code></span>}} {{#if:{{{last2|}}}|{{#if:{{{first2|}}}||<span class=error>WPBannerDoc error: {{para|first2}} must be specified with {{para|last2}}</span>}}|{{#if:{{{first2|}}}|<span class=error>WPBannerDoc error: {{para|last2}} must be specified with {{para|first2}}</span>}} }} | |listas=This parameter, which is the equivalent of the [[Help:Category#Default sort key|DEFAULTSORT sortkey]] that should be placed on all biographical articles, is a sortkey for the article talk page (e.g. for {{{first}}} {{{last}}}, use {{para|listas|{{ucfirst:{{{last}}}}}, {{{first}}}}} so that the talk page will show up in the {{uc:{{str index|{{{last}}}|1}}}}'s and not the {{str index|{{{first}}}|1}}'s of the various assessment and administrative categories{{#if:{{{last2|}}}|; similarly, for topics with titles beginning with an [[article (grammar)|article]] such as "the" or "a" - e.g. for {{{first2}}} {{{last2}}}, use {{para|listas|{{ucfirst:{{{last2}}}}}, {{{first2}}}}} so that the talk page will show up in the {{uc:{{str index|{{{last2}}}|1}}}}'s}}). 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.<br />If the article is using {{tl|WikiProject banner shell}} then it is preferable to add {{para|listas}} to that template instead of a project banner template. Putting the parameter on more than one template is not required. {{#if:{{{last|}}}||<span class=error>WPBannerDoc error: {{para|last}} must be specified with <code>{{{1}}}</code></span>}} {{#if:{{{first|}}}||<span class=error>WPBannerDoc error: {{para|first}} must be specified with <code>{{{1}}}</code></span>}} {{#if:{{{last2|}}}|{{#if:{{{first2|}}}||<span class=error>WPBannerDoc error: {{para|first2}} must be specified with {{para|last2}}</span>}}|{{#if:{{{first2|}}}|<span class=error>WPBannerDoc error: {{para|last2}} must be specified with {{para|first2}}</span>}} }} | ||
|needs-infobox|infobox=set {{para|{{{1}}}|yes}} if the article needs an [[ | |needs-infobox|infobox=set {{para|{{{1}}}|yes}} if the article needs an [[BattleIntelligence:Manual of Style/Infoboxes|infobox]]. Remember that infoboxes are not suitable for all articles, and can overwhelm short articles. | ||
**<small>This parameter populates {{cl|{{#if:{{{INFOBOX_CAT|}}}|{{{INFOBOX_CAT}}}|{{{PROJECT}}} articles needing infoboxes}}}}.</small>{{#if:{{{INFOBOX_CAT|}}}{{{PROJECT|}}}||<span class=error>WPBannerDoc error: either {{para|PROJECT}} or {{para|INFOBOX_CAT}} must be specified with <code>{{{1}}}</code></span>}} | **<small>This parameter populates {{cl|{{#if:{{{INFOBOX_CAT|}}}|{{{INFOBOX_CAT}}}|{{{PROJECT}}} articles needing infoboxes}}}}.</small>{{#if:{{{INFOBOX_CAT|}}}{{{PROJECT|}}}||<span class=error>WPBannerDoc error: either {{para|PROJECT}} or {{para|INFOBOX_CAT}} must be specified with <code>{{{1}}}</code></span>}} | ||
|small=this parameter is no longer supported and can safely be removed from the template. | |small=this parameter is no longer supported and can safely be removed from the template. | ||
Latest revision as of 00:06, 1 May 2025
- WPBannerDoc error: required first parameter missing
File:Test Template Info-Icon - Version (2).svg Template documentation[view] [edit] [history] [purge]
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.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
{{WPBannerDoc|attention|PROJECT=Characters|ATTENTION_CAT=}}
{{WPBannerDoc|auto|AUTO_ASSESS_CAT=}}
{{WPBannerDoc|category}}
{{WPBannerDoc|class|PROJECT=Characters|ASSESSMENT_LINK=BattleIntelligence:WikiProject Characters/Assessment}}
{{WPBannerDoc|importance|PROJECT=Characters|ASSESSMENT_LINK=Wikipedia:WikiProject Characters/Assessment}}
{{WPBannerDoc|listas|first=John|last=Doe}}
{{WPBannerDoc|needs-infobox|PROJECT=Characters|INFOBOX_CAT=}}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- BattleIntelligence:Template documentation – how-to guide