Module:About: Difference between revisions
From Zoophilia Wiki
Jump to navigationJump to search
meta>Nihiltres m (Case-sensitivity fail.) |
meta>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 | 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 = {} | ||
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 | ||
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 = { | ||
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 | ||
-- Set initial "about" string | |||
local pageType = (args.section and options.sectionString) or | |||
options.pageTypeStrings[mw.title.getCurrentTitle().namespace] or | |||
options.defaultPageType | |||
local pageType = (args.section and | |||
pageTypeStrings[mw.title.getCurrentTitle().namespace] or | |||
local about = '' | local about = '' | ||
if args[1] then | if args[1] then | ||
about = string.format( | about = string.format(options.aboutForm, pageType, args[1]) | ||
end | end | ||
local forSee = | -- 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
Documentation for this module may be created at Module:About/doc
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