Difference between revisions of "Module:About"

From blackwiki
Jump to navigation Jump to search
test>Nihiltres
m (Case-sensitivity fail.)
test>Nihiltres
(Switched _forSee to new Module:Hatnote list, added some options (migrated most strings from hard-coded to default options), and added comments)
Line 1: Line 1:
 
local mArguments --initialize lazily
 
local mArguments --initialize lazily
local mHatnote = require('Module:Hatnote/sandbox') --sandbox since we use mHatnote._forSee(). Blocks removing from alpha.
+
local mHatnote = require('Module:Hatnote')
 +
local mHatList = require('Module:Hatnote list')
 
local libraryUtil = require('libraryUtil')
 
local libraryUtil = require('libraryUtil')
 
local checkType = libraryUtil.checkType
 
local checkType = libraryUtil.checkType
 
local p = {}
 
local p = {}
  
--A passthrough that gets args from the frame and all
 
 
function p.about (frame)
 
function p.about (frame)
 +
-- A passthrough that gets args from the frame and all
 +
 
mArguments = require('Module:Arguments')
 
mArguments = require('Module:Arguments')
 
args = mArguments.getArgs(frame)
 
args = mArguments.getArgs(frame)
Line 12: Line 14:
 
end
 
end
  
--Produces "about" hatnote. No options or defaults yet, but the machinery's there.
+
 
 
function p._about (args, options)
 
function p._about (args, options)
 +
-- Produces "about" hatnote.
 +
 +
-- Type checks and defaults
 
checkType('_about', 1, args, 'table', true)
 
checkType('_about', 1, args, 'table', true)
 
args = args or {}
 
args = args or {}
Line 19: Line 24:
 
options = options or {}
 
options = options or {}
 
local defaultOptions = {
 
local defaultOptions = {
--whatever
+
aboutForm = 'This %s is about %s. ',
 +
defaultPageType = 'page',
 +
pageTypeStrings = {
 +
[0] = 'article',
 +
[14] = 'category'
 +
},
 +
sectionString = 'section'
 
}
 
}
 
for k, v in pairs(defaultOptions) do
 
for k, v in pairs(defaultOptions) do
Line 25: Line 36:
 
end
 
end
  
local pageTypeStrings = {
+
-- Set initial "about" string
[0] = 'article',
+
local pageType = (args.section and options.sectionString) or
[14] = 'category'
+
options.pageTypeStrings[mw.title.getCurrentTitle().namespace] or
}
+
options.defaultPageType
local pageType = (args.section and 'section') or
 
pageTypeStrings[mw.title.getCurrentTitle().namespace] or
 
'page'
 
 
 
 
local about = ''
 
local about = ''
 
if args[1] then
 
if args[1] then
about = string.format('This %s is about %s. ', pageType, args[1])
+
about = string.format(options.aboutForm, pageType, args[1])
 
end
 
end
  
local forSee = mHatnote._forSee(args, 2)
+
-- Set for-see list
 +
local forSee = mHatList._forSee(args, 2)
  
 +
-- Concatenate and return
 
return mHatnote._hatnote(about .. forSee)
 
return mHatnote._hatnote(about .. forSee)
 
end
 
end
  
 
return p
 
return p

Revision as of 17:13, 8 April 2016

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')
local mHatList = require('Module:Hatnote list')
local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType
local p = {}

function p.about (frame)
	-- A passthrough that gets args from the frame and all

	mArguments = require('Module:Arguments')
	args = mArguments.getArgs(frame)
	return p._about(args)
end


function p._about (args, options)
	-- Produces "about" hatnote.

	-- Type checks and defaults
	checkType('_about', 1, args, 'table', true)
	args = args or {}
	checkType('_about', 2, options, 'table', true)
	options = options or {}
	local defaultOptions = {
		aboutForm = 'This %s is about %s. ',
		defaultPageType = 'page',
		pageTypeStrings = {
			[0] = 'article',
			[14] = 'category'
		},
		sectionString = 'section'
	}
	for k, v in pairs(defaultOptions) do
		if options[k] == nil then options[k] = v end
	end

	-- Set initial "about" string
	local pageType = (args.section and options.sectionString) or
		options.pageTypeStrings[mw.title.getCurrentTitle().namespace] or
		options.defaultPageType
	local about = ''
	if args[1] then
		about = string.format(options.aboutForm, pageType, args[1])
	end

	-- Set for-see list
	local forSee = mHatList._forSee(args, 2)

	-- Concatenate and return
	return mHatnote._hatnote(about .. forSee)
end

return p