Diff: Module:Section link
Comparing revision #1 (2022-10-22 09:09:53) with revision #2 (2023-02-04 10:26:46).
| Old | New |
|---|---|
-- This module implements {{section link}}. |
-- This module implements {{section link}}. |
require('strict'); |
require('strict'); |
local checkType = require('libraryUtil').checkType |
local checkType = require('libraryUtil').checkType |
local p = {} |
local p = {} |
local function makeSectionLink(page, section, display) |
local function makeSectionLink(page, section, display) |
display = display or section |
display = display or section |
page = page or '' |
page = page or '' |
-- MediaWiki doesn't allow these in `page`, so only need to do for `section` |
-- MediaWiki doesn't allow these in `page`, so only need to do for `section` |
if type(section) == 'string' then |
if type(section) == 'string' then |
section = string.gsub(section, "{", "{") |
section = string.gsub(section, "{", "{") |
section = string.gsub(section, "}", "}") |
section = string.gsub(section, "}", "}") |
end |
end |
return string.format('[[%s#%s|%s]]', page, section, display) |
return string.format('[[%s#%s|%s]]', page, section, display) |
end |
end |
local function normalizeTitle(title) |
local function normalizeTitle(title) |
title = mw.ustring.gsub(mw.ustring.gsub(title, "'", ""), '"', '') |
title = mw.ustring.gsub(mw.ustring.gsub(title, "'", ""), '"', '') |
title = mw.ustring.gsub(title, "%b<>", "") |
title = mw.ustring.gsub(title, "%b<>", "") |
return mw.title.new(title).prefixedText |
return mw.title.new(title).prefixedText |
end |
end |
function p._main(page, sections, options, title) |
function p._main(page, sections, options, title) |
-- Validate input. |
-- Validate input. |
checkType('_main', 1, page, 'string', true) |
checkType('_main', 1, page, 'string', true) |
checkType('_main', 3, options, 'table', true) |
checkType('_main', 3, options, 'table', true) |
if sections == nil then |
if sections == nil then |
sections = {} |
sections = {} |
elseif type(sections) == 'string' then |
elseif type(sections) == 'string' then |
sections = {sections} |
sections = {sections} |
elseif type(sections) ~= 'table' then |
elseif type(sections) ~= 'table' then |
error(string.format( |
error(string.format( |
"type error in argument #2 to '_main' " .. |
"type error in argument #2 to '_main' " .. |
"(string, table or nil expected, got %s)", |
"(string, table or nil expected, got %s)", |
type(sections) |
type(sections) |
), 2) |
), 2) |
end |
end |
options = options or {} |
options = options or {} |
title = title or mw.title.getCurrentTitle() |
title = title or mw.title.getCurrentTitle() |
-- Deal with blank page names elegantly |
-- Deal with blank page names elegantly |
if page and not page:find('%S') then |
if page and not page:find('%S') then |
page = nil |
page = nil |
options.nopage = true |
options.nopage = true |
end |
end |
-- Make the link(s). |
-- Make the link(s). |
local isShowingPage = not options.nopage |
local isShowingPage = not options.nopage |
if #sections <= 1 then |
if #sections <= 1 then |
local linkPage = page or '' |
local linkPage = page or '' |
local section = sections[1] or 'Notes' |
local section = sections[1] or 'Notes' |
local display = '§ ' .. section |
local display = '§ ' .. section |
if isShowingPage then |
if isShowingPage then |
page = page or title.prefixedText |
page = page or title.prefixedText |
if options.display and options.display ~= '' then |
if options.display and options.display ~= '' then |
if normalizeTitle(options.display) == normalizeTitle(page) then |
if normalizeTitle(options.display) == normalizeTitle(page) then |
display = options.display .. ' ' .. display |
display = options.display .. ' ' .. display |
else |
else |
error(string.format( |
error(string.format( |
'Display title "%s" was ignored since it is ' .. |
'Display title "%s" was ignored since it is ' .. |
"not equivalent to the page's actual title", |
"not equivalent to the page's actual title", |
options.display |
options.display |
), 0) |
), 0) |
end |
end |
else |
else |
display = page .. ' ' .. display |
display = page .. ' ' .. display |
end |
end |
end |
end |
return makeSectionLink(linkPage, section, display) |
return makeSectionLink(linkPage, section, display) |
else |
else |
-- Multiple sections. First, make a list of the links to display. |
-- Multiple sections. First, make a list of the links to display. |
local ret = {} |
local ret = {} |
for i, section in ipairs(sections) do |
for i, section in ipairs(sections) do |
ret[i] = makeSectionLink(page, section) |
ret[i] = makeSectionLink(page, section) |
end |
end |
-- Assemble the list of links into a string with mw.text.listToText. |
-- Assemble the list of links into a string with mw.text.listToText. |
-- We use the default separator for mw.text.listToText, but a custom |
-- We use the default separator for mw.text.listToText, but a custom |
-- conjunction. There is also a special case conjunction if we only |
-- conjunction. There is also a special case conjunction if we only |
-- have two links. |
-- have two links. |
local conjunction |
local conjunction |
if #sections == 2 then |
if #sections == 2 then |
conjunction = '​ and ' |
conjunction = '​ and ' |
else |
else |
conjunction = ', and ' |
conjunction = ', and ' |
end |
end |
ret = mw.text.listToText(ret, nil, conjunction) |
ret = mw.text.listToText(ret, nil, conjunction) |
-- Add the intro text. |
-- Add the intro text. |
local intro = '§§ ' |
local intro = '§§ ' |
if isShowingPage then |
if isShowingPage then |
intro = (page or title.prefixedText) .. ' ' .. intro |
intro = (page or title.prefixedText) .. ' ' .. intro |
end |
end |
ret = intro .. ret |
ret = intro .. ret |
return ret |
return ret |
end |
end |
end |
end |
function p.main(frame) |
function p.main(frame) |
local yesno = require('Module:Yesno') |
local yesno = require('Module:Yesno') |
local args = require('Module:Arguments').getArgs(frame, { |
local args = require('Module:Arguments').getArgs(frame, { |
wrappers = 'Template:Section link', |
wrappers = 'Template:Section link', |
valueFunc = function (key, value) |
valueFunc = function (key, value) |
value = value:match('^%s*(.-)%s*$') -- Trim whitespace |
value = value:match('^%s*(.-)%s*$') -- Trim whitespace |
-- Allow blank first parameters, as the wikitext template does this. |
-- Allow blank first parameters, as the wikitext template does this. |
if value ~= '' or key == 1 then |
if value ~= '' or key == 1 then |
return value |
return value |
end |
end |
end |
end |
}) |
}) |
for k, v in pairs(args) do -- replace underscores in the positional parameter values |
for k, v in pairs(args) do -- replace underscores in the positional parameter values |
if 'number' == type(k) then |
if 'number' == type(k) then |
if not yesno (args['keep-underscores']) then -- unless |keep-underscores=yes |
if not yesno (args['keep-underscores']) then -- unless |keep-underscores=yes |
args[k] = mw.uri.decode (v, 'WIKI'); -- percent-decode; replace underscores with space characters |
args[k] = mw.uri.decode (v, 'WIKI'); -- percent-decode; replace underscores with space characters |
else |
else |
args[k] = mw.uri.decode (v, 'PATH'); -- percent-decode; retain underscores |
args[k] = mw.uri.decode (v, 'PATH'); -- percent-decode; retain underscores |
end |
end |
end |
end |
end |
end |
-- Sort the arguments. |
-- Sort the arguments. |
local page |
local page |
local sections, options = {}, {} |
local sections, options = {}, {} |
for k, v in pairs(args) do |
for k, v in pairs(args) do |
if k == 1 then |
if k == 1 then |
-- Doing this in the loop because of a bug in [[Module:Arguments]] |
-- Doing this in the loop because of a bug in [[Module:Arguments]] |
-- when using pairs with deleted arguments. |
-- when using pairs with deleted arguments. |
page = mw.text.decode(v, true) |
page = mw.text.decode(v, true) |
elseif type(k) == 'number' then |
elseif type(k) == 'number' then |
sections[k] = v |
sections[k] = v |
else |
else |
options[k] = v |
options[k] = v |
end |
end |
end |
end |
options.nopage = yesno (options.nopage); -- make boolean |
options.nopage = yesno (options.nopage); -- make boolean |
-- Extract section from page, if present |
-- Extract section from page, if present |
if page then |
if page then |
local p, s = page:match('^(.-)#(.*)$') |
local p, s = page:match('^(.-)#(.*)$') |
if p then page, sections[1] = p, s end |
if p then page, sections[1] = p, s end |
end |
end |
-- Compress the sections array. |
-- Compress the sections array. |
local function compressArray(t) |
local function compressArray(t) |
local nums, ret = {}, {} |
local nums, ret = {}, {} |
for num in pairs(t) do |
for num in pairs(t) do |
nums[#nums + 1] = num |
nums[#nums + 1] = num |
end |
end |
table.sort(nums) |
table.sort(nums) |
for i, num in ipairs(nums) do |
for i, num in ipairs(nums) do |
ret[i] = t[num] |
ret[i] = t[num] |
end |
end |
return ret |
return ret |
end |
end |
sections = compressArray(sections) |
sections = compressArray(sections) |
return p._main(page, sections, options) |
return p._main(page, sections, options) |
end |
end |
return p |
return p |