Module:About

From blackwiki
Revision as of 04:26, 8 April 2016 by test>Nihiltres (A prototype…)
Jump to navigation Jump to search

This module implements the {{about}} hatnote template.

Usage

  • The about function implements the {{about}} template directly, using the frame and applying no options. This should probably only be used in {{about}}.
  • The _about function can be used from Lua to supply a custom arguments list (its first argument) and/or an options table (its second argument). Options include:
    • aboutForm A string that can be used to substitute the form of the initial "about" message. It should include two substitution points: the first for the page type (e.g. "article"), and the second for the description of what the page is about. It should also include a trailing space for easy concatenation or omission. Defaults to 'This %s is about %s. '.
    • sectionString Gives the page type string for when the named argument section is specified. Defaults to 'section'.

local mArguments --initialize lazily
local mHatnote = require('Module:Hatnote/Sandbox') --sandbox since we use mHatnote._forSee(). Blocks removing from alpha.
local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType
local p = {}

--A passthrough that gets args from the frame and all
function p.about (frame)
	mArguments = require('Module:Arguments')
	args = mArguments.getArgs(frame)
	return p._about(args)
end

--Produces "about" hatnote. No options or defaults yet, but the machinery's there.
function p._about (args, options)
	checkType('_about', 1, args, 'table', true)
	args = args or {}
	checkType('_about', 2, options, 'table', true)
	options = options or {}
	local defaultOptions = {
		--whatever
	}
	for k, v in pairs(defaultOptions) do
		if options[k] == nil then options[k] = v end
	end

	local pageTypeStrings = {
		[0] = 'article',
		[14] = 'category'
	}
	local pageType = (args.section and 'section') or
		pageTypeStrings[mw.title.getCurrentTitle().namespace] or
		'page'

	local about = ''
	if args[1] then
		about = string.format('This %s is about %s. ', pageType, args[1])
	end

	local forSee = mHatnote._forSee(args, 2)

	return mHatnote._hatnote(about .. forSee)
end

return p