Module:Portal bar: Difference between revisions

From LearnSocialStudies
MainPage>Admin
m (1 revision)
 
m (1 revision imported)
 
(No difference)

Latest revision as of 08:40, 23 December 2021

-- This module implements {{#invoke:Portal bar|main}}.

local p = {}

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

-- Builds the portal bar used by {{#invoke:Portal bar|main}}. function p._main( portals, args )

   if #portals < 1 then return  end -- Don't display a blank navbox if no portals were specified.
   local list = htmlBuilder.create( 'ul' )
   for i, portal in ipairs( portals ) do
       list
           .tag( 'li' )
               .css( 'display', 'inline' )
               .css( 'white-space', 'nowrap' )
               .tag( 'span' )
                   .css( 'margin', 'auto 0.5em' )
                   .wikitext( mw.ustring.format( 'File:%s', getImageName{ portal } ) )
                   .done()
               .tag( 'span' )
                   .css( 'font-weight', 'bold' )
                   .wikitext( mw.ustring.format( '%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.
       local root = htmlBuilder.create( 'div' )
       root
           .addClass( 'noprint' )
           .css( 'width', '100%' )
           .css( 'text-align', 'center' )
           .css( 'padding', '1px' )
           .css( 'font-size', '88%' )
           .wikitext( tostring( list ) )
       return tostring( root )
   else
       return buildNavbox{
           name = 'Portal bar',
           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 frame == mw.getCurrentFrame() 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 {{#invoke:Portal|portal}}. 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