Jump to content

Module:OOO/Variants: Difference between revisions

From Out of Ore Wiki
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
-- Module:OOO/Variants
-- Module:OOO/Variants
-- Renders a right-aligned TabberNeue block of OOOInfoBox variants.
-- Renders a TabberNeue block of OOOInfoBox variants, wrapped so it aligns with the infobox.
-- Usage examples:
-- Usage:
--  {{OOOVariants|400162|400163|400113|400169|400170}}
--  {{OOOVariants|400162|400163|400113|400169|400170}}                   -- scroll is default
--  {{OOOVariants | label1=2 m | art1=400162 | label2=3 m | art2=400163 | width=300 | align=left }}
--  {{OOOVariants|400162|400163|...|mode=wrap}}                          -- opt-in wrap
--  {{OOOVariants | label1=2 m | art1=400162 | width=300 | align=left }} -- still works
--
--
-- Optional params (global):
-- Global params:
--  |domain=Buildings   -- which data bucket to use; defaults to Buildings
--  |domain=Buildings       -- bucket (default: Buildings)
--  |align=right       -- right (default), left, none, center
--  |align=right|left|none|center
--  |width=300         -- pixels; applies to wrapper and each infobox
--  |width=300             -- px; applies to wrapper + OOOInfoBox (240–600)
--  |mode=scroll|wrap      -- default: scroll (adds class used by gadget)
--
--
-- Optional per-tab overrides (append tab index N):
-- Per-tab overrides (append N):
--  |labelN=..., |imageN=..., |descriptionN=..., |dimensionsN=..., |classN=...
--  |labelN=... |imageN=... |descriptionN=... |dimensionsN=... |classN=...


local DATA = require('Module:OOO/Data')
local DATA = require('Module:OOO/Data')
local p = {}
local p = {}


-- keys we allow forwarding to OOOInfoBox per tab (suffix with index)
local PASSTHROUGH = { 'image', 'description', 'dimensions', 'class' }
local PASSTHROUGH = { 'image', 'description', 'dimensions', 'class' }


Line 24: Line 26:
end
end


-- Sanitize label for tab header (avoid raw '|' or '=' breaking tabber syntax)
local function safe_label(s)
local function safe_label(s)
   s = tostring(s or '')
   s = tostring(s or '')
Line 31: Line 32:
end
end


-- Resolve a nice label: explicit labelN > data.displayName > art id
local function label_for(domain, art, given)
local function label_for(domain, art, given)
   if given and given ~= '' then return given end
   if given and given ~= '' then return given end
Line 44: Line 44:
   local domain = tostring_or_nil(args.domain or args.type) or 'Buildings'
   local domain = tostring_or_nil(args.domain or args.type) or 'Buildings'
   local align  = tostring_or_nil(args.align) or 'right'
   local align  = tostring_or_nil(args.align) or 'right'
   local width  = tonumber(args.width) -- optional shared width for wrapper + infoboxes
  local mode  = tostring_or_nil(args.mode)  or 'scroll'  -- DEFAULT: scroll
   local width  = tonumber(args.width)


   -- Build each tab
   -- Build each tab entry
   local entries = {}
   local entries = {}
   local i = 1
   local i = 1
Line 55: Line 56:
     local label = label_for(domain, art, args['label'..i] or args['name'..i])
     local label = label_for(domain, art, args['label'..i] or args['name'..i])


     -- Args passed to the underlying OOOInfoBox template
     -- Args forwarded to OOOInfoBox
     local ibx = {
     local ibx = {
       art = art,
       art   = art,
       type = domain,
       type = domain,
       align = align,
       align = align,
     }
     }
Line 79: Line 80:
   end
   end


  -- Build the TabberNeue tag (ensures the extension parses it, not raw text)
   local inner  = table.concat(entries, '|-|\n')
   local inner  = table.concat(entries, '|-|\n')
   local tabber = frame:extensionTag('tabber', inner)
   local tabber = frame:extensionTag('tabber', inner)


   -- Wrap so tabs float with the infobox; mirror align/width
   -- Wrapper around tabber so it floats with the infobox and gets our styles
   local wrap = mw.html.create('div'):addClass('ooo-infobox-tabwrap')
   local wrap = mw.html.create('div'):addClass('ooo-infobox-tabwrap')
   if align == 'left' then
   if align == 'left' then
Line 92: Line 92:
     wrap:addClass('ooo-infobox-tabwrap--center')
     wrap:addClass('ooo-infobox-tabwrap--center')
   end
   end
  -- Scroll is default; only skip when explicitly |mode=wrap
  if mode ~= 'wrap' then
    wrap:addClass('ooo-infobox-tabwrap--scroll')
  end
   if width and width >= 240 and width <= 600 then
   if width and width >= 240 and width <= 600 then
     wrap:css('width', tostring(width) .. 'px')
     wrap:css('width', tostring(width) .. 'px')
   end
   end
   wrap:wikitext(tabber)
   wrap:wikitext(tabber)


Line 101: Line 108:
   html = html .. frame:extensionTag('templatestyles', '', { src = 'Template:OOOInfoBoxTabber/styles.css' })
   html = html .. frame:extensionTag('templatestyles', '', { src = 'Template:OOOInfoBoxTabber/styles.css' })


   -- Optional debug comment (viewable in page source)
   -- Optional debug comment
   if tostring(args.debug) == '1' then
   if tostring(args.debug) == '1' then
     html = html .. string.format('<!-- OOOVariants: domain=%s, align=%s, width=%s, tabs=%d -->',
     html = html .. string.format('<!-- OOOVariants: domain=%s, align=%s, mode=%s, width=%s, tabs=%d -->',
       domain, align, width or 'default', #entries)
       domain, align, mode, width or 'default', #entries)
   end
   end



Latest revision as of 09:08, 13 October 2025

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

-- Module:OOO/Variants
-- Renders a TabberNeue block of OOOInfoBox variants, wrapped so it aligns with the infobox.
-- Usage:
--   {{OOOVariants|400162|400163|400113|400169|400170}}                    -- scroll is default
--   {{OOOVariants|400162|400163|...|mode=wrap}}                           -- opt-in wrap
--   {{OOOVariants | label1=2 m | art1=400162 | width=300 | align=left }}  -- still works
--
-- Global params:
--   |domain=Buildings       -- bucket (default: Buildings)
--   |align=right|left|none|center
--   |width=300              -- px; applies to wrapper + OOOInfoBox (240–600)
--   |mode=scroll|wrap       -- default: scroll (adds class used by gadget)
--
-- Per-tab overrides (append N):
--   |labelN=... |imageN=... |descriptionN=... |dimensionsN=... |classN=...

local DATA = require('Module:OOO/Data')

local p = {}

local PASSTHROUGH = { 'image', 'description', 'dimensions', 'class' }

local function tostring_or_nil(v)
  if v == nil then return nil end
  return tostring(v)
end

local function safe_label(s)
  s = tostring(s or '')
  s = s:gsub('|', '&#124;'):gsub('=', '&#61;')
  return s
end

local function label_for(domain, art, given)
  if given and given ~= '' then return given end
  local rec = DATA.get(domain, art) or {}
  return rec.displayName or tostring(art)
end

function p.tabs(frame)
  local parent = frame:getParent() or frame
  local args   = parent.args or {}

  local domain = tostring_or_nil(args.domain or args.type) or 'Buildings'
  local align  = tostring_or_nil(args.align) or 'right'
  local mode   = tostring_or_nil(args.mode)  or 'scroll'   -- DEFAULT: scroll
  local width  = tonumber(args.width)

  -- Build each tab entry
  local entries = {}
  local i = 1
  while true do
    local art = args['art'..i] or args[i]
    if not art then break end

    local label = label_for(domain, art, args['label'..i] or args['name'..i])

    -- Args forwarded to OOOInfoBox
    local ibx = {
      art   = art,
      type  = domain,
      align = align,
    }
    if width and width >= 240 and width <= 600 then
      ibx.width = width
    end
    for _, key in ipairs(PASSTHROUGH) do
      local v = args[key..i]
      if v and v ~= '' then ibx[key] = v end
    end

    local content = frame:expandTemplate{ title = 'OOOInfoBox', args = ibx }
    entries[#entries+1] = string.format('%s=\n%s\n', safe_label(label), content)

    i = i + 1
  end

  if #entries == 0 then
    return '<strong class="error">OOOVariants: no variants provided</strong>'
  end

  local inner  = table.concat(entries, '|-|\n')
  local tabber = frame:extensionTag('tabber', inner)

  -- Wrapper around tabber so it floats with the infobox and gets our styles
  local wrap = mw.html.create('div'):addClass('ooo-infobox-tabwrap')
  if align == 'left' then
    wrap:addClass('ooo-infobox-tabwrap--left')
  elseif align == 'none' then
    wrap:addClass('ooo-infobox-tabwrap--none')
  elseif align == 'center' then
    wrap:addClass('ooo-infobox-tabwrap--center')
  end

  -- Scroll is default; only skip when explicitly |mode=wrap
  if mode ~= 'wrap' then
    wrap:addClass('ooo-infobox-tabwrap--scroll')
  end

  if width and width >= 240 and width <= 600 then
    wrap:css('width', tostring(width) .. 'px')
  end

  wrap:wikitext(tabber)

  -- Attach wrapper TemplateStyles
  local html = tostring(wrap)
  html = html .. frame:extensionTag('templatestyles', '', { src = 'Template:OOOInfoBoxTabber/styles.css' })

  -- Optional debug comment
  if tostring(args.debug) == '1' then
    html = html .. string.format('<!-- OOOVariants: domain=%s, align=%s, mode=%s, width=%s, tabs=%d -->',
      domain, align, mode, width or 'default', #entries)
  end

  return html
end

return p