Module:Portal bar and Module:Portal bar/sandbox: Difference between pages
Appearance
(Difference between pages)
Content deleted Content added
Andy M. Wang (talk | contribs) syncing to sandbox per edit request. Removes heavy navbox table dependency, adds navig region, fixes MediaViewer image cycling |
missing styles on borderless version |
||
Line 16: | Line 16: | ||
:attr( 'role', 'navigation' ) |
:attr( 'role', 'navigation' ) |
||
:attr( 'aria-label' , 'Portals' ) |
:attr( 'aria-label' , 'Portals' ) |
||
⚫ | |||
⚫ | |||
:css( 'font-weight', 'bold' ) |
:css( 'font-weight', 'bold' ) |
||
if yesno( args.border ) == false then |
if yesno( args.border ) == false then |
||
nav |
nav |
||
:css( 'padding', '0.1em 1.7em' ) |
:css( 'padding', '0.1em 1.7em' ) |
||
⚫ | |||
⚫ | |||
else |
else |
||
nav |
nav |
||
: |
:addClass( 'navbox' ) |
||
:css( 'border', '1px solid #aaa' ) |
|||
:css( 'padding', '0.4em 2em' ) |
:css( 'padding', '0.4em 2em' ) |
||
:css( 'background', '#fdfdfd' ) |
|||
end |
end |
||
Revision as of 11:56, 13 July 2016
![]() | This is the module sandbox page for Module:Portal bar (diff). |
![]() | This module depends on the following other modules: |
![]() | This module uses TemplateStyles: |
This module implements the {{portal bar}} template. It displays a horizontal bar of portals.
See here and here for testcases.
Note: in order to make the test cases work, the Sandbox CSS classes have "-sand" appended to their names. If you wish to update the CSS, copy the contents of each class from Module:Portal bar/sandbox/styles.css to Module:Portal bar/styles.css, but do not alter the class names, nor just copy-paste the entire CSS file. For the current difference in CSS between Sandbox and Main, see here.
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
,true
orinclude
, then the portal box will show redlinked portals
Examples
{{#invoke:portal bar|main|Visual arts|Science|Literature}}
Produces:
{{#invoke:portal bar|main|Visual arts|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 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 nav = mw.html.create( 'div' )
:addClass( 'noprint metadata' )
:attr( 'role', 'navigation' )
:attr( 'aria-label' , 'Portals' )
:css( 'font-weight', 'bold' )
if yesno( args.border ) == false then
nav
:css( 'padding', '0.1em 1.7em' )
:css( 'font-size', '88%' )
:css( 'text-align', 'center' )
else
nav
:addClass( 'navbox' )
:css( 'padding', '0.4em 2em' )
end
local list = mw.html.create( 'ul' )
:css( 'margin', '0' )
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()
:wikitext( string.format( '[[Portal:%s|%s portal]]', portal, portal ) )
end
nav
:node( list )
return tostring( nav )
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