Module:Template translation: Difference between revisions

m
16 revisions imported
m (there are other chars that generate exceptions in mw.language.isKnownLanguageTag, and some language codes still not validated correctly; check this correctly)
m (16 revisions imported)
 
(36 intermediate revisions by 18 users not shown)
Line 1:
local this = {}
 
function this.checkLanguage(subpage, default)
--[[Check first if there's an any invalid character that would cause the
mw.language.isKnownLanguageTag function() to throw an exception:
Line 22:
case-insensitive; they are not "SupportedLanguages" for MediaWiki, so
they are not "KnownLanguageTags" for MediaWiki).
To be more restrictive, we exclude any character that is not
* that is not ASCII and not a lowercase letter, minus-hyphen, or digit, and any code
that or does not start by a letter or does not finish by a letter or digit.;
of* or that has more than 8 characters between hyphens, or has two hyphens.;
* or that has two hyphens;
* or with specific uses in template subpages and unusable as languages.
--]]
or string.find(subpage, "^[%l][%-%d%l]*[%d%l]$") ~= nil
and string.find(subpage, "[%d%l][%d%l][%d%l][%d%l][%d%l][%d%l][%d%l][%d%l][%d%l]") == nil
and string.find(subpage, "%-%-") == nil
and subpage ~= "doc"
and subpage ~= "layout"
and subpage ~= "sandbox"
and subpage ~= "testcases"
then
return subpage
Line 40 ⟶ 46:
]]
function this.getLanguageSubpage()
--[[This code does not work ibin all namespaces where the Translate tool works.
-- It works in the main namespace on Meta because it allows subpages there
-- It would not work in the main namespace of English Wikipedia (but the
Line 57 ⟶ 63:
local subpage = titleparts[#titleparts]
return this.checkLanguage(subpage, '')
end
 
--[[Get the first part of the language code of the subpage, before the '-'.
]]
function this.getMainLanguageSubpage()
parts = mw.text.split( this.getLanguageSubpage(), '-' )
return parts[1]
end
 
Line 85 ⟶ 98:
end
 
function this.title(namespace, basepagename, subpage)
--[[If on a translation subpage (like Foobar/de), this function renders
local message, title
local pagename = basepagename
if (subpage or '') ~= ''
then
pagename = pagename .. '/' .. subpage
end
local valid, title = xpcall(function()
return mw.title.new(pagename, namespace) -- costly
end, function(msg) -- catch undocumented exception (!?)
-- thrown when namespace does not exist. The doc still
-- says it should return a title, even in that case...
message = msg
end)
if valid and title ~= nil and (title.id or 0) ~= 0
then
return title
end
return { -- "pseudo" mw.title object with id = nil in case of error
prefixedText = pagename, -- the only property we need below
message = message -- only for debugging
}
end
 
--[[If on a translation subpage (like Foobar/de), this function returns
a given template in the same language, if the translation is available.
Otherwise, the template is renderedreturned in its default language, without
modification.
This is aimed at replacing the current implementation of Template:TNTTNTN.
 
This version does not expand the returned template name: this solves the
problem of self-recursion in TNT when translatable templates need themselves
to transclude other translable templates (such as Tnavbar).
]]
function this.renderTranslatedTemplategetTranslatedTemplate(frame, withStatus)
local args = frame.args
local pagename = args['template']
Line 100 ⟶ 141:
]]
local title
local namespace = args['namespacetntns'] or ''
if (namespace ~= '') -- Checks for namespacetntns parameter for custom ns.
then
title = mwthis.title.new(pagenamenamespace, namespacepagename) -- Costly
else -- Supposes that set page is in ns10.
namespace = 'Template'
title = mwthis.title.new(pagenamenamespace, namespacepagename) -- Costly
if (title.id == 0)nil
then -- not found in the Template namespace, assume the main namespace (for backward compatibility)
namespace = ''
title = mwthis.title.new(pagenamenamespace, namespacepagename) -- Costly
end
end
Line 123 ⟶ 164:
then
-- Check if a translation of the pagename exists in English
local newtitle = mwthis.title.new(namespace, pagename .. '/' .., 'en', namespace) -- Costly
-- Use the translation when it exists
if (newtitle.id ~= 0)nil
then
title = newtitle
Line 131 ⟶ 172:
else
-- Check if a translation of the pagename exists in that language
local newtitle = mwthis.title.new(namespace, pagename .. '/' .., subpage, namespace) -- Costly
if (newtitle.id == 0)nil
then
-- Check if a translation of the pagename exists in English
newtitle = mwthis.title.new(namespace, pagename .. '/' .., 'en', namespace) -- Costly
end
-- Use the translation when it exists
if (newtitle.id ~= 0)nil
then
title = newtitle
end
end
-- At this point the title should exist
if withStatus then
-- At this point the title should exist, otherwise render a red link to the missing page (resolved in its assumed namespace)
-- status returned to Lua function below
if (title.id == 0)
return title.prefixedText, title.id ~= nil
then
else
return '[[' .. title.prefixedText .. ']]'
-- returned directly to MediaWiki
return title.prefixedText
end
end
 
--[[If on a translation subpage (like Foobar/de), this function renders
a given template in the same language, if the translation is available.
Otherwise, the template is rendered in its default language, without
modification.
This is aimed at replacing the current implementation of Template:TNT.
Note that translatable templates cannot transclude themselves other
translatable templates, as it will recurse on TNT. Use TNTN instead
to return only the effective template name to expand externally, with
template parameters also provided externally.
]]
function this.renderTranslatedTemplate(frame)
local title, found = this.getTranslatedTemplate(frame, true)
-- At this point the title should exist prior to performing the expansion
-- of the template, otherwise render a red link to the missing page
-- (resolved in its assumed namespace). If we don't tet this here, a
-- script error would be thrown. Returning a red link is consistant with
-- MediaWiki behavior when attempting to transclude inexistant templates.
if not found then
return '[[' .. title .. ']]'
end
 
-- Copy args pseudo-table to a proper table so we can feed it to expandTemplate.
-- Then render the pagename.
local args = frame.args
local pargs = (frame:getParent() or {}).args
local arguments = {}
if (args['noshift'] or '') == ''
then
for k, v in pairs(pargs) do
-- numbered args >= 1 need to be shifted
local n = tonumber(k) or 0
if (n > 0)
then
if (n >= 2)
then
arguments[n - 1] = v
end
else
arguments[k] = v
end
end
else -- special case where TNT is used as autotranslate
-- (don't shift again what is shifted in the invokation)
for k, v in pairs(pargs) do
arguments[k] = v
end
end
arguments['template'] = title -- override the existing parameter of the base template name supplied with the full name of the actual template expanded
arguments['tntns'] = nil -- discard the specified namespace override
arguments['uselang'] = args['uselang'] -- argument forwarded into parent frame
arguments['noshift'] = args['noshift'] -- argument forwarded into parent frame
return frame:expandTemplate{title = ':' .. title, args = arguments}
end
 
--[[A helper for mocking TNT in Special:TemplateSandbox. TNT breaks
TemplateSandbox; mocking it with this method means templates won't be
localized but at least TemplateSandbox substitutions will work properly.
Won't work with complex uses.
]]
function this.mockTNT(frame)
local pargs = (frame:getParent() or {}).args
local arguments = {}
for k, v in pairs((frame:getParent() or {}).argspargs) do
-- numbered args >= 1 need to be shifted
local n = tonumber(k) or 0
if (n > 0)
then
if (n >= 2)
then
arguments[n - 1] = v
end
Line 166 ⟶ 271:
end
end
if not pargs[1]
arguments['template'] = title.prefixedText -- override the existing parameter of the base template name supplied with the full name of the actual template expanded
then
arguments['namespace'] = nil -- discard the specified namespace override
return ''
end
return frame:expandTemplate{title = ':' .. title.prefixedText, args = arguments}
return frame:expandTemplate{title = 'Template:' .. pargs[1], args = arguments}
end