Module:Navbar: Difference between revisions

Jump to navigation Jump to search
imported>Dragons flight
m (Protected Module:Navbar: Highly visible template: Used on a significant number of pages, but also still in testing. ([Edit=Allow only autoconfirmed users] (indefinite) [Move=Allow only autoconfirmed users] (indefinite)))
m (Protected "Module:Navbar": Important page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
 
(32 intermediate revisions by 17 users not shown)
Line 1: Line 1:
local p = {}
local p = {}
local cfg = mw.loadData('Module:Navbar/configuration')


local HtmlBuilder = require('Module:HtmlBuilder')
local function get_title_arg(is_collapsible, template)
local title_arg = 1
if is_collapsible then title_arg = 2 end
if template then title_arg = 'template' end
return title_arg
end
 
local function choose_links(template, args)
-- The show table indicates the default displayed items.
-- view, talk, edit, hist, move, watch
-- TODO: Move to configuration.
local show = {true, true, true, false, false, false}
if template then
show[2] = false
show[3] = false
local index = {t = 2, d = 2, e = 3, h = 4, m = 5, w = 6,
talk = 2, edit = 3, hist = 4, move = 5, watch = 6}
-- TODO: Consider removing TableTools dependency.
for _, v in ipairs(require ('Module:TableTools').compressSparseArray(args)) do
local num = index[v]
if num then show[num] = true end
end
end
 
local remove_edit_link = args.noedit
if remove_edit_link then show[3] = false end
return show
end


function trim(s)
local function add_link(link_description, ul, is_mini, font_style)
    return mw.ustring.match( s, "^%s*(.-)%s*$" )
local l
if link_description.url then
l = {'[', '', ']'}
else
l = {'[[', '|', ']]'}
end
ul:tag('li')
:addClass('nv-' .. link_description.full)
:wikitext(l[1] .. link_description.link .. l[2])
:tag(is_mini and 'abbr' or 'span')
:attr('title', link_description.html_title)
:cssText(font_style)
:wikitext(is_mini and link_description.mini or link_description.full)
:done()
:wikitext(l[3])
:done()
end
end


function _navbar( args )
local function make_list(title_text, has_brackets, displayed_links, is_mini, font_style)
    if not args[1] then
        local span = HtmlBuilder.create('span')
local title = mw.title.new(mw.text.trim(title_text), cfg.title_namespace)
if not title then
        span
error(cfg.invalid_title .. title_text)
            .addClass('error')
end
            .css('float', 'left')
local talkpage = title.talkPageTitle and title.talkPageTitle.fullText or ''
            .css('white-space', 'nowrap')
            .wikitext('Error: No name provided')
-- TODO: Get link_descriptions and show into the configuration module.
-- link_descriptions should be easier...
        return span
local link_descriptions = {
    end
{ ['mini'] = 'v', ['full'] = 'view', ['html_title'] = 'View this template',
['link'] = title.fullText, ['url'] = false },
    local title;
{ ['mini'] = 't', ['full'] = 'talk', ['html_title'] = 'Discuss this template',
    local pageName = trim(args[1])
['link'] = talkpage, ['url'] = false },
    if mw.ustring.sub(pageName, 1, 1) == ':' then
{ ['mini'] = 'e', ['full'] = 'edit', ['html_title'] = 'Edit this template',
        title = mw.title.new( mw.ustring.sub(pageName, 2) );
['link'] = title:fullUrl('action=edit'), ['url'] = true },
    else
{ ['mini'] = 'h', ['full'] = 'hist', ['html_title'] = 'History of this template',
        title = mw.title.new( pageName, 'Template' );
['link'] = title:fullUrl('action=history'), ['url'] = true },
    end     
{ ['mini'] = 'm', ['full'] = 'move', ['html_title'] = 'Move this template',
['link'] = mw.title.new('Special:Movepage'):fullUrl('target='..title.fullText), ['url'] = true },
    local mainpage = title.fullText;
{ ['mini'] = 'w', ['full'] = 'watch', ['html_title'] = 'Watch this template',
    local talkpage = title.talkPageTitle and title.talkPageTitle.fullText or ''
['link'] = title:fullUrl('action=watch'), ['url'] = true }
    local editurl = title:fullUrl( 'action=edit' );
}
 
    local viewLink, talkLink, editLink = 'view', 'talk', 'edit'
local ul = mw.html.create('ul')
    if args.mini then
if has_brackets then
        viewLink, talkLink, editLink = 'v', 't', 'e'
ul:addClass(cfg.classes.brackets)
    end
:cssText(font_style)
end
    local div = HtmlBuilder.create( 'div' )
    div
for i, _ in ipairs(displayed_links) do
        .addClass( 'noprint' )
if displayed_links[i] then add_link(link_descriptions[i], ul, is_mini, font_style) end
        .addClass( 'plainlinks' )
end
        .addClass( 'hlist' )
return ul:done()
        .addClass( 'navbar')
        .cssText( args.style )
end
 
    if args.mini then div.addClass('mini') end
function p._navbar(args)
    if not (args.mini or args.plain) then
-- TODO: We probably don't need both fontstyle and fontcolor...
        div
local font_style = args.fontstyle
            .tag( 'span' )
local font_color = args.fontcolor
                .css( 'word-spacing', 0 )
local is_collapsible = args.collapsible
                .cssText( args.fontstyle )
local is_mini = args.mini
                .wikitext( args.text or 'This box:' )
local is_plain = args.plain
                .wikitext( ' ' )
    end
local collapsible_class = nil
if is_collapsible then
    if args.brackets then
collapsible_class = cfg.classes.collapsible
        div
if not is_plain then is_mini = 1 end
            .tag('span')
if font_color then
                .css('margin-right', '-0.125em')
font_style = (font_style or '') .. '; color: ' .. font_color .. ';'
                .cssText( args.fontstyle )
end
                .wikitext( '[' )
end
                .newline();
    end
local navbar_style = args.style
local div = mw.html.create():tag('div')
    local ul = div.tag('ul');
div
:addClass(cfg.classes.navbar)
    ul
:addClass(cfg.classes.plainlinks)
        .tag( 'li' )
:addClass(cfg.classes.horizontal_list)
            .addClass( 'nv-view' )
:addClass(collapsible_class) -- we made the determination earlier
            .wikitext( '[[' .. mainpage .. '|' )
:cssText(navbar_style)
            .tag( 'span ' )
 
                .attr( 'title', 'View this template' )
if is_mini then div:addClass(cfg.classes.mini) end
                .cssText( args.fontstyle or '' )
 
                .wikitext( viewLink )
local box_text = (args.text or cfg.box_text) .. ' '
                .done()
-- the concatenated space guarantees the box text is separated
            .wikitext( ']]' )
if not (is_mini or is_plain) then
            .done()
div
        .tag( 'li' )
:tag('span')
            .addClass( 'nv-talk' )
:addClass(cfg.classes.box_text)
            .wikitext( '[[' .. talkpage .. '|' )
:cssText(font_style)
            .tag( 'span ' )
:wikitext(box_text)
                .attr( 'title', 'Discuss this template' )
end
                .cssText( args.fontstyle or '' )
                .wikitext( talkLink )
local template = args.template
                .done()
local displayed_links = choose_links(template, args)
            .wikitext( ']]' );
local has_brackets = args.brackets
local title_arg = get_title_arg(is_collapsible, template)
    if not args.noedit then  
local title_text = args[title_arg] or (':' .. mw.getCurrentFrame():getParent():getTitle())
        ul
local list = make_list(title_text, has_brackets, displayed_links, is_mini, font_style)
            .tag( 'li' )
div:node(list)
                .addClass( 'nv-edit' )
 
                .wikitext( '[' .. editurl .. ' ' )
if is_collapsible then
                .tag( 'span ' )
local title_text_class
                    .attr( 'title', 'Edit this template' )
if is_mini then
                    .cssText( args.fontstyle or '' )
title_text_class = cfg.classes.collapsible_title_mini
                    .wikitext( editLink )
else
                    .done()
title_text_class = cfg.classes.collapsible_title_full
                .wikitext( ']' );
end
    end
div:done()
:tag('div')
    if args.brackets then
:addClass(title_text_class)
        div
:cssText(font_style)
            .tag('span')
:wikitext(args[1])
                .css('margin-left', '-0.125em')
end
                .cssText( args.fontstyle or '' )
                .wikitext( ']' )
local frame = mw.getCurrentFrame()
                .newline();
-- hlist -> navbar is best-effort to preserve old Common.css ordering.
    end
return frame:extensionTag{
name = 'templatestyles', args = { src = cfg.hlist_templatestyles }
    return tostring(div)
} .. frame:extensionTag{
name = 'templatestyles', args = { src = cfg.templatestyles }
} .. tostring(div:done())
end
end


function p.navbar(frame)
function p.navbar(frame)
    local origArgs
return p._navbar(require('Module:Arguments').getArgs(frame))
    -- If called via #invoke, use the args passed into the invoking template.
    -- Otherwise, for testing purposes, assume args are being passed directly in.
    if frame == mw.getCurrentFrame() then
        origArgs = frame:getParent().args
    else
        origArgs = frame
    end
    -- ParserFunctions considers the empty string to be false, so to preserve the previous
    -- behavior of {{navbar}}, change any empty arguments to nil, so Lua will consider
    -- them false too.
    args = {}
    for k, v in pairs(origArgs) do
        if v ~= '' then
            args[k] = v
        end
    end
    return _navbar(args)
end
end
 
return p
return p

Latest revision as of 03:34, 15 September 2023

Documentation for this module may be created at Module:Navbar/doc

local p = {}
local cfg = mw.loadData('Module:Navbar/configuration')

local function get_title_arg(is_collapsible, template)
	local title_arg = 1
	if is_collapsible then title_arg = 2 end
	if template then title_arg = 'template' end
	return title_arg
end

local function choose_links(template, args)
	-- The show table indicates the default displayed items.
	-- view, talk, edit, hist, move, watch
	-- TODO: Move to configuration.
	local show = {true, true, true, false, false, false}
	if template then
		show[2] = false
		show[3] = false
		local index = {t = 2, d = 2, e = 3, h = 4, m = 5, w = 6,
			talk = 2, edit = 3, hist = 4, move = 5, watch = 6}
		-- TODO: Consider removing TableTools dependency.
		for _, v in ipairs(require ('Module:TableTools').compressSparseArray(args)) do
			local num = index[v]
			if num then show[num] = true end
		end
	end

	local remove_edit_link = args.noedit
	if remove_edit_link then show[3] = false end
	
	return show
	
end

local function add_link(link_description, ul, is_mini, font_style)
	local l
	if link_description.url then
		l = {'[', '', ']'}
	else
		l = {'[[', '|', ']]'}
	end
	ul:tag('li')
		:addClass('nv-' .. link_description.full)
		:wikitext(l[1] .. link_description.link .. l[2])
		:tag(is_mini and 'abbr' or 'span')
			:attr('title', link_description.html_title)
			:cssText(font_style)
			:wikitext(is_mini and link_description.mini or link_description.full)
			:done()
		:wikitext(l[3])
		:done()
end

local function make_list(title_text, has_brackets, displayed_links, is_mini, font_style)
	
	local title = mw.title.new(mw.text.trim(title_text), cfg.title_namespace)
	if not title then
		error(cfg.invalid_title .. title_text)
	end
	local talkpage = title.talkPageTitle and title.talkPageTitle.fullText or ''
	
	-- TODO: Get link_descriptions and show into the configuration module.
	-- link_descriptions should be easier...
	local link_descriptions = {
		{ ['mini'] = 'v', ['full'] = 'view', ['html_title'] = 'View this template',
			['link'] = title.fullText, ['url'] = false },
		{ ['mini'] = 't', ['full'] = 'talk', ['html_title'] = 'Discuss this template',
			['link'] = talkpage, ['url'] = false },
		{ ['mini'] = 'e', ['full'] = 'edit', ['html_title'] = 'Edit this template',
			['link'] = title:fullUrl('action=edit'), ['url'] = true },
		{ ['mini'] = 'h', ['full'] = 'hist', ['html_title'] = 'History of this template',
			['link'] = title:fullUrl('action=history'), ['url'] = true },
		{ ['mini'] = 'm', ['full'] = 'move', ['html_title'] = 'Move this template',
			['link'] = mw.title.new('Special:Movepage'):fullUrl('target='..title.fullText), ['url'] = true },
		{ ['mini'] = 'w', ['full'] = 'watch', ['html_title'] = 'Watch this template', 
			['link'] = title:fullUrl('action=watch'), ['url'] = true }
	}

	local ul = mw.html.create('ul')
	if has_brackets then
		ul:addClass(cfg.classes.brackets)
			:cssText(font_style)
	end
	
	for i, _ in ipairs(displayed_links) do
		if displayed_links[i] then add_link(link_descriptions[i], ul, is_mini, font_style) end
	end
	return ul:done()
	
end

function p._navbar(args)
	
	-- TODO: We probably don't need both fontstyle and fontcolor...
	local font_style = args.fontstyle
	local font_color = args.fontcolor
	local is_collapsible = args.collapsible
	local is_mini = args.mini
	local is_plain = args.plain
	
	local collapsible_class = nil
	if is_collapsible then
		collapsible_class = cfg.classes.collapsible
		if not is_plain then is_mini = 1 end
		if font_color then
			font_style = (font_style or '') .. '; color: ' .. font_color .. ';'
		end
	end
	
	local navbar_style = args.style
	local div = mw.html.create():tag('div')
	div
		:addClass(cfg.classes.navbar)
		:addClass(cfg.classes.plainlinks)
		:addClass(cfg.classes.horizontal_list)
		:addClass(collapsible_class) -- we made the determination earlier
		:cssText(navbar_style)

	if is_mini then div:addClass(cfg.classes.mini) end

	local box_text = (args.text or cfg.box_text) .. ' '
	 -- the concatenated space guarantees the box text is separated
	if not (is_mini or is_plain) then
		div
			:tag('span')
				:addClass(cfg.classes.box_text)
				:cssText(font_style)
				:wikitext(box_text)
	end
	
	local template = args.template
	local displayed_links = choose_links(template, args)
	local has_brackets = args.brackets
	local title_arg = get_title_arg(is_collapsible, template)
	local title_text = args[title_arg] or (':' .. mw.getCurrentFrame():getParent():getTitle())
	local list = make_list(title_text, has_brackets, displayed_links, is_mini, font_style)
	div:node(list)

	if is_collapsible then
		local title_text_class
		if is_mini then
			title_text_class = cfg.classes.collapsible_title_mini
		else
			title_text_class = cfg.classes.collapsible_title_full
		end
		div:done()
			:tag('div')
			:addClass(title_text_class)
			:cssText(font_style)
			:wikitext(args[1])
	end
	
	local frame = mw.getCurrentFrame()
	-- hlist -> navbar is best-effort to preserve old Common.css ordering.
	return frame:extensionTag{
		name = 'templatestyles', args = { src = cfg.hlist_templatestyles }
	} .. frame:extensionTag{
		name = 'templatestyles', args = { src = cfg.templatestyles }
	} .. tostring(div:done())
end

function p.navbar(frame)
	return p._navbar(require('Module:Arguments').getArgs(frame))
end

return p