Module:Class/doc - Revision history

64.114 etc at 02:21, 19 October 2024

2024-10-19T02:21:33Z

← Previous revision		Revision as of 02:21, 19 October 2024
Line 1:		Line 1:
	{{high-use~~\|9500000\|all-pages=yes~~}}		{{high-use}}
			{{cascade-protected template\|page=module}}
	{{Lua\|Module:Arguments\|Module:Class/definition.json}}		{{Lua\|Module:Arguments\|Module:Class/definition.json}}
	{{TemplateStyles\|Module:Class/styles.css}}		{{TemplateStyles\|Module:Class/styles.css}}

Warudo: Added the page to :Category:Module documentation pages

2024-08-29T20:45:20Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 20:45, 29 August 2024
Line 43:		Line 43:

	}}</includeonly>		}}</includeonly>
			<noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

Nihiltres: /* Documentation for Module:Class/definition.json */ Update to reflect "colour" being an object, and add textOnBlack property because it's clearly necessary now that dark mode is official

2024-07-11T21:56:39Z

Documentation for Module:Class/definition.json: Update to reflect "colour" being an object, and add textOnBlack property because it's clearly necessary now that dark mode is official

← Previous revision		Revision as of 21:56, 11 July 2024
Line 7:		Line 7:

	==Documentation for [[Module:Class/definition.json]]==		==Documentation for [[Module:Class/definition.json]]==
			Following are notes documenting the model for the class definition JSON.
	Since it's not practical to include documentation directly on the page, these notes document the prototype definition object model so far. This is all subject to change, and this documentation might be out of date as the model is better defined, but particularly tentative properties are noted as such.

	* 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 <code>DEFAULT</code>) and canonical class codes are, so far, strictly alphabetic (<code>bplus</code>, not <code>b+</code>)		* 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 <code>DEFAULT</code>) and canonical class codes are, so far, strictly alphabetic (<code>bplus</code>, not <code>b+</code>)
Line 13:		Line 13:
	* A class definition can have a number of properties:		* A class definition can have a number of properties:
	*;<code>categoryRoot</code>: ''(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 <code>FA-Class</code>.		*;<code>categoryRoot</code>: ''(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 <code>FA-Class</code>.
			*;<code>colour</code>
	*;<code>colour</code>: ''(~~string~~)'' A string that can be used as a CSS colour value, e.g. <code>#6699ff</code>		: ''(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. <code>#6699ff</code>
			*:;<code>base</code>: ''(string)'' a colour string reflecting a base background colour<ref group="model">This is assumed to be a light-mode colour; it might be desirable to split this into light- and dark-mode properties.</ref>
			*:;<code>textOnBlack</code>: ''(string)'' a colour string reflecting a suitable colour to use for text on a black background
			*:;<code>textOnWhite</code>: ''(string)'' a colour string reflecting a suitable colour to use for text on a white background
	*;<code>icon</code>		*;<code>icon</code>
	*: ''(object)'' An object containing icon-related properties:		*: ''(object)'' An object containing icon-related properties:

MSGJ: copied from Module talk:Class/definition.json

2023-02-21T21:32:19Z

copied from Module talk:Class/definition.json

← Previous revision		Revision as of 21:32, 21 February 2023
Line 6:		Line 6:
	This module implements [[Template:Class]], [[Template:Class/icon]] and [[Template:Class/colour]].		This module implements [[Template:Class]], [[Template:Class/icon]] and [[Template:Class/colour]].

			==Documentation for [[Module:Class/definition.json]]==
			Since it's not practical to include documentation directly on the page, these notes document the prototype definition object model so far. This is all subject to change, and this documentation might be out of date as the model is better defined, but particularly tentative properties are noted as such.

			* 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 <code>DEFAULT</code>) and canonical class codes are, so far, strictly alphabetic (<code>bplus</code>, not <code>b+</code>)
			* An alias should be an object with exactly one property '''<code>alias</code>''' that contains the canonical class code string.
			* A class definition can have a number of properties:
			*;<code>categoryRoot</code>: ''(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 <code>FA-Class</code>.
			*;<code>colour</code>: ''(string)'' A string that can be used as a CSS colour value, e.g. <code>#6699ff</code>
			*;<code>icon</code>
			*: ''(object)'' An object containing icon-related properties:
			*:;<code>file</code>: ''(string)'' A filename, without <code>File:</code> prefix, preferably formatted with underscores,<ref group="model" name="underscores"/> e.g. <code>Featured_article_star.svg</code>
			*:;<code>default</code>: ''(boolean)'' Whether the icon should be displayed by default—usually only high quality ranks display icons by default
			*:;<code>requiresAttribution</code>: ''(boolean)'' <code>true</code> if the <code>file</code> property refers to a file that is ''not'' public domain or CC0-licensed. When a file ''is'' PD/CC0 and thus this property <code>false</code>, we can disable image linking and alt text, which is good for accessibility for purely-decorative images.
			*;<code>labels</code>
			*: ''(object)'' An object containing label strings. All the label properties are particularly tentative.
			*:;<code>adjective</code>: ''(string)'' A label string describing an adjective that could be used to describe a page with this class. Prefer lowercase or title case.<ref group="model" name="lowerTitle"/> This property is highly tentative.
			*:;<code>full</code>: ''(string)'' A label string describing a noun phrase that could be used to describe a page with this class. Prefer lowercase or title case.<ref group="model" name="lowerTitle"/> This property is highly tentative.
			*:;<code>short</code>: ''(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. <code>Redirect</code> or <code>GA</code>). One particular precedent imported to this property is that class code <code>unassessed</code> uses <code>???</code> as its short label. This property is highly tentative.
			*:;<code>tooltip</code>: ''(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.
			*;<code>page</code>: ''(string)'' The full page name of a wiki page describing the quality class, preferably formatted with spaces,<ref group="model" name="spaces"/> e.g. <code>Wikipedia:Featured articles</code>
			*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 <code>DEFAULT</code> 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 <code>unassessed</code> class definition.

			===Object model notes===
			<references group="model">
			<ref group="model" name="spaces">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.</ref>
			<ref group="model" name="underscores">Underscores are probably better for file names because they're more easily used in URLs, and don't hurt anything being used in wikitext.</ref>
			<ref group="model" name="lowerTitle">Lowercase is better for full or generic words, e.g. "featured", but title case is better for constructed values, e.g. "Start-Class".</ref>
			</references>

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|

Nihiltres: Removed deleted sub-module from Lua template

2022-10-21T02:45:08Z

Removed deleted sub-module from Lua template

← Previous revision		Revision as of 02:45, 21 October 2022
Line 1:		Line 1:
	{{high-use\|9500000\|all-pages=yes}}		{{high-use\|9500000\|all-pages=yes}}
	{{Lua\|Module:Arguments~~\|Module:Class/configuration~~\|Module:Class/definition.json}}		{{Lua\|Module:Arguments\|Module:Class/definition.json}}
	{{TemplateStyles\|Module:Class/styles.css}}		{{TemplateStyles\|Module:Class/styles.css}}

Nihiltres: Updated documentation

2022-06-11T17:52:28Z

Updated documentation

← Previous revision		Revision as of 17:52, 11 June 2022
Line 1:		Line 1:
			{{high-use\|9500000\|all-pages=yes}}
	{{Module rating\|release}}
	{{Lua\|Module:Arguments\|Module:Class/configuration\|Module:Class/definition.json}}		{{Lua\|Module:Arguments\|Module:Class/configuration\|Module:Class/definition.json}}
	{{TemplateStyles\|Module:Class/styles.css}}		{{TemplateStyles\|Module:Class/styles.css}}

	== Usage ==		== Usage ==
	This module ~~will implement~~ [[Template:Class]], [[Template:Class/icon]] and [[Template:Class/colour]].		This module implements [[Template:Class]], [[Template:Class/icon]] and [[Template:Class/colour]].

Nihiltres: +Module:Class/definition.json as dependency

2022-06-09T19:19:44Z

+Module:Class/definition.json as dependency

← Previous revision		Revision as of 19:19, 9 June 2022
Line 1:		Line 1:
	{{Module rating\|release}}		{{Module rating\|release}}
	{{Lua\|Module:Arguments\|Module:Class/configuration}}		{{Lua\|Module:Arguments\|Module:Class/configuration\|Module:Class/definition.json}}
	{{TemplateStyles\|Module:Class/styles.css}}		{{TemplateStyles\|Module:Class/styles.css}}

Gonnym at 04:43, 27 May 2022

2022-05-27T04:43:39Z

← Previous revision		Revision as of 04:43, 27 May 2022
Line 1:		Line 1:
	{{Module rating\|release}}		{{Module rating\|release}}
			{{Lua\|Module:Arguments\|Module:Class/configuration}}
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
			{{TemplateStyles\|Module:Class/styles.css}}

	== Usage ==		== Usage ==
	This module will implement [[Template:Class]], [[Template:Class/icon]] and [[Template:Class/colour]].		This module will implement [[Template:Class]], [[Template:Class/icon]] and [[Template:Class/colour]].
	<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}\|''function_name''}}</code>


	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|
			<includeonly>{{Sandbox other\|\|
	<!-- Categories below this line, please; interwikis at Wikidata -->

	}}</includeonly>		}}</includeonly>

Pppery: Wishful thinking

2020-05-12T21:03:16Z

Wishful thinking

← Previous revision		Revision as of 21:03, 12 May 2020
Line 2:		Line 2:
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
	== Usage ==		== Usage ==
	This module ~~implements~~ [[Template:Class]], [[Template:Class/icon]] and [[Template:Class/colour]].		This module will implement [[Template:Class]], [[Template:Class/icon]] and [[Template:Class/colour]].
	<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}\|''function_name''}}</code>		<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}\|''function_name''}}</code>

Mr. Guye at 22:21, 25 May 2017

2017-05-25T22:21:15Z

← Previous revision		Revision as of 22:21, 25 May 2017
Line 1:		Line 1:
			{{Module rating\|release}}
	{{Module rating \|<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
	== Usage ==		== Usage ==

← Previous revision		Revision as of 02:21, 19 October 2024
Line 1:		Line 1:
	{{high-use~~\|9500000\|all-pages=yes~~}}		{{high-use}}
			{{cascade-protected template\|page=module}}
	{{Lua\|Module:Arguments\|Module:Class/definition.json}}		{{Lua\|Module:Arguments\|Module:Class/definition.json}}
	{{TemplateStyles\|Module:Class/styles.css}}		{{TemplateStyles\|Module:Class/styles.css}}

← Previous revision		Revision as of 02:45, 21 October 2022
Line 1:		Line 1:
	{{high-use\|9500000\|all-pages=yes}}		{{high-use\|9500000\|all-pages=yes}}
	{{Lua\|Module:Arguments~~\|Module:Class/configuration~~\|Module:Class/definition.json}}		{{Lua\|Module:Arguments\|Module:Class/definition.json}}
	{{TemplateStyles\|Module:Class/styles.css}}		{{TemplateStyles\|Module:Class/styles.css}}

← Previous revision		Revision as of 19:19, 9 June 2022
Line 1:		Line 1:
	{{Module rating\|release}}		{{Module rating\|release}}
	{{Lua\|Module:Arguments\|Module:Class/configuration}}		{{Lua\|Module:Arguments\|Module:Class/configuration\|Module:Class/definition.json}}
	{{TemplateStyles\|Module:Class/styles.css}}		{{TemplateStyles\|Module:Class/styles.css}}