Модул:Navbox
Jump to navigation
Jump to search
Ҳуҷҷатгузорӣ
![]() |
Ин модул ҳуҷҷатгузории кофӣ надорад.
Вы можете помочь проекту, создав описание модуля: что он делает, как его использовать, какие параметры он принимает, в какие категории добавляет. Это поможет другим использовать его. P.S. Также не забываем про категорию и интервики. P.P.S. Некоторые советы по оформлению есть на странице проекта «Документирование шаблонов». |
--
-- Реализует {{Ҷадвали новбарӣ}} ва {{Зергурӯҳи ҷадвали новбарӣ}}.
-- Основной объём кода заимствован из английского Module:Navbox.
--
local p = {}
local getArgs -- lazily initialized
local yesno -- lazily initialized
local args
local border
local listnums = {}
local ODD_EVEN_MARKER = '\127_ODDEVEN_\127'
local RESTART_MARKER = '\127_ODDEVEN0_\127'
local REGEX_MARKER = '\127_ODDEVEN(%d?)_\127'
local maintitle
local name
local navigation
local navbar
local above
local image
local below
local titlestyle
local groupstyle
local bodystyle
local basestyle
local liststyle
local evenodd_VARIABLE
local abovestyle
local belowstyle
local imageleft
local imageleftstyle
local style
local groupwidth
local listpadding
local bodyclass
local titleclass
local aboveclass
local belowclass
local groupclass
local listclass
local imageclass
local function striped(wikitext)
-- Return wikitext with markers replaced for odd/even striping.
-- Child (subgroup) navboxes are flagged with a category that is removed
-- by parent navboxes. The result is that the category shows all pages
-- where a child navbox is not contained in a parent navbox.
local orphanCat = '[[Гурӯҳ:Шаблонҳои новбарии беволидайн]]'
if border == 'subgroup' and args.orphan ~= 'yes' then
-- No change; striping occurs in outermost navbox.
return wikitext .. orphanCat
end
local first, second = 'odd', 'even'
if evenodd_VARIABLE then
if evenodd_VARIABLE == 'swap' then
first, second = second, first
else
first = evenodd_VARIABLE
second = first
end
end
local changer
if first == second then
changer = first
else
local index = 0
changer = function (code)
if code == '0' then
-- Current occurrence is for a group before a nested table.
-- Set it to first as a valid although pointless class.
-- The next occurrence will be the first row after a title
-- in a subgroup and will also be first.
index = 0
return first
end
index = index + 1
return index % 2 == 1 and first or second
end
end
local regex = orphanCat:gsub('([%[%]])', '%%%1')
return (wikitext:gsub(regex, ''):gsub(REGEX_MARKER, changer)) -- () omits gsub count
end
local function addNewline(s)
if s:match('^[*:;#]') or s:match('^{|') then
return '\n' .. s ..'\n'
else
return s
end
end
local function renderNavBar(titleCell)
if navbar ~= 'off' and navbar ~= 'plain' and not (not name and mw.getCurrentFrame():getParent():getTitle():gsub('/регдон$', '') == 'Шаблон:Ҷадвали новбарӣ') then
-- Check color contrast of the gear icon
local styleratio = require('Module:Color contrast')._styleratio
local gearColor = ''
local contrastStyle = titlestyle or basestyle
local gearStyleBlack = (contrastStyle and mw.text.unstripNoWiki(contrastStyle) .. '; color:#666;' or '')
local gearStyleWhite = (contrastStyle and mw.text.unstripNoWiki(contrastStyle) .. '; color:#fff;' or '')
if styleratio{gearStyleBlack} < styleratio{gearStyleWhite} then
gearColor = ' white'
end
--- Gear creation
titleCell
:tag('span')
:addClass('navbox-gear')
:css('float', 'left')
:css('text-align', 'left')
:css('width', '5em')
:css('margin-right', '0.5em')
:wikitext('[[File:Wikipedia interwiki section gear icon' .. gearColor .. '.svg|14px|Дидани шаблон|link=Шаблон:' .. name .. '|alt=⛭]]')
end
end
--
-- Title row
--
local function renderTitleRow(tbl)
if not maintitle then return end
local titleRow = tbl:tag('tr')
if args.titlegroup then
titleRow
:tag('th')
:attr('scope', 'row')
:addClass('navbox-group')
:addClass(args.titlegroupclass)
:cssText(basestyle)
:cssText(groupstyle)
:cssText(args.titlegroupstyle)
:wikitext(args.titlegroup)
end
local titleCell = titleRow:tag('th'):attr('scope', 'col')
if args.titlegroup then
titleCell
:css('border-left', '2px solid #fdfdfd')
:css('width', '100%')
end
local titleColspan = 2
if imageleft then titleColspan = titleColspan + 1 end
if image then titleColspan = titleColspan + 1 end
if args.titlegroup then titleColspan = titleColspan - 1 end
titleCell
:cssText(basestyle)
:cssText(titlestyle)
:addClass('navbox-title')
:attr('colspan', titleColspan)
renderNavBar(titleCell)
titleCell
:tag('div')
:attr('id', mw.uri.anchorEncode(maintitle))
:addClass(titleclass)
:css('font-size', '114%')
:css('margin', '0 5em')
:wikitext(addNewline(maintitle))
end
--
-- Above/Below rows
--
local function getAboveBelowColspan()
local ret = 2
if imageleft then ret = ret + 1 end
if image then ret = ret + 1 end
return ret
end
local function renderAboveRow(tbl)
if not above then return end
tbl:tag('tr')
:tag('td')
:addClass('navbox-abovebelow')
:addClass(aboveclass)
:cssText(basestyle)
:cssText(abovestyle)
:attr('colspan', getAboveBelowColspan())
:tag('div')
:wikitext(addNewline(above))
end
local function renderBelowRow(tbl)
if not below then return end
tbl:tag('tr')
:tag('td')
:addClass('navbox-abovebelow')
:addClass(belowclass)
:cssText(basestyle)
:cssText(belowstyle)
:attr('colspan', getAboveBelowColspan())
:tag('div')
:wikitext(addNewline(below))
end
--
-- List rows
--
local function haveSubgroups()
for i = 1, 23 do
if (args['group' .. i] or args['сарлавҳа' .. i] or args['гурӯҳ' .. i]) and (args['list' .. i] or args['феҳрист' .. i]) then
return true
end
end
return false
end
local function renderListRow(tbl, index, listnum)
local row = tbl:tag('tr')
if index == 1 and imageleft then
row
:tag('td')
:addClass('navbox-image')
:addClass(imageclass)
:css('width', '1px')
:css('padding', '0px 7px 0px 0px')
:cssText(imageleftstyle)
:attr('rowspan', #listnums)
:tag('div')
:wikitext(addNewline(imageleft))
end
if (args['group' .. listnum] or args['сарлавҳа' .. listnum] or args['гурӯҳ' .. listnum]) then
local groupCell = row:tag('th')
groupCell
:attr('scope', 'row')
:addClass('navbox-group')
:addClass(groupclass)
:cssText(basestyle)
:css('width', groupwidth or '1px') -- If groupwidth not specified, minimize width
groupCell
:cssText(groupstyle)
:cssText(args['group' .. listnum .. 'style'] or args['сабки_гурӯҳҳо' .. listnum] or args['сабки_сарлавҳа' .. listnum])
:wikitext(args['group' .. listnum] or args['сарлавҳа' .. listnum] or args['гурӯҳ' .. listnum])
end
local listCell = row:tag('td')
if (args['group' .. listnum] or args['сарлавҳа' .. listnum] or args['гурӯҳ' .. listnum]) then
listCell
:css('text-align', 'left')
:css('border-left-width', '2px')
:css('border-left-style', 'solid')
else
if haveSubgroups() then
listCell
:attr('colspan', 2)
end
end
if not groupwidth then
listCell:css('width', '100%')
end
local listText = args['list' .. listnum] or args['феҳрист' .. listnum]
local oddEven = ODD_EVEN_MARKER
if listText:sub(1, 12) == '</div><table' then
-- Assume list text is for a subgroup navbox so no automatic striping for this row.
oddEven = listText:find('<th[^>]*"navbox%-title"') and RESTART_MARKER or 'odd'
end
listCell
:css('padding', '0px')
:cssText(liststyle)
:cssText(args['list' .. listnum .. 'style'] or args['сабки_феҳристҳо' .. listnum])
:addClass('navbox-list')
:addClass('navbox-' .. oddEven)
:addClass(listclass)
:tag('div')
:css('padding', args['list' .. listnum .. 'padding'] or listpadding or '0em 0.25em')
:wikitext(addNewline(listText))
if index == 1 and image then
row
:tag('td')
:addClass('navbox-image')
:addClass(imageclass)
:css('width', '1px')
:css('padding', '0px 0px 0px 7px')
:cssText(imagestyle)
:attr('rowspan', #listnums)
:tag('div')
:wikitext(addNewline(image))
end
end
--
-- Tracking categories
--
local function needsChangetoSubgroups()
for i = 1, 23 do
if (args['group' .. i] or args['сарлавҳа' .. i] or args['гурӯҳ' .. i]) and not (args['list' .. i] or args['феҳрист' .. i]) then
return true
end
end
return false
end
local function needsHorizontalLists()
if border == 'subgroup' or args.tracking == 'no' then
return false
end
local listClasses = {
['plainlist'] = true, ['hlist'] = true, ['hlist hnum'] = true,
['hlist hwrap'] = true, ['hlist vcard'] = true, ['vcard hlist'] = true,
['hlist vevent'] = true, ['hlist hlist-items-nowrap'] = true, ['hlist-items-nowrap'] = true,
}
return not (listClasses[listclass] or listClasses[bodyclass])
end
-- local function hasBackgroundColors()
-- return mw.ustring.match(titlestyle or '','background') or mw.ustring.match(groupstyle or '','background') or mw.ustring.match(basestyle or '','background')
-- end
local function isIllegible()
local styleratio = require('Module:Color contrast')._styleratio
for key, style in pairs(args) do
if tostring(key):match("style$") or tostring(key):match("^сабк") then
if styleratio{mw.text.unstripNoWiki(style)} < 4.5 then
return true
end
end
end
return false
end
local function getTrackingCategories()
local cats = {}
if needsChangetoSubgroups() then table.insert(cats, 'Шаблонҳои новбарӣ бо истифодаи хатои сарлавҳаҳо') end
if needsHorizontalLists() then table.insert(cats, 'Шаблонҳои новбарӣ бидуни феҳристи уфуқӣ') end
if isIllegible() then table.insert(cats, 'Шаблонҳои новбарии ба таври потенсиалӣ нохоно') end
return cats
end
local function renderTrackingCategories(builder)
local title = mw.title.getCurrentTitle()
if title.namespace ~= 10 then return end -- not in template space
local subpage = title.subpageText
if subpage == 'doc' or subpage == 'регдон' or subpage == 'санҷишҳо' then return end
for i, cat in ipairs(getTrackingCategories()) do
builder:wikitext('[[Гурӯҳ:' .. cat .. ']]')
end
end
--
-- Main navbox tables
--
local function renderMainTable()
local tbl = mw.html.create('table')
:addClass('nowraplinks')
:addClass(bodyclass)
if maintitle and (args.state ~= 'plain' and args.state ~= 'off') then
tbl
:addClass('collapsible')
:addClass(args.state or 'autocollapse')
end
tbl:css('border-spacing', 0)
if border == 'subgroup' or border == 'none' then
tbl
:addClass('navbox-subgroup')
:cssText(bodystyle)
:cssText(style)
else -- regular navbox - bodystyle and style will be applied to the wrapper table
tbl
:addClass('navbox-inner')
:css('background', 'transparent')
:css('color', 'inherit')
end
tbl:cssText(args.innerstyle)
renderTitleRow(tbl)
renderAboveRow(tbl)
for i, listnum in ipairs(listnums) do
renderListRow(tbl, i, listnum)
end
renderBelowRow(tbl)
return tbl
end
function p._navbox(navboxArgs)
args = navboxArgs
if not yesno then
yesno = require('Module:Yesno');
end
for k, v in pairs(args) do
local listnum = ('' .. k):match('^list(%d+)$') or ('' .. k):match('^феҳрист(%d+)$')
if listnum then table.insert(listnums, tonumber(listnum)) end
end
table.sort(listnums)
border = mw.text.trim(args.border or args[1] or '')
if border == 'child' then
border = 'subgroup'
end
maintitle = args.title or args['сарлавҳа']
navbar = args.navbar or args['пайванди_дидабароӣ']
name = args.name or args['ном']
navigation = yesno(args.navigation or args['новбарӣ'], '')
above = args.above or args['болоӣ']
image = args.image or args['тасвир']
imagestyle = args.imagestyle or args['сабки_тасвир']
imageleft = args.imageleft or args['тасвир2'] or args['тасвир_аз_чап']
imageleftstyle = args.imageleftstyle or args.imagestyle2 or args['сабки_тасвир_аз_чап']
below = args.below or args['поёнӣ']
titlestyle = args.titlestyle or args['сабки_сарлавҳаи_асосӣ'] or args['сабки_сарлавҳа']
groupstyle = args.groupstyle or args['сабки_сарлавҳаҳо'] or args['сабки_гурӯҳ']
bodystyle = args.bodystyle or args['сабки_бадан']
basestyle = args.basestyle or args['сабки_базавӣ'] or args['сабк']
style = args.style
liststyle = args.liststyle or args['сабки_феҳристҳо']
abovestyle = args.abovestyle or args['сабки_болоӣ']
belowstyle = args.belowstyle or args['сабки_поёнӣ']
evenodd_VARIABLE = args.evenodd or args['ҷуфт_тоқ'] or args['ҷуфт_тоқ']
groupwidth = args.groupwidth or args['бари_гурӯҳ']
listpadding = args.listpadding or args['фосилаи_феҳристҳо']
bodyclass = args.bodyclass or args['синфи_бадан']
titleclass = args.titleclass or args['синфи_сарлавҳа']
aboveclass = args.aboveclass or args['синфи_болоӣ']
belowclass = args.belowclass or args['синфи_поёнӣ']
groupclass = args.groupclass or args['синфи_групп']
listclass = args.listclass or args['синфи_феҳристҳо']
imageclass = args.imageclass or args['синфи_тасвир']
-- render the main body of the navbox
local tbl = renderMainTable()
-- render the appropriate wrapper around the navbox, depending on the border param
local res = mw.html.create()
if border == 'none' then
local nav = res:tag('div')
:attr('role', 'navigation')
:node(tbl)
if maintitle then
nav:attr('aria-labelledby', mw.uri.anchorEncode(maintitle))
else
nav:attr('aria-label', 'Шаблони новбарӣ')
end
if name and name ~= '-' then
nav:attr('data-name', name)
end
if navigation == true then
nav:attr('data-navboxnavigation', '1')
elseif navigation == false then
nav:attr('data-navboxnavigation', '0')
end
elseif border == 'subgroup' then
-- We assume that this navbox is being rendered in a list cell of a parent navbox, and is
-- therefore inside a div with padding:0em 0.25em. We start with a </div> to avoid the
-- padding being applied, and at the end add a <div> to balance out the parent's </div>
res
:wikitext('</div>') -- XXX: hack due to lack of unclosed support in mw.html.
:node(tbl)
:wikitext('<div>') -- XXX: hack due to lack of unclosed support in mw.html.
else
local nav = res:tag('div')
:attr('role', 'navigation')
:addClass('navbox')
:cssText(bodystyle)
:cssText(style)
:css('padding', '3px')
:node(tbl)
if maintitle then
nav:attr('aria-labelledby', mw.uri.anchorEncode(maintitle))
else
nav:attr('aria-label', 'Шаблони новбарӣ')
end
if name and name ~= '-' then
nav:attr('data-name', name)
end
if navigation == true then
nav:attr('data-navboxnavigation', '1')
elseif navigation == false then
nav:attr('data-navboxnavigation', '0')
end
end
renderTrackingCategories(res)
return striped(tostring(res))
end
function p.navbox(frame)
if not getArgs then
getArgs = require('Module:Arguments').getArgs
end
if not yesno then
yesno = require('Module:Yesno');
end
args = getArgs(frame, {wrappers = {'Шаблон:Ҷадвали новбарӣ', 'Шаблон:Зергурӯҳи ҷадвали новбарӣ'}})
if frame.args.border then
-- This allows Template:Navbox_subgroup to use {{#invoke:Navbox|navbox|border=...}}.
args.border = frame.args.border
end
-- Read the arguments in the order they'll be output in, to make references number in the right order.
local _
_ = maintitle
_ = above
for i = 1, 23 do
_ = args["group" .. tostring(i)] and args["сарлавҳа" .. tostring(i)] and args["гурӯҳ" .. tostring(i)]
_ = args["list" .. tostring(i)] and args["феҳрист" .. tostring(i)]
end
_ = below
return p._navbox(args)
end
return p