Module:About: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Nihiltres
(A prototype…)
 
m (8 revisions imported)
 
(7 intermediate revisions by 2 users not shown)
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 13:
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 23:
options = options or {}
options = options or {}
local defaultOptions = {
local defaultOptions = {
--whatever
aboutForm = 'This %s is about %s. ',
PageType = require('Module:Pagetype').main(),
otherText = nil, --included for complete list
sectionString = 'section'
}
}
for k, v in pairs(defaultOptions) do
for k, v in pairs(defaultOptions) do
Line 25: Line 32:
end
end


local pageTypeStrings = {
-- Set initial "about" string
[0] = 'article',
local pageType = (args.section and options.sectionString) or options.PageType
[14] = 'category'
}
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
--Allow passing through certain options
local fsOptions = {
otherText = options.otherText,
extratext = args.text
}
local hnOptions = {
selfref = args.selfref
}


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


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


return p
return p

Latest revision as of 00:23, 2 September 2020

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. ',
		PageType = require('Module:Pagetype').main(),
		otherText = nil, --included for complete list
		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.PageType
	local about = ''
	if args[1] then
		about = string.format(options.aboutForm, pageType, args[1])
	end
	
	--Allow passing through certain options
	local fsOptions = {
		otherText = options.otherText,
		extratext = args.text
	}
	local hnOptions = {
		selfref = args.selfref
	}

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

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

return p