Module:Class/doc

This is a documentation subpage for Module:Class.
It may contain usage information, categories and other content that is not part of the original module page.

This Lua module is used on approximately 4,370,000 pages, or roughly 7% of all pages.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This module can only be edited by administrators because it is transcluded onto one or more cascade-protected pages.

This module depends on the following other modules:

This module uses TemplateStyles:

Module:Class/styles.css (sandbox)

Usage

This module implements Template:Class, Template:Class/icon and Template:Class/colour.

Documentation for Module:Class/definition.json

Following are notes documenting the model for the class definition JSON.

The top-level JSON object contains a number of objects. Each is either a class definition, or an alias. The keys are "class codes" that can be used as input. The keys containing class definitions are the canonical class codes. Class codes should be lowercase (except the special code DEFAULT) and canonical class codes are, so far, strictly alphabetic (bplus, not b+)
An alias should be an object with exactly one property alias that contains the canonical class code string.
A class definition can have a number of properties:
categoryRoot

(string) The root of a category name for articles of the quality class. For example, the top-level category for featured articles is Category:FA-Class articles, and subject-level categories might exist at "Category:FA-Class subject articles", so its root is FA-Class.

colour

(object) An object containing colour-related properties; each value within should be a string that can be used as a CSS colour value, e.g. #6699ff

base

(string) a colour string reflecting a base background colour^{[model 1]}

textOnBlack

(string) a colour string reflecting a suitable colour to use for text on a black background

textOnWhite

(string) a colour string reflecting a suitable colour to use for text on a white background

icon

(object) An object containing icon-related properties:
file

(string) A filename, without File: prefix, preferably formatted with underscores,^{[model 2]} e.g. Featured_article_star.svg

default

(boolean) Whether the icon should be displayed by default—usually only high quality ranks display icons by default

requiresAttribution

(boolean) true if the file property refers to a file that is not public domain or CC0-licensed. When a file is PD/CC0 and thus this property false, we can disable image linking and alt text, which is good for accessibility for purely-decorative images.

labels

(object) An object containing label strings. All the label properties are particularly tentative.
adjective

(string) A label string describing an adjective that could be used to describe a page with this class. Prefer lowercase or title case.^{[model 3]} This property is highly tentative.

full

(string) A label string describing a noun phrase that could be used to describe a page with this class. Prefer lowercase or title case.^{[model 3]} This property is highly tentative.

short

(string) A label string describing a short name for the class that can be used in context. This may frequently be the same as the class code, but should usually be capitalized (e.g. Redirect or GA). One particular precedent imported to this property is that class code unassessed uses ??? as its short label. This property is highly tentative.

tooltip

(string) A label string with a tooltip that should be used to describe the class if more details are needed. This property is optional and probably should only be specified if needed.

page

(string) The full page name of a wiki page describing the quality class, preferably formatted with spaces,^{[model 4]} e.g. Wikipedia:Featured articles
At the moment, there's no definition of which properties might be mandatory or optional for class definitions; for now, it's probably safest to assume that "label" properties are mandatory.
Tentatively a special DEFAULT object, using capitalization to separate it from other keys, defines defaults that can be used. This should either be a complete object (all properties mandatory) or an alias to a complete object. In English Wikipedia's case this is currently an alias to the unassessed class definition.

Object model notes

^ This is assumed to be a light-mode colour; it might be desirable to split this into light- and dark-mode properties.
^ Underscores are probably better for file names because they're more easily used in URLs, and don't hurt anything being used in wikitext.
^ ^a ^b Lowercase is better for full or generic words, e.g. "featured", but title case is better for constructed values, e.g. "Start-Class".
^ Spaces are probably better for referencing wiki pages because they're easily used as strings or in wikitext; use in URLs would have to do other transformations anyway.

[1] This is assumed to be a light-mode colour; it might be desirable to split this into light- and dark-mode properties.

[underscores-2] Underscores are probably better for file names because they're more easily used in URLs, and don't hurt anything being used in wikitext.

[lowerTitle-3] Lowercase is better for full or generic words, e.g. "featured", but title case is better for constructed values, e.g. "Start-Class".

[spaces-4] Spaces are probably better for referencing wiki pages because they're easily used as strings or in wikitext; use in URLs would have to do other transformations anyway.

[model 1]

[model 2]

[model 3]

[model 4]