Modul:Class

Belgekirina modulê[nîşan bide] [biguhêre] [dîrokê bibîne] [rojane bike]

Usage

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

  (string) A string that can be used as a CSS colour value, e.g. #6699ff

  icon

  (object) An object containing icon-related properties:

  file

  (string) A filename, without File: prefix, preferably formatted with underscores, 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. 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. 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, 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

Ev belgekirina li jor rasterast ji Modul:Class/belge tê wergirtin. (biguhêre | dîrokê bibîne)
Bikarhêner dikarin ceribandinên xwe yên vê modulê li ser rûpelên ceribandinê (biafirîne | bar bike) û testcases (biafirîne) pêk bînin.
Binrûpelên vê modulê nîşan bide.

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

local mArguments -- lazily loaded
local definitions = mw.loadJsonData('Module:Class/definition.json')

local p = {}

--------------------------------------------------------------------------------
-- Local configuration and messages
--------------------------------------------------------------------------------

local cfg = {
	defaultCode = 'DEFAULT',
	classPrefix = 'assess-',
	globalClass = 'assess',
	defaultClassSuffix = 'default',
	unboldClassSuffix = 'unbold',
	catRootFormat = 'Gotarên %s bi %s',
	catTopicFormat = 'Gotarên %s bi %s',
	catBEsinifTopicFormat = 'Gotarên %s %s',
	catBasicFormat = 'Gotarên bi %s',
	categoryFormat = '[[:Kategorî:%s|%s]]',
	templateLocation = 'Template:Class',
	iconTemplateLocation = 'Template:Class/icon',
	colourTemplateLocation = 'Template:Class/colour',
	stylesLocation = 'Module:Class/styles.css',
	baseColourPath = {'colour', 'base'},
	iconPath = {"icon", "file"},
	iconDefaultPath = {"icon", "default"},
	iconAttribPath = {"icon", "requiresAttribution"},
	fullLabelPath = {"labels", "full"},
	shortLabelPath = {"labels", "short"},
	categoryRootPath = {"categoryRoot"}, -- behsa categoryRoot li modula [[Modul:Class/definition.json]] dike
	tooltipPath = {"labels", "tooltip"},
	yes = {"erê"}, -- li jêr min erê/yes çêkir. Niha ev tercime nayê bikaranîn
	no = {"na"}, -- li jêr min na/no çêkir. Niha ev tercime nayê bikaranîn
	argumentNames = { -- li jêr e. Nayê bikaranîn
		class = "class",
		style = "style"
	},
	getOptions = { --li jêr hem kurdî hem îngilîzî dikare bi kar bîne li gorî koda nû
		--First item is localized argument name, second is case-sensitivity
		bold = {"bold", "stûr", false},
		header = {"header", "header", false},
		image = {"image", "wêne", false},
		rowspan = {"rowspan","rowspan", false},
		fullcategory = {"fullcategory", "fulkategorî", true},
		category = {"category", "kategorî", true},
		topic = {"topic", "mijar", true}
	}
}

--------------------------------------------------------------------------------
-- Argument helper functions
--------------------------------------------------------------------------------

local function getRawArgs(frame, wrapper)
	--Retrieves the arguments from the frame
	mArguments = mArguments or require('Module:Arguments')
	return mArguments.getArgs(frame, {
		wrappers = wrapper,
		trim = false,
		removeBlanks = false
	})
end

local function makeInvokeFunction(func, wrapper)
	--Wraps a general function into an invokable version
	return function (frame)
		local args = getRawArgs(frame, wrapper)
		return func(args)
	end
end

--------------------------------------------------------------------------------
-- String helper functions
--------------------------------------------------------------------------------

local function trim(str)
	--Trims strings, passes through non-strings without modification
	return (type(str) == 'string') and mw.text.trim(str) or str
end

local function normalizeValue(val)
	--Normalizes strings, particularly class codes
	if type(val) == 'string' then val = trim(val):lower() end
	if val == '' then val = nil end
	return val
end

local function ucfirst(str)
	--Capitalizes the first character of a string
	return mw.ustring.upper(mw.ustring.sub(str, 1, 1)) .. mw.ustring.sub(str, 2)
end

--------------------------------------------------------------------------------
-- Definition helper functions
--------------------------------------------------------------------------------

local function getDefinition(code)
	--Retrieves the definition and canonical class code for a given code.
	--Returns two values: the definition object and the canonical class code
	--string.
	local canonicalCode = normalizeValue(code)
	if code == cfg.defaultCode then canonicalCode = code end
	local class = definitions[canonicalCode]
	while class and class.alias do
		canonicalCode = class.alias
		class = definitions[class.alias]
	end
	if not class then
		return nil, nil
	end
	return class, canonicalCode
end

local function getDefault()
	--Shortcut function for retrieving the default definition
	return getDefinition(cfg.defaultCode) end

local function getProperty(class, default, map)
	--Retrieves a given property from a string given a class definition, a
	--default class definition, and a map for the path to traverse through the
	--class object. The map should be a sequential table of string property
	--names, e.g. {"colour", "base"} would retrieve someClass.colour.base
	local prop, dProp = class, default
	for k, v in ipairs(map) do
		prop = ((type(prop) == 'table') or nil) and prop[v]
		dProp = ((type(dProp) == 'table') or nil) and dProp[v]
	end
	if prop == nil then prop = dProp end
	return prop
end

--------------------------------------------------------------------------------
-- Color functions
--------------------------------------------------------------------------------

function p._colour(code)
	--Retrieves the base colour for a given code
	return getProperty(getDefinition(code), getDefault(), cfg.baseColourPath)
end

function p.colour(frame)
	--Retrieves the base colour for a given code; is invokable
	local args = getRawArgs(frame, cfg.colourTemplateLocation)
	-- Nowiki tags prevent output beginning with "#" from triggering bug 14974.
	return frame:extensionTag('nowiki', p._colour(args[1]))
end

--------------------------------------------------------------------------------
-- Icon functions
--------------------------------------------------------------------------------

function p._icon(args)
	--Retrieves an icon image and formats it as wikitext
	local class = getDefinition(args["class"] or args["sinif"] or args[1])
	local default = getDefault()
	local file = getProperty(class, default, cfg.iconPath)
	local label = 
		getProperty(class, default, cfg.tooltipPath) or
		ucfirst(getProperty(class, default, cfg.fullLabelPath))
	local attrib = getProperty(class, default, cfg.iconAttribPath)
	local size = args.size or '16px'
	local span = mw.html.create('span')

	span
		:cssText(args[cfg.argumentNames.style])
		:attr('title', label)
		:wikitext(
			string.format(
				'[[File:%s|%s|' .. size .. '%s|class=noviewer|alt=]]',
				file,
				label,
				attrib and '' or '|link='
			)
		)
	return tostring(span)
end

p.icon = makeInvokeFunction(p._icon, cfg.iconTemplateLocation)
--Invokable version of p._icon

--------------------------------------------------------------------------------
-- Class functions
--------------------------------------------------------------------------------

function p._class(args)
	--Parses its arguments into a table cell with an optional icon, a name
	--linked to an appropriate category, and appropriate colour styling
	local classDef, classCode =
		getDefinition(args[cfg.argumentNames.class] or args[1])
	local default = getDefault()
	local iconDefault = getProperty(classDef, default, cfg.iconDefaultPath)
	local shortLabel = getProperty(classDef, default, cfg.shortLabelPath)
	local categoryRoot = getProperty(classDef, default, cfg.categoryRootPath)
	--o is short for "options", go for "get options". Bool true → case-sensitive
	local o, go = {}, cfg.getOptions
	for k, v in pairs(go) do
	    o[v[1]] = (v[3] and trim(args[v[1]]) or normalizeValue(args[v[1]])) or (v[3] and trim(args[v[2]]) or normalizeValue(args[v[2]]))
	end

	local cell = mw.html.create(o.header and 'th' or 'td')
	--image=yes forces icon, image=no disables it, otherwise checks default
	local icon = iconDefault and (o.image ~= 'no' and o.image ~= 'na') or (o.image == 'yes' or o.image == 'erê' or o.image == 'belê')
	icon = icon and p.icon(args) .. ' ' or ''

	local category
	if o.fullcategory then
		category = o.fullcategory
	elseif o.category then
		if categoryRoot == "yên nehatine sinifandin" then
			category = string.format(cfg.catBEsinifTopicFormat, o.category, categoryRoot)
		else
			category = string.format(cfg.catRootFormat, o.category, categoryRoot)
		end
	elseif o.topic then
		if categoryRoot == "yên nehatine sinifandin" then
			category = string.format(cfg.catBEsinifTopicFormat, o.topic, categoryRoot)
		else
			category = string.format(cfg.catTopicFormat, o.topic, categoryRoot)
		end
	else
		if categoryRoot == "yên nehatine sinifandin" then
			category = "Gotarên nehatine sinifandin"
		else
			category = string.format(cfg.catBasicFormat, categoryRoot)
		end
	end
	local text = string.format(cfg.categoryFormat, category, shortLabel)
	cell
		:addClass(cfg.globalClass)
		:addClass(
			o.bold == (o.image ~= 'no' and o.image ~= 'na') and cfg.classPrefix .. cfg.unboldClassSuffix or nil
		)
		:addClass(cfg.classPrefix .. (classCode or cfg.defaultClassSuffix))
		:attr('rowspan', tonumber(o.rowspan))
		:wikitext(mw.getCurrentFrame():extensionTag{ name = 'templatestyles', args = {src = cfg.stylesLocation} }, icon, text)

	return tostring(cell)
end

p.class = makeInvokeFunction(p._class, cfg.templateLocation)
--Invokable version of p._class

return p