Jump to content

Template:B/doc

Add links
From Wikipedia, the free encyclopedia
[Raw output of this template is intentionally suppressed.]
Appearance of basic usage, immediately following |class=, in wikiproject banner source code, and after mandatory substitution:
B
  |b1  =
  |b2  =
  |b3  =
  |b4  =
  |b5  =
  |b6  =
Appearance (if any) of the results as rendered in the Wikipedia talk page to which it is applied are entirely dependent on the wikiproject template to which this subtemplate is applied.
Either the expanded banner template will show a list of B-class criteria supplied by this subtemplate, or this subtemplate will operate silently as a source-code-only checklist.

Usage

[edit]

|class={{subst:B}}

To provide known values immediately:

|class={{subst:B|b1 value|b2 value|b3 value|b4 value|b5 value|b6 value|assessment class}}

See below for more examples, including providing few, one or zero B-criteria values.

Procedure

[edit]

This template is intended for use with any WikiProject article talk page banners that are based on {{WPBannerMeta}} and which make use of its B_CHECKLIST = yes feature.

Its purpose is to speed up the creation of B-class checklist parameters, or speed up the entry of their values for editors who are doing large amounts of assessment and have memorized the order of the parameters already, by obviating the need to manually create the 6 required checklist parameters.

The template must be substituted, or the banner's B-class checklist will not work properly. It substitutes cleanly, with no evidence of having been created by a template, such as leftover conditional code.

No parameters are required. If the 7th parameter is used, then either it must be specified numerically (e.g. {{subst:B|7=C}}) or all 7 parameters must be present, though the first 6 may be empty ({{subst:B|||||||C}}). If used, the 7th parameter must have a value that corresponds to one of the quality assessment classes (C, Stub, etc.). The default value is B.

Examples

[edit]

indicating C-class article ready for B-class checklist assessment, can be done more expediently with:

or

Similarly,

indicating a stub that (essentially by definition) cannot meet most B-class criteria, and has not even been evaluated for some of them, but is sufficient in supporting materials, can be done more expediently with:

The end result of each pair of examples will look the same in the final code.

Note that it must be preceded by |class=, and must be followed by | and the next parameter or, if at end of template, by }}.

Parameter values

[edit]

Note that there is no testing to ensure that the values entered are valid; a value of "yess" or "Statr" will appear verbatim, so check before saving.

The first 6 parameters are in the same b1 through b6 order as in WPBannerMeta:

  1. Referencing and citations
  2. Coverage and accuracy
  3. Structure
  4. Grammar
  5. Supporting materials
  6. Accessibility

The available values for all of these 6 parameters are ? (unassessed, the default), blank (empty, but present, which defaults to ?), yes (which indicates a passing assessment) or no (which indicates a failing assessment). The template does not output actual empty (blank) values, as this will trigger the WikiProject banner to display very longwinded B-class assessment parameter instructions, because the meta-template for the banner is not coded to recognize these parameters if empty, thus the "?".

The (sensible) available assessment classes for the 7th parameter are Stub, Start, C and B. The GA and higher assessments do not use B-class checklist parameters, and various other values, such as Cat and NA, are not logically applicable to use of this template, since they are for non-articles. Similarly, the Current and Future assessments, for articles about current or upcoming events and which are in a constant state of flux, are pointless to assess for B-class status until the event is past. The parameters can be used with GA and up to show (in the source view) a historical assessment at B-class, but the B checklist will not be displayed by the banner. The default selection, B, will appear as "C" in the banner until all B-class checklist items are yes. Please note: Do not just fill them with yes if you have not actually assessed the article for compliance with the B-class quality checklist!

TemplateData

[edit]
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:B in articles based on its TemplateData.

TemplateData for B

A checklist for deciding whether to rate articles as B-class. Note that an article should pass ALL the criteria before being rated as B-class. This is a somewhat lower standard than good or featured article status, though not especially so. Leave entries blank if you haven't gotten around to a particular criterion yet.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
b1 (referencing and citation)1

Does the article have reliable sources? Are they cited using inline citations, especially for controversial or important information?

Suggested values
no yes
Example
no
Stringoptional
b2 (coverage and accuracy)2

Does the article reasonably cover the topic? Does it have any obvious or unmistakable omissions, inaccuracies, or errors?

Suggested values
no yes
Example
no
Stringsuggested
b3 (structure)3

Does the article have a well-defined structure? This would include both section headings and a lead section. (The headings should also be meaningful or natural places to break up the content.)

Suggested values
no yes
Example
no
Stringoptional
b4 (grammar)4

Does the article have proper spelling and grammar? (The prose does not have to brilliant or tear-inducing, just okay.)

Suggested values
no yes
Example
no
Stringoptional
b5 (supporting materials)5

Does the article have (if applicable) an infobox, illustrations, diagrams, external links, or other relevant non-article content?

Suggested values
no yes
Example
no
Stringoptional
b6 (accessibility)6

Is the article comprehensible enough? Do you understand it, or do you lack the necessary background knowledge about the discipline, country, field of work, etc. in question?

Suggested values
no yes
Example
no
Stringoptional
Article assessment7

The assessment of the article on Wikipedia's quality assessment scale (i.e. Stub, Start, C, B, A, GA, FA, in roughly that order).

Suggested values
Stub Start C B A GA FA
Stringsuggested

See also

[edit]


Retrieved from "https://en.wikipedia.org/w/index.php?title=Template:B/doc&oldid=1207166839"