Template:WPBannerDoc/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

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 capitalization 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=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 {{WPBannerDoc/class mask}} template may be used, e.g.
      |class_values={{WPBannerDoc/class mask
       |category=yes
       |template=yes
      }}
      which is equivalent to |class_values=fa, a, ga, b, c, start, stub, fl, list, category, template, na
  • infobox – variant of needs-infobox.
  • sort
    • |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.

Examples

{{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