Module:Infobox: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
← Older editNewer edit →
meta>WOSlinker
call navbar via module rather than template
meta>Jackmcbarn
from sandbox, remove now-unnecessary argument parsing complexity, and some other fixes
Line 2: Line 2:
-- This module implements {{Infobox}}
-- This module implements {{Infobox}}
--
--
 
local p = {}
local p = {}
local navbar = require('Module:Navbar')._navbar
local args = {}
local origArgs
local root


local function union(t1, t2)
local function union(t1, t2)
Line 27: Line 21:
end
end


local function getArgNums(prefix)
local function getArgNums(args, prefix)
     -- Returns a table containing the numbers of the arguments that exist
     -- Returns a table containing the numbers of the arguments that exist
     -- for the specified prefix. For example, if the prefix was 'data', and
     -- for the specified prefix. For example, if the prefix was 'data', and
Line 40: Line 34:
end
end


local function addRow(rowArgs)
local function addRow(root, args, rowArgs)
     -- Adds a row to the infobox, with either a header cell
     -- Adds a row to the infobox, with either a header cell
     -- or a label/data cell combination.
     -- or a label/data cell combination.
Line 72: Line 66:
                     :done()
                     :done()
         end
         end
       
 
         local dataCell = row:tag('td')
         local dataCell = row:tag('td')
         if not rowArgs.label then  
         if not rowArgs.label then
             dataCell
             dataCell
                 :attr('colspan', 2)
                 :attr('colspan', 2)
                 :css('text-align', 'center')  
                 :css('text-align', 'center')
         end
         end
         dataCell
         dataCell
Line 88: Line 82:
end
end


local function renderTitle()
local function renderTitle(root, args)
     if not args.title then return end
     if not args.title then return end


Line 98: Line 92:
end
end


local function renderAboveRow()
local function renderAboveRow(root, args)
     if not args.above then return end
     if not args.above then return end
   
 
     root
     root
         :tag('tr')
         :tag('tr')
Line 113: Line 107:
end
end


local function renderBelowRow()
local function renderBelowRow(root, args)
     if not args.below then return end
     if not args.below then return end
   
 
     root
     root
         :tag('tr')
         :tag('tr')
Line 127: Line 121:
end
end


local function renderSubheaders()
local function renderSubheaders(root, args)
     if args.subheader then
     if args.subheader then
         args.subheader1 = args.subheader
         args.subheader1 = args.subheader
Line 134: Line 128:
         args.subheaderrowclass1 = args.subheaderrowclass
         args.subheaderrowclass1 = args.subheaderrowclass
     end
     end
     local subheadernums = getArgNums('subheader')
     local subheadernums = getArgNums(args, 'subheader')
     for k, num in ipairs(subheadernums) do
     for k, num in ipairs(subheadernums) do
         addRow({
         addRow(root, args, {
             data = args['subheader' .. tostring(num)],
             data = args['subheader' .. tostring(num)],
             datastyle = args.subheaderstyle or args['subheaderstyle' .. tostring(num)],
             datastyle = args.subheaderstyle or args['subheaderstyle' .. tostring(num)],
Line 145: Line 139:
end
end


local function renderImages()
local function renderImages(root, args)
     if args.image then
     if args.image then
         args.image1 = args.image
         args.image1 = args.image
Line 152: Line 146:
         args.caption1 = args.caption
         args.caption1 = args.caption
     end
     end
     local imagenums = getArgNums('image')
     local imagenums = getArgNums(args, 'image')
     for k, num in ipairs(imagenums) do
     for k, num in ipairs(imagenums) do
         local caption = args['caption' .. tostring(num)]
         local caption = args['caption' .. tostring(num)]
Line 162: Line 156:
                     :wikitext(caption)
                     :wikitext(caption)
         end
         end
         addRow({
         addRow(root, args, {
             data = tostring(data),
             data = tostring(data),
             datastyle = args.imagestyle,
             datastyle = args.imagestyle,
Line 171: Line 165:
end
end


local function renderRows()
local function renderRows(root, args)
     -- Gets the union of the header and data argument numbers,
     -- Gets the union of the header and data argument numbers,
     -- and renders them all in order using addRow.
     -- and renders them all in order using addRow.
     local rownums = union(getArgNums('header'), getArgNums('data'))
     local rownums = union(getArgNums(args, 'header'), getArgNums(args, 'data'))
     table.sort(rownums)
     table.sort(rownums)
     for k, num in ipairs(rownums) do
     for k, num in ipairs(rownums) do
         addRow({
         addRow(root, args, {
             header = args['header' .. tostring(num)],
             header = args['header' .. tostring(num)],
             label = args['label' .. tostring(num)],
             label = args['label' .. tostring(num)],
Line 193: Line 187:
end
end


local function renderNavBar()
local function renderNavBar(root, args)
     if not args.name then return end
     if not args.name then return end
   
 
     root
     root
         :tag('tr')
         :tag('tr')
Line 201: Line 195:
                 :attr('colspan', '2')
                 :attr('colspan', '2')
                 :css('text-align', 'right')
                 :css('text-align', 'right')
                 :wikitext(navbar{
                 :wikitext(require('Module:Navbar')._navbar{
                     args.name,
                     args.name,
                     mini = 1,
                     mini = 1,
Line 207: Line 201:
end
end


local function renderItalicTitle()
local function renderItalicTitle(root, args)
     local italicTitle = args['italic title'] and mw.ustring.lower(args['italic title'])
     local italicTitle = args['italic title'] and mw.ustring.lower(args['italic title'])
     if italicTitle == '' or italicTitle == 'force' or italicTitle == 'yes' then
     if italicTitle == '' or italicTitle == 'force' or italicTitle == 'yes' then
Line 214: Line 208:
end
end


local function renderTrackingCategories()
local function renderTrackingCategories(root, args)
     if args.decat ~= 'yes' then
     if args.decat ~= 'yes' then
         if #(getArgNums('data')) == 0 and mw.title.getCurrentTitle().namespace == 0 then
         if #(getArgNums(args, 'data')) == 0 and mw.title.getCurrentTitle().namespace == 0 then
             root:wikitext('[[Category:Articles which use infobox templates with no data rows]]')
             root:wikitext('[[Category:Articles which use infobox templates with no data rows]]')
         end
         end
Line 225: Line 219:
end
end


local function _infobox()
function p.infobox(frame)
    local args = require('Module:Arguments').getArgs(frame, { wrappers = 'Template:Infobox', valueFunc = function(k, v)
    if v ~= '' or k == 'italic title' then
    return v
    end
    end })
 
     -- Specify the overall layout of the infobox, with special settings
     -- Specify the overall layout of the infobox, with special settings
     -- if the infobox is used as a 'child' inside another infobox.
     -- if the infobox is used as a 'child' inside another infobox.
    local root
     if args.child ~= 'yes' then
     if args.child ~= 'yes' then
         root = mw.html.create('table')
         root = mw.html.create('table')
       
 
         root
         root
             :addClass('infobox')
             :addClass('infobox')
             :addClass(args.bodyclass)
             :addClass(args.bodyclass)
           
 
             if args.subbox == 'yes' then
             if args.subbox == 'yes' then
                 root
                 root
Line 252: Line 253:
         root
         root
             :cssText(args.bodystyle)
             :cssText(args.bodystyle)
   
 
         renderTitle()
         renderTitle(root, args)
         renderAboveRow()
         renderAboveRow(root, args)
     else
     else
         root = mw.html.create()
         root = mw.html.create()
       
 
         root
         root
             :wikitext(args.title)
             :wikitext(args.title)
     end
     end


     renderSubheaders()
     renderSubheaders(root, args)
     renderImages()  
     renderImages(root, args)
     renderRows()  
     renderRows(root, args)
     renderBelowRow()
     renderBelowRow(root, args)
     renderNavBar()
     renderNavBar(root, args)
     renderItalicTitle()
     renderItalicTitle(root, args)
     renderTrackingCategories()
     renderTrackingCategories(root, args)
   
 
     return tostring(root)
     return tostring(root)
end
end


local function preprocessSingleArg(argName)
    -- If the argument exists and isn't blank, add it to the argument table.
    -- Blank arguments are treated as nil to match the behaviour of ParserFunctions.
    if origArgs[argName] and origArgs[argName] ~= '' then
        args[argName] = origArgs[argName]
    end
end
local function preprocessArgs(prefixTable, step)
    -- Assign the parameters with the given prefixes to the args table, in order, in batches
    -- of the step size specified. This is to prevent references etc. from appearing in the
    -- wrong order. The prefixTable should be an array containing tables, each of which has
    -- two possible fields, a "prefix" string and a "depend" table. The function always parses
    -- parameters containing the "prefix" string, but only parses parameters in the "depend"
    -- table if the prefix parameter is present and non-blank.
    if type(prefixTable) ~= 'table' then
        error("Non-table value detected for the prefix table", 2)
    end
    if type(step) ~= 'number' then
        error("Invalid step value detected", 2)
    end
   
    -- Get arguments without a number suffix, and check for bad input.
    for i,v in ipairs(prefixTable) do
        if type(v) ~= 'table' or type(v.prefix) ~= "string" or (v.depend and type(v.depend) ~= 'table') then
            error('Invalid input detected to preprocessArgs prefix table', 2)
        end
        preprocessSingleArg(v.prefix)
        -- Only parse the depend parameter if the prefix parameter is present and not blank.
        if args[v.prefix] and v.depend then
            for j, dependValue in ipairs(v.depend) do
                if type(dependValue) ~= 'string' then
                    error('Invalid "depend" parameter value detected in preprocessArgs')
                end
                preprocessSingleArg(dependValue)
            end
        end
    end
    -- Get arguments with number suffixes.
    local a = 1 -- Counter variable.
    local moreArgumentsExist = true
    while moreArgumentsExist == true do
        moreArgumentsExist = false
        for i = a, a + step - 1 do
            for j,v in ipairs(prefixTable) do
                local prefixArgName = v.prefix .. tostring(i)
                if origArgs[prefixArgName] then
                    moreArgumentsExist = true -- Do another loop if any arguments are found, even blank ones.
                    preprocessSingleArg(prefixArgName)
                end
                -- Process the depend table if the prefix argument is present and not blank, or
                -- we are processing "prefix1" and "prefix" is present and not blank, and
                -- if the depend table is present.
                if v.depend and (args[prefixArgName] or (i == 1 and args[v.prefix])) then
                    for j,dependValue in ipairs(v.depend) do
                        local dependArgName = dependValue .. tostring(i)
                        preprocessSingleArg(dependArgName)
                    end
                end
            end
        end
        a = a + step
    end
end
function p.infobox(frame)
    -- If called via #invoke, use the args passed into the invoking template.
    -- Otherwise, for testing purposes, assume args are being passed directly in.
    if frame == mw.getCurrentFrame() then
        origArgs = frame:getParent().args
    else
        origArgs = frame
    end
   
    -- Parse the data parameters in the same order that the old {{infobox}} did, so that
    -- references etc. will display in the expected places. Parameters that depend on
    -- another parameter are only processed if that parameter is present, to avoid
    -- phantom references appearing in article reference lists.
    preprocessSingleArg('child')
    preprocessSingleArg('bodyclass')
    preprocessSingleArg('subbox')
    preprocessSingleArg('bodystyle')
    preprocessSingleArg('title')
    preprocessSingleArg('titleclass')
    preprocessSingleArg('titlestyle')
    preprocessSingleArg('above')
    preprocessSingleArg('aboveclass')
    preprocessSingleArg('abovestyle')
    preprocessArgs({
        {prefix = 'subheader', depend = {'subheaderstyle', 'subheaderrowclass'}}
    }, 10)
    preprocessSingleArg('subheaderstyle')
    preprocessSingleArg('subheaderclass')
    preprocessArgs({
        {prefix = 'image', depend = {'caption', 'imagerowclass'}}
    }, 10)
    preprocessSingleArg('captionstyle')
    preprocessSingleArg('imagestyle')
    preprocessSingleArg('imageclass')
    preprocessArgs({
        {prefix = 'header'},
        {prefix = 'data', depend = {'label'}},
        {prefix = 'rowclass'},
        {prefix = 'rowstyle'},
        {prefix = 'class'},
        {prefix = 'dataid'},
        {prefix = 'labelid'},
        {prefix = 'headerid'},
        {prefix = 'rowid'}
    }, 50)
    preprocessSingleArg('headerclass')
    preprocessSingleArg('headerstyle')
    preprocessSingleArg('labelstyle')
    preprocessSingleArg('datastyle')
    preprocessSingleArg('below')
    preprocessSingleArg('belowclass')
    preprocessSingleArg('belowstyle')
    preprocessSingleArg('name')
    args['italic title'] = origArgs['italic title'] -- different behaviour if blank or absent
    preprocessSingleArg('decat')
    return _infobox()
end
return p
return p

Revision as of 17:32, 25 May 2015

Lua error in Module:TNT at line 167: Missing Commons dataset I18n/Module:TNT.tab. Module:Infobox is a Lua module that implements the {{Infobox}} template. Please see the template page for usage instructions.

Tracking categories

--
-- This module implements {{Infobox}}
--

local p = {}

local function union(t1, t2)
    -- Returns the union of the values of two tables, as a sequence.
    local vals = {}
    for k, v in pairs(t1) do
        vals[v] = true
    end
    for k, v in pairs(t2) do
        vals[v] = true
    end
    local ret = {}
    for k, v in pairs(vals) do
        table.insert(ret, k)
    end
    return ret
end

local function getArgNums(args, prefix)
    -- Returns a table containing the numbers of the arguments that exist
    -- for the specified prefix. For example, if the prefix was 'data', and
    -- 'data1', 'data2', and 'data5' exist, it would return {1, 2, 5}.
    local nums = {}
    for k, v in pairs(args) do
        local num = tostring(k):match('^' .. prefix .. '([1-9]%d*)$')
        if num then table.insert(nums, tonumber(num)) end
    end
    table.sort(nums)
    return nums
end

local function addRow(root, args, rowArgs)
    -- Adds a row to the infobox, with either a header cell
    -- or a label/data cell combination.
    if rowArgs.header then
        root
            :tag('tr')
                :addClass(rowArgs.rowclass)
                :cssText(rowArgs.rowstyle)
                :attr('id', rowArgs.rowid)
                :tag('th')
                    :attr('colspan', 2)
                    :attr('id', rowArgs.headerid)
                    :addClass(rowArgs.class)
                    :addClass(args.headerclass)
                    :css('text-align', 'center')
                    :cssText(args.headerstyle)
                    :wikitext(rowArgs.header)
    elseif rowArgs.data then
        local row = root:tag('tr')
        row:addClass(rowArgs.rowclass)
        row:cssText(rowArgs.rowstyle)
        row:attr('id', rowArgs.rowid)
        if rowArgs.label then
            row
                :tag('th')
                    :attr('scope', 'row')
                    :attr('id', rowArgs.labelid)
                    :css('text-align', 'left')
                    :cssText(args.labelstyle)
                    :wikitext(rowArgs.label)
                    :done()
        end

        local dataCell = row:tag('td')
        if not rowArgs.label then
            dataCell
                :attr('colspan', 2)
                :css('text-align', 'center')
        end
        dataCell
            :attr('id', rowArgs.dataid)
            :addClass(rowArgs.class)
            :cssText(rowArgs.datastyle)
            :newline()
            :wikitext(rowArgs.data)
    end
end

local function renderTitle(root, args)
    if not args.title then return end

    root
        :tag('caption')
            :addClass(args.titleclass)
            :cssText(args.titlestyle)
            :wikitext(args.title)
end

local function renderAboveRow(root, args)
    if not args.above then return end

    root
        :tag('tr')
            :tag('th')
                :attr('colspan', 2)
                :addClass(args.aboveclass)
                :css('text-align', 'center')
                :css('font-size', '125%')
                :css('font-weight', 'bold')
                :cssText(args.abovestyle)
                :wikitext(args.above)
end

local function renderBelowRow(root, args)
    if not args.below then return end

    root
        :tag('tr')
            :tag('td')
                :attr('colspan', '2')
                :addClass(args.belowclass)
                :css('text-align', 'center')
                :cssText(args.belowstyle)
                :newline()
                :wikitext(args.below)
end

local function renderSubheaders(root, args)
    if args.subheader then
        args.subheader1 = args.subheader
    end
    if args.subheaderrowclass then
        args.subheaderrowclass1 = args.subheaderrowclass
    end
    local subheadernums = getArgNums(args, 'subheader')
    for k, num in ipairs(subheadernums) do
        addRow(root, args, {
            data = args['subheader' .. tostring(num)],
            datastyle = args.subheaderstyle or args['subheaderstyle' .. tostring(num)],
            class = args.subheaderclass,
            rowclass = args['subheaderrowclass' .. tostring(num)]
        })
    end
end

local function renderImages(root, args)
    if args.image then
        args.image1 = args.image
    end
    if args.caption then
        args.caption1 = args.caption
    end
    local imagenums = getArgNums(args, 'image')
    for k, num in ipairs(imagenums) do
        local caption = args['caption' .. tostring(num)]
        local data = mw.html.create():wikitext(args['image' .. tostring(num)])
        if caption then
            data
                :tag('div')
                    :cssText(args.captionstyle)
                    :wikitext(caption)
        end
        addRow(root, args, {
            data = tostring(data),
            datastyle = args.imagestyle,
            class = args.imageclass,
            rowclass = args['imagerowclass' .. tostring(num)]
        })
    end
end

local function renderRows(root, args)
    -- Gets the union of the header and data argument numbers,
    -- and renders them all in order using addRow.
    local rownums = union(getArgNums(args, 'header'), getArgNums(args, 'data'))
    table.sort(rownums)
    for k, num in ipairs(rownums) do
        addRow(root, args, {
            header = args['header' .. tostring(num)],
            label = args['label' .. tostring(num)],
            data = args['data' .. tostring(num)],
            datastyle = args.datastyle,
            class = args['class' .. tostring(num)],
            rowclass = args['rowclass' .. tostring(num)],
            rowstyle = args['rowstyle' .. tostring(num)],
            dataid = args['dataid' .. tostring(num)],
            labelid = args['labelid' .. tostring(num)],
            headerid = args['headerid' .. tostring(num)],
            rowid = args['rowid' .. tostring(num)]
        })
    end
end

local function renderNavBar(root, args)
    if not args.name then return end

    root
        :tag('tr')
            :tag('td')
                :attr('colspan', '2')
                :css('text-align', 'right')
                :wikitext(require('Module:Navbar')._navbar{
                    args.name,
                    mini = 1,
                })
end

local function renderItalicTitle(root, args)
    local italicTitle = args['italic title'] and mw.ustring.lower(args['italic title'])
    if italicTitle == '' or italicTitle == 'force' or italicTitle == 'yes' then
        root:wikitext(mw.getCurrentFrame():expandTemplate({title = 'italic title'}))
    end
end

local function renderTrackingCategories(root, args)
    if args.decat ~= 'yes' then
        if #(getArgNums(args, 'data')) == 0 and mw.title.getCurrentTitle().namespace == 0 then
            root:wikitext('[[Category:Articles which use infobox templates with no data rows]]')
        end
        if args.child == 'yes' and args.title then
            root:wikitext('[[Category:Pages which use embedded infobox templates with the title parameter]]')
        end
    end
end

function p.infobox(frame)
    local args = require('Module:Arguments').getArgs(frame, { wrappers = 'Template:Infobox', valueFunc = function(k, v)
    	if v ~= '' or k == 'italic title' then
    		return v
    	end
    end })

    -- Specify the overall layout of the infobox, with special settings
    -- if the infobox is used as a 'child' inside another infobox.
    local root
    if args.child ~= 'yes' then
        root = mw.html.create('table')

        root
            :addClass('infobox')
            :addClass(args.bodyclass)

            if args.subbox == 'yes' then
                root
                    :css('padding', '0')
                    :css('border', 'none')
                    :css('margin', '-3px')
                    :css('width', 'auto')
                    :css('min-width', '100%')
                    :css('font-size', '100%')
                    :css('clear', 'none')
                    :css('float', 'none')
                    :css('background-color', 'transparent')
            else
                root
                    :css('width', '22em')
            end
        root
            :cssText(args.bodystyle)

        renderTitle(root, args)
        renderAboveRow(root, args)
    else
        root = mw.html.create()

        root
            :wikitext(args.title)
    end

    renderSubheaders(root, args)
    renderImages(root, args)
    renderRows(root, args)
    renderBelowRow(root, args)
    renderNavBar(root, args)
    renderItalicTitle(root, args)
    renderTrackingCategories(root, args)

    return tostring(root)
end

return p
Retrieved from "https://zoophilia.wiki/index.php?title=Module:Infobox&oldid=66277"