Модуль:Documentation: различия между версиями

Материал из in.wiki
Перейти к навигации Перейти к поиску
 
Строка 1: Строка 1:
−
-- This module implements {{documentation}}.
 
−
 
−
-- Get required modules.
 
−
local getArgs = require('Module:Arguments').getArgs
 
−
local htmlBuilder = require('Module:HtmlBuilder')
 
−
local messageBox = require('Module:Message box')
 
−
 
−
-- Get the config table.
 
−
local cfg = mw.loadData('Module:Documentation/config')
 
−
 
 
local p = {}
 
local p = {}
  
−
-- Often-used functions.
+
local yesno = require('Module:Yesno')
−
local ugsub = mw.ustring.gsub
 
−
 
 
−
----------------------------------------------------------------------------
 
−
-- Helper functions
 
−
--
 
−
-- These are defined as local functions, but are made available in the p
 
−
-- table for testing purposes.
 
−
----------------------------------------------------------------------------
 
−
 
 
−
local function message(cfgKey, valArray, expectType)
 
−
--[[
 
−
-- Gets a message from the cfg table and formats it if appropriate.
 
−
-- The function raises an error if the value from the cfg table is not
 
−
-- of the type expectType. The default type for expectType is 'string'.
 
−
-- If the table valArray is present, strings such as $1, $2 etc. in the
 
−
-- message are substituted with values from the table keys [1], [2] etc.
 
−
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.',
 
−
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."
 
−
--]]
 
−
local msg = cfg[cfgKey]
 
−
expectType = expectType or 'string'
 
−
if type(msg) ~= expectType then
 
−
error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
 
−
end
 
−
if not valArray then
 
−
return msg
 
−
end
 
  
−
local function getMessageVal(match)
+
local medal = 'медаль'
−
match = tonumber(match)
+
local order = 'орден'
−
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
+
local insignia = 'знак отличия'
−
end
+
local badge = 'почётный знак'
 +
local badge2 = 'почетный знак'
 +
local title = 'звание' --почётное
 +
local rank = 'звание' --воинское
 +
local prize = 'премия'
 +
local commemorative = 'памятный знак'
 +
local awardTypes = {medal, order, insignia, badge, badge2, title, prize, commemorative}
 +
local exampleTitle = '== Пример использования ==\n'
 +
local namePlaceholder = 'Имя и фамилия'
 +
local textPrefix = 'Шаблон предназначен для обозначения людей'
 +
local orDivisons = ' или подразделений'
 +
local typesTitle = '== Таблица вариантов  ==\n'
 +
local _type = 'тип'
 +
local note = 'примечание'
  
−
local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
+
local function expand(frame, tname, targs)
−
return ret
+
return frame:expandTemplate({title = tname, args = targs})
 
end
 
end
  
−
p.message = message
+
local parameters = {
 +
['имя'] = {['ученый'] = 'Имя', ['учёный'] = 'Имя', ['политик'] = 'Имя', ['театральный деятель'] = 'Имя', default = 'имя'},
 +
['награды'] = {['ученый'] = 'Награды и премии', ['учёный'] = 'Награды и премии', ['персона'] = 'награды и премии', ['спортсмен'] = 'медали', ['политик'] = 'Награды', ['театральный деятель'] = 'Награды', default = 'награды' },
 +
['звание'] = {default = 'звание'}
 +
}
  
−
local function makeWikilink(page, display)
+
local function get_param_name(tname, pname)  
−
if display then
+
if not parameters[pname] then
−
return mw.ustring.format('[[%s|%s]]', page, display)
+
return pname
−
else
 
−
return mw.ustring.format('[[%s]]', page)
 
 
end
 
end
 +
return parameters[pname][mw.ustring.lower(tname)] or parameters[pname].default or pname
 
end
 
end
  
−
p.makeWikilink = makeWikilink
+
local function instead_of_link(link)  
−
 
+
return ' Размещается вместо ссылки [[' .. link .. ']]'
−
local function makeCategoryLink(cat, sort)
 
−
local catns = mw.site.namespaces[14].name
 
−
return makeWikilink(catns .. ':' .. cat, sort)
 
 
end
 
end
  
−
p.makeCategoryLink = makeCategoryLink
+
local function in_param(frame, tname, pname)  
−
 
+
return ' в частности, в графе ' .. expand(frame, 'para', {[1]=pname}) .. ' шаблона ' .. expand(frame, 'tl', {[1]=tname}) .. '.\n\n'
−
local function makeUrlLink(url, display)
 
−
return mw.ustring.format('[%s %s]', url, display)
 
 
end
 
end
  
−
p.makeUrlLink = makeUrlLink
+
function repeat_whitespace(n)
−
 
+
local r = ''
−
local function makeToolbar(...)
+
for i = 1, n do
−
local ret = {}
+
r = r .. ' '
−
local lim = select('#', ...)
 
−
if lim < 1 then
 
−
return nil
 
 
end
 
end
−
for i = 1, lim do
+
return r
−
ret[#ret + 1] = select(i, ...)
+
end
−
end
 
−
return '<small style="font-style: normal;">(' .. table.concat(ret, ' &#124; ') .. ')</small>'
 
−
end
 
  
−
p.makeToolbar = makeToolbar
+
local function render_example(frame, pageName, tname, paramName, paramTarget, example)
−
 
+
local templateResult = expand(frame, tname, {[paramTarget] = example, [paramName] = namePlaceholder})
−
----------------------------------------------------------------------------
+
local nameLen = mw.ustring.len(paramName)
−
-- Argument processing
+
local targetLen = mw.ustring.len(paramTarget)
−
----------------------------------------------------------------------------
+
local maxLen = math.max(nameLen, targetLen)
 +
local pre = '<pre>\n{{' .. tname .. '\n|' .. paramName .. repeat_whitespace(3 + maxLen - nameLen) .. '= ' .. namePlaceholder .. '\n|'  .. paramTarget .. repeat_whitespace(3 + maxLen - targetLen) ..  '= {{' .. pageName .. '}}\n}}</pre>'
 +
return templateResult .. '\n\n' .. pre
 +
end
  
−
local function makeInvokeFunc(funcName)
+
local function template_res_and_pre(frame, pageName, tname, paramName, paramTarget)  
−
return function (frame)
+
return render_example(frame, pageName, tname, paramName, paramTarget, expand(frame, pageName))
−
local args = getArgs(frame, {
 
−
valueFunc = function (key, value)
 
−
if type(value) == 'string' then
 
−
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.
 
−
if key == 'heading' or value ~= '' then
 
−
return value
 
−
else
 
−
return nil
 
−
end
 
−
else
 
−
return value
 
−
end
 
−
end
 
−
})
 
−
return p[funcName](args)
 
−
end
 
 
end
 
end
  
−
----------------------------------------------------------------------------
+
local function cat_link(cat)  
−
-- Main function
+
return '[[:К:' .. cat .. '|' .. cat .. ']]'
−
----------------------------------------------------------------------------
 
−
 
 
−
p.main = makeInvokeFunc('_main')
 
−
 
 
−
function p._main(args)
 
−
--[[
 
−
-- This function defines logic flow for the module.
 
−
-- @args - table of arguments passed by the user
 
−
--
 
−
-- Messages:
 
−
-- 'main-div-id' --> 'template-documentation'
 
−
-- 'main-div-classes' --> 'template-documentation iezoomfix'
 
−
--]]
 
−
local env = p.getEnvironment(args)
 
−
local root = htmlBuilder.create()
 
−
root
 
−
.wikitext(p.protectionTemplate(env))
 
−
.wikitext(p.sandboxNotice(args, env))
 
−
-- This div tag is from {{documentation/start box}}, but moving it here
 
−
-- so that we don't have to worry about unclosed tags.
 
−
.tag('div')
 
−
.attr('id', message('main-div-id'))
 
−
.addClass(message('main-div-classes'))
 
−
.newline()
 
−
.wikitext(p._startBox(args, env))
 
−
.wikitext(p._content(args, env))
 
−
.tag('div')
 
−
.css('clear', 'both') -- So right or left floating items don't stick out of the doc box.
 
−
.newline()
 
−
.done()
 
−
.done()
 
−
.wikitext(p._endBox(args, env))
 
−
.newline()
 
−
.wikitext(p.addTrackingCategories(env))
 
−
return tostring(root)
 
 
end
 
end
  
−
----------------------------------------------------------------------------
+
local function format_categories(categories)
−
-- Environment settings
+
local cats = {}
−
----------------------------------------------------------------------------
+
for s in mw.ustring.gmatch(categories, '[^/]+') do
−
 
+
table.insert(cats, cat_link(s))
−
function p.getEnvironment(args)
 
−
--[[
 
−
-- Returns a table with information about the environment, including title objects and other namespace- or
 
−
-- path-related data.
 
−
-- @args - table of arguments passed by the user
 
−
--
 
−
-- Title objects include:
 
−
-- env.title - the page we are making documentation for (usually the current title)
 
−
-- env.templateTitle - the template (or module, file, etc.)
 
−
-- env.docTitle - the /doc subpage.
 
−
-- env.sandboxTitle - the /sandbox subpage.
 
−
-- env.testcasesTitle - the /testcases subpage.
 
−
-- env.printTitle - the print version of the template, located at the /Print subpage.
 
−
--
 
−
-- Data includes:
 
−
-- env.subjectSpace - the number of the title's subject namespace.
 
−
-- env.docSpace - the number of the namespace the title puts its documentation in.
 
−
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.
 
−
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.
 
−
--
 
−
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value
 
−
-- returned will be nil.
 
−
--]]
 
−
 
−
local env, envFuncs = {}, {}
 
−
 
 
−
-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value
 
−
-- returned by that function is memoized in the env table so that we don't call any of the functions
 
−
-- more than once. (Nils won't be memoized.)
 
−
setmetatable(env, {
 
−
__index = function (t, key)
 
−
local envFunc = envFuncs[key]
 
−
if envFunc then
 
−
local success, val = pcall(envFunc)
 
−
if success then
 
−
env[key] = val -- Memoise the value.
 
−
return val
 
−
end
 
−
end
 
−
return nil
 
−
end
 
−
})
 
−
 
 
−
function envFuncs.title()
 
−
-- The title object for the current page, or a test page passed with args.page.
 
−
local title
 
−
local titleArg = args.page
 
−
if titleArg then
 
−
title = mw.title.new(titleArg)
 
−
else
 
−
title = mw.title.getCurrentTitle()
 
−
end
 
−
return title
 
 
end
 
end
−
 
+
if #cats == 0 then
−
function envFuncs.templateTitle()
+
return ''
−
--[[
 
−
-- The template (or module, etc.) title object.
 
−
-- Messages:
 
−
-- 'sandbox-subpage' --> 'sandbox'
 
−
-- 'testcases-subpage' --> 'testcases'
 
−
--]]
 
−
local subjectSpace = env.subjectSpace
 
−
local title = env.title
 
−
local subpage = title.subpageText
 
−
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then
 
−
return mw.title.makeTitle(subjectSpace, title.baseText)
 
−
else
 
−
return mw.title.makeTitle(subjectSpace, title.text)
 
−
end
 
 
end
 
end
−
 
+
local ret = 'Шаблон автоматически добавляет статью в категори'
−
function envFuncs.docTitle()
+
if #cats > 1 then
−
--[[
+
ret = ret ..'и'
−
-- Title object of the /doc subpage.
+
else
−
-- Messages:
+
ret = ret .. 'ю'
−
-- 'doc-subpage' --> 'doc'
 
−
--]]
 
−
local title = env.title
 
−
local docname = args[1] -- User-specified doc page.
 
−
local docpage
 
−
if docname then
 
−
docpage = docname
 
−
else
 
−
docpage = env.docpageBase .. '/' .. message('doc-subpage')
 
−
end
 
−
return mw.title.new(docpage)
 
−
end
 
−
 
−
function envFuncs.sandboxTitle()
 
−
--[[
 
−
-- Title object for the /sandbox subpage.
 
−
-- Messages:
 
−
-- 'sandbox-subpage' --> 'sandbox'
 
−
--]]
 
−
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))
 
−
end
 
−
 
−
function envFuncs.testcasesTitle()
 
−
--[[
 
−
-- Title object for the /testcases subpage.
 
−
-- Messages:
 
−
-- 'testcases-subpage' --> 'testcases'
 
−
--]]
 
−
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
 
−
end
 
−
 
−
function envFuncs.printTitle()
 
−
--[[
 
−
-- Title object for the /Print subpage.
 
−
-- Messages:
 
−
-- 'print-subpage' --> 'Print'
 
−
--]]
 
−
return env.templateTitle:subPageTitle(message('print-subpage'))
 
 
end
 
end
 +
ret = ret .. ' ' .. mw.text.listToText(cats) .. '.'
 +
return ret
 +
end
  
−
function envFuncs.subjectSpace()
+
local function starts_with(st, prefix)
−
-- The subject namespace number.
+
return mw.ustring.sub(st, 1, mw.ustring.len(prefix)) == prefix
−
return mw.site.namespaces[env.title.namespace].subject.id
+
end
−
end
+
local function quotate_default(st, quotes)
−
 
+
if (quotes == nil or yesno(quotes)) and not starts_with(st, '«') then
−
function envFuncs.docSpace()
+
return '«' .. st .. '»'
−
-- The documentation namespace number. For most namespaces this is the same as the
 
−
-- subject namespace. However, pages in the Article, File, MediaWiki or Category
 
−
-- namespaces must have their /doc, /sandbox and /testcases pages in talk space.
 
−
local subjectSpace = env.subjectSpace
 
−
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
 
−
return subjectSpace + 1
 
−
else
 
−
return subjectSpace
 
−
end
 
 
end
 
end
 +
return st
 +
end
  
−
function envFuncs.docpageBase()
+
local function get_param_num(args, prefix)
−
-- The base page of the /doc, /sandbox, and /testcases subpages.
+
local num = 0
−
-- For some namespaces this is the talk page, rather than the template page.
+
while args[prefix .. tostring(num+1)] ~= nil do
−
local templateTitle = env.templateTitle
+
num = num + 1
−
local docSpace = env.docSpace
 
−
local docSpaceText = mw.site.namespaces[docSpace].name
 
−
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.
 
−
return docSpaceText .. ':' .. templateTitle.text
 
 
end
 
end
−
+
return num
−
function envFuncs.compareUrl()
+
end
−
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].
 
−
local templateTitle = env.templateTitle
 
−
local sandboxTitle = env.sandboxTitle
 
−
if templateTitle.exists and sandboxTitle.exists then
 
−
local compareUrl = mw.uri.fullUrl(
 
−
'Special:ComparePages',
 
−
{page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
 
−
)
 
−
return tostring(compareUrl)
 
−
else
 
−
return nil
 
−
end
 
−
end
 
  
−
return env
+
local function types_table(frame, pageName, args)
−
end
+
local t = mw.html.create('table'):addClass('wide center')
−
 
+
local headers = t:tag('tr')
−
----------------------------------------------------------------------------
+
headers:tag('th'):wikitext('Код шаблона<br />(для копирования)')
−
-- Auxiliary templates
+
headers:tag('th'):wikitext('Шаблоном отображается')
−
----------------------------------------------------------------------------
+
headers:tag('th'):wikitext('Примечание к отображаемому шаблоном')
−
 
+
local varCount = get_param_num(args, _type)
−
function p.sandboxNotice(args, env)
+
local defaultStr = t:tag('tr')
−
--[=[
+
defaultStr:tag('td'):addClass('nowrap'):wikitext('{{' .. pageName .. '}}')
−
-- Generates a sandbox notice for display above sandbox pages.
+
defaultStr:tag('td'):wikitext(expand(frame, pageName, {}))
−
-- @args - a table of arguments passed by the user
+
defaultStr:tag('td'):wikitext(args[note .. '0'])
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
+
for i = 1, varCount do
−
--
+
local varStr = t:tag('tr')
−
-- Messages:
+
local istr = tostring(i)
−
-- 'sandbox-notice-image' --> '[[Image:Sandbox.png|50px|alt=|link=]]'
+
local var = args[_type .. istr]
−
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'
+
varStr:tag('td'):addClass('nowrap'):wikitext('{{' .. pageName .. '|тип=' .. var .. '}}')
−
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'
+
varStr:tag('td'):wikitext(expand(frame, pageName, {[_type]=var}))
−
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page'
+
varStr:tag('td'):wikitext(args[note .. istr])
−
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'
 
−
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'
 
−
-- 'sandbox-notice-compare-link-display' --> 'diff'
 
−
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'
 
−
-- 'sandbox-notice-testcases-link-display' --> 'test cases'
 
−
-- 'sandbox-category' --> 'Template sandboxes'
 
−
--]=]
 
−
local title = env.title
 
−
local sandboxTitle = env.sandboxTitle
 
−
local templateTitle = env.templateTitle
 
−
local subjectSpace = env.subjectSpace
 
−
if not (subjectSpace and title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then
 
−
return nil
 
 
end
 
end
−
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".
+
return typesTitle .. tostring(t) .. '\n'
−
local omargs = {}
 
−
omargs.image = message('sandbox-notice-image')
 
−
-- Get the text. We start with the opening blurb, which is something like
 
−
-- "This is the template sandbox for [[Template:Foo]] (diff)."
 
−
local text = ''
 
−
local frame = mw.getCurrentFrame()
 
−
local isPreviewing = frame:preprocess('{{REVISIONID}}') == '' -- True if the page is being previewed.
 
−
local pagetype
 
−
if subjectSpace == 10 then
 
−
pagetype = message('sandbox-notice-pagetype-template')
 
−
elseif subjectSpace == 828 then
 
−
pagetype = message('sandbox-notice-pagetype-module')
 
−
else
 
−
pagetype = message('sandbox-notice-pagetype-other')
 
−
end
 
−
local templateLink = makeWikilink(templateTitle.prefixedText)
 
−
local compareUrl = env.compareUrl
 
−
if isPreviewing or not compareUrl then
 
−
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
 
−
else
 
−
local compareDisplay = message('sandbox-notice-compare-link-display')
 
−
local compareLink = makeUrlLink(compareUrl, compareDisplay)
 
−
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
 
−
end
 
−
-- Get the test cases page blurb if the page exists. This is something like
 
−
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."
 
−
local testcasesTitle = env.testcasesTitle
 
−
if testcasesTitle and testcasesTitle.exists then
 
−
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
 
−
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
 
−
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})
 
−
end
 
−
-- Add the sandbox to the sandbox category.
 
−
text = text .. makeCategoryLink(message('sandbox-category'))
 
−
omargs.text = text
 
−
return messageBox.main('ombox', omargs)
 
 
end
 
end
  
−
function p.protectionTemplate(env)
+
local function guess_type(pageName)
−
-- Generates the padlock icon in the top right.
+
for _, awardType in ipairs(awardTypes) do
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
+
if starts_with(mw.ustring.lower(pageName), awardType) then
−
-- Messages:
+
return awardType
−
-- 'protection-template' --> 'pp-template'
 
−
-- 'protection-template-args' --> {docusage = 'yes'}
 
−
local title = env.title
 
−
local protectionTemplate = message('protection-template')
 
−
local namespace = title.namespace
 
−
if not (protectionTemplate and (namespace == 10 or namespace == 828)) then
 
−
-- Don't display the protection template if we are not in the template or module namespaces.
 
−
return nil
 
−
end
 
−
local frame = mw.getCurrentFrame()
 
−
local function getProtectionLevel(protectionType, page)
 
−
-- Gets the protection level for page, or for the current page if page is not specified.
 
−
local level = frame:callParserFunction('PROTECTIONLEVEL', protectionType, page)
 
−
if level ~= '' then
 
−
return level
 
−
else
 
−
return nil -- The parser function returns the blank string if there is no match.
 
 
end
 
end
−
end
 
−
local prefixedTitle = title.prefixedText
 
−
if getProtectionLevel('move', prefixedTitle) == 'sysop' or getProtectionLevel('edit', prefixedTitle) then
 
−
-- The page is full-move protected, or full, template, or semi-protected.
 
−
return frame:expandTemplate{title = protectionTemplate, args = message('protection-template-args', nil, 'table')}
 
 
end
 
end
 
return nil
 
return nil
 
end
 
end
  
−
----------------------------------------------------------------------------
+
local function trim_parentheses(str)
−
-- Start box
+
for s in mw.ustring.gmatch(str, '[^%(]+') do
−
----------------------------------------------------------------------------
+
return s:match('^%s*(.-)%s*$')
−
 
 
−
p.startBox = makeInvokeFunc('_startBox')
 
−
 
 
−
function p._startBox(args, env)
 
−
--[[
 
−
-- This function generates the start box.
 
−
-- @args - a table of arguments passed by the user
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
--
 
−
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make
 
−
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox
 
−
-- which generate the box HTML.
 
−
--]]
 
−
env = env or p.getEnvironment(args)
 
−
local links
 
−
local content = args.content
 
−
if not content then
 
−
-- No need to include the links if the documentation is on the template page itself.
 
−
local linksData = p.makeStartBoxLinksData(args, env)
 
−
if linksData then
 
−
links = p.renderStartBoxLinks(linksData)
 
−
end
 
−
end
 
−
-- Generate the start box html.
 
−
local data = p.makeStartBoxData(args, env, links)
 
−
if data then
 
−
return p.renderStartBox(data)
 
−
else
 
−
-- User specified no heading.
 
−
return nil
 
 
end
 
end
 +
return str
 
end
 
end
  
−
function p.makeStartBoxLinksData(args, env)
+
local function trim_type_and_parentheses(pageName)
−
--[[
+
local autoType = guess_type(pageName)
−
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.
+
if autoType ~= nil then
−
-- @args - a table of arguments passed by the user
+
local typeLen = mw.ustring.len(autoType)
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
+
pageName = mw.ustring.sub(pageName, typeLen + 2, mw.ustring.len(pageName))
−
--
 
−
-- Messages:
 
−
-- 'view-link-display' --> 'view'
 
−
-- 'edit-link-display' --> 'edit'
 
−
-- 'history-link-display' --> 'history'
 
−
-- 'purge-link-display' --> 'purge'
 
−
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'
 
−
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
 
−
-- 'docpage-preload' --> 'Template:Documentation/preload'
 
−
-- 'create-link-display' --> 'create'
 
−
--]]
 
−
local subjectSpace = env.subjectSpace
 
−
local title = env.title
 
−
local docTitle = env.docTitle
 
−
if not title or not docTitle then
 
−
return nil
 
 
end
 
end
 +
return trim_parentheses(pageName)
 +
end
  
−
local data = {}
+
local function get_award_type_text(awardType)
−
data.title = title
+
if awardType == order then
−
data.docTitle = docTitle
+
return ', награждённых орденом'
−
-- View, display, edit, and purge links if /doc exists.
+
elseif awardType == medal then
−
data.viewLinkDisplay = message('view-link-display')
+
return ', награждённых медалью'
−
data.editLinkDisplay = message('edit-link-display')
+
elseif awardType == insignia then
−
data.historyLinkDisplay = message('history-link-display')
+
return ', награждённых знаком отличия'
−
data.purgeLinkDisplay = message('purge-link-display')
+
elseif awardType == badge or awardType == badge2 then
−
-- Create link if /doc doesn't exist.
+
return ', награждённых почётным знаком'
−
local preload = args.preload
+
elseif awardType == title then
−
if not preload then
+
return ', удостоенных звания'
−
if subjectSpace == 6 then -- File namespace
+
elseif awardType == prize then
−
preload = message('file-docpage-preload')
+
return ' — лауреатов премии'
−
elseif subjectSpace == 828 then -- Module namespace
+
elseif awardType == commemorative then
−
preload = message('module-preload')
+
return ', награждённых памятным знаком'
−
else
 
−
preload = message('docpage-preload')
 
−
end
 
 
end
 
end
−
data.preload = preload
+
return ''
−
data.createLinkDisplay = message('create-link-display')
 
−
return data
 
 
end
 
end
  
−
function p.renderStartBoxLinks(data)
+
function p.print_types_table(frame)
−
--[[
+
local mt = mw.html.create('table'):addClass('wikitable')
−
-- Generates the [view][edit][history][purge] or [create] links from the data table.
+
local headers = mt:tag('tr'):css('text-align', 'center')
−
-- @data - a table of data generated by p.makeStartBoxLinksData
+
headers:tag('th'):wikitext('Значение параметра')
−
--]]
+
headers:tag('th'):wikitext('Отображаемый текст')
−
+
for _, awardType in ipairs(awardTypes) do
−
local function escapeBrackets(s)
+
local row = mt:tag('tr')
−
-- Escapes square brackets with HTML entities.
+
row:tag('td'):wikitext(expand(frame, 'para', {'тип', awardType}))
−
s = s:gsub('%[', '&#91;') -- Replace square brackets with HTML entities.
+
row:tag('td'):wikitext('…' .. get_award_type_text(awardType))
−
s = s:gsub('%]', '&#93;')
 
−
return s
 
 
end
 
end
−
 
+
return tostring(mt)
−
local ret
 
−
local docTitle = data.docTitle
 
−
local title = data.title
 
−
if docTitle.exists then
 
−
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)
 
−
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)
 
−
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)
 
−
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)
 
−
ret = '[%s] [%s] [%s] [%s]'
 
−
ret = escapeBrackets(ret)
 
−
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)
 
−
else
 
−
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)
 
−
ret = '[%s]'
 
−
ret = escapeBrackets(ret)
 
−
ret = mw.ustring.format(ret, createLink)
 
−
end
 
−
return ret
 
 
end
 
end
  
−
function p.makeStartBoxData(args, env, links)
+
local function _award_base(frame, args, pageName, tname, paramAward)
−
--[=[
+
local res = textPrefix
−
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.
+
if yesno(args['подразделения']) then
−
-- @args - a table of arguments passed by the user
+
res = res .. orDivisons
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.
 
−
--
 
−
-- Messages:
 
−
-- 'documentation-icon-wikitext' --> '[[File:Template-info.png|50px|link=|alt=Documentation icon]]'
 
−
-- 'template-namespace-heading' --> 'Template documentation'
 
−
-- 'module-namespace-heading' --> 'Module documentation'
 
−
-- 'file-namespace-heading' --> 'Summary'
 
−
-- 'other-namespaces-heading' --> 'Documentation'
 
−
-- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks'
 
−
-- 'start-box-link-id' --> 'doc_editlinks'
 
−
-- 'testcases-create-link-display' --> 'create'
 
−
--]=]
 
−
local subjectSpace = env.subjectSpace
 
−
if not subjectSpace then
 
−
-- Default to an "other namespaces" namespace, so that we get at least some output
 
−
-- if an error occurs.
 
−
subjectSpace = 2
 
−
end
 
−
local data = {}
 
−
 
−
-- Heading
 
−
local heading = args.heading -- Blank values are not removed.
 
−
if heading == '' then
 
−
-- Don't display the start box if the heading arg is defined but blank.
 
−
return nil
 
−
end
 
−
if heading then
 
−
data.heading = heading
 
−
elseif subjectSpace == 10 then -- Template namespace
 
−
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')
 
−
elseif subjectSpace == 828 then -- Module namespace
 
−
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')
 
−
elseif subjectSpace == 6 then -- File namespace
 
−
data.heading = message('file-namespace-heading')
 
−
else
 
−
data.heading = message('other-namespaces-heading')
 
−
end
 
−
 
−
-- Heading CSS
 
−
local headingStyle = args['heading-style']
 
−
if headingStyle then
 
−
data.headingStyleText = headingStyle
 
−
elseif subjectSpace == 10 then
 
−
-- We are in the template or template talk namespaces.
 
−
data.headingFontWeight = 'bold'
 
−
data.headingFontSize = '125%'
 
−
else
 
−
data.headingFontSize = '150%'
 
 
end
 
end
−
+
local awardType = args['тип'] or guess_type(pageName) or medal
−
-- Data for the [view][edit][history][purge] or [create] links.
+
res = res .. get_award_type_text(awardType)
−
if links then
+
if not yesno(args['без названия']) then
−
data.linksClass = message('start-box-linkclasses')
+
local quotes = args['кавычки']
−
data.linksId = message('start-box-link-id')
+
local titleString = args[1] or args['название'] or trim_type_and_parentheses(pageName)
−
data.links = links
+
res = res .. ' ' .. quotate_default(titleString, quotes)
 
end
 
end
−
+
res = res .. '.'
−
return data
+
local link = args[2] or args['ссылка'] or pageName
−
end
+
res = res .. instead_of_link(link) .. ';'
 +
local paramAward = get_param_name(tname, 'награды')
 +
res = res .. in_param(frame, tname, paramAward)
  
−
function p.renderStartBox(data)
+
local categories = args['категория'] or args['категории']
−
-- Renders the start box html.
+
if categories then
−
-- @data - a table of data generated by p.makeStartBoxData.
+
res = res .. format_categories(categories) .. '\n'
−
local sbox = htmlBuilder.create('div')
 
−
sbox
 
−
.css('padding-bottom', '3px')
 
−
.css('border-bottom', '1px solid #aaa')
 
−
.css('margin-bottom', '1ex')
 
−
.newline()
 
−
.tag('span')
 
−
.cssText(data.headingStyleText)
 
−
.css('font-weight', data.headingFontWeight)
 
−
.css('font-size', data.headingFontSize)
 
−
.wikitext(data.heading)
 
−
local links = data.links
 
−
if links then
 
−
sbox.tag('span')
 
−
.addClass(data.linksClass)
 
−
.attr('id', data.linksId)
 
−
.wikitext(links)
 
 
end
 
end
−
return tostring(sbox)
 
−
end
 
  
−
----------------------------------------------------------------------------
+
local filename = args['файл']
−
-- Documentation content
+
if filename then
−
----------------------------------------------------------------------------
+
res = res .. '\nВ качестве изображения используется файл [[:Файл:' .. filename .. '|' .. filename .. ']] [[Файл:' .. filename .. '|x17px|link=|alt=]]\n'
−
 
 
−
p.content = makeInvokeFunc('_content')
 
−
 
 
−
function p._content(args, env)
 
−
-- Displays the documentation contents
 
−
-- @args - a table of arguments passed by the user
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
env = env or p.getEnvironment(args)
 
−
local docTitle = env.docTitle
 
−
local content = args.content
 
−
if not content and docTitle and docTitle.exists then
 
−
local frame = mw.getCurrentFrame()
 
−
content = frame:expandTemplate{title = docTitle.prefixedText}
 
 
end
 
end
−
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
 
−
-- of docs are interpreted correctly.
 
−
return '\n' .. (content or '') .. '\n'
 
−
end
 
−
 
−
----------------------------------------------------------------------------
 
−
-- End box
 
−
----------------------------------------------------------------------------
 
−
 
−
p.endBox = makeInvokeFunc('_endBox')
 
  
−
function p._endBox(args, env)
+
if get_param_num(args, _type) > 0 then
−
--[=[
+
res = res .. types_table(frame, pageName, args)
−
-- This function generates the end box (also known as the link box).
 
−
-- @args - a table of arguments passed by the user
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
--
 
−
-- Messages:
 
−
-- 'fmbox-id' --> 'documentation-meta-data'
 
−
-- 'fmbox-style' --> 'background-color: #ecfcf4'
 
−
-- 'fmbox-textstyle' --> 'font-style: italic'
 
−
--
 
−
-- The HTML is generated by the {{fmbox}} template, courtesy of [[Module:Message box]].
 
−
--]=]
 
−
 
−
-- Get environment data.
 
−
env = env or p.getEnvironment(args)
 
−
local subjectSpace = env.subjectSpace
 
−
local docTitle = env.docTitle
 
−
if not subjectSpace or not docTitle then
 
−
return nil
 
−
end
 
−
 
−
-- Check whether we should output the end box at all. Add the end
 
−
-- box by default if the documentation exists or if we are in the
 
−
-- user, module or template namespaces.
 
−
local linkBox = args['link box']
 
−
if linkBox == 'off'
 
−
or not (
 
−
docTitle.exists
 
−
or subjectSpace == 2
 
−
or subjectSpace == 828
 
−
or subjectSpace == 10
 
−
)
 
−
then
 
−
return nil
 
 
end
 
end
  
−
-- Assemble the arguments for {{fmbox}}.
+
res = res .. exampleTitle
−
local fmargs = {}
+
return res
−
fmargs.id = message('fmbox-id') -- Sets 'documentation-meta-data'
+
end
−
fmargs.image = 'none'
 
−
fmargs.style = message('fmbox-style') -- Sets 'background-color: #ecfcf4'
 
−
fmargs.textstyle = message('fmbox-textstyle') -- 'font-style: italic;'
 
  
−
-- Assemble the fmbox text field.
+
function p.award(frame)
−
local text = ''
+
if not getArgs then
−
if linkBox then
+
getArgs = require('Module:Arguments').getArgs
−
text = text .. linkBox
 
−
else
 
−
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]."
 
−
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then
 
−
-- We are in the user, template or module namespaces.
 
−
-- Add sandbox and testcases links.
 
−
-- "Editors can experiment in this template's sandbox and testcases pages."
 
−
text = text .. p.makeExperimentBlurb(args, env)
 
−
text = text .. '<br />'
 
−
if not args.content and not args[1] then
 
−
-- "Please add categories to the /doc subpage."
 
−
-- Don't show this message with inline docs or with an explicitly specified doc page,
 
−
-- as then it is unclear where to add the categories.
 
−
text = text .. (p.makeCategoriesBlurb(args, env) or '')
 
−
end
 
−
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"
 
−
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates.
 
−
if printBlurb then
 
−
text = text .. '<br />' .. printBlurb
 
−
end
 
−
end
 
 
end
 
end
−
fmargs.text = text
+
local args = getArgs(frame)
−
 
+
local pageName = mw.title.getCurrentTitle().text
−
return messageBox.main('fmbox', fmargs)
+
local tname = args['шаблон'] or 'Военный деятель'
 +
local paramAward = get_param_name(tname, 'награды')
 +
local res = _award_base(frame, args, pageName, tname, paramAward)
 +
local paramName = get_param_name(tname, 'имя')
 +
res = res .. template_res_and_pre(frame, pageName, tname, paramName, paramAward)
 +
res = res .. '<br clear="all" />'
 +
return res
 
end
 
end
  
−
function p.makeDocPageBlurb(args, env)
+
function p.award_demo(frame)
−
--[=[
+
if not getArgs then
−
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".
+
getArgs = require('Module:Arguments').getArgs
−
-- @args - a table of arguments passed by the user
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
--
 
−
-- Messages:
 
−
-- 'edit-link-display' --> 'edit'
 
−
-- 'history-link-display' --> 'history'
 
−
-- 'transcluded-from-blurb' -->
 
−
-- 'The above [[Wikipedia:Template documentation|documentation]]
 
−
-- is [[Wikipedia:Transclusion|transcluded]] from $1.'
 
−
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
 
−
-- 'create-link-display' --> 'create'
 
−
-- 'create-module-doc-blurb' -->
 
−
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
 
−
--]=]
 
−
local docTitle = env.docTitle
 
−
if not docTitle then
 
−
return nil
 
 
end
 
end
−
local ret
+
local args = getArgs(frame)
−
if docTitle.exists then
+
local pageName = mw.title.getCurrentTitle().text
−
-- /doc exists; link to it.
+
local tname = args['шаблон'] or 'Военный деятель'
−
local docLink = makeWikilink(docTitle.prefixedText)
+
local paramAward = get_param_name(tname, 'награды')
−
local editUrl = docTitle:fullUrl{action = 'edit'}
+
local res = _award_base(frame, args, pageName, tname, paramAward)
−
local editDisplay = message('edit-link-display')
+
local paramName = get_param_name(tname, 'имя')
−
local editLink = makeUrlLink(editUrl, editDisplay)
+
local demo = args['демо'] or args['demo']
−
local historyUrl = docTitle:fullUrl{action = 'history'}
+
res = res .. render_example(frame, pageName, tname, paramName, paramAward, demo)
−
local historyDisplay = message('history-link-display')
+
res = res .. '<br clear="all" />'
−
local historyLink = makeUrlLink(historyUrl, historyDisplay)
+
return res
−
ret = message('transcluded-from-blurb', {docLink})
 
−
.. ' '
 
−
.. makeToolbar(editLink, historyLink)
 
−
.. '<br />'
 
−
elseif env.subjectSpace == 828 then
 
−
-- /doc does not exist; ask to create it.
 
−
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}
 
−
local createDisplay = message('create-link-display')
 
−
local createLink = makeUrlLink(createUrl, createDisplay)
 
−
ret = message('create-module-doc-blurb', {createLink})
 
−
.. '<br />'
 
−
end
 
−
return ret
 
 
end
 
end
−
 
+
function p.rank(frame)
−
function p.makeExperimentBlurb(args, env)
+
if not getArgs then
−
--[[
+
getArgs = require('Module:Arguments').getArgs
−
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."
 
−
-- @args - a table of arguments passed by the user
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
--
 
−
-- Messages:
 
−
-- 'sandbox-link-display' --> 'sandbox'
 
−
-- 'sandbox-edit-link-display' --> 'edit'
 
−
-- 'compare-link-display' --> 'diff'
 
−
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'
 
−
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
 
−
-- 'sandbox-create-link-display' --> 'create'
 
−
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'
 
−
-- 'mirror-link-display' --> 'mirror'
 
−
-- 'sandbox-link-display' --> 'sandbox'
 
−
-- 'testcases-link-display' --> 'testcases'
 
−
-- 'testcases-edit-link-display'--> 'edit'
 
−
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'
 
−
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
 
−
-- 'testcases-create-link-display' --> 'create'
 
−
-- 'testcases-link-display' --> 'testcases'
 
−
-- 'testcases-edit-link-display' --> 'edit'
 
−
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'
 
−
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'
 
−
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'
 
−
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'
 
−
--]]
 
−
local subjectSpace = env.subjectSpace
 
−
local templateTitle = env.templateTitle
 
−
local sandboxTitle = env.sandboxTitle
 
−
local testcasesTitle = env.testcasesTitle
 
−
local templatePage = templateTitle.prefixedText
 
−
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then
 
−
return nil
 
 
end
 
end
−
-- Make links.
+
local args = getArgs(frame)
−
local sandboxLinks, testcasesLinks
+
local pageName = mw.title.getCurrentTitle().text
−
if sandboxTitle.exists then
+
local rankNameDefault = mw.text.trim(mw.ustring.sub(pageName, (mw.ustring.find(pageName, ',', 1, true) or 0) +1))
−
local sandboxPage = sandboxTitle.prefixedText
+
local tname = args['шаблон'] or 'Военный деятель'
−
local sandboxDisplay = message('sandbox-link-display')
+
local res = textPrefix
−
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)
+
local special = yesno(args['специальное'])
−
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}
+
res = res .. ', носящих '
−
local sandboxEditDisplay = message('sandbox-edit-link-display')
+
if special then
−
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)
+
res = 'специальное '
−
local compareUrl = env.compareUrl
 
−
local compareLink
 
−
if compareUrl then
 
−
local compareDisplay = message('compare-link-display')
 
−
compareLink = makeUrlLink(compareUrl, compareDisplay)
 
−
end
 
−
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
 
−
else
 
−
local sandboxPreload
 
−
if subjectSpace == 828 then
 
−
sandboxPreload = message('module-sandbox-preload')
 
−
else
 
−
sandboxPreload = message('template-sandbox-preload')
 
−
end
 
−
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}
 
−
local sandboxCreateDisplay = message('sandbox-create-link-display')
 
−
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
 
−
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
 
−
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templatePage, summary = mirrorSummary}
 
−
local mirrorDisplay = message('mirror-link-display')
 
−
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
 
−
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
 
 
end
 
end
−
if testcasesTitle.exists then
+
local rankType = args['тип'] or 'звание'
−
local testcasesPage = testcasesTitle.prefixedText
+
res = res ..  rankType .. ' '
−
local testcasesDisplay = message('testcases-link-display')
+
local rankName = args[1] or args['звание'] or rankNameDefault
−
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
+
local quotes = args['кавычки']
−
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}
+
res = res .. quotate_default(rankName, quotes) .. '.'
−
local testcasesEditDisplay = message('testcases-edit-link-display')
+
local link = args[2] or args['ссылка'] or mw.ustring.lower(rankNameDefault)
−
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
+
res = res .. instead_of_link(link) .. ';'  
−
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
+
local paramRank = get_param_name(tname, 'звание')
−
else
+
res = res .. in_param(frame, tname, paramRank)
−
local testcasesPreload
+
 
−
if subjectSpace == 828 then
+
local categories = args['категория'] or args['категории']
−
testcasesPreload = message('module-testcases-preload')
+
if categories then
−
else
+
res = res .. format_categories(categories) .. '\n'
−
testcasesPreload = message('template-testcases-preload')
 
−
end
 
−
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}
 
−
local testcasesCreateDisplay = message('testcases-create-link-display')
 
−
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)
 
−
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)
 
−
end
 
−
local messageName
 
−
if subjectSpace == 828 then
 
−
messageName = 'experiment-blurb-module'
 
−
else
 
−
messageName = 'experiment-blurb-template'
 
 
end
 
end
−
return message(messageName, {sandboxLinks, testcasesLinks})
 
−
end
 
  
−
function p.makeCategoriesBlurb(args, env)
+
if get_param_num(args, _type) > 0 then
−
--[[
+
res = res .. types_table(frame, pageName, args)
−
-- Generates the text "Please add categories to the /doc subpage."
 
−
-- @args - a table of arguments passed by the user
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
-- Messages:
 
−
-- 'doc-link-display' --> '/doc'
 
−
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'
 
−
--]]
 
−
local docTitle = env.docTitle
 
−
if not docTitle then
 
−
return nil
 
 
end
 
end
−
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
 
−
return message('add-categories-blurb', {docPathLink})
 
−
end
 
  
−
function p.makeSubpagesBlurb(args, env)
+
res = res .. exampleTitle
−
--[[
+
local paramName = get_param_name(tname, 'имя')
−
-- Generates the "Subpages of this template" link.
+
res = res .. template_res_and_pre(frame, pageName, tname, paramName, paramRank)
−
-- @args - a table of arguments passed by the user
+
res = res .. '<br clear="all" />'
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
+
return res
−
 
−
-- Messages:
 
−
-- 'template-pagetype' --> 'template'
 
−
-- 'module-pagetype' --> 'module'
 
−
-- 'default-pagetype' --> 'page'
 
−
-- 'subpages-link-display' --> 'Subpages of this $1'
 
−
--]]
 
−
local subjectSpace = env.subjectSpace
 
−
local templateTitle = env.templateTitle
 
−
if not subjectSpace or not templateTitle then
 
−
return nil
 
−
end
 
−
local pagetype
 
−
if subjectSpace == 10 then
 
−
pagetype = message('template-pagetype')
 
−
elseif subjectSpace == 828 then
 
−
pagetype = message('module-pagetype')
 
−
else
 
−
pagetype = message('default-pagetype')
 
−
end
 
−
local subpagesLink = makeWikilink(
 
−
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',
 
−
message('subpages-link-display', {pagetype})
 
−
)
 
−
return message('subpages-blurb', {subpagesLink})
 
 
end
 
end
  
−
function p.makePrintBlurb(args, env)
+
local function templates_set()
−
--[=[
+
local set = {['военный деятель'] = true}
−
-- Generates the blurb displayed when there is a print version of the template available.
+
for p, tl in pairs(parameters) do
−
-- @args - a table of arguments passed by the user
+
for t, _ in pairs(tl) do
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
+
if t ~= 'default' then
−
--
+
set[t] = true
−
-- Messages:
+
end
−
-- 'print-link-display' --> '/Print'
 
−
-- 'print-blurb' --> 'A [[Help:Books/for experts#Improving the book layout|print version]]'
 
−
-- .. ' of this template exists at $1.'
 
−
-- .. ' If you make a change to this template, please update the print version as well.'
 
−
-- 'display-print-category' --> true
 
−
-- 'print-category' --> 'Templates with print versions'
 
−
--]=]
 
−
local printTitle = env.printTitle
 
−
if not printTitle then
 
−
return nil
 
−
end
 
−
local ret
 
−
if printTitle.exists then
 
−
local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display'))
 
−
ret = message('print-blurb', {printLink})
 
−
local displayPrintCategory = message('display-print-category', nil, 'boolean')
 
−
if displayPrintCategory then
 
−
ret = ret .. makeCategoryLink(message('print-category'))
 
 
end
 
end
 
end
 
end
−
return ret
+
return set
 
end
 
end
  
−
----------------------------------------------------------------------------
+
function p.supported_templates(frame)
−
-- Tracking categories
+
local res = ''
−
----------------------------------------------------------------------------
+
local set = templates_set()
−
 
+
for tl, _ in pairs(set) do
−
function p.addTrackingCategories(env)
+
res = res .. '* ' .. expand(frame, 'tl', {tl}) .. '\n'
−
--[[
 
−
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
 
−
-- Messages:
 
−
-- 'display-strange-usage-category' --> true
 
−
-- 'doc-subpage' --> 'doc'
 
−
-- 'testcases-subpage' --> 'testcases'
 
−
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'
 
−
--
 
−
-- /testcases pages in the module namespace are not categorised, as they may have
 
−
-- {{documentation}} transcluded automatically.
 
−
--]]
 
−
local title = env.title
 
−
local subjectSpace = env.subjectSpace
 
−
if not title or not subjectSpace then
 
−
return nil
 
 
end
 
end
−
local subpage = title.subpageText
+
return res
−
local ret = ''
 
−
if message('display-strange-usage-category', nil, 'boolean')
 
−
and (
 
−
subpage == message('doc-subpage')
 
−
or subjectSpace ~= 828 and subpage == message('testcases-subpage')
 
−
)
 
−
then
 
−
ret = ret .. makeCategoryLink(message('strange-usage-category'))
 
−
end
 
−
return ret
 
 
end
 
end
  
 
return p
 
return p

Версия от 23:00, 2 мая 2022

Для документации этого модуля может быть создана страница Модуль:Documentation/doc 

local p = {}

local yesno = require('Module:Yesno')

local medal = 'медаль'
local order = 'орден'
local insignia = 'знак отличия'
local badge = 'почётный знак'
local badge2 = 'почетный знак'
local title = 'звание' --почётное
local rank = 'звание' --воинское
local prize = 'премия'
local commemorative = 'памятный знак'
local awardTypes = {medal, order, insignia, badge, badge2, title, prize, commemorative}
local exampleTitle = '== Пример использования ==\n'
local namePlaceholder = 'Имя и фамилия'
local textPrefix = 'Шаблон предназначен для обозначения людей'
local orDivisons = ' или подразделений'
local typesTitle = '== Таблица вариантов  ==\n'
local _type = 'тип'
local note = 'примечание'

local function expand(frame, tname, targs)
	return frame:expandTemplate({title = tname, args = targs})
end

local parameters = {
	['имя'] = {['ученый'] = 'Имя', ['учёный'] = 'Имя', ['политик'] = 'Имя', ['театральный деятель'] = 'Имя', default = 'имя'},
	['награды'] = {['ученый'] = 'Награды и премии', ['учёный'] = 'Награды и премии', ['персона'] = 'награды и премии', ['спортсмен'] = 'медали', ['политик'] = 'Награды', ['театральный деятель'] = 'Награды', default = 'награды' },
	['звание'] = {default = 'звание'}
}

local function get_param_name(tname, pname) 
	if not parameters[pname] then
		return pname
	end
	return parameters[pname][mw.ustring.lower(tname)] or parameters[pname].default or pname
end

local function instead_of_link(link) 
	return ' Размещается вместо ссылки [[' .. link .. ']]'
end

local function in_param(frame, tname, pname) 
	return ' в частности, в графе ' .. expand(frame, 'para', {[1]=pname}) .. ' шаблона ' .. expand(frame, 'tl', {[1]=tname}) .. '.\n\n'
end

function repeat_whitespace(n)
	local r = '' 
	for i = 1, n do
		 r = r .. ' '
	end
	return r
end

local function render_example(frame, pageName, tname, paramName, paramTarget, example)
	local templateResult = expand(frame, tname, {[paramTarget] = example, [paramName] = namePlaceholder})
	local nameLen = mw.ustring.len(paramName)
	local targetLen = mw.ustring.len(paramTarget)
	local maxLen = math.max(nameLen, targetLen)
	local pre = '<pre>\n{{' .. tname .. '\n|' .. paramName .. repeat_whitespace(3 + maxLen - nameLen) .. '= ' .. namePlaceholder .. '\n|'  .. paramTarget .. repeat_whitespace(3 + maxLen - targetLen) ..  '= {{' .. pageName .. '}}\n}}</pre>'
	return templateResult .. '\n\n' .. pre
end

local function template_res_and_pre(frame, pageName, tname, paramName, paramTarget) 
	return render_example(frame, pageName, tname, paramName, paramTarget, expand(frame, pageName))
end

local function cat_link(cat) 
	return '[[:К:' .. cat .. '|' .. cat .. ']]'
end

local function format_categories(categories)
	local cats = {}
	for s in mw.ustring.gmatch(categories, '[^/]+') do
		table.insert(cats, cat_link(s))
	end
	if #cats == 0 then
		return ''
	end
	local ret = 'Шаблон автоматически добавляет статью в категори'
	if #cats > 1 then
		ret = ret ..'и'
	else
		ret = ret .. 'ю'
	end
	ret = ret .. ' ' .. mw.text.listToText(cats) .. '.'
	return ret
end

local function starts_with(st, prefix)
	return mw.ustring.sub(st, 1, mw.ustring.len(prefix)) == prefix
end
local function quotate_default(st, quotes)
	if (quotes == nil or yesno(quotes)) and not starts_with(st, '«') then
		return '«' .. st .. '»'
	end
	return st
end

local function get_param_num(args, prefix)
	local num = 0
	while args[prefix .. tostring(num+1)] ~= nil do
		num = num + 1
	end
	return num
end

local function types_table(frame, pageName, args)
	local t = mw.html.create('table'):addClass('wide center')
	local headers = t:tag('tr')
	headers:tag('th'):wikitext('Код шаблона<br />(для копирования)')
	headers:tag('th'):wikitext('Шаблоном отображается')
	headers:tag('th'):wikitext('Примечание к отображаемому шаблоном')
	local varCount = get_param_num(args, _type)
	local defaultStr = t:tag('tr')
	defaultStr:tag('td'):addClass('nowrap'):wikitext('{{' .. pageName .. '}}')
	defaultStr:tag('td'):wikitext(expand(frame, pageName, {}))
	defaultStr:tag('td'):wikitext(args[note .. '0'])
	for i = 1, varCount do 
		local varStr = t:tag('tr')
		local istr = tostring(i)
		local var = args[_type .. istr]
		varStr:tag('td'):addClass('nowrap'):wikitext('{{' .. pageName .. '|тип=' .. var .. '}}')
		varStr:tag('td'):wikitext(expand(frame, pageName, {[_type]=var}))
		varStr:tag('td'):wikitext(args[note .. istr])
	end
	return typesTitle .. tostring(t) .. '\n'
end

local function guess_type(pageName)
	for _, awardType in ipairs(awardTypes) do
		if starts_with(mw.ustring.lower(pageName), awardType) then
			return awardType
		end
	end
	return nil
end

local function trim_parentheses(str)
	for s in mw.ustring.gmatch(str, '[^%(]+') do
		return s:match('^%s*(.-)%s*$')
	end
	return str
end

local function trim_type_and_parentheses(pageName)
	local autoType = guess_type(pageName) 
	if autoType ~= nil then 
		local typeLen = mw.ustring.len(autoType)
		pageName = mw.ustring.sub(pageName, typeLen + 2, mw.ustring.len(pageName))
	end
	return trim_parentheses(pageName)
end

local function get_award_type_text(awardType)
	if awardType == order then
		return ', награждённых орденом'
	elseif awardType == medal then
		return ', награждённых медалью'
	elseif awardType == insignia then
		return ', награждённых знаком отличия'
	elseif awardType == badge or awardType == badge2 then
		return ', награждённых почётным знаком'
	elseif awardType == title then
		return ', удостоенных звания'
	elseif awardType == prize then
		return ' — лауреатов премии'
	elseif awardType == commemorative then
		return ', награждённых памятным знаком'
	end
	return ''
end

function p.print_types_table(frame)
	local mt = mw.html.create('table'):addClass('wikitable')
	local headers = mt:tag('tr'):css('text-align', 'center')
	headers:tag('th'):wikitext('Значение параметра')
	headers:tag('th'):wikitext('Отображаемый текст')
	for _, awardType in ipairs(awardTypes) do
		local row = mt:tag('tr')
		row:tag('td'):wikitext(expand(frame, 'para', {'тип', awardType}))
		row:tag('td'):wikitext('…' .. get_award_type_text(awardType))
	end
	return tostring(mt)
end

local function _award_base(frame, args, pageName, tname, paramAward)
	local res = textPrefix
	if yesno(args['подразделения']) then
		res = res .. orDivisons
	end
	local awardType = args['тип'] or guess_type(pageName) or medal
	res = res .. get_award_type_text(awardType)
	if not yesno(args['без названия']) then
		local quotes = args['кавычки']
		local titleString = args[1] or args['название'] or trim_type_and_parentheses(pageName)
		res = res .. ' ' .. quotate_default(titleString, quotes)
	end
	res = res .. '.'
	local link = args[2] or args['ссылка'] or pageName
	res = res .. instead_of_link(link) .. ';'
	local paramAward = get_param_name(tname, 'награды')
	res = res .. in_param(frame, tname, paramAward)

	local categories = args['категория'] or args['категории']
	if categories then
		res = res .. format_categories(categories) .. '\n'
	end

	local filename = args['файл']
	if filename then
		res = res .. '\nВ качестве изображения используется файл [[:Файл:' .. filename .. '|' .. filename .. ']] [[Файл:' .. filename .. '|x17px|link=|alt=]]\n'
	end

	if get_param_num(args, _type) > 0 then
		res = res .. types_table(frame, pageName, args)
	end

	res = res .. exampleTitle
	return res
end

function p.award(frame)
	if not getArgs then
		getArgs = require('Module:Arguments').getArgs
	end
	local args = getArgs(frame)
	local pageName = mw.title.getCurrentTitle().text
	local tname = args['шаблон'] or 'Военный деятель'
	local paramAward = get_param_name(tname, 'награды')
	local res = _award_base(frame, args, pageName, tname, paramAward)
	local paramName = get_param_name(tname, 'имя')
	res = res .. template_res_and_pre(frame, pageName, tname, paramName, paramAward)
	res = res .. '<br clear="all" />'
	return res
end

function p.award_demo(frame)
	if not getArgs then
		getArgs = require('Module:Arguments').getArgs
	end
	local args = getArgs(frame)
	local pageName = mw.title.getCurrentTitle().text
	local tname = args['шаблон'] or 'Военный деятель'
	local paramAward = get_param_name(tname, 'награды')
	local res = _award_base(frame, args, pageName, tname, paramAward)
	local paramName = get_param_name(tname, 'имя')
	local demo = args['демо'] or args['demo']
	res = res .. render_example(frame, pageName, tname, paramName, paramAward, demo)
	res = res .. '<br clear="all" />'
	return res
end
function p.rank(frame)
	if not getArgs then
		getArgs = require('Module:Arguments').getArgs
	end
	local args = getArgs(frame)
	local pageName = mw.title.getCurrentTitle().text
	local rankNameDefault = mw.text.trim(mw.ustring.sub(pageName, (mw.ustring.find(pageName, ',', 1, true) or 0) +1))
	local tname = args['шаблон'] or 'Военный деятель'
	local res = textPrefix
	local special = yesno(args['специальное'])
	res = res .. ', носящих '
	if special then 
		res = 'специальное '
	end
	local rankType = args['тип'] or 'звание'
	res = res ..  rankType .. ' '
	local rankName = args[1] or args['звание'] or rankNameDefault
	local quotes = args['кавычки']
	res = res .. quotate_default(rankName, quotes) .. '.'
	local link = args[2] or args['ссылка'] or mw.ustring.lower(rankNameDefault)
	res = res .. instead_of_link(link) .. ';' 
	local paramRank = get_param_name(tname, 'звание')
	res = res .. in_param(frame, tname, paramRank)

	local categories = args['категория'] or args['категории']
	if categories then
		res = res .. format_categories(categories) .. '\n'
	end

	if get_param_num(args, _type) > 0 then
		res = res .. types_table(frame, pageName, args)
	end

	res = res .. exampleTitle
	local paramName = get_param_name(tname, 'имя')
	res = res .. template_res_and_pre(frame, pageName, tname, paramName, paramRank)
	res = res .. '<br clear="all" />'
	return res
end

local function templates_set()
	local set = {['военный деятель'] = true}
	for p, tl in pairs(parameters) do
		for t, _ in pairs(tl) do
			if t ~= 'default' then
				set[t] = true
			end
		end
	end
	return set
end

function p.supported_templates(frame)
	local res = ''
	local set = templates_set()
	for tl, _ in pairs(set) do
		res = res .. '* ' .. expand(frame, 'tl', {tl}) .. '\n'
	end
	return res
end

return p
Источник — https://in.wiki/w/index.php?title=Модуль:Documentation&oldid=9160