Module:Template link general: Difference between revisions
From The Goon Show Depository
en>Primefac (update from sandbox - fixes to _show_result and adding _expand) |
m (1 revision imported) |
||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
-- This implements Template:Tlg | -- This implements [[Template:Tlg]] | ||
local getArgs = require('Module:Arguments').getArgs | local getArgs = require('Module:Arguments').getArgs | ||
local yesno = require('Module:Yesno') | |||
local cfg = mw.loadData('Module:Template link general/config') | |||
local p = {} | local p = {} | ||
Line 33: | Line 37: | ||
local function linkTitle(args) | local function linkTitle(args) | ||
if | if yesno(args.nolink) then | ||
return args[ | return args[1] | ||
end | end | ||
local titleObj | local titleObj | ||
local titlePart = '[[' | local titlePart = '[[' | ||
if args[ | if args[1] then | ||
-- This handles :Page and other NS | -- This handles :Page and other NS | ||
titleObj = mw.title.new(args[ | titleObj = mw.title.new(args[1], 'Template') | ||
else | else | ||
titleObj = mw.title.getCurrentTitle() | titleObj = mw.title.getCurrentTitle() | ||
end | end | ||
titlePart = titlePart .. (titleObj ~= nil and titleObj.fullText or | titlePart = titlePart .. (titleObj ~= nil and titleObj.fullText or | ||
addTemplate(args[ | addTemplate(args[1])) | ||
local textPart = args.alttext | local textPart = args.alttext | ||
if not _ne(textPart) then | if not _ne(textPart) then | ||
if titleObj ~= nil then | if titleObj ~= nil then | ||
textPart = titleObj:inNamespace("Template") and args[ | textPart = titleObj:inNamespace("Template") and args[1] or titleObj.fullText | ||
else | else | ||
-- redlink | -- redlink | ||
textPart = args[ | textPart = args[1] | ||
end | end | ||
end | end | ||
if yesno(args.brace) then | |||
if | |||
textPart = nw('{{') .. textPart .. nw('}}') | textPart = nw('{{') .. textPart .. nw('}}') | ||
elseif | elseif yesno(args.braceinside) then | ||
textPart = nw('{') .. textPart .. nw('}') | textPart = nw('{') .. textPart .. nw('}') | ||
end | end | ||
titlePart = titlePart .. '|' .. textPart .. ']]' | titlePart = titlePart .. '|' .. textPart .. ']]' | ||
if | if yesno(args.braceinside) then | ||
titlePart = nw('{') .. titlePart .. nw('}') | titlePart = nw('{') .. titlePart .. nw('}') | ||
end | end | ||
Line 80: | Line 79: | ||
local args = getArgs(frame, { | local args = getArgs(frame, { | ||
trim = true, | trim = true, | ||
removeBlanks = false | removeBlanks = false, | ||
wrappers = { | |||
'Template:Tlg', | |||
}, | |||
}) | }) | ||
return p._main(args) | return p._main(args) | ||
Line 86: | Line 88: | ||
function p._main(args) | function p._main(args) | ||
local bold = | -- TemplateStyles | ||
local italic = | local templateStyles = { | ||
local dontBrace = | mono = false, | ||
local code = | nowrap = false, | ||
local | } | ||
local bold = yesno(args.bold) or yesno(args.boldlink) or yesno(args.boldname) | |||
local italic = yesno(args.italic) or yesno(args.italics) | |||
local dontBrace = yesno(args.brace) or yesno(args.braceinside) | |||
local code = yesno(args.code) or yesno(args.tt) | |||
local classes = {} | |||
-- Build the link part | -- Build the link part | ||
local titlePart = linkTitle(args) | local titlePart = linkTitle(args) | ||
if bold then titlePart = "'''" .. titlePart .. "'''" end | if bold then titlePart = "'''" .. titlePart .. "'''" end | ||
if _ne(args.nowrapname) then titlePart = '<span class="nowrap">' .. titlePart .. '</span>' end | |||
if yesno(args.subst) then | |||
local substLink = cfg['subst-link'] | |||
if _ne(substLink) and yesno(args['link subst']) then | |||
titlePart = '[[' .. substLink .. '|subst]]:' .. titlePart | |||
else | |||
titlePart = 'subst:' .. titlePart | |||
end | |||
end | |||
if yesno(args.nowrapname) then | |||
templateStyles.nowrap = true | |||
titlePart = '<span class="nowrap">' .. titlePart .. '</span>' | |||
end | |||
-- Build the arguments | -- Build the arguments | ||
local textPart = "" | local textPart = "" | ||
local textPartBuffer | local textPartBuffer = "" | ||
local i = 2 | local i = 2 | ||
while args[i] do | while args[i] do | ||
local val = args[i] | local val = args[i] | ||
textPartBuffer = textPartBuffer .. '|' | |||
if val ~= "" then | if val ~= "" then | ||
if | if yesno(args.nowiki) then | ||
-- Unstrip nowiki tags first because calling nw on something that already contains nowiki tags will | -- Unstrip nowiki tags first because calling nw on something that already contains nowiki tags will | ||
-- mangle the nowiki strip marker and result in literal UNIQ...QINU showing up | -- mangle the nowiki strip marker and result in literal UNIQ...QINU showing up | ||
val = nw(mw.text.unstripNoWiki(val)) | val = nw(mw.text.unstripNoWiki(val)) | ||
end | end | ||
if italic then val = '<span style="font-style:italic;">' .. val .. '</span>' end | |||
if italic then | |||
textPart = textPart .. textPartBuffer .. val | textPart = textPart .. textPartBuffer .. val | ||
textPartBuffer = "" | |||
end | end | ||
i = i + 1 | i = i+1 | ||
end | end | ||
local tagName = nil | |||
local css = nil | |||
-- final wrap | -- final wrap | ||
local ret = titlePart .. textPart | local ret = titlePart .. textPart | ||
if not dontBrace then ret = nw('{{') .. ret .. nw('}}') end | if not dontBrace then ret = nw('{{') .. ret .. nw('}}') end | ||
if | if yesno(args.a) then ret = nw('*') .. ' ' .. ret end | ||
if | if yesno(args.kbd) then | ||
if code then | tagName = 'kbd' | ||
ret = '< | end | ||
if yesno(args.mono) then | |||
templateStyles.mono = true | |||
table.insert(classes, 'monospaced') | |||
end | |||
local plaincode = yesno(args.plaincode) and not code | |||
if code or plaincode then | |||
if tagName then | |||
-- kbd == true && code == true | |||
ret = ('<%s>%s</%s>'):format(tagName, ret, tagName) | |||
end | |||
tagName = 'code' | |||
if plaincode then | |||
css = { | |||
background = 'transparent', | |||
border = 'none', | |||
} | |||
end | |||
end | |||
if yesno(args.nowrap) then | |||
templateStyles.nowrap = true | |||
table.insert(classes, 'nowrap') | |||
end | |||
if tagName or #classes > 0 or css then | |||
local span = mw.html.create(tagName or 'span') | |||
:addClass(table.concat(classes, ' ')) | |||
:wikitext(ret) | |||
if css then | |||
span:css(css) | |||
end | |||
ret = tostring(span:allDone()) | |||
end | |||
local ts = {} | |||
if templateStyles.mono then | |||
table.insert(ts, mw.getCurrentFrame():extensionTag{ | |||
name = 'templatestyles', | |||
args = { src = 'Template:Mono/styles.css' } | |||
}) | |||
end | end | ||
if | if templateStyles.nowrap then | ||
table.insert(ts, mw.getCurrentFrame():extensionTag{ | |||
name = 'templatestyles', | |||
args = { src = 'Template:Nowrap/styles.css' } | |||
}) | |||
end | end | ||
if | if yesno(args.debug) then | ||
ret = ret .. '\n<pre>' .. mw.text.encode(mw.dumpObject(args)) .. '</pre>' | |||
end | end | ||
return ret | return table.concat(ts) .. ret | ||
end | end | ||
return p | return p |
Latest revision as of 11:48, 20 July 2022
This Lua module is used in system messages, and on approximately 3,570,000 pages, or roughly 14567% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
This module depends on the following other modules: |
Implements {{Template link general}} and other templates in its family
Basic usage
{{#invoke:template link general|main}}
This module is used by {{template link general}} and related templates to display links to templates. It is similar to {{tl}} but with additional formatting options and the ability to include parameters in the display. See Template:Template link general § Parameters for the full list, which can be enabled by passing any value to them (such as "on", "yes", etc).
-- This implements [[Template:Tlg]]
local getArgs = require('Module:Arguments').getArgs
local yesno = require('Module:Yesno')
local cfg = mw.loadData('Module:Template link general/config')
local p = {}
-- Is a string non-empty?
local function _ne(s)
return s ~= nil and s ~= ""
end
local nw = mw.text.nowiki
local function addTemplate(s)
local i, _ = s:find(':', 1, true)
if i == nil then
return 'Template:' .. s
end
local ns = s:sub(1, i - 1)
if ns == '' or mw.site.namespaces[ns] then
return s
else
return 'Template:' .. s
end
end
local function trimTemplate(s)
local needle = 'template:'
if s:sub(1, needle:len()):lower() == needle then
return s:sub(needle:len() + 1)
else
return s
end
end
local function linkTitle(args)
if yesno(args.nolink) then
return args[1]
end
local titleObj
local titlePart = '[['
if args[1] then
-- This handles :Page and other NS
titleObj = mw.title.new(args[1], 'Template')
else
titleObj = mw.title.getCurrentTitle()
end
titlePart = titlePart .. (titleObj ~= nil and titleObj.fullText or
addTemplate(args[1]))
local textPart = args.alttext
if not _ne(textPart) then
if titleObj ~= nil then
textPart = titleObj:inNamespace("Template") and args[1] or titleObj.fullText
else
-- redlink
textPart = args[1]
end
end
if yesno(args.brace) then
textPart = nw('{{') .. textPart .. nw('}}')
elseif yesno(args.braceinside) then
textPart = nw('{') .. textPart .. nw('}')
end
titlePart = titlePart .. '|' .. textPart .. ']]'
if yesno(args.braceinside) then
titlePart = nw('{') .. titlePart .. nw('}')
end
return titlePart
end
function p.main(frame)
local args = getArgs(frame, {
trim = true,
removeBlanks = false,
wrappers = {
'Template:Tlg',
},
})
return p._main(args)
end
function p._main(args)
-- TemplateStyles
local templateStyles = {
mono = false,
nowrap = false,
}
local bold = yesno(args.bold) or yesno(args.boldlink) or yesno(args.boldname)
local italic = yesno(args.italic) or yesno(args.italics)
local dontBrace = yesno(args.brace) or yesno(args.braceinside)
local code = yesno(args.code) or yesno(args.tt)
local classes = {}
-- Build the link part
local titlePart = linkTitle(args)
if bold then titlePart = "'''" .. titlePart .. "'''" end
if yesno(args.subst) then
local substLink = cfg['subst-link']
if _ne(substLink) and yesno(args['link subst']) then
titlePart = '[[' .. substLink .. '|subst]]:' .. titlePart
else
titlePart = 'subst:' .. titlePart
end
end
if yesno(args.nowrapname) then
templateStyles.nowrap = true
titlePart = '<span class="nowrap">' .. titlePart .. '</span>'
end
-- Build the arguments
local textPart = ""
local textPartBuffer = ""
local i = 2
while args[i] do
local val = args[i]
textPartBuffer = textPartBuffer .. '|'
if val ~= "" then
if yesno(args.nowiki) then
-- Unstrip nowiki tags first because calling nw on something that already contains nowiki tags will
-- mangle the nowiki strip marker and result in literal UNIQ...QINU showing up
val = nw(mw.text.unstripNoWiki(val))
end
if italic then val = '<span style="font-style:italic;">' .. val .. '</span>' end
textPart = textPart .. textPartBuffer .. val
textPartBuffer = ""
end
i = i+1
end
local tagName = nil
local css = nil
-- final wrap
local ret = titlePart .. textPart
if not dontBrace then ret = nw('{{') .. ret .. nw('}}') end
if yesno(args.a) then ret = nw('*') .. ' ' .. ret end
if yesno(args.kbd) then
tagName = 'kbd'
end
if yesno(args.mono) then
templateStyles.mono = true
table.insert(classes, 'monospaced')
end
local plaincode = yesno(args.plaincode) and not code
if code or plaincode then
if tagName then
-- kbd == true && code == true
ret = ('<%s>%s</%s>'):format(tagName, ret, tagName)
end
tagName = 'code'
if plaincode then
css = {
background = 'transparent',
border = 'none',
}
end
end
if yesno(args.nowrap) then
templateStyles.nowrap = true
table.insert(classes, 'nowrap')
end
if tagName or #classes > 0 or css then
local span = mw.html.create(tagName or 'span')
:addClass(table.concat(classes, ' '))
:wikitext(ret)
if css then
span:css(css)
end
ret = tostring(span:allDone())
end
local ts = {}
if templateStyles.mono then
table.insert(ts, mw.getCurrentFrame():extensionTag{
name = 'templatestyles',
args = { src = 'Template:Mono/styles.css' }
})
end
if templateStyles.nowrap then
table.insert(ts, mw.getCurrentFrame():extensionTag{
name = 'templatestyles',
args = { src = 'Template:Nowrap/styles.css' }
})
end
if yesno(args.debug) then
ret = ret .. '\n<pre>' .. mw.text.encode(mw.dumpObject(args)) .. '</pre>'
end
return table.concat(ts) .. ret
end
return p