Template:BPBannerDoc/doc

Usage

This template generates standardised parameter documentation for various parameters commonly used with WikiProject banner templates. For example output, see Template:BPBannerDoc/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 {{BPBannerMeta}} 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 {{BPBannerMeta}} on the main template page. If any are omitted from the {{BPBannerMeta}}, omit the same ones from {{BPBannerDoc}} 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=inline is 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, na Alternatively, the {{BPBannerDoc/class mask}} template may be used, e.g.

    |class_values={{BPBannerDoc/class mask
     |category=yes
     |template=yes
    }}

    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 {{BPBannerMeta}} on the main template page. If any are omitted from the {{BPBannerMeta}}, omit the same ones from {{BPBannerDoc}} also.
  • |importance_values= – when |IMPORTANCE_SCALE=inline is 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.
• listas
  • |last= – last portion of the example name (the primary sort key)
  • |first= – first portion of the example name (the secondary sort key)
  • |last2= – the secondary example name, omitting the article
  • |first2= – the article of the secondary example name
• needs-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

{{BPBannerDoc|attention|PROJECT=Rock music|ATTENTION_CAT=}}
{{BPBannerDoc|auto|AUTO_ASSESS_CAT=}}
{{BPBannerDoc|category}}
{{BPBannerDoc|class|PROJECT=Rock music|ASSESSMENT_LINK=Bharatpedia:WikiProject Rock music/Assessment}}
{{BPBannerDoc|importance|PROJECT=Rock music|ASSESSMENT_LINK=Bharatpedia:WikiProject Rock music/Assessment}}
{{BPBannerDoc|listas|first=John|last=Doe}}
{{BPBannerDoc|needs-infobox|PROJECT=Rock music|INFOBOX_CAT=}}

See also

• {{BPBannerDoc/addcat}} – used to create documentation for additional categories used with note parameters
• {{BPBannerDoc/alias}} – used to show which parameters have identical meanings
• {{BPBannerDoc/assessment}} – used only in {{BPBannerDoc}}; not for use elsewhere
• {{BPBannerDoc/class mask}} – used to show variations in class values
• {{BPBannerDoc/collaboration}} – used to create documentation for collaboration parameters
• {{BPBannerDoc/image needed}} – used to create documentation for {{BPBannerMeta/hooks/image needed}}
• {{BPBannerDoc/note}} – used to create documentation for note parameters
• {{BPBannerDoc/peerreview}} – used to create documentation for peer review parameters
• {{BPBannerDoc/tf}} – used to create documentation for taskforce parameters
• {{BPBannerMeta}} – the meta-template for WikiProject banners
• Bharatpedia:Template documentation – how-to guide