Difference between revisions of "Module:Hatnote group"

From blackwiki
Jump to navigation Jump to search
test>Nihiltres
(Tweaked to avoid outputting empty class attributes on spans)
test>Nihiltres
(Removed some needless linebreaks for better readability, and used pairs instead of ipairs for iterating over key-based lists (whoops))
Line 38: Line 38:
 
for k, v in pairs(rawDivs) do
 
for k, v in pairs(rawDivs) do
 
row = {}
 
row = {}
row.text = string.gsub(
+
row.text = string.gsub(v, hatnotePattern, '%3')
v,
 
hatnotePattern,
 
'%3'
 
)
 
 
--Here we set class names as keys for easier intersection later
 
--Here we set class names as keys for easier intersection later
 
row.classes = {}
 
row.classes = {}
 
for k, v in ipairs(
 
for k, v in ipairs(
 
mw.text.split(
 
mw.text.split(
string.gsub(
+
string.gsub(v, hatnotePattern, '%2'),
v,
 
hatnotePattern,
 
'%2'
 
),
 
 
' ',
 
' ',
 
true
 
true
Line 65: Line 57:
 
local universalClasses = innerHatnotes[1].classes
 
local universalClasses = innerHatnotes[1].classes
 
for k, v in ipairs(innerHatnotes) do
 
for k, v in ipairs(innerHatnotes) do
for l, w in ipairs(v.classes) do
+
for l, w in pairs(v.classes) do
 
universalClasses[l] = (universalClasses[l] and w)
 
universalClasses[l] = (universalClasses[l] and w)
 
end
 
end
Line 72: Line 64:
 
--Remove universal classes from div items, then create class strings per row
 
--Remove universal classes from div items, then create class strings per row
 
for k, v in ipairs(innerHatnotes) do
 
for k, v in ipairs(innerHatnotes) do
for l, w in ipairs(v.classes) do
+
for l, w in pairs(v.classes) do
 
if universalClasses[l] then v.classes[l] = nil end
 
if universalClasses[l] then v.classes[l] = nil end
 
end
 
end
Line 84: Line 76:
 
innerSpans,
 
innerSpans,
 
(v.classString ~= '') and
 
(v.classString ~= '') and
string.format(
+
string.format('<span class="%s">%s</span>', v.classString, v.text) or
'<span class="%s">%s</span>',
+
string.format('<span>%s</span>', v.text)
v.classString,
 
v.text
 
) or
 
string.format(
 
'<span>%s</span>',
 
v.text
 
)
 
 
)
 
)
 
end
 
end

Revision as of 19:29, 6 October 2016

This experimental template applies Module:Hatnote group to merge hatnotes it is given as input; this has the net effect of making them formatted inline relative to one another. For example:

{{about|USE1||PAGE1}}
{{redirect|REDIRECT|USE2|PAGE2}}

would normally display as:

Script error: No such module "about".

but, when wrapped in this template:

{{hatnote group|
{{about|USE1||PAGE1}}
{{redirect|REDIRECT|USE2|PAGE2}}
}}

displays as

Script error: No such module "hatnote group".

Technically, it changes the hatnotes by converting their div wrappers into spans, wrapping the group in a new hatnote div, and migrating classes appropriately. Classes are migrated to the appropriate span, unless every hatnote in the group includes that class, in which case the class will be migrated to the new div wrapper. For example:

{{hatnote|extraclasses=example demonstration |Hatnote 1}}
{{hatnote|extraclasses=example |Hatnote 2}}
{{hatnote|extraclasses=example |Hatnote 3}}

would normally be rendered to:

<div role="note" class="hatnote navigation-not-searchable example demonstration">Hatnote 1</div>
<div role="note" class="hatnote navigation-not-searchable example">Hatnote 2</div>
<div role="note" class="hatnote navigation-not-searchable example">Hatnote 3</div>

but, when wrapped in this template, becomes:

<div role="note" class="hatnote navigation-not-searchable example">
<span class="demonstration">Hatnote 1</span> 
<span>Hatnote 2</span> 
<span>Hatnote 3</span> 
</div>

local mHatnote = require('Module:Hatnote')
local p = {}

--Passes through single argument from parent frame
function p.group (frame)
	return p._group(frame:getParent().args[1], frame:getParent().args.category)	
end

function p._group (inputText, category)
	--If there's an error element, pass everything through unchanged for easier
	--error resolution
	if string.find(inputText, '<%a- class="error"', 1, true) then return inputText end
	
	--Heavily reused hatnote data capture pattern
	local hatnotePattern = '(<div role="note" class="hatnote%s?(.-)">(.-)</div>)'
	
	--Capture hatnote divs and "loose" categories; we'll ignore everything else
	local rawDivs = {}
	local looseCategories = ''
	for x in string.gmatch(inputText, hatnotePattern) do
		table.insert(rawDivs, x)
	end
	for x in string.gmatch(inputText, '[[Category:.-]]') do
		looseCategories = looseCategories .. x
	end

	--if no inner hatnotes, return an error
	if not rawDivs[1] then
		return mHatnote.makeWikitextError(
			'no inner hatnotes detected',
			'Template:Hatnote group',
			category
		)
	end

	--Preprocess divs into strings and classes
	local innerHatnotes = {}
	for k, v in pairs(rawDivs) do
		row = {}
		row.text = string.gsub(v, hatnotePattern, '%3')
		--Here we set class names as keys for easier intersection later
		row.classes = {}
		for k, v in ipairs(
			mw.text.split(
				string.gsub(v, hatnotePattern, '%2'),
				' ',
				true
			)
		) do
			row.classes[v] = true
		end
			
		table.insert(innerHatnotes, row)
	end
	
	--Identify any universal classes ("hatnote" ignored by omission earlier)
	local universalClasses = innerHatnotes[1].classes
	for k, v in ipairs(innerHatnotes) do
		for l, w in pairs(v.classes) do
			universalClasses[l] = (universalClasses[l] and w)
		end
	end
	
	--Remove universal classes from div items, then create class strings per row
	for k, v in ipairs(innerHatnotes) do
		for l, w in pairs(v.classes) do
			if universalClasses[l] then v.classes[l] = nil end
		end
		v.classString = table.concat(v.classes, " ")
	end
	
	--Process div items into classed span items
	local innerSpans = {}
	for k, v in ipairs(innerHatnotes) do
		table.insert(
			innerSpans,
			(v.classString ~= '') and
				string.format('<span class="%s">%s</span>', v.classString, v.text) or
				string.format('<span>%s</span>', v.text)
		)
	end

	--Concatenate spans and categories, and return wrapped as a single hatnote
	local outputText = table.concat(innerSpans, " ") .. looseCategories
	local hnOptions = {extraClasses = table.concat(universalClasses, " ")}
	return mHatnote._hatnote(outputText)
end

return p