Template:Assessment Quality Summary/doc

From Wikibooks, open books for an open world
Jump to navigation Jump to search

Usage[edit source]

This template will display information about quality assessments. The template is generally used for the instructions on a WikiProject's "/Assessment" page.

Full syntax[edit source]

The full syntax is as follows:

{{Assessment Quality Summary
 |banner=
 |topic=
 |extraparam=
}}

Parameters[edit source]

  • |banner= (required) - the name of the WikiProject's project banner template, without the "Template:" prefix. This parameter is found in the banner name field. (Note: a template shortcut can also be used).
For example: |BANNER_NAME=Template:banner
  • |topic= (required) - set so that the quality categories are: "Foo-quality topic pages". This parameter can be found in one of two places. By default, the topic field would equal the project field, or if it exists, the corresponding assessment category field.
For example: |PROJECT=topic  or  |ASSESSMENT_CAT=topic pages
  • |extraparam= (optional) - extra parameters to be passed over to the WikiProject's banner, usually the name of a task force with a yes. This parameter is found in the corresponding task force field.
For example: |tf 1=extraparam=yes

Example[edit source]

{{Assessment Quality Summary
 |banner     = WikiProject Languages
 |topic      = French language
 |extraparam = french=yes
}}

Result:

A page's quality assessment is generated from the quality parameter in the {{WikiProject Languages}} project banner on its talk page:

{{WikiProject Languages|quality=???|french=yes}}

The following values may be used for the quality parameter to describe the quality of the page:

FB (for featured book pages only; adds page to Category:FB-quality French language pages)  FB 
A (adds pages to Category:A-quality French language pages)  A 
B (adds pages to Category:B-quality French language pages)  B 
C (adds pages to Category:C-quality French language pages)  C 
Start (adds pages to Category:Start-quality French language pages)  Start 
Stub (adds pages to Category:Stub-quality French language pages)  Stub 

For pages that are not part of books, the following values can also be used for the quality parameter:

Category (for categories; adds pages to Category:Category-quality French language pages)  Category 
Project (for project pages; adds pages to Category:Project-quality French language pages)  Project 
Template (for templates; adds pages to Category:Template-quality French language pages)  Template 
Shelf (for shelf pages; adds pages to Category:Shelf-quality French language pages)  Shelf 
NB (for any other pages where assessment is unnecessary; adds pages to Category:NB-quality French language pages)  NB 
??? (pages for which a valid quality has not yet been provided are listed in Category:Unassessed-quality French language pages)  ??? 

The quality parameter should be assigned according to the quality scale below.

See also[edit source]

Standard class types
 FB   A   B   C 
{{quality|FB}} {{quality|A}} {{quality|B}} {{quality|C}}
 Start   Stub   NB   ??? 
{{quality|Start}} {{quality|Stub}} {{quality|NB}} {{quality|Unassessed}}
Non-standard quality types
 Project   Category   Shelf   Template 
{{quality|Project}} {{quality|Category}} {{quality|Shelf}} {{quality|Template}}
Priority types
 Top   High   Mid 
{{priority|Top}} {{priority|High}} {{priority|Mid}}
 Low   NB   ??? 
{{priority|Low}} {{priority|NB}} {{priority|Unknown}}
Quality
Priority