Difference between revisions of "Module:Portal bar"

From blackwiki
Jump to navigation Jump to search
test>Nemo bis
test>Jackmcbarn
(use mw.html and other fixes from sandbox)
Line 1: Line 1:
 
-- This module implements {{portal bar}}.
 
-- This module implements {{portal bar}}.
 +
 +
require('Module:No globals')
  
 
local p = {}
 
local p = {}
  
local htmlBuilder = require( 'Module:HtmlBuilder' )
 
 
local buildNavbox = require( 'Module:Navbox' )._navbox
 
local buildNavbox = require( 'Module:Navbox' )._navbox
 
local getImageName = require( 'Module:Portal' ).image
 
local getImageName = require( 'Module:Portal' ).image
Line 10: Line 11:
 
-- Builds the portal bar used by {{portal bar}}.
 
-- Builds the portal bar used by {{portal bar}}.
 
function p._main( portals, args )
 
function p._main( portals, args )
    if #portals < 1 then return '' end -- Don't display a blank navbox if no portals were specified.
+
if #portals < 1 then return '' end -- Don't display a blank navbox if no portals were specified.
    local list = htmlBuilder.create( 'ul' )
+
local list = mw.html.create( 'ul' )
    for i, portal in ipairs( portals ) do
+
for _, portal in ipairs( portals ) do
        list
+
list
            .tag( 'li' )
+
:tag( 'li' )
                .css( 'display', 'inline' )
+
:css( 'display', 'inline' )
                .css( 'white-space', 'nowrap' )
+
:css( 'white-space', 'nowrap' )
                .tag( 'span' )
+
:tag( 'span' )
                    .css( 'margin', 'auto 0.5em' )
+
:css( 'margin', 'auto 0.5em' )
                    .wikitext( mw.ustring.format( '[[File:%s|24x21px]]', getImageName{ portal } ) )
+
:wikitext( string.format( '[[File:%s|24x21px]]', getImageName{ portal } ) )
                    .done()
+
:done()
                .tag( 'span' )
+
:tag( 'span' )
                    .css( 'font-weight', 'bold' )
+
:css( 'font-weight', 'bold' )
                    .wikitext( mw.ustring.format( '[[Portal:%s|%s portal]]', portal, portal ) )
+
:wikitext( string.format( '[[Portal:%s|%s portal]]', portal, portal ) )
    end
+
end
    if yesno( args.border ) == false then -- Don't display a border if args.border is "no", "n", "false", 0 or false.
+
if yesno( args.border ) == false then -- Don't display a border if args.border is "no", "n", "false", 0 or false.
        local root = htmlBuilder.create( 'div' )
+
return tostring(
        root
+
mw.html.create( 'div' )
            .addClass( 'noprint' )
+
:addClass( 'noprint metadata' )
            .addClass( 'metadata' )
+
:css( 'width', '100%' )
            .css( 'width', '100%' )
+
:css( 'text-align', 'center' )
            .css( 'text-align', 'center' )
+
:css( 'padding', '1px' )
            .css( 'padding', '1px' )
+
:css( 'font-size', '88%' )
            .css( 'font-size', '88%' )
+
:node( list )
            .wikitext( tostring( list ) )
+
)
        return tostring( root )
+
else
    else
+
return buildNavbox{
        return buildNavbox{
+
navbar = 'off',
            name = 'Portal bar',
+
bodyclass = 'noprint',
            bodyclass = 'noprint',
+
list1 = tostring( list )
            list1 = tostring( list )
+
}
        }
+
end
    end
 
 
end
 
end
  
 
-- Processes external arguments and sends them to the other functions.
 
-- Processes external arguments and sends them to the other functions.
 
function p.main( frame )
 
function p.main( frame )
    -- If called via #invoke, use the args passed into the invoking
+
-- If called via #invoke, use the args passed into the invoking
    -- template, or the args passed to #invoke if any exist. Otherwise
+
-- template, or the args passed to #invoke if any exist. Otherwise
    -- assume args are being passed directly in from the debug console
+
-- assume args are being passed directly in from the debug console
    -- or from another Lua module.
+
-- or from another Lua module.
    local origArgs
+
local origArgs
    if frame == mw.getCurrentFrame() then
+
if type( frame.getParent ) == 'function' then
        origArgs = frame:getParent().args
+
origArgs = frame:getParent().args
        for k, v in pairs( frame.args ) do
+
for k, v in pairs( frame.args ) do
            origArgs = frame.args
+
origArgs = frame.args
            break
+
break
        end
+
end
    else
+
else
        origArgs = frame
+
origArgs = frame
    end
+
end
    -- Process the args to make an array of portal names that can be used with ipairs. We need to use ipairs because we want to list
+
-- Process the args to make an array of portal names that can be used with ipairs. We need to use ipairs because we want to list
    -- all the portals in the order they were passed to the template, but we also want to be able to deal with positional arguments
+
-- all the portals in the order they were passed to the template, but we also want to be able to deal with positional arguments
    -- passed explicitly, for example {{portal|2=Politics}}. The behaviour of ipairs is undefined if nil values are present, so we
+
-- passed explicitly, for example {{portal|2=Politics}}. The behaviour of ipairs is undefined if nil values are present, so we
    -- need to make sure they are all removed.
+
-- need to make sure they are all removed.
    local portals, args = {}, {}
+
local portals, args = {}, {}
    for k, v in pairs( origArgs ) do
+
for k, v in pairs( origArgs ) do
        if type( k ) == 'number' and type( v ) == 'string' then -- Make sure we have no non-string portal names.
+
if type( k ) == 'number' and type( v ) == 'string' then -- Make sure we have no non-string portal names.
            if mw.ustring.find( v, '%S' ) then -- Remove blank values.
+
if mw.ustring.find( v, '%S' ) then -- Remove blank values.
                table.insert( portals, k )
+
table.insert( portals, k )
            end
+
end
        elseif type( k ) ~= 'number' then -- Separate named arguments from portals.
+
elseif type( k ) ~= 'number' then -- Separate named arguments from portals.
            if type( v ) == 'string' then
+
if type( v ) == 'string' then
                v = mw.text.trim( v )
+
v = mw.text.trim( v )
            end
+
end
            args[ k ] = v
+
args[ k ] = v
        end
+
end
    end
+
end
    table.sort( portals )
+
table.sort( portals )
    for i, v in ipairs( portals ) do
+
for i, v in ipairs( portals ) do
        portals[ i ] = mw.text.trim( origArgs[ v ] ) -- Swap keys with values, trimming whitespace.
+
portals[ i ] = mw.text.trim( origArgs[ v ] ) -- Swap keys with values, trimming whitespace.
    end
+
end
    return p._main( portals, args )
+
return p._main( portals, args )
 
end
 
end
  
 
return p
 
return p

Revision as of 02:45, 1 December 2014

This module implements the {{portal bar}} template. It displays a horizontal bar of portals.

Usage

{{#invoke:Portal bar|main|''portal 1''|''portal 2 ''|...|border=''no''}}
  • Positional parameters - the names of the portals to be displayed.
  • border - if |border= is equal to no, n, false, or 0, then the portal box will have no border.
  • redlinks - if |redlinks= is equal to yes, y, true or include, then the portal box will show redlinked portals

Examples

  • {{#invoke:portal bar|main|Art|Science|Literature}}

Produces:

  • {{#invoke:portal bar|main|Art|Science|Literature|border=no}}

Produces:

For further examples, see Template:Portal bar/testcases.

Images

This module uses Module:Portal to get portal images. To add, change, or remove images, please see the instructions at Module:Portal#Image.


-- This module implements {{portal bar}}.

require('Module:No globals')

local p = {}

local buildNavbox = require( 'Module:Navbox' )._navbox
local getImageName = require( 'Module:Portal' ).image
local yesno = require( 'Module:Yesno' )

-- Builds the portal bar used by {{portal bar}}.
function p._main( portals, args )
	if #portals < 1 then return '' end -- Don't display a blank navbox if no portals were specified.
	local list = mw.html.create( 'ul' )
	for _, portal in ipairs( portals ) do
		list
			:tag( 'li' )
				:css( 'display', 'inline' )
				:css( 'white-space', 'nowrap' )
				:tag( 'span' )
					:css( 'margin', 'auto 0.5em' )
					:wikitext( string.format( '[[File:%s|24x21px]]', getImageName{ portal } ) )
					:done()
				:tag( 'span' )
					:css( 'font-weight', 'bold' )
					:wikitext( string.format( '[[Portal:%s|%s portal]]', portal, portal ) )
	end
	if yesno( args.border ) == false then -- Don't display a border if args.border is "no", "n", "false", 0 or false.
		return tostring(
			mw.html.create( 'div' )
				:addClass( 'noprint metadata' )
				:css( 'width', '100%' )
				:css( 'text-align', 'center' )
				:css( 'padding', '1px' )
				:css( 'font-size', '88%' )
				:node( list )
		)
	else
		return buildNavbox{
			navbar = 'off',
			bodyclass = 'noprint',
			list1 = tostring( list )
		}
	end
end

-- Processes external arguments and sends them to the other functions.
function p.main( frame )
	-- If called via #invoke, use the args passed into the invoking
	-- template, or the args passed to #invoke if any exist. Otherwise
	-- assume args are being passed directly in from the debug console
	-- or from another Lua module.
	local origArgs
	if type( frame.getParent ) == 'function' then
		origArgs = frame:getParent().args
		for k, v in pairs( frame.args ) do
			origArgs = frame.args
			break
		end
	else
		origArgs = frame
	end
	-- Process the args to make an array of portal names that can be used with ipairs. We need to use ipairs because we want to list
	-- all the portals in the order they were passed to the template, but we also want to be able to deal with positional arguments
	-- passed explicitly, for example {{portal|2=Politics}}. The behaviour of ipairs is undefined if nil values are present, so we
	-- need to make sure they are all removed.
	local portals, args = {}, {}
	for k, v in pairs( origArgs ) do
		if type( k ) == 'number' and type( v ) == 'string' then -- Make sure we have no non-string portal names.
			if mw.ustring.find( v, '%S' ) then -- Remove blank values.
				table.insert( portals, k )
			end
		elseif type( k ) ~= 'number' then -- Separate named arguments from portals.
			if type( v ) == 'string' then
				v = mw.text.trim( v )
			end
			args[ k ] = v
		end
	end
	table.sort( portals )
	for i, v in ipairs( portals ) do
		portals[ i ] = mw.text.trim( origArgs[ v ] ) -- Swap keys with values, trimming whitespace.
	end
	return p._main( portals, args )
end

return p