Module:Infobox/doc

This is a documentation subpage for Module:Infobox. It contains usage information, categories, and other content that is not part of the original module page.

Module:Infobox requires Module:Edit button.

Module:Infobox requires Module:SMW Utils.

Module:Infobox requires strict.

Module:Infobox is required by 15 modules

1. Module:Infobox Class
2. Module:Infobox Emote
3. Module:Infobox Episode
4. Module:Infobox Item
5. Module:Infobox Monster
6. Module:Infobox NPC
7. Module:Infobox Profession
8. Module:Infobox Quest
9. Module:Infobox Room
10. Module:Infobox Scenery
11. Module:Infobox Shop
12. Module:Infobox Skill Node
13. Module:Infobox Spell
14. Module:Infobox Venture
15. Module:Param Parse

.

Creating a template step-by-step

Import Module:Infobox and Module:Param Parse

local Infobox = require('Module:Infobox')
local parse = require('Module:Param Parse')

Unpack the frame arguments from the Template

function p.main(frame)
	local args = frame:getParent().args
	...

Setup the Module config settings

	local config = {
		infobox_name = 'Scenery',
	}

Map your arguments to parsing functions

Main article: Module:Param Parse

Use the functions in Module:Param Parse to validate and format the data.

	local params = {
		{name = 'name', func = parse.has_content, smw_property = 'Name'},
		{name = 'image', func = parse.image, smw_property = 'Image', smw_func = parse.image_smw, category_incomplete = 'Scenery missing Image'},
		{name = 'examine', func = parse.has_content},
		{name = 'episode', func = parse.episode, smw_property = 'Episode', smw_func = parse.episode_smw, category_incomplete = 'Scenery missing Episode'},
 		...
	}

Define an Infobox object

Main article: Module:Infobox § new

	local infobox = Infobox.new(config, params, args)

Create your table

Main article: Module:Infobox § create

	infobox
		:add_row{
			{tag='th', content=Infobox.param('name'), class='infobox.subheader', colspan='2'},
		}
		:add_row{
			{tag='td', content=Infobox.param('image'), colspan='2'},
		}
		:pad(2)
		:add_row{
			{tag='td', content='[[Examine]]'},
			{tag='td', content=Infobox.param('examine')},
		}
		:add_row{
			{tag='td', content='[[Episode]]'},
			{tag='td', content=Infobox.param('episode')},
		}
		...

You're done!

	return infobox
end

Functions

Referring to params

Each parameter can have a different value for each version. In addition, there are 3 different representations of each value. Therefore, a parameter must be accessed via one of the 3 helper functions:

helper function	example	explanation
Infobox.raw_param(name)	"1000"	Raw value as passed by the Template
Infobox.param(name)	"1,000"	Value formatted for display in the Infobox
Infobox.smw_param(name)	1000	Value formatted to be saved as an SMW property

Infobox.new(config, params, args)

Creates a new infobox. Automatically parses the arguments, creates SMW subobjects and adds categories.

	local infobox = Infobox.new(config, params, args)

config

There are only 2 parameters for config

	local config = {
    	infobox_name = 'Scenery', -- mandatory unique identifier for css
    	max_buttons = 6, -- optional, defaults to 6, max number of switch buttons before using a dropdown list instead
	}

params

A list of parameters to be processed by the Infobox module

	local params = {
		{ name = <param>, func = <func>, ... },
		...
	}

key	value
name	parameter name as used in the Template
func	A function in Module:Param Parse to validate and process the Template argument. You can also use a local function, but this is not recommended. If func is a function, will call func(Infobox.raw_param(name)): {name = <param>, func = <func>, ... }, If func is a table, it takes the following parameters: {name = <param>, func = { name = <func>, params = <func_params>}, ... }, name function in Module:Param Parse params a list of parameters to pass the the function, in the form of constants, or Infobox.raw_param(name), Infobox.param(name), Infobox.smw_param(name)
empty (optional)	text to display in the infobox if func returns nil; defaults to "? (edit)"
category_never (optional)	category to add if func returns nil for all versions
category_partial (optional)	category to add if func returns nil for some versions, but a value for other versions
category_incomplete (optional)	category to add if func returns nil for at least 1 version (i.e. category_never and category_partial combined)
category_complete (optional)	category to add if func returns a value for all versions
smw_property (optional)	if this string is defined, the parameter will be saved into SMW
smw_func (optional)	function to validate and process the Template argument to save into SMW. func is used by default if smw_func is not defined

args

Arguments passed via the Template

	local args = frame:getParent().args

infobox:is_param_defined(param)

Used to conditionally display a line in the infobox

	infobox:add_row{
		{tag='th', content=Infobox.param('name'), class='infobox.subheader', colspan='2'},
	}
	if infobox:is_param_defined(Infobox.param('owner')) > 0 then
		infobox:add_row{
			{tag='td', content='[[Owner]]'},
			{tag='td', content=Infobox.param('owner')},
		}
	end

param	a parameter referenced via Infobox.raw_param(name), Infobox.param(name) or Infobox.smw_param(name)
Returns	0 if param is never defined 1 if param is defined for a fraction of the versions 2 if param is defined for all versions

Infobox:add_row(...)

Adds a row to the infobox table. Parameter should be a table of cells:

	infobox:add_row{
		{tag='td', content='[[Cell1]]', ...},
		{tag='td', content=Infobox.param('param'), ...},
		{tag='td', content='[[Cell3]]', ...},
        ...
        addClass = 'row-class'
	}

Each cell should have a set of key-values, of which only the tag and content are mandatory:

key	value
tag	'td' or 'th'
content	a string or Infobox.param(name), Infobox.raw_param(name), Infobox.smw_param(name)
attr (optional)	a table of attributes to add to the cell mw.html:attr({ arg1 = '1', ... })
css (optional)	a table of css to add to the cell mw.html:css({ arg1 = '1', ... })
class (optional)	a string with a class to add, or a table of classes to add. infobox-subheader is commonly used. mw.html:addClass(...)
rowspan (optional)	Set the cell rowspan mw.html:attr('rowspan',arg)
rowspan (optional)	Set the cell colspan mw.html:attr('colspan',arg)
title (optional)	Set the cell title mw.html:attr('title',arg)

Infobox:pad(colspan, class)

Adds a blank row of padding spanning the given number of columns. Will always add the class infobox-padding, but can optionally add another class:

	infobox:pad("10", class=<class>)

Infobox:addClass(class)

Adds a class to the entire table

	infobox:addClass(class)