Module:Listbox: Difference between revisions

From Zelda Dungeon Wiki
Jump to navigation Jump to search
Want an adless experience? Log in or Create an account.
(fix some variable names)
m (change label class to zdw-label to distinguish from bootstrap)
 
(36 intermediate revisions by the same user not shown)
Line 1: Line 1:
local Box = require( 'Module:Box' ).Box
local Args = require( 'Module:Args' )
local Lazy = require( 'Module:Lazy' ) -- may load: Tabs, Gallery
local Listing = require( 'Module:Listing' )


function getCategoryProps( categoryName )
function buildHList( parent, sections )
   local categoryContent = mw.title.new( categoryName, 'Category' ):getContent()
   local list = parent:addClass( 'hlist' )
   local props = {}
    :tag( 'ul' )
 
   for _, section in ipairs( sections ) do
  for match in string.gmatch( categoryContent, '{{Prop|([^}]*)}}' ) do
    -- !!!! This may break if Template:Main is modified !!!!
     local prop, value = unpack(mw.text.split( match, '|' ))
    local expandedMainTemplate = section.summary:match( 'Main article: %[%[(.-)]]' )
 
     local link = expandedMainTemplate and mw.text.split( expandedMainTemplate, '|' )[1]
     -- table if multiple values, value if one value, true if no values (i.e. flag)
     list:tag( 'li' )
    props[prop] = value and string.match( value, ',' ) and mw.text.split( value, ',' ) or value or true
      :wikitext( '[[' .. (link or section.name) .. '|' .. section.name .. ']]' )
   end
   end
  return props
end
end


function getPageTree( categoryName, expandVariants )
local Navbox = Listing.Navbox
  -- get all pages in the category
  local pages = mw.ext.dpl.getPages{ category = categoryName, ordermethod = 'sortkey', order = 'ascending' }


  -- organize them according to metadata
local Listbox = setmetatable( {}, Navbox )
  local pageTree = { default = {} }
Listbox.__index = Listbox
  for _, page in ipairs( pages ) do
    -- get metadata
    if page.extra then
      -- remove extra from sortkey
      page.sortkey = string.sub( page.sortkey, 1, -string.len( page.extra ) - 2 )


      local success, result = pcall( mw.text.jsonDecode, page.extra )
function Listbox.new( args )
      if success then
  local obj = Navbox.new( args )
        page.extra = result
  return setmetatable( obj, Listbox )
      else
        page.sortkey = page.text .. mw.getCurrentFrame():expandTemplate{ title = 'Tt', args = { 'PARSING ERROR: Please ensure the argument to \'extra\' in this page\'s invocation of \'Cat\' is valid JSON' } }
        page.extra = {}
      end
    else page.extra = {}
    end
 
    -- add page to group
    page.__index = page -- allow variants to fall back to page
    page.extra.__index = page.extra -- allow variants' extra to fall back to page's extra
    local variants = expandVariants and page.extra.variants or {{}} -- that's a table containing a single table (variant) with no properties (overrides)
    for _, variant in ipairs( variants ) do
      setmetatable( variant, page.extra )
      if not variant.group then variant.group = 'default' end
      if not pageTree[variant.group] then pageTree[variant.group] = {} end
      pageTree[variant.group][#pageTree[variant.group] + 1] = setmetatable( { extra = variant }, page )
    end
  end
 
  return pageTree
end
end


function buildGallery( pages )
-- override
  local Gallery = Lazy.load( 'Module:Gallery' ).Gallery
function Listbox:renderContent()
  local gallery = Gallery.new() -- TODO define appropriate args. CD/Header has: {{Gallery|size={{#ifeq:{{{size|}}}|large|95|62}}|pad=1|square={{{square|true}}}}}
   local listing = Listing._parseListing( self.subject )
  for _, page in ipairs( pages ) do
    gallery:addFile( 'No Image.png', '[[' .. page.text .. '|' .. (page.extra.name or page.text) .. ']]', {
      link = page.text,
      alt = page.extra.name or page.text
    } )
  end
 
  return gallery:render()
end
 
 
function buildGalleries( categoryProps, pageTree )
   local Gallery = Lazy.load( 'Module:Gallery' ).Gallery
 
  local defaultGallery = nil
  if pageTree.default then
    defaultGallery = buildGallery( pageTree.default )
  end


   if categoryProps.groups then
   -- If categories weren't set already (because caller used single arg), then use the ones parsed from the page.
    local Tabs = Lazy.load( 'Module:Tabs' ).Tabs
  -- CODE SMELL: setting unrelated state. this only works because renderFooter is called after renderContent.
    local tabs = Tabs.new()
  if #self.categories == 0 then self.categories = listing.categories end


    if defaultGallery then
      tabs:addTabTopWithContent{
        contentId = 'General',
        content = defaultGallery
      }
    end
    -- coerce it to a table for easier processing
    local groups = type( categoryProps.groups ) == 'table' and categoryProps.groups or { categoryProps.groups }
    for index, group in ipairs( groups ) do
      if pageTree[group] then
        tabs:addTabTopWithContent{
          contentId = group,
          content = buildGallery( pageTree[group] )
        }
      end
    end
    return tabs:render()
  end
  return defaultGallery
end
function renderHList( parent, pages )
  local list = parent:addClass( 'hlist' )
    :tag( 'ul' )
  for _, page in ipairs( pages ) do
    list:tag( 'li' )
      :wikitext( '[[' .. page.text .. '|' .. (page.extra.name or page.text) .. ']]' )
  end
end
function buildTable( categoryProps, pageTree )
   local content = mw.html.create( 'table' )
   local content = mw.html.create( 'table' )
   if #pageTree.default then
   if #listing.topLevelLeaves > 0 then
     local defaultCell = content:tag( 'tr' )
     local defaultCell = content:tag( 'tr' )
       :tag( 'td' )
       :tag( 'td' )
Line 121: Line 39:
       :attr( 'colspan', '2' )
       :attr( 'colspan', '2' )
       :css( 'text-align', 'center' )
       :css( 'text-align', 'center' )
     renderHList( defaultCell, pageTree.default )
     buildHList( defaultCell, listing.topLevelLeaves )
   end
   end
   if categoryProps.groups then
   if #listing.groups > 0 then
    -- coerce it to a table for easier processing
     for index, group in ipairs( listing.groups ) do
    local groups = type( categoryProps.groups ) == 'table' and categoryProps.groups or { categoryProps.groups }
       local row = content:tag( 'tr' )
     for index, group in ipairs( groups ) do
      row:tag( 'th' )
       if pageTree[group] then
        :addClass( 'zdw-label' )
        local row = content:tag( 'tr' )
        :wikitext( group.name )
        row:tag( 'th' )
      local cell = row:tag( 'td' )
          :addClass( 'label' )
        :addClass( (index + (#listing.topLevelLeaves > 0 and 1 or 0)) % 2 == 0 and 'even' or 'odd' )
          :wikitext( group )
      buildHList( cell, group.sections )
        local cell = row:tag( 'td' )
          :addClass( (index + (#pageTree.default and 1 or 0)) % 2 == 0 and 'even' or 'odd' )
        renderHList( cell, pageTree[group] )
      end
     end
     end
   end
   end
Line 142: Line 56:
end
end


local Navbox = Box.new()
local p = {}
Navbox.__index = Navbox
setmetatable( Navbox, Box )
 
function Navbox.new( format, args )
  local subject = args[1] .. ' ' .. args[2]
  args.class = 'navbox'
  args.title = subject
  args.edit = subject
  args.hide = 'show' -- TODO count number of navboxes, hide after the second or third (could relegate to the calling template)
  local obj = Box.new( 'light', args )
  obj.format = format
  obj.subject = subject
  obj.categories = { args[1], subject, args[2] }
  return setmetatable( obj, Navbox )
end
 
function Navbox:renderContent()
  local categoryProps = getCategoryProps( self.subject )
  local pageTree = getPageTree( self.subject, self.format == 'gallery' )
  local build = setmetatable( {
    gallery = buildGalleries
  }, {
    __index = function() return buildTable end -- default
  } )
  return build[self.format]( categoryProps, pageTree )
end
 
local p, mt = {}, {}


function p._main( format, args )
function p.main( frame )
   local navbox = Navbox.new( format, args )
   local listbox = Listbox.new( Args.fromFrame( frame ) )
  return navbox:render()
   return listbox:render()
end
 
-- translates p.function( frame ) to p._main( function, args )
function mt.__index( table, key )
   return function ( frame )
    return table._main( key, frame.args )
  end
end
end


-- for use in the debug console:
-- for use in the debug console:
-- =p.list(p.debugframe)
-- =p.main(p.debugframe)
p.debugframe = {
p.debugframe = {
   args = {
   args = {},
     [1] = "The Legend of Zelda",
  getParent = function() return {
     [2] = "Enemies",
     args = {
   }
      [1] = "The Legend of Zelda Locations"
     }
   } end
}
}


return setmetatable( p, mt )
return p

Latest revision as of 02:17, November 16, 2020

Documentation for this module may be created at Module:Listbox/doc

local Args = require( 'Module:Args' )
local Listing = require( 'Module:Listing' )

function buildHList( parent, sections )
  local list = parent:addClass( 'hlist' )
    :tag( 'ul' )
  for _, section in ipairs( sections ) do
    -- !!!! This may break if Template:Main is modified !!!!
    local expandedMainTemplate = section.summary:match( 'Main article: %[%[(.-)]]' )
    local link = expandedMainTemplate and mw.text.split( expandedMainTemplate, '|' )[1]
    list:tag( 'li' )
      :wikitext( '[[' .. (link or section.name) .. '|' .. section.name .. ']]' )
  end
end

local Navbox = Listing.Navbox

local Listbox = setmetatable( {}, Navbox )
Listbox.__index = Listbox

function Listbox.new( args )
  local obj = Navbox.new( args )
  return setmetatable( obj, Listbox )
end

-- override
function Listbox:renderContent()
  local listing = Listing._parseListing( self.subject )

  -- If categories weren't set already (because caller used single arg), then use the ones parsed from the page.
  -- CODE SMELL: setting unrelated state. this only works because renderFooter is called after renderContent.
  if #self.categories == 0 then self.categories = listing.categories end

  local content = mw.html.create( 'table' )
  if #listing.topLevelLeaves > 0 then
    local defaultCell = content:tag( 'tr' )
      :tag( 'td' )
      :addClass( 'odd' )
      :attr( 'colspan', '2' )
      :css( 'text-align', 'center' )
    buildHList( defaultCell, listing.topLevelLeaves )
  end
  if #listing.groups > 0 then
    for index, group in ipairs( listing.groups ) do
      local row = content:tag( 'tr' )
      row:tag( 'th' )
        :addClass( 'zdw-label' )
        :wikitext( group.name )
      local cell = row:tag( 'td' )
        :addClass( (index + (#listing.topLevelLeaves > 0 and 1 or 0)) % 2 == 0 and 'even' or 'odd' )
      buildHList( cell, group.sections )
    end
  end

  return content
end

local p = {}

function p.main( frame )
  local listbox = Listbox.new( Args.fromFrame( frame ) )
  return listbox:render()
end

-- for use in the debug console:
-- =p.main(p.debugframe)
p.debugframe = {
  args = {},
  getParent = function() return {
    args = {
      [1] = "The Legend of Zelda Locations"
    }
  } end
}

return p