Module:Military navigation

Module documentationviewedithistorypurge

Navigation templates

The various navigation templates maintained by the Military history WikiProject are all intended to be implemented through a single base template, which combines the project's common template style with the standard navigation box format. This is needed primarily to allow multiple such templates to be stacked together—with each other, or with infobox templates—to present the appearance of a continuous block; it is also beneficial for providing a consistent appearance to the entire set of articles within our scope.

Any military-related navigational template should be created using the {{military navigation}} base template, as shown below:

{{Military navigation
| name = 
| raw_name =
| state = 
| style = 
| title = 
| image = 
| imageleft = 
| odd_color = 
| even_color = 
| above = 
| listclass = 

| group1 = 
| list1 = 

| group2 = 
| list2 = 

| group3 = 
| list3 = 
...
| group30 = 
| list30 = 

| below = 
}}

name

The actual page name (i.e. "XYZ" for Template:XYZ) of the newly-created template.

raw_name

Use instead of "name" to omit the  V · T · E  links from the title bar.

title

The displayed title of the navigation box.

listclass

Optional – but typically hlist, to format content as horizontal lists. In the case of hlists in above or below fields, set bodyclass=hlist, instead.

style

Optional – an alternative style for the template; this may be set to "wide" to produce a full-width box. The alternative style should be used sparingly; it is intended that the majority of navigational templates will use the default style (in the wild, "wide" has become quite common). The above example template formatted with style=wide is shown below:

state

Optional – may be set to "collapsed" to force the template to render in its closed state by default.

odd_color/even_color

Optional – the stripe colors for alternating listN items to use. These parameters should be used sparingly; in the absence of a good reason to do otherwise, templates should use the default stripe colors.

groupN/listN

The body of the navigation box, consisting of successive horizontal blocks of content (the listN fields) with optional labels (the corresponding groupN fields). Please see the documentation for {{navbox}} for more details on the different layouts possible.

above

Optional – the sub-header of the navigation box; please see the documentation for {{navbox}} for more details on the resulting layout when this is used.

below

Optional – the footer of the navigation box; please see the documentation for {{navbox}} for more details on the resulting layout when this is used.

image

Optional – an image to be displayed at the right of the box, given in the form [[File:Example.jpg|100px]]. This parameter should be used sparingly, and typically only in conjunction with the full-width template style.

imageleft

Optional – an image to be displayed at the left of the box, given in the form [[File:Example.jpg|100px]]. This parameter should be used sparingly, and typically only in conjunction with the full-width template style.

Common problems with navigation templates

There are several known issues with the current navigation template design that editors should be aware of:

Shifted header wrapping

A long header used in a narrow navigation template may wrap incorrectly, with the second line being indented further than necessary. A workaround is possible by adding a <br /> tag between the words where the wrapping is to occur. This should be done to separate link-text to the right of the 'pipe' (|), as follows: [[Article title|Article <br /> title]]. An alternative method is to use {{wrap}} for the link-text as follows: [[A very long article title|{{wrap|A very long article title}}]], which allows the browser to break as-needed.

Stretching or overflowed boxes

A very long header formatted as a single link may cause a template to stretch beyond its normal width, or the whole link to extend off too far to the right. A workaround is possible by breaking the header onto multiple lines, as shown above.

The above documentation is transcluded from Module:Military navigation/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.

local p = { }

local Navbox = require('Module:Navbox')
local inArray = require("Module:TableTools").inArray
local Styles = mw.loadData('Module:WPMILHIST Infobox style')
local cfg = mw.loadData('Module:Navbox/configuration')


local function isblank(s)
	return (not s) or s == ''
end
local function ifnotblank(s,pre,t)
	return (s and s ~= '') and (pre..s) or t
end

function p._main(args)
    local tcats = ''

	-- process bodystyle and titlestyle
	if args.style == 'wide' then
		args['titlestyle'] = Styles['nav_box_wide_header']
		args['bodystyle'] = Styles['nav_box_wide']
	else
		args['titlestyle'] = Styles['nav_box_header']
		if args.border == cfg.keyword.border_child or args.border == cfg.keyword.border_subgroup then
			args['bodystyle'] = Styles['nav_box_child']
			tcats = tcats .. '[[Category:Pages using military navigation subgroups without wide style]]'
		else
			args['bodystyle'] = Styles['nav_box']
		end
	end

	-- process groupstyle, abovestyle, belowstyle
	args['groupstyle'] = Styles['nav_box_label'] .. (args['groupstyle'] or '')
	args['abovestyle'] = Styles['nav_box_label'] .. (args['abovestyle'] or '')
	args['belowstyle'] = Styles['nav_box_label'] .. (args['belowstyle'] or '')
	-- process oddstyle, evenstyle
	args['oddstyle'] = ifnotblank(args['odd_color'],'background:',nil)
	args['evenstyle'] = ifnotblank(args['even_color'],'background:',nil)
	-- process name and rawname
	args['name'] = ifnotblank(args['name'],'',args['rawname'])
	if isblank(args['name']) then args['navbar'] = 'plain' end
	
	-- process subgroups
	for k, v in pairs(args) do
		local listnum = tostring(k):match(cfg.pattern.listnum)
		if listnum and inArray(cfg.keyword.subgroups, v) then
			local subArgs = {
				[cfg.arg.border] = cfg.keyword.border_subgroup,
				[cfg.arg.navbar] = cfg.keyword.navbar_plain,
				style            = args.style
			}
			local hasSubArgs = false
			for kk, vv in pairs(args) do
				kk = tostring(kk)
				for _, vvv in ipairs(cfg.arg.subgroups_and_num) do
					vvv = string.format(vvv, listnum) .. "_"
					if (#kk > #vvv) and (kk:sub(1, #vvv) == vvv) then
						subArgs[kk:sub(#vvv + 1)] = vv
						hasSubArgs = true
					end
				end
			end
			args[k] = hasSubArgs and p._main(subArgs) or v
		end
	end
	
	-- add allow wrap
	if args['title'] and args.style ~= 'wide' then
		if not mw.ustring.match(args['title'], '<span class="wrap">') then
			-- probably a more efficient way to match 15 or more characters
			local m = '[^%[%]<>|][^%[%]<>|][^%[%]<>|][^%[%]<>|][^%[%]<>|]'
			m = m .. m .. m
			args['title'] = mw.ustring.gsub(args['title'], 
				'%[%[(' .. m .. '[^%[%]<>|]*)%]%]', 
				'[[%1|<span class="wrap">%1</span>]]')
			args['title'] = mw.ustring.gsub(args['title'], 
				'%[%[([^%[%]<>|]*)|(' .. m .. '[^%[%]<>|]*)%]%]', 
				'[[%1|<span class="wrap">%2</span>]]')
		end
	end
	
	-- add navbox-vertical for non-wide format
	if args.style ~= 'wide' then
		args['bodyclass'] = 'navbox-vertical' .. (args['bodyclass'] and (' ' .. args['bodyclass']) or '')
	end

	--fallback to "battles" for "list1" for compatibility with [[Template:Campaignbox]]
	if isblank(args['list1']) and not isblank(args.battles) then
		args['list1'] = args.battles
	end
	
    return tcats .. Navbox._navbox(args)
end 

function p.main(frame)
    local args = { }
    local pargs = frame:getParent().args
	local fargs = frame.args

    for k, v in pairs(pargs) do
        if v and v ~= '' then
			args[k] = v
        end
    end
    for k, v in pairs(fargs) do
        if v and v ~= '' then
            args[k] = v
        end
    end
	return p._main(args)
end

return p