-- This module documents the track gauges-- as defined in .-- General note: "id" is the size-id (in mm). With this id, definitions can vary (mm, ft/in, name)-- Alias (the normalised input value) is the primary search termlocal p = local getArgs = require('Module:Arguments').getArgslocal modMath = require('Module:Math')local modTrackGauge = require('Module:Track gauge') -- sandbox herelocal dataPageName = 'Module:Track gauge/data/sandbox' -- sandbox here
local gaugeDataAll = nillocal tableTools = require('Module:tableTools')-- global counters (to keep between the id-row building calls)local ttlSizeClassCount = local ttlAliasCount = 0local ttlEntries = 0local ttlUnitCount = local ttlAltNameCount = 0local ttlAltName = local ttlLinkCount = 0local ttlContentCatsCount = 0local ttlMentioningCatsCount = 0local ttlMentioningPageCount = 0local ttlListedRange = ------------------------------------------------------------------------------------- prepareArgs -- Arguments coming from an #invoke or from a module-----------------------------------------------------------------------------------local function prepareArgs(frame) local origArgs = getArgs(frame) -- Trim whitespace, make lower-case and remove blank arguments for all arguments -- searchAlias is the cleaned value of [1]. [1] is kept as rawInput for error message local args = args['searchAlias'] = args['rawInput'] = origArgs[1] or
for k, v in pairs(origArgs) do if tonumber(k)
'docsortlabel' then -- not in TG args[k] = v else args[k] = mw.ustring.lower(v) end else -- Unnamed argument, alias to be searched args[k] = modTrackGauge.normaliseAliasInput(v) if k
return argsend------------------------------------------------------------------------------------- formatUnitPlaintext-- Pattern '00016.5 mm' for table.sort and catsort.-----------------------------------------------------------------------------------local function formatUnitPlaintext(tgEntry, unit, fmtZeroPadding, toFracChar) -- Returns plaintext (ASCII) only. No css. if tgEntry
'imp' then -- imperial local ft = local inch = local frac = if tgEntry.ft then ft = tgEntry.ft .. ' ft' end if tgEntry.num then frac = ' ' .. tgEntry.num .. '/' .. tgEntry.den if toFracChar then -- as used in contentCat pagenames if frac
' 1/4' then frac = '¼' elseif frac
' 1/2' then frac = '½' elseif frac
' 7/8' then frac = '⅞' else frac = frac .. ' (error: fraction character missing in module:Track gauge)' end end if tgEntry['in'] then frac = ' ' .. tgEntry['in'] .. frac .. ' in' else frac = ' ' .. frac .. ' in' end else if tgEntry['in'] then inch = ' ' .. tgEntry['in'] .. ' in' end end return mw.text.trim(ft .. inch .. frac) else -- metric (mm) if fmtZeroPadding
then return '*' else return catSort endend------------------------------------------------------------------------------------- documentGaugeClass-----------------------------------------------------------------------------------local function documentGaugeClass(tgEntry, countMentionings) local size = tonumber(tgEntry.id or 0) local j if size > 1435 then j = 5 elseif size
'there' then -- Untested, April 2014 anch = '#' .. anch else anch = mw.html.create:tag('span'):attr('id', anch) end return tostring(anch)end------------------------------------------------------------------------------------- noWrap -- Add span tags to prevent a string from wrapping.-----------------------------------------------------------------------------------local function noWrap(s) return mw.ustring.format('
%s', s)end------------------------------------------------------------------------------------- frac -- A slimmed-down version of the template (a single nowrap to be added with the unit)-----------------------------------------------------------------------------------local function frac(whole, num, den) return mw.ustring.format('%s%s%s⁄%s', whole or , whole and ' ' or , num, den )end------------------------------------------------------------------------------------- debugReturnArgs-----------------------------------------------------------------------------------function p.debugReturnArgs(frame) local args = prepareArgs(frame) local retArgs = for k, a in pairs(args) do table.insert(retArgs, k .. '=' .. a) end return 'Args: ' .. table.concat(retArgs, '; ')end------------------------------------------------------------------------------------- checkData -- Public. Performs various checks on the /data subpage.-- not maintained since ca. 2015-----------------------------------------------------------------------------------function p.checkData(frame) --To be allowed: entry.link empty; then use entry.name. local dataPage = frame and frame.args and frame.args[1] or dataPageName local data = mw.loadData(dataPage) local exists, dupes, dupeSort, ret =,,, -- Check for duplicate aliases. for ti, t in ipairs(data) do for ai, alias in ipairs(t.aliases or) do if not exists[alias] then exists[alias] = else if not dupes[alias] then dupes[alias] = end table.insert(dupes[alias],) end end end for alias in pairs(dupes) do table.insert(dupeSort, alias) end table.sort(dupeSort) for i1, alias in ipairs(dupeSort) do local positions = for i2, aliasKeys in ipairs(dupes[alias]) do local position = mw.ustring.format('gauge %d, alias %d (gauge id:%s)', aliasKeys[1], aliasKeys[2], data[aliasKeys[1]].id or ) table.insert(positions, position) end local aliasText = mw.ustring.format('Duplicate aliases "%s" detected at the following positions: %s.', alias, mw.text.listToText(positions, '; ')) table.insert(ret, aliasText) end -- Check for numerators without denominators. for ti, t in ipairs(data) do local num = t.num local den = t.den if num and not den then table.insert(ret, mw.ustring.format('Numerator "%s" with no denominator detected at gauge %d (id: %s).', num, ti, t.id or )) elseif den and not num then table.insert(ret, mw.ustring.format('Denominator "%s" with no numerator detected at gauge %d (id: %s).', den, ti, t.id or )) end end -- Check for gauges with no imperial or no metric measurements. for ti, t in ipairs(data) do if not (t.ft or t['in'] or t.num or t.den) then table.insert(ret, mw.ustring.format('No imperial measurements found for gauge %d (id: %s).', ti, t.id or )) end if not (t.m or t.mm) then table.insert(ret, mw.ustring.format('No metric measurements found for gauge %d (id: %s).', ti, t.id or )) end end -- Check for non-numeric measurements. local measurements = for ti, t in ipairs(data) do for mi, measurement in ipairs(measurements) do local measurementVal = t[measurement] if measurementVal and not tonumber(measurementVal) then table.insert(ret, mw.ustring.format('Non-numeric %s measurement ("%s") found for gauge %d (id: %s).', measurement, measurementVal, ti, t.id or )) end end end -- Check for gauges with no id. for ti, t in ipairs(data) do if not t.id then local aliases = for i, alias in ipairs(t.aliases) do table.insert(aliases, mw.ustring.format('%s', alias)) end aliases = mw.ustring.format(' (aliases: %s)', mw.text.listToText(aliases)) table.insert(ret, mw.ustring.format('No id found for track gauge %d%s.', ti, aliases or )) end end -- Check for gauges with no aliases. for ti, t in ipairs(data) do if type(t.aliases) ~= 'table' then table.insert(ret, mw.ustring.format('No aliases found for gauge %d (id: %s).', ti, t.id or )) else local isAlias = false for ai, alias in ipairs(t.aliases) do isAlias = true break end if not isAlias then table.insert(ret, mw.ustring.format('No aliases found for gauge %d (id: %s).', ti, t.id or )) end end end -- Check for named gauges with no links and gauges with links but no names. -- 20140520: no link? could be acceptable. Code falls back to the unlinked name (in test now). if false then -- skipped 2014-05-25 for ti, t in ipairs(data) do if t.name and not t.link then table.insert(ret, mw.ustring.format('No link found for the named gauge "%s" at position %d (id: %s).', t.name, ti, t.id or )) elseif t.link and not t.name then table.insert(ret, mw.ustring.format('No name found for the gauge with link "%s" at position %d (id: %s).', t.link, ti, t.id or )) end end end -- Check for invalid def1 values. for ti, t in ipairs(data) do local def = t.def1 if def ~= 'imp' and def ~= 'met' then table.insert(ret, mw.ustring.format('Invalid def1 value "%s" found for gauge %d (id: %s).', def or , ti, t.id or )) end end -- Check for unwanted whitespace. for ti, t in ipairs(data) do for tkey, tval in pairs(t) do if tkey 'table' then for ai, alias in ipairs(tval) do if mw.ustring.find(alias, '%s') then table.insert(ret, mw.ustring.format('Unwanted whitespace detected in gauge %d alias %d ("%s", gauge id: %s).', ti, ai, alias, t.id or )) end end elseif tkey
'link' or tkey
'contentcat' then if tval ~= mw.text.trim(tval) then table.insert(ret, mw.ustring.format('Unwanted whitespace detected in %s field of gauge %d ("%s", gauge id: %s).', tkey, ti, tval, t.id or )) end elseif mw.ustring.find(tval, '%s') then table.insert(ret, mw.ustring.format('Unwanted whitespace detected in %s field of gauge %d ("%s", gauge id: %s).', tkey, ti, tval, t.id or )) end end end -- Added April 2014: alias should not double with another id (imp and mm not ambiguous) local self_id = local self_def = for ti, t in ipairs(data) do self_id = t.id self_def = t.def1 for iC, aliasCheck in ipairs(t.aliases) do if tonumber(aliasCheck) ~= nil then if self_id ~= aliasCheck then for iTwo, tTwo in ipairs(data) do if aliasCheck
id=%s mm ambiguous with gauge id=%s mm (%s)' , aliasCheck, self_def, self_id, tTwo.id, tTwo.def1) ) end end end end end end -- Return any errors found. for i, msg in ipairs(ret) do ret[i] = mw.ustring.format('then catC = elseif tgEntry.contentcat ~= nil then catC = '' else -- no name given, try default name: local catCsuffix = ' gauge railways' if tgEntry.def1
'imp' then label = formatUnitPlaintext(tgEntry, 'imp', nil, true) catTitle = mw.title.makeTitle(14, label .. catCsuffix) if catTitle.exists then catC = '' end end end return catCend------------------------------------------------------------------------------------- catMentions -- maintenance only-----------------------------------------------------------------------------------function p.catMentions(frame) local args = prepareArgs(frame) local tgEntry = modTrackGauge.getTrackGaugeEntry(args.searchAlias) if tgEntry
searchAlias then return tgEntry.id end end end -- Next search: by id (autodocument only, not in main RG) if tonumber(searchAlias) ~= nil then for i, tgEntry in ipairs(gaugeDataAll) do if tgEntry.id
'all' then idFrom = -math.huge idTo = math.huge break end end if args.docfrom ~= nil then idFrom = tonumber(fromInputToId(args.docfrom) or mw.ustring.gsub(args.docfrom, 'mm', )) idTo = math.huge end if args.docto ~= nil then idTo = tonumber(fromInputToId(args.docto) or mw.ustring.gsub(args.docto, 'mm', )) end if idTo > 0 then -- Some subset is requested from the whole data set if idFrom > idTo then local dummy = idFrom idFrom = idTo idTo = dummy end for i, tgEntry in ipairs(gaugeDataAll) do if (tonumber(tgEntry.id) >= idFrom) and (tonumber(tgEntry.id) <= idTo) then
table.insert(tgList, tonumber(tgEntry.id)) end end tgList = tableTools.removeDuplicates(tgList) table.sort(tgList) if #tgList > 1 then ttlListedRange[1] = tgList[1] .. ' mm - ' .. tgList[#tgList] .. ' mm ' end end -- Individual entries can be mentioned in args (all unnamed = numbered params) -- Need a straight table.to keep sequence right local id local argsAliasesIn = tableTools.compressSparseArray(args) for i, argsAlias in ipairs(argsAliasesIn) do id = fromInputToId(argsAlias) if id ~= nil then table.insert(tgList, i, tonumber(id)) table.insert(ttlListedRange, i, id .. ' mm; ') end end ttlListedRange = tableTools.compressSparseArray(ttlListedRange) ttlListedRange = tableTools.removeDuplicates(ttlListedRange) tgList = tableTools.compressSparseArray(tgList) tgList = tableTools.removeDuplicates(tgList) return tgListend------------------------------------------------------------------------------------- documentPostListStats -- build footer table, after list only-----------------------------------------------------------------------------------local function documentPostListStats(countTgList) -- Report data counters -- Data
local retFoot = table.insert(retFoot, '\n*Sources') table.insert(retFoot, ':Data pages: ') table.insert(retFoot, '*Data') table.insert(retFoot, ':Listed: ' .. table.concat(ttlListedRange, ) .. ' (' .. countTgList .. ' rows)') table.insert(retFoot, ":Entries (defined gauges, per unit): " .. ttlEntries) table.insert(retFoot, ":Gauges (defined gauges, per size): " .. countTgList) for i, stat in ipairs (ttlUnitCount) do table.insert(retFoot, ':' .. stat[2] .. ': ' .. stat[1]) end
table.insert(retFoot, ':Aliases (input options): ' .. ttlAliasCount) table.insert(retFoot, ':Named definitions (as output link; ' .. ttlAltNameCount .. '): ' .. table.concat(ttlAltName, '; '))
table.insert(retFoot, ':Entries with an article link: ' .. ttlLinkCount) -- TODO table.insert(retFoot, '*Named gauges (named input)') -- todo -- Categories (content, maintenance) table.insert(retFoot, '*Categories') table.insert(retFoot, ':Content categories: ' .. ttlContentCatsCount) table.insert(retFoot, ':"Article mentions track gauge" categories: ' .. ttlMentioningCatsCount) table.insert(retFoot, ':Articles listed in "mentions" categories: ' .. ttlMentioningPageCount .. ' (not unique)') -- Size classes (narrow, broad, ..) table.insert(retFoot, '*Size classes') for i, stat in ipairs (ttlSizeClassCount) do if stat[2] ~= 0 then table.insert(retFoot, ':' .. stat[2] .. ' ' .. stat[3] .. ' (' .. stat[4] .. ' mentionings)') end end
local anchor = tostring(mw.html.create:tag('span'):attr('id', 'Statistics')) -- help:using colors. Hue=190 (blue) local statTable = anchor .. '\n
| -' .. '\n! style="background:#ceecf2; width:100%;" | Track gauge data statistics' .. '\n | -' .. '\n | ' .. table.concat(retFoot, '\n') .. '\n |
-- Header row 1 (title) local pagetitle = mw.title.getCurrentTitle urlPurgePage = pagetitle:fullUrl urlPurgePage = '
[' .. urlPurgePage .. ' (purge)]' if docTitlethen docState = 'uncollapsed' end -- Header row 2 (sort buttons, blank cells) local sortColHeaders = local sortClass = if (numberOfEntries or 0) > 1 then sortClass = 'sortable' local sortCell = '! style="background:' .. docBgHeader .. ';"' -- todo: 10 cols with bg color sortColHeaders = '\n|- style="background:' .. docBgHeader .. '; line-height:90%;"' .. '\n! || || || || || || || || ||' end -- Header row 3 (column headers) local catMparent = modTrackGauge.catMentions(nil, 'Mentionings', 'show') --10 columns: local tableStyle = 'style="text-align:right; width:100%; font-size:85%;" ' local retHdr = table.insert(retHdr, '\n
| -') table.insert(retHdr, '! colspan=10 style="background:' .. docBgHeader .. ';" | ' .. docTitle) table.insert(retHdr, ' | -') table.insert(retHdr, '! style="background:' .. docBgHeader .. ';" | Gauge (mm)') table.insert(retHdr, '! style="background:' .. docBgHeader .. ';" | Gauge (ft, in)') table.insert(retHdr, '! style="background:' .. docBgHeader .. ';" | Alt name') table.insert(retHdr, '! style="background:' .. docBgHeader .. ';" | Gauge (inch)') table.insert(retHdr, '! style="background:' .. docBgHeader .. ';" | Def unit') table.insert(retHdr, '! style="background:' .. docBgHeader .. '; width:8em;" | Aliases (input options)') table.insert(retHdr, '! style="background:' .. docBgHeader .. ';" | Class ') table.insert(retHdr, '! style="background:' .. docBgHeader .. '; min-width:5em;" | Source article') table.insert(retHdr, '! style="background:' .. docBgHeader .. ';" | Category (content)') table.insert(retHdr, '! style="background:' .. docBgHeader .. ';" | ' .. catMparent .. ' (maintenance)') return table.concat(retHdr, '\n') .. sortColHeadersend------------------------------------------------------------------------------------- documentFooter-----------------------------------------------------------------------------------local function documentFooter return ' |
' -- From the size-id, build the set of existing entries (met, imp, and variants) local entry = local defType = 0 -- data for i, tgEntry in ipairs(gaugeDataAll) do if id
'met' and entry[1]
'imp' and entry[2]
nil then -- (plain numbers are not shown) table.insert(alis, tostring(v)) end end for j, v in ipairs(alis) do if string.match(v, '^%d')
end local def = -- Definition unit code: 'met' or 'imp' local defText = for i, v in ipairs (entry) do table.insert(def, v.def1) if v.def1
'met' then table.insert(defText, 'met') ttlUnitCount[1][1] = ttlUnitCount[1][1] + 1 end end if #entry >= 2 then if #entry
1 then measure[1] = tostring(mw.html.create:tag('span'):wikitext(measure[1]):css('font-weight', 'bold')) unitanchor[1] = anchor(entry[1], 'met') end if defType >= 2 then measure[2] = tostring(mw.html.create:tag('span'):wikitext(measure[2]):css('font-weight', 'bold')) unitanchor[2] = anchor(entry[1], 'imp') end -- Linked article local linkArticle = for i, e in ipairs(entry) do table.insert(linkArticle, e.pagename) end ttlLinkCount = ttlLinkCount + #linkArticle local eq if #linkArticle >= 2 then eq = true for i, v in ipairs(linkArticle) do if v ~= linkArticle[1] then eq = false break end end if eq
then -- no cat; option to prevent expensive calls skipCheck = true elseif e.contentcat ~= nil then label = string.match(e.contentcat, '([%S]*)') or 'nomatch' table.insert(catContent, 'cat:' .. label .. ' ...') end end if #catContent >= 2 then eq = true for i, v in ipairs(catContent) do if v ~= catContent[1] then eq = false break end end if eq
0 and not skipCheck then local catCsuffix = ' gauge railways' if modMath._mod(defType, 2)
-- Mentions category local catMentions = modTrackGauge.catMentions(entry[1], "cat:mnt", 'show') local catCount = mw.site.stats.pagesInCategory(modTrackGauge.catMentions(entry[1], nil, 'pagename'), pages) ttlMentioningCatsCount = ttlMentioningCatsCount + 1 -- Exists ttlMentioningPageCount = ttlMentioningPageCount + catCount
-- class: Counter SizeClass (narrow, broad, ...) local rgSizeClass = documentGaugeClass(entry[1], catCount)
ttlEntries = ttlEntries + #entry sortCount = mw.text.truncate('00000' .. tostring(catCount), -5, ) sortCount = '
' catCount = sortCount .. catCount .. ' P'-- Compose the size-id row with all cell values (10 columns) local row = table.insert(row, datasortvalue .. unitanchor[1] .. measure[1]) table.insert(row, datasortvalue .. unitanchor[2] .. measure[2]) table.insert(row, table.concat(entryAltName, rowSplit)) table.insert(row, datasortvalue .. inchCount) table.insert(row, table.concat(defText, rowSplit)) table.insert(row, table.concat(aliasList, rowSplit)) table.insert(row, rgSizeClass) table.insert(row, table.concat(linkArticle, rowSplit)) table.insert(row, table.concat(catContent, rowSplit)) table.insert(row, catCount .. ' ' .. catMentions)
return '\n|- style="background:' .. docBgColor .. '; border-top:2px solid #aaa;" |' .. '\n|' .. table.concat(row, ' || ')end------------------------------------------------------------------------------------- documentGauge -- Selfdocument gauge data (one, multiple, range, all)-----------------------------------------------------------------------------------function p.documentGauge(frame) local args = prepareArgs(frame) gaugeDataAll = mw.loadData(dataPageName)
-- Init glolbal counters by table: ttlUnitCount = ttlSizeClassCount =
local tgList = documentBuildTgList(args) -- Now loop through the prepared tgList[id] and add rows to result le -- One row contains all available entries for the id (met, imp, a third variant) local rowTGid = for i, numId in ipairs(tgList) do table.insert(rowTGid, documentFromIdToEntrySet(tostring(numId))) end -- Return args local retArgs = if args.docreturnargs
'on' then retStats = documentPostListStats(#tgList) end -- Build up return documentHeader(#tgList, args.doctitle or , args.docstate or ) .. table.concat(rowTGid, ) .. table.concat(documentFooter, ) .. retStats .. retArgsend---------------------------------------------------------- doc--------------------------------------------------------function p.docFracAliases(frame) local args = prepareArgs(frame) gaugeDataAll = mw.loadData(dataPageName)
local tgList = documentBuildTgList(args) local ttlHitCount =0 local rowIMP = local fracAlias = for i, id in ipairs(tgList) do for j, tgEntry in pairs(gaugeDataAll) do if nil and tostring(id)
tgEntry.id then fracAlias = anchor(tgEntry, 'imp', 'there') fracAlias = mw.ustring.lower(mw.ustring.gsub(fracAlias, '[%s%,%#]', )) table.insert(rowIMP, fracAlias .. '||' .. i .. '||' .. id .. '||' .. modTrackGauge.formatImp(tgEntry) .. ' || plus ' .. tgEntry.num) end if tostring(id)
'imp' and tgEntry.num ~= nil then if tgEntry.ft ~= nil then ttlHitCount = ttlHitCount + 1 fracAlias = anchor(tgEntry, 'imp', 'there') fracAlias = mw.ustring.lower(mw.ustring.gsub(fracAlias, '[%s%,%#]', )) fracAlias = mw.ustring.gsub(fracAlias, '⁄', '/')
table.insert(rowIMP, fracAlias .. '||' .. i .. '||' .. id .. '||' .. modTrackGauge.formatImp(tgEntry)) fracAlias = tostring((tonumber((tgEntry.ft) or 0) * 12) + tonumber(tgEntry["in"] or 0)) .. tgEntry.num .. '/' .. tgEntry.den .. 'in' table.insert(rowIMP, fracAlias .. '||' .. i .. '||' .. id .. '||' .. modTrackGauge.formatImp(tgEntry)) end end end end
-- return '\n|' .. ttlHitCount .. ' hits. ' .. #rowIMP
return '\n\n|-\n\n|' .. table.concat(rowIMP, '\n\n|-\n\n|') end return p