Difference between revisions of "Module:About/sandbox"

From blackwiki
Jump to navigation Jump to search
blackwiki>Nihiltres
m (Derp, that option's passed to mHatList._forSee, not mHatnote._hatnote)
blackwiki>Galobtter
(sync; add args.text option and pass as options.extratext)
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 mHatList = require('Module:Hatnote list/sandbox')
 
local libraryUtil = require('libraryUtil')
 
local libraryUtil = require('libraryUtil')
 
local checkType = libraryUtil.checkType
 
local checkType = libraryUtil.checkType
Line 8: Line 8:
 
function p.about (frame)
 
function p.about (frame)
 
-- A passthrough that gets args from the frame and all
 
-- 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 25: Line 24:
 
local defaultOptions = {
 
local defaultOptions = {
 
aboutForm = 'This %s is about %s. ',
 
aboutForm = 'This %s is about %s. ',
defaultPageType = 'page',
+
PageType = require('Module:Pagetype').main(),
 
namespace = mw.title.getCurrentTitle().namespace,
 
namespace = mw.title.getCurrentTitle().namespace,
 
otherText = nil, --included for complete list
 
otherText = nil, --included for complete list
pageTypesByNamespace = {
 
[0] = 'article',
 
[14] = 'category'
 
},
 
 
sectionString = 'section'
 
sectionString = 'section'
 
}
 
}
Line 39: Line 34:
  
 
-- Set initial "about" string
 
-- Set initial "about" string
local pageType = (args.section and options.sectionString) or
+
local pageType = (args.section and options.sectionString) or options.PageType
options.pageTypesByNamespace[options.namespace] or
 
options.defaultPageType
 
 
local about = ''
 
local about = ''
 
if args[1] then
 
if args[1] then
Line 49: Line 42:
 
--Allow passing through certain options
 
--Allow passing through certain options
 
local fsOptions = {
 
local fsOptions = {
otherText = options.otherText
+
otherText = options.otherText,
}
+
extratext = args.text
local hnOptions = {
 
selfref = args.selfref
 
 
}
 
}
  
Line 59: Line 50:
  
 
-- Concatenate and return
 
-- Concatenate and return
return mHatnote._hatnote(about .. forSee, hnOptions)
+
return mHatnote._hatnote(about .. forSee)
 
end
 
end
  
 
return p
 
return p

Revision as of 08:34, 31 March 2018

Documentation for this module may be created at Module:About/sandbox/doc

local mArguments --initialize lazily
local mHatnote = require('Module:Hatnote')
local mHatList = require('Module:Hatnote list/sandbox')
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(),
		namespace = mw.title.getCurrentTitle().namespace,
		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
	}

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

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

return p