Module:AutosortTable - Revision history

JohnFromPinckney: From sandbox: documentation completed (params missing) & expanded (new params); caption & rowheader now supported; coding per mw:cc

2021-02-21T00:27:13Z

From sandbox: documentation completed (params missing) & expanded (new params); caption & rowheader now supported; coding per mw:cc

← Previous revision		Revision as of 00:27, 21 February 2021
Line 8:		Line 8:
	\| class = wikitable <!-- Class for the entire table -->		\| class = wikitable <!-- Class for the entire table -->
	\| style = width: 50%; <!-- CSS for the entire table -->		\| style = width: 50%; <!-- CSS for the entire table -->
	\| separator = -- <!-- Separator string used to separate cells -->		\| separator = -- <!-- Separator string used to separate cells; pipe (\|) invalid -->
	\| order = 2, 1 <!-- Order for sorting preference, takes a comma-separated list of column numbers -->		\| order = 2, 1 <!-- Order for sorting preference, takes a comma-separated list of column numbers -->
	\| numeric = 2 <!-- Columns which use numeric sorting. Takes a comma-separated list of column numbers -->		\| numeric = 2 <!-- Columns which use numeric sorting. Takes comma-separated list of column numbers -->
			\| descending = 1 <!-- Columns for which sort order should be descending. Takes comma-separated list of col numbers -->
			\| hidden = 2 <!-- Columns which are not to be displayed. Takes comma-separated list of col numbers -->
			\| rowheader = 1 <!-- Cell(s) in each non-header row to be emitted as row header, per WP:ACCESS#Data tables. Usually just 1, but accepts comma-separated list of col numbers -->
			\| caption = Notable people by age <!-- Table caption per WP:ACCESS -->
	\| header = -- Name -- Age <!-- Table header -->		\| header = -- Name -- Age <!-- Table header -->
			\| footer = <!-- Table footer, typically a totals row or duplication of header -->

	\| -- Bob -- 20 <!-- Row 1 -->		\| -- Bob -- 20 <!-- Row 1 -->
	\| -- Peter -- 35 <!-- Row 2 -->		\| -- Peter -- 35 <!-- Row 2 -->
Line 18:		Line 22:
	\| -- James -- 50 <!-- Row 4 -->		\| -- James -- 50 <!-- Row 4 -->
	\| background-color: #FFDDDD -- Henry -- 45 <!-- Row 5, with CSS -->		\| background-color: #FFDDDD -- Henry -- 45 <!-- Row 5, with CSS -->
			\| colstyle = -- text-align:left; -- text-align:right; -- -- --

			<!-- CSS to be used on content of respective columns, here 1st & 2nd -->

	}}		}}
	]]		]]
Line 40:		Line 46:
	local footer = args.footer		local footer = args.footer
	local colstyle = args.colstyle		local colstyle = args.colstyle
			local rowheader = args.rowheader or ""
			local caption = args.caption

	-- Frequently-used functions		-- Frequently-used functions
Line 49:		Line 57:

	local seplen = #sep		local seplen = #sep
	local nsortLookup, descLookup, hiddenLookup = {}, {}, {}		local nsortLookup, descLookup, hiddenLookup, rowHeading = {}, {}, {}, {}

	-- Create the table		-- Create the table
Line 57:		Line 65:
	if class then htable:attr('class', class) end		if class then htable:attr('class', class) end
	if style then htable:attr('style', style) end		if style then htable:attr('style', style) end
			if caption then

			local hcaption = htable:tag('caption')
			hcaption:wikitext(caption)
			end

	-- Parses a row string. The 'key' parameter is used to assign a unique key to the result so that equal rows do not cause sort errors.		-- Parses a row string. The 'key' parameter is used to assign a unique key to the result so that equal rows do not cause sort errors.
	local parse = function(s, key)		local parse = function(s, key)
Line 68:		Line 80:
	css = strSub(s, 1, firstSep - 1)		css = strSub(s, 1, firstSep - 1)
	s = strSub(s, firstSep + seplen, -1)		s = strSub(s, firstSep + seplen, -1)
	end		end
		⚫	return {key = key, css = css, data = strSplit(s, sep, true)}

⚫	return { key = key, css = css, data = strSplit(s, sep, true) }
	end		end

Line 96:		Line 107:
	cell:attr('class', 'sortbottom')		cell:attr('class', 'sortbottom')
	else		else
	~~-- Ordinary cell~~		if rowHeading[i] then
	~~cell~~ ~~= row:tag('td')~~		-- Cell is a row heading
			cell = row:tag('th')
			cell:attr('scope', 'row')
			else
			-- Ordinary cell
			cell = row:tag('td')
			end
	local cellCss = colstyle and colstyle[i]		local cellCss = colstyle and colstyle[i]
	if cellCss then cell:attr('style', strTrim(cellCss)) end -- Apply the column styling, if necessary		if cellCss then cell:attr('style', strTrim(cellCss)) end -- Apply the column styling, if necessary
Line 104:		Line 121:
	end		end
	end		end

	return row		return row
	end		end
Line 125:		Line 141:
	desc = strSplit(desc, '%s,%s')		desc = strSplit(desc, '%s,%s')
	hidden = strSplit(hidden, '%s,%s')		hidden = strSplit(hidden, '%s,%s')
			rowheader = strSplit(rowheader, '%s,%s')


	for i, v in ipairs(order) do order[i] = tonumber(v) end		for i, v in ipairs(order) do order[i] = tonumber(v) end
	for i, v in ipairs(nsort) do nsortLookup[tonumber(v) or -1] = true end		for i, v in ipairs(nsort) do nsortLookup[tonumber(v) or -1] = true end
	for i, v in ipairs(desc) do descLookup[tonumber(v) or -1] = true end		for i, v in ipairs(desc) do descLookup[tonumber(v) or -1] = true end
	for i, v in ipairs(hidden) do hiddenLookup[tonumber(v) or -1] = true end		for i, v in ipairs(hidden) do hiddenLookup[tonumber(v) or -1] = true end
			for i, v in ipairs(rowheader) do rowHeading[tonumber(v) or -1] = true end


	--Sorting comparator function.		--Sorting comparator function.
	local sortFunc = function(a, b)		local sortFunc = function(a, b)

JohnFromPinckney: Clean-up of minor errors in comments

2021-02-19T02:18:20Z

Clean-up of minor errors in comments

← Previous revision		Revision as of 02:18, 19 February 2021
Line 6:		Line 6:
	{{#invoke: AutosortTable\|create		{{#invoke: AutosortTable\|create

	\| class = wikitable <!-- Class for the entire table -->		\| class = wikitable <!-- Class for the entire table -->
	\| style = width: 50%; <!-- CSS for the entire table -->		\| style = width: 50%; <!-- CSS for the entire table -->
	\| separator = -- <!-- Separator string used to separate cells -->		\| separator = -- <!-- Separator string used to separate cells -->
	\| order = 2, 1 <!-- Order for sorting preference, takes a ~~coma~~-separated list of column numbers -->		\| order = 2, 1 <!-- Order for sorting preference, takes a comma-separated list of column numbers -->
	\| numeric = 2 <!-- Columns which use numeric sorting. Takes a ~~coma~~-separated list of column numbers -->		\| numeric = 2 <!-- Columns which use numeric sorting. Takes a comma-separated list of column numbers -->
	\| header = -- Name -- Age <!-- Table header -->		\| header = -- Name -- Age <!-- Table header -->

	\| -- Bob -- 20 <!-- Row 1 -->		\| -- Bob -- 20 <!-- Row 1 -->
	\| -- Peter -- 35 <!-- Row 2 -->		\| -- Peter -- 35 <!-- Row 2 -->
	\| -- John -- 35 <!-- Row 3 -->		\| -- John -- 35 <!-- Row 3 -->
	\| -- James -- 50 <!-- Row 4 -->		\| -- James -- 50 <!-- Row 4 -->
	\| background-color: #FFDDDD -- Henry -- 45 <!-- Row 5, with CSS -->		\| background-color: #FFDDDD -- Henry -- 45 <!-- Row 5, with CSS -->

	}}		}}
Line 58:		Line 58:
	if style then htable:attr('style', style) end		if style then htable:attr('style', style) end

	-- Parses a row string. The key ~~paremter~~ is used to assign a unique key to the result so that equal rows do not cause sort errors.		-- Parses a row string. The 'key' parameter is used to assign a unique key to the result so that equal rows do not cause sort errors.
	local parse = function(s, key)		local parse = function(s, key)
	local css		local css
Line 75:		Line 75:
	--[[		--[[
	Writes a row to the table.		Writes a row to the table.
	css: CSS to apply to the row.		css: CSS to apply to the row
	data: The data (cells) of the row		data: The data (cells) of the row
	_type: Can be 'header', 'footer' or nil.		_type: Can be 'header', 'footer' or nil.
Line 91:		Line 91:
	cell:attr('scope', 'col')		cell:attr('scope', 'col')
	elseif _type == 'footer' then		elseif _type == 'footer' then
	-- Footer: Mark as 'sortbottom' so that it does not sort ~~whe~~ the table is made user-sortable		-- Footer: Mark as 'sortbottom' so that it does not sort when the table is made user-sortable
	-- with the 'wikitable sortable' class		-- with the 'wikitable sortable' class
	cell = row:tag('td')		cell = row:tag('td')
Line 138:		Line 138:
	local ai, bi = ad[index], bd[index]		local ai, bi = ad[index], bd[index]
	if nsortLookup[index] then		if nsortLookup[index] then
	-- Numeric sort. Find the first ~~occurence~~ of a number an use it. Decimal points are allowed. Scientific notation not supported.		-- Numeric sort. Find the first occurrence of a number and use it. Decimal points are allowed. Scientific notation not supported.
	ai = tonumber( (ai:find('.', 1, true) and ai:match('[+-]?%d*%.%d+') or ai:match('[+-]?%d+')) or 0 )		ai = tonumber( (ai:find('.', 1, true) and ai:match('[+-]?%d*%.%d+') or ai:match('[+-]?%d+')) or 0 )
	bi = tonumber( (bi:find('.', 1, true) and bi:match('[+-]?%d*%.%d+') or bi:match('[+-]?%d+')) or 0 )		bi = tonumber( (bi:find('.', 1, true) and bi:match('[+-]?%d*%.%d+') or bi:match('[+-]?%d+')) or 0 )
Line 158:		Line 158:
	writeHtml(footerData.css, footerData.data, 'footer')		writeHtml(footerData.css, footerData.data, 'footer')
	end		end


	return tostring(html)		return tostring(html)

	end		end


	return _module		return _module

Quantocius Quantotius: Just fixing the comment currently being used for documentation, and what appears to be a minor bug on line 96; will double check

2020-08-28T17:08:39Z

Just fixing the comment currently being used for documentation, and what appears to be a minor bug on line 96; will double check

← Previous revision		Revision as of 17:08, 28 August 2020
Line 8:		Line 8:
	\| class = wikitable <!-- Class for the entire table -->		\| class = wikitable <!-- Class for the entire table -->
	\| style = width: 50%; <!-- CSS for the entire table -->		\| style = width: 50%; <!-- CSS for the entire table -->
	\| ~~sep~~ = -- <!-- Separator string used to separate cells -->		\| separator = -- <!-- Separator string used to separate cells -->
	\| order = 2, 1 <!-- Order for sorting preference, takes a coma-separated list of column numbers -->		\| order = 2, 1 <!-- Order for sorting preference, takes a coma-separated list of column numbers -->
	\| ~~nsort~~ = 2 <!-- Columns which use numeric sorting. Takes a coma-separated list of column numbers -->		\| numeric = 2 <!-- Columns which use numeric sorting. Takes a coma-separated list of column numbers -->
	\| header = -- Name -- Age <!-- Table header -->		\| header = -- Name -- Age <!-- Table header -->

Line 94:		Line 94:
	-- with the 'wikitable sortable' class		-- with the 'wikitable sortable' class
	cell = row:tag('td')		cell = row:tag('td')
	cell:~~class~~('sortbottom')		cell:attr('class', 'sortbottom')
	else		else
	-- Ordinary cell		-- Ordinary cell

Jackmcbarn: fix typo

2015-06-24T02:50:26Z

fix typo

← Previous revision		Revision as of 02:50, 24 June 2015
Line 94:		Line 94:
	-- with the 'wikitable sortable' class		-- with the 'wikitable sortable' class
	cell = row:tag('td')		cell = row:tag('td')
	cell.class('sortbottom')		cell:class('sortbottom')
	else		else
	-- Ordinary cell		-- Ordinary cell

Jackmcbarn: use mw.html

2015-01-07T20:22:09Z

use mw.html

← Previous revision		Revision as of 20:22, 7 January 2015
Line 23:		Line 23:

	local _module = {}		local _module = {}

	local HtmlBuilder = require('Module:HtmlBuilder')

	_module.create = function(frame)		_module.create = function(frame)
Line 55:		Line 53:
	-- Create the table		-- Create the table

	local html = ~~HtmlBuilder~~.create()		local html = mw.html.create()
	local htable = html.tag('table')		local htable = html:tag('table')
	if class then htable.attr('class', class) end		if class then htable:attr('class', class) end
	if style then htable.attr('style', style) end		if style then htable:attr('style', style) end

	-- Parses a row string. The key paremter is used to assign a unique key to the result so that equal rows do not cause sort errors.		-- Parses a row string. The key paremter is used to assign a unique key to the result so that equal rows do not cause sort errors.
Line 82:		Line 80:
	]]		]]
	local writeHtml = function(css, data, _type)		local writeHtml = function(css, data, _type)
	local row = htable.tag('tr')		local row = htable:tag('tr')
	if css then row.attr('style', strTrim(css)) end		if css then row:attr('style', strTrim(css)) end

	for i, v in ipairs(data) do		for i, v in ipairs(data) do
Line 90:		Line 88:
	if _type == 'header' then		if _type == 'header' then
	-- Header: use the 'th' tag with scope="col"		-- Header: use the 'th' tag with scope="col"
	cell = row.tag('th')		cell = row:tag('th')
	cell.attr('scope', 'col')		cell:attr('scope', 'col')
	elseif _type == 'footer' then		elseif _type == 'footer' then
	-- Footer: Mark as 'sortbottom' so that it does not sort whe the table is made user-sortable		-- Footer: Mark as 'sortbottom' so that it does not sort whe the table is made user-sortable
	-- with the 'wikitable sortable' class		-- with the 'wikitable sortable' class
	cell = row.tag('td')		cell = row:tag('td')
	cell.class('sortbottom')		cell.class('sortbottom')
	else		else
	-- Ordinary cell		-- Ordinary cell
	cell = row.tag('td')		cell = row:tag('td')
	local cellCss = colstyle and colstyle[i]		local cellCss = colstyle and colstyle[i]
	if cellCss then cell.attr('style', strTrim(cellCss)) end -- Apply the column styling, if necessary		if cellCss then cell:attr('style', strTrim(cellCss)) end -- Apply the column styling, if necessary
	end		end
	cell.wikitext(strTrim(v))		cell:wikitext(strTrim(v))
	end		end
	end		end

Jfd34 at 10:07, 17 February 2014

2014-02-17T10:07:26Z

← Previous revision		Revision as of 10:07, 17 February 2014
Line 100:		Line 100:
	-- Ordinary cell		-- Ordinary cell
	cell = row.tag('td')		cell = row.tag('td')
		⚫	local cellCss = colstyle and colstyle[i]
		⚫	if cellCss then cell.attr('style', strTrim(cellCss)) end -- Apply the column styling, if necessary
	end		end
⚫	local cellCss = colstyle[i]
⚫	if cellCss then cell.attr('style', strTrim(cellCss)) end -- Apply the column styling, if necessary
	cell.wikitext(strTrim(v))		cell.wikitext(strTrim(v))
	end		end
Line 111:		Line 111:

	-- Parse the column styles		-- Parse the column styles
	colstyle = parse(colstyle, -1).data		if colstyle then colstyle = parse(colstyle, -1).data end

	-- Write the header first		-- Write the header first

Jfd34 at 09:59, 17 February 2014

2014-02-17T09:59:12Z

Show changes

Jfd34 at 16:59, 16 February 2014

2014-02-16T16:59:48Z

← Previous revision		Revision as of 16:59, 16 February 2014
Line 38:		Line 38:
	local desc = args.descending or ""		local desc = args.descending or ""
	local nsort = args.numeric or ""		local nsort = args.numeric or ""
			local hidden = args.hidden or ""
	local header = args.header		local header = args.header
	local footer = args.footer		local footer = args.footer
Line 49:		Line 50:

	local seplen = #sep		local seplen = #sep
		⚫	local nsortLookup, descLookup, hiddenLookup = {}, {}, {}

	-- Create the table		-- Create the table
Line 80:		Line 82:
	local writeHtml = function(css, data, _type)		local writeHtml = function(css, data, _type)
	local row = htable.tag('tr')		local row = htable.tag('tr')
	if css then row.attr('style', css) end		if css then row.attr('style', strTrim(css)) end

	for i, v in ipairs(data) do		for i, v in ipairs(data) do
	~~local~~ ~~cell~~		if not hiddenLookup[i] then
	if ~~_type~~ == ~~'header'~~ ~~then~~		local cell
	-- ~~Header:~~ ~~use the~~ 'th' ~~tag with scope="col"~~		if _type == 'header' then
	~~cell~~ = ~~row.tag(~~'th')		-- Header: use the 'th' tag with scope="col"
	cell.~~attr~~('~~scope', 'col~~')		cell = row.tag('th')
	~~elseif~~ ~~_type~~ == '~~footer~~' ~~then~~		cell.attr('scope', 'col')
	-- Footer: Mark as 'sortbottom' so that it does not sort whe the table is made user-sortable		elseif _type == 'footer' then
			-- Footer: Mark as 'sortbottom' so that it does not sort whe the table is made user-sortable
	-- with the 'wikitable sortable' class		-- with the 'wikitable sortable' class
	cell = row.tag('td')		cell = row.tag('td')
	cell.class('sortbottom')		cell.class('sortbottom')
	else		else
	-- Ordinary cell		-- Ordinary cell
	cell = row.tag('td')		cell = row.tag('td')
			end
		⚫	cell.wikitext(strTrim(v))
	end		end
⚫	cell.wikitext(strTrim(v))
	end		end

Line 116:		Line 120:
	nsort = strSplit(nsort, '%s,%s')		nsort = strSplit(nsort, '%s,%s')
	desc = strSplit(desc, '%s,%s')		desc = strSplit(desc, '%s,%s')
			hidden = strSplit(hidden, '%s,%s')
⚫	local nsortLookup, descLookup = {}, {}

	for i, v in ipairs(order) do order[i] = tonumber(v) end		for i, v in ipairs(order) do order[i] = tonumber(v) end
	for i, v in ipairs(nsort) do nsortLookup[tonumber(v) or -1] = true end		for i, v in ipairs(nsort) do nsortLookup[tonumber(v) or -1] = true end
	for i, v in ipairs(desc) do descLookup[tonumber(v) or -1] = true end		for i, v in ipairs(desc) do descLookup[tonumber(v) or -1] = true end
			for i, v in ipairs(hidden) do hiddenLookup[tonumber(v) or -1] = true end

	--Sorting comparator function.		--Sorting comparator function.

Jfd34 at 12:53, 15 February 2014

2014-02-15T12:53:00Z

← Previous revision		Revision as of 12:53, 15 February 2014
Line 123:		Line 123:
	--Sorting comparator function.		--Sorting comparator function.
	local sortFunc = function(a, b)		local sortFunc = function(a, b)
	mw.log(a and table.concat(a.data, ':'), b and table.concat(b.data, ':'))
	local ad, bd = a.data, b.data		local ad, bd = a.data, b.data
	for i = 1, #order do		for i = 1, #order do
Line 134:		Line 133:
	end		end
	if ai ~= bi then		if ai ~= bi then
	~~return~~ descLookup[index] ~~and~~ ai > bi or ai < bi		if descLookup[index] then return ai > bi else return ai < bi end
	end		end
	end		end

Jfd34 at 12:47, 15 February 2014

2014-02-15T12:47:39Z

← Previous revision		Revision as of 12:47, 15 February 2014
Line 66:		Line 66:
	else -- CSS before first separator		else -- CSS before first separator
	css = strSub(s, 1, firstSep - 1)		css = strSub(s, 1, firstSep - 1)
	s = strSub(s, firstSep + seplen ~~+ 1~~, -1)		s = strSub(s, firstSep + seplen, -1)
	end		end

Line 123:		Line 123:
	--Sorting comparator function.		--Sorting comparator function.
	local sortFunc = function(a, b)		local sortFunc = function(a, b)
			mw.log(a and table.concat(a.data, ':'), b and table.concat(b.data, ':'))
	local ad, bd = a.data, b.data		local ad, bd = a.data, b.data
	for i = 1, #order do		for i = 1, #order do