Difference between revisions of "Module:Portal bar"
Jump to navigation
Jump to search
test>Jackmcbarn (use mw.html and other fixes from sandbox) |
test>Graeme Bartlett m (Changed protection level of Module:Portal bar: High-risk Lua module ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only administrators] (indefinite))) |
(No difference)
| |
Revision as of 12:02, 13 December 2015
| This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
| 40px | This Lua module is used on approximately 81,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages. Consider discussing changes on the talk page before implementing them.
Transclusion count updated automatically (see documentation). |
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 tono,n,false, or0, then the portal box will have no border.redlinks- if|redlinks=is equal toyes,y,trueorinclude, 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