Module:Hatnote: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Mr. Stradivarius
m (1 revision imported)
 
(46 intermediate revisions by 11 users not shown)
Line 3: Line 3:
--                                                                            --
--                                                                            --
-- This module produces hatnote links and links to related articles. It      --
-- This module produces hatnote links and links to related articles. It      --
-- implements the {{rellink}} and {{hatnote}} meta-templates, and a few of    --
-- implements the {{hatnote}} and {{format link}} meta-templates and includes --
-- the more popular templates they depend on, including {{main}},            --
-- helper functions for other Lua hatnote modules.                           --
-- {{see also}}, {{further}} and {{details}}.                                 --
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


local mTableTools = require('Module:TableTools')
local libraryUtil = require('libraryUtil')
local mArguments = require('Module:Arguments')
local checkType = libraryUtil.checkType
local checkTypeForNamedArg = libraryUtil.checkTypeForNamedArg
local mArguments -- lazily initialise [[Module:Arguments]]
local yesno -- lazily initialise [[Module:Yesno]]
local formatLink -- lazily initialise [[Module:Format link]] ._formatLink
 
local p = {}


--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- Argument processing
-- Helper functions
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


--[[
local function getArgs(frame)
-- The p table is for functions to be returned from #invoke, and for functions
-- Fetches the arguments from the parent frame. Whitespace is trimmed and
-- to be used from other Lua modules. The f table is for functions acting as a
-- blanks are removed.
-- bridge between #invoke functions and Lua module functions. #invoke functions
mArguments = require('Module:Arguments')
-- are connected to f table functions through the makeInvokeFunction function.
return mArguments.getArgs(frame, {parentOnly = true})
-- Functions for use from other Lua modules have names beginning with an
end
-- underscore.  
 
--]]
local function removeInitialColon(s)
local p, f = {}, {}
-- Removes the initial colon from a string, if present.
return s:match('^:?(.*)')
end


local function makeInvokeFunction(func)
function p.defaultClasses(inline)
return function(frame)
-- Provides the default hatnote classes as a space-separated string; useful
local args = mArguments.getArgs(frame, {parentOnly = true})
-- for hatnote-manipulation modules like [[Module:Hatnote group]].
return func(args)
return
end
(inline == 1 and 'hatnote-inline' or 'hatnote') .. ' ' ..
'navigation-not-searchable'
end
end


--------------------------------------------------------------------------------
function p.disambiguate(page, disambiguator)
-- Helper functions
-- Formats a page title with a disambiguation parenthetical,
--------------------------------------------------------------------------------
-- i.e. "Example" → "Example (disambiguation)".
checkType('disambiguate', 1, page, 'string')
checkType('disambiguate', 2, disambiguator, 'string', true)
disambiguator = disambiguator or 'disambiguation'
return mw.ustring.format('%s (%s)', page, disambiguator)
end


local function findNamespaceId(link)
function p.findNamespaceId(link, removeColon)
-- Finds the namespace id (namespace number) of a link or a pagename. This
-- Finds the namespace id (namespace number) of a link or a pagename. This
-- function will not work if the link is enclosed in double brackets or if
-- function will not work if the link is enclosed in double brackets. Colons
-- the link has been escaped with the colon trick.
-- are trimmed from the start of the link by default. To skip colon
-- trimming, set the removeColon parameter to false.
checkType('findNamespaceId', 1, link, 'string')
checkType('findNamespaceId', 2, removeColon, 'boolean', true)
if removeColon ~= false then
link = removeInitialColon(link)
end
local namespace = link:match('^(.-):')
local namespace = link:match('^(.-):')
if namespace then
if namespace then
Line 50: Line 69:
end
end


local function formatLink(link, display)
function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
-- Makes a wikilink from the given link and display values. Links are
-- Formats an error message to be returned to wikitext. If
-- escaped with colons if necessary, and links to sections are detected
-- addTrackingCategory is not false after being returned from
-- and displayed with " § " as a separator rather than the standard
-- [[Module:Yesno]], and if we are not on a talk page, a tracking category
-- MediaWiki "#".
-- is added.
 
checkType('makeWikitextError', 1, msg, 'string')
-- Find whether we need to use the colon trick or not. We need to use the
checkType('makeWikitextError', 2, helpLink, 'string', true)
-- colon trick for categories and files, as otherwise category links
yesno = require('Module:Yesno')
-- categorise the page and file links display the file.
title = title or mw.title.getCurrentTitle()
local namespace = findNamespaceId(link)
-- Make the help link text.
local colon
local helpText
if namespace == 6 or namespace == 14 then
if helpLink then
colon = ':'
helpText = ' ([[' .. helpLink .. '|help]])'
else
else
colon = ''
helpText = ''
end
end
 
-- Make the category text.
-- Find the display value.
local category
if not display then
if not title.isTalkPage -- Don't categorise talk pages
local page, section = link:match('^(.-)#(.*)$')
and title.namespace ~= 2 -- Don't categorise userspace
if page then
and yesno(addTrackingCategory) ~= false -- Allow opting out
display = page .. ' § ' .. section
then
end
category = 'Hatnote templates with errors'
end
category = mw.ustring.format(
 
'[[%s:%s]]',
-- Assemble the link.
mw.site.namespaces[14].name,
if display then
category
return string.format('[[%s%s|%s]]', colon, link, display)
)
else
else
return string.format('[[%s%s]]', colon, link)
category = ''
end
end
return mw.ustring.format(
'<strong class="error">Error: %s%s.</strong>%s',
msg,
helpText,
category
)
end
end


local function formatPages(...)
local curNs = mw.title.getCurrentTitle().namespace
-- Formats a list of pages using formatLink and returns it as an array. Nil
p.missingTargetCat =
-- values are not allowed.
--Default missing target category, exported for use in related modules
local pages = {...}
((curNs == 0) or (curNs == 14)) and
local ret = {}
'Articles with hatnote templates targeting a nonexistent page' or nil
for i, page in ipairs(pages) do
ret[i] = formatLink(page)
end
return ret
end


local function formatPageTables(pages)
function p.quote(title)
-- Takes a list of page/display tables and returns it as a list of
--Wraps titles in quotation marks. If the title starts/ends with a quotation
-- formatted links. Nil values are not allowed.
--mark, kerns that side as with {{-'}}
local links = {}
local quotationMarks = {
for i, t in ipairs(pages) do
["'"]=true, ['"']=true, ['“']=true, ["‘"]=true, ['”']=true, ["’"]=true
local link = t[1]
}
local display = t[2]
local quoteLeft, quoteRight = -- Test if start/end are quotation marks
links[i] = formatLink(link, display)
quotationMarks[string.sub(title,  1,  1)],
quotationMarks[string.sub(title, -1, -1)]
if quoteLeft or quoteRight then
title = mw.html.create("span"):wikitext(title)
end
end
return links
if quoteLeft  then title:css("padding-left",  "0.15em") end
end
if quoteRight then title:css("padding-right", "0.15em") end
 
return '"' .. tostring(title) .. '"'
local function makeWikitextError(msg)
-- Formats an error message to be returned to wikitext.
return string.format('<strong class="error">Error: %s.</strong>', msg)
end
end


Line 117: Line 137:
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


function p._hatnote(s)
function p.hatnote(frame)
return string.format('<div class="dablink">%s</div>', s)
local args = getArgs(frame)
end
 
function f.hatnote(args)
local s = args[1]
if not s then
return makeWikitextError('no text specified')
end
return p._hatnote(s)
end
 
p.hatnote = makeInvokeFunction(f.hatnote)
 
--------------------------------------------------------------------------------
-- Rellink
--
-- Produces a standard link to a related article. Implements the {{rellink}}
-- template.
--------------------------------------------------------------------------------
 
function p._rellink(s, extraclasses)
if extraclasses then
extraclasses = ' ' .. extraclasses
else
extraclasses = ''
end
return string.format('<div class="rellink%s">%s</div>', extraclasses, s)
end
 
function f.rellink(args)
local s = args[1]
local s = args[1]
local extraclasses = args.extraclasses
if not s then
if not s then
return makeWikitextError('no text specified')
return p.makeWikitextError(
end
'no text specified',
return p._rellink(s, extraclasses)
'Template:Hatnote#Errors',
end
args.category
 
)
p.rellink = makeInvokeFunction(f.rellink)
 
--------------------------------------------------------------------------------
-- Details
--
-- Produces a "For more details on this topic" link. the first parameter is the
-- page linked to, and if the second parameter is present it is used instead
-- of the "this topic" text.
--------------------------------------------------------------------------------
 
function p._details(page, topic)
page = formatLink(page)
topic = topic or 'this topic'
local text = string.format('For more details on %s, see %s.', topic, page)
local extraclasses = 'boilerplate seealso'
return p._rellink(text, extraclasses)
end
 
function f.details(args)
local page = args[1]
local topic = args[2]
if not page then
return makeWikitextError('no page specified')
end
return p._details(page, topic)
end
 
p.details = makeInvokeFunction(f.details)
 
--------------------------------------------------------------------------------
-- Further
--
-- Produces a "Further information: a, b and c" link. It accepts an unlimited
-- number of positional parameters, each of which is a page name.
--------------------------------------------------------------------------------
 
function p._further(...)
local links = formatPages(...)
local text = 'Further information: ' .. mw.text.listToText(links)
return p._rellink(text)
end
 
function f.further(args)
local pages = mTableTools.compressSparseArray(args)
if #pages < 1 then
return makeWikiTextError('no pages specified')
end
return p._further(unpack(pages))
end
 
p.further = makeInvokeFunction(f.further)
 
--------------------------------------------------------------------------------
-- Main
--
-- Produces a link to a main article or articles. If used in category or
-- category talk space, produces "The main article for this category is xxx".
-- Otherwise, produces "Main article: xxx". Accepts an unlimited number of
-- page/display tables. Non-table inputs will result in an error. The first
-- value in the table should be the page name. Omitting this will result in an
-- error, except in the case of the first table, which uses the page name as a
-- fallaback. The second value in the table is an optional display value for
-- the link. If the first page name is not in mainspace, the output uses "page"
-- instead of "article". If more than one page is specified, the function uses
-- plural forms.
--------------------------------------------------------------------------------
 
function p._main(...)
-- Get the list of pages. If no first page was specified we use the current
-- page name.
local pages = {...}
local currentTitle = mw.title.getCurrentTitle()
local firstPageTable = pages[1]
local firstPage
if firstPageTable then
firstPage = firstPageTable[1]
else
firstPage = currentTitle.text
firstPageTable = {firstPage}
pages[1] = firstPageTable
end
end
 
return p._hatnote(s, {
-- Find the pagetype.
extraclasses = args.extraclasses,
local firstPageNs = findNamespaceId(firstPage)
selfref = args.selfref
local pagetype = firstPageNs == 0 and 'article' or 'page'
})
 
-- Make the formatted link text
local links = formatPageTables(pages)
links = mw.text.listToText(links)
 
-- Build the text.
local isPlural = #pages > 1
local currentNs = currentTitle.namespace
local isCategoryNamespace = currentNs - currentNs % 2 == 14
local stringToFormat
if isCategoryNamespace then
if isPlural then
stringToFormat = 'The main %ss for this'
.. ' [[Wikipedia:Categorization|category]] are %s'
else
stringToFormat = 'The main %s for this'
.. ' [[Wikipedia:Categorization|category]] is %s'
end
else
if isPlural then
stringToFormat = 'Main %ss: %s'
else
stringToFormat = 'Main %s: %s'
end
end
local text = string.format(stringToFormat, pagetype, links)
 
-- Pass the text to p._rellink.
local extraclasses = 'relarticle mainarticle'
return p._rellink(text, extraclasses)
end
end


function f.main(args)
function p._hatnote(s, options)
local pages = {}
checkType('_hatnote', 1, s, 'string')
for k, v in pairs(args) do
checkType('_hatnote', 2, options, 'table', true)
if type(k) == 'number' then
options = options or {}
local display = args['l' .. tostring(k)]
local inline = options.inline
local page = {v, display}
local hatnote = mw.html.create(inline == 1 and 'span' or 'div')
pages[k] = page
local extraclasses
end
if type(options.extraclasses) == 'string' then
extraclasses = options.extraclasses
end
end
pages = mTableTools.compressSparseArray(pages)
return p._main(unpack(pages))
end
p.main = makeInvokeFunction(f.main)


--------------------------------------------------------------------------------
hatnote
-- See also
:attr('role', 'note')
--
:addClass(p.defaultClasses(inline))
-- Produces a "See also: a, b and c" link. The first parameter is an optional
:addClass(extraclasses)
-- alternative for the "See also" text. The following parameters are an
:addClass(options.selfref and 'selfref' or nil)
-- unlimited number of page/display tables. The first entry in the table is the
:wikitext(s)
-- page name, and the second entry in the table is the display text.
--------------------------------------------------------------------------------


function p._seealso(altphrase, ...)
return mw.getCurrentFrame():extensionTag{
altphrase = altphrase or 'See also'
name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' }
local pages = {...}
} .. tostring(hatnote)
local links = formatPageTables(pages)
links = mw.text.listToText(links)
local text = altphrase .. ': ' .. links
local extraclasses = 'boilerplate seealso'
return p._rellink(text, extraclasses)
end
end
function f.seealso(args)
local pages = {}
for k, v in pairs(args) do
if type(k) == 'number' then
local numstring = tostring(k)
local display = args['label ' .. numstring]
or args['l' .. numstring]
local page = {v, display}
pages[k] = page
end
end
pages = mTableTools.compressSparseArray(pages)
if not pages[1] then
return makeWikitextError(
'[[Template:See also|'
.. 'Template must be given at least one article name]]'
)
end
local altphrase = args.altphrase
return p._seealso(altphrase, unpack(pages))
end
p.seealso = makeInvokeFunction(f.seealso)


return p
return p

Latest revision as of 20:03, 28 November 2023

This is a meta-module that provides various functions for making hatnotes. It implements the {{hatnote}} template, for use in hatnotes at the top of pages, and the {{format link}} template, which is used to format a wikilink for use in hatnotes. It also contains a number of helper functions for use in other Lua hatnote modules.

Use from wikitext

The functions in this module cannot be used directly from #invoke, and must be used through templates instead. Please see Template:Hatnote and Template:Format link for documentation.

Use from other Lua modules

To load this module from another Lua module, use the following code.

<syntaxhighlight lang="lua"> local mHatnote = require('Module:Hatnote') </syntaxhighlight>

You can then use the functions as documented below.

Hatnote

<syntaxhighlight lang="lua"> mHatnote._hatnote(s, options) </syntaxhighlight>

Formats the string s as a hatnote. This encloses s in the tags <div class="hatnote">...</div>. Options are provided in the options table. Options include:

  • options.extraclasses - a string of extra classes to provide
  • options.selfref - if this is not nil or false, adds the class "selfref", used to denote self-references to Wikipedia (see Template:Selfref))

The CSS of the hatnote class is defined in MediaWiki:Common.css.

Example 1

<syntaxhighlight lang="lua"> mHatnote._hatnote('This is a hatnote.') </syntaxhighlight>

Produces: <div class="hatnote">This is a hatnote.</div>

Displays as:

This is a hatnote.
Example 2

<syntaxhighlight lang="lua"> mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true}) </syntaxhighlight>

Produces: <div class="hatnote boilerplate seealso selfref">This is a hatnote.</div>

Displayed as:

This is a hatnote.

Format link

<syntaxhighlight lang="lua"> mHatnote._formatLink{link = link, display = display, italicizePage = true, italicizeSection = true} </syntaxhighlight>

Formats link as a wikilink for display in hatnote templates, with optional display value display. Categories and files are automatically escaped with the colon trick, and links to sections are automatically formatted as page § section, rather than the MediaWiki default of page#section.

If italicizePage is true then the page portion of the link is italicized, and if italicizePage is true then the section portion of the link is italicized.

Examples
<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion'}</syntaxhighlight> → [[Lion]] → Script error: The function "formatLink" does not exist.
<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion#Etymology'}</syntaxhighlight> → [[Lion#Etymology|Lion §&nbsp;Etymology]] → Script error: The function "formatLink" does not exist.
<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Category:Lions'}</syntaxhighlight> → [[:Category:Lions]] → Script error: The function "formatLink" does not exist.
<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion#Etymology', display = 'Etymology of lion'}</syntaxhighlight> → [[Lion#Etymology|Etymology of lion]] → Script error: The function "formatLink" does not exist.
<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Quo warranto#Philippines', italicizePage = true}</syntaxhighlight> → [[Quo warranto#Philippines|<i>Quo warranto</i> §&nbsp;Philippines]] → Script error: The function "formatLink" does not exist.
<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice', italicizeSection = true}</syntaxhighlight> → [[Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice|Cybercrime Prevention Act of 2012 §&nbsp;<i>Disini v. Secretary of Justice</i>]] → Script error: The function "formatLink" does not exist.

Format pages

<syntaxhighlight lang="lua"> mHatnote.formatPages(...) </syntaxhighlight>

Formats a list of pages using the _formatLink function, and returns the result as an array. For example, the code <syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.formatPages('Lion', 'Category:Lions', 'Lion#Etymology')</syntaxhighlight> would produce an array like <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{'Lion', 'Category:Lions', 'Lion § Etymology'}</syntaxhighlight>.

Format page tables

<syntaxhighlight lang="lua"> mHatnote.formatPageTables(...) </syntaxhighlight>

Takes a list of page/display tables, formats them with the _formatLink function, and returns the result as an array. Each item in the list must be a table. The first value in the table is the link, and is required. The second value in the table is the display value, and is optional. For example, the code <syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.formatPages({'Lion', 'the Lion article'}, {'Category:Lions'}, {'Lion#Etymology', 'the etymology of lion'})</syntaxhighlight> would produce an array like <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{'the Lion article', 'Category:Lions', 'the etymology of lion'}</syntaxhighlight>.

Find namespace id

<syntaxhighlight lang="lua"> mHatnote.findNamespaceId(link, removeColon) </syntaxhighlight>

Finds the namespace id of the string link, which should be a valid page name, with or without the section name. This function will not work if the page name is enclosed with square brackets. When trying to parse the namespace name, colons are removed from the start of the link by default. This is helpful if users have specified colons when they are not strictly necessary. If you do not need to check for initial colons, set removeColon to false.

Examples
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.findNamespaceId('Lion')</syntaxhighlight> → 0
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.findNamespaceId('Category:Lions')</syntaxhighlight> → 14
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.findNamespaceId(':Category:Lions')</syntaxhighlight> → 14
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.findNamespaceId(':Category:Lions', false)</syntaxhighlight> → 0 (the namespace is detected as ":Category", rather than "Category")

Make wikitext error

<syntaxhighlight lang="lua"> mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory) </syntaxhighlight>

Formats the string msg as a red wikitext error message, with optional link to a help page helpLink. Normally this function also adds Category:Hatnote templates with errors (0). To suppress categorization, pass false as third parameter of the function (addTrackingCategory).

Examples:

<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.makeWikitextError('an error has occurred')</syntaxhighlight> → Error: an error has occurred.
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.makeWikitextError('an error has occurred', 'Template:Example#Errors')</syntaxhighlight> → Error: an error has occurred (help).

Examples

For an example of how this module is used in other Lua modules, see Module:Main


--------------------------------------------------------------------------------
--                              Module:Hatnote                                --
--                                                                            --
-- This module produces hatnote links and links to related articles. It       --
-- implements the {{hatnote}} and {{format link}} meta-templates and includes --
-- helper functions for other Lua hatnote modules.                            --
--------------------------------------------------------------------------------

local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType
local checkTypeForNamedArg = libraryUtil.checkTypeForNamedArg
local mArguments -- lazily initialise [[Module:Arguments]]
local yesno -- lazily initialise [[Module:Yesno]]
local formatLink -- lazily initialise [[Module:Format link]] ._formatLink

local p = {}

--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

local function getArgs(frame)
	-- Fetches the arguments from the parent frame. Whitespace is trimmed and
	-- blanks are removed.
	mArguments = require('Module:Arguments')
	return mArguments.getArgs(frame, {parentOnly = true})
end

local function removeInitialColon(s)
	-- Removes the initial colon from a string, if present.
	return s:match('^:?(.*)')
end

function p.defaultClasses(inline)
	-- Provides the default hatnote classes as a space-separated string; useful
	-- for hatnote-manipulation modules like [[Module:Hatnote group]].
	return
		(inline == 1 and 'hatnote-inline' or 'hatnote') .. ' ' ..
		'navigation-not-searchable'
end

function p.disambiguate(page, disambiguator)
	-- Formats a page title with a disambiguation parenthetical,
	-- i.e. "Example" → "Example (disambiguation)".
	checkType('disambiguate', 1, page, 'string')
	checkType('disambiguate', 2, disambiguator, 'string', true)
	disambiguator = disambiguator or 'disambiguation'
	return mw.ustring.format('%s (%s)', page, disambiguator)
end

function p.findNamespaceId(link, removeColon)
	-- Finds the namespace id (namespace number) of a link or a pagename. This
	-- function will not work if the link is enclosed in double brackets. Colons
	-- are trimmed from the start of the link by default. To skip colon
	-- trimming, set the removeColon parameter to false.
	checkType('findNamespaceId', 1, link, 'string')
	checkType('findNamespaceId', 2, removeColon, 'boolean', true)
	if removeColon ~= false then
		link = removeInitialColon(link)
	end
	local namespace = link:match('^(.-):')
	if namespace then
		local nsTable = mw.site.namespaces[namespace]
		if nsTable then
			return nsTable.id
		end
	end
	return 0
end

function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
	-- Formats an error message to be returned to wikitext. If
	-- addTrackingCategory is not false after being returned from
	-- [[Module:Yesno]], and if we are not on a talk page, a tracking category
	-- is added.
	checkType('makeWikitextError', 1, msg, 'string')
	checkType('makeWikitextError', 2, helpLink, 'string', true)
	yesno = require('Module:Yesno')
	title = title or mw.title.getCurrentTitle()
	-- Make the help link text.
	local helpText
	if helpLink then
		helpText = ' ([[' .. helpLink .. '|help]])'
	else
		helpText = ''
	end
	-- Make the category text.
	local category
	if not title.isTalkPage -- Don't categorise talk pages
		and title.namespace ~= 2 -- Don't categorise userspace
		and yesno(addTrackingCategory) ~= false -- Allow opting out
	then
		category = 'Hatnote templates with errors'
		category = mw.ustring.format(
			'[[%s:%s]]',
			mw.site.namespaces[14].name,
			category
		)
	else
		category = ''
	end
	return mw.ustring.format(
		'<strong class="error">Error: %s%s.</strong>%s',
		msg,
		helpText,
		category
	)
end

local curNs = mw.title.getCurrentTitle().namespace
p.missingTargetCat =
	--Default missing target category, exported for use in related modules
	((curNs ==  0) or (curNs == 14)) and
	'Articles with hatnote templates targeting a nonexistent page' or nil

function p.quote(title)
	--Wraps titles in quotation marks. If the title starts/ends with a quotation
	--mark, kerns that side as with {{-'}}
	local quotationMarks = {
		["'"]=true, ['"']=true, ['“']=true, ["‘"]=true, ['”']=true, ["’"]=true
	}
	local quoteLeft, quoteRight = -- Test if start/end are quotation marks
		quotationMarks[string.sub(title,  1,  1)],
		quotationMarks[string.sub(title, -1, -1)]
	if quoteLeft or quoteRight then
		title = mw.html.create("span"):wikitext(title)
	end
	if quoteLeft  then title:css("padding-left",  "0.15em") end
	if quoteRight then title:css("padding-right", "0.15em") end
	return '"' .. tostring(title) .. '"'
end

--------------------------------------------------------------------------------
-- Hatnote
--
-- Produces standard hatnote text. Implements the {{hatnote}} template.
--------------------------------------------------------------------------------

function p.hatnote(frame)
	local args = getArgs(frame)
	local s = args[1]
	if not s then
		return p.makeWikitextError(
			'no text specified',
			'Template:Hatnote#Errors',
			args.category
		)
	end
	return p._hatnote(s, {
		extraclasses = args.extraclasses,
		selfref = args.selfref
	})
end

function p._hatnote(s, options)
	checkType('_hatnote', 1, s, 'string')
	checkType('_hatnote', 2, options, 'table', true)
	options = options or {}
	local inline = options.inline
	local hatnote = mw.html.create(inline == 1 and 'span' or 'div')
	local extraclasses
	if type(options.extraclasses) == 'string' then
		extraclasses = options.extraclasses
	end

	hatnote
		:attr('role', 'note')
		:addClass(p.defaultClasses(inline))
		:addClass(extraclasses)
		:addClass(options.selfref and 'selfref' or nil)
		:wikitext(s)

	return mw.getCurrentFrame():extensionTag{
		name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' }
	} .. tostring(hatnote)
end

return p