(updated doc) |
No edit summary |
||
(4 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
{{Lua|Module:Navbar}} |
{{Lua|Module:Navbar}} |
||
{{Uses TemplateStyles|Module:InfoboxBuilder/styles.css}} |
{{Uses TemplateStyles|Module:InfoboxBuilder/styles.css}} |
||
This module creates an infobox using the builder pattern. All infoboxes using this module can be found at [[:Category:Infobox modules]]. |
|||
== Building an infobox == |
== Building an infobox == |
||
Line 218: | Line 220: | ||
<code>processingFn</code> should be a <code>function</code> or a <code>table</code> that transforms the raw value of the argument passed in. This value is optional. |
<code>processingFn</code> should be a <code>function</code> or a <code>table</code> that transforms the raw value of the argument passed in. This value is optional. |
||
A collection of predefined processing functions can be found at [[Module: |
A collection of predefined processing functions can be found at [[Module:ProcessingFunctions]]. |
||
;default |
;default |
||
Line 349: | Line 351: | ||
<code>displayFn</code> should be a <code>function</code> that transforms one or more processed arguments (based on <code>content</code> into something that can be displayed (ex. an HTML list). The order of the parameters in this function is the same as the order of <code>content</code>, if <code>content</code> is a <code>table</code>. This value is optional. |
<code>displayFn</code> should be a <code>function</code> that transforms one or more processed arguments (based on <code>content</code> into something that can be displayed (ex. an HTML list). The order of the parameters in this function is the same as the order of <code>content</code>, if <code>content</code> is a <code>table</code>. This value is optional. |
||
A collection of predefined display functions can be found at [[Module: |
A collection of predefined display functions can be found at [[Module:DisplayFunctions]]. |
||
;attr |
;attr |
||
Line 497: | Line 499: | ||
<code>displayFn</code> should be a <code>function</code> that transforms one or more processed arguments (based on <code>content</code> into something that can be displayed (ex. an HTML list). The order of the parameters in this function is the same as the order of <code>content</code>, if <code>content</code> is a <code>table</code>. This value is optional. |
<code>displayFn</code> should be a <code>function</code> that transforms one or more processed arguments (based on <code>content</code> into something that can be displayed (ex. an HTML list). The order of the parameters in this function is the same as the order of <code>content</code>, if <code>content</code> is a <code>table</code>. This value is optional. |
||
A collection of predefined display functions can be found at [[Module: |
A collection of predefined display functions can be found at [[Module:DisplayFunctions]]. |
||
;attr |
;attr |
||
Line 598: | Line 600: | ||
<small>[[#L-621|↓ Jump to definition]]</small> |
<small>[[#L-621|↓ Jump to definition]]</small> |
||
<includeonly>[[Category:Builder modules]]</includeonly> |
Latest revision as of 16:33, 19 October 2022
This is a documentation subpage for Module:InfoboxBuilder. It contains usage information, categories and other content that is not part of the original module page. |
This module depends on the following other modules: |
This module uses TemplateStyles: |
This module creates an infobox using the builder pattern. All infoboxes using this module can be found at Category:Infobox modules.
Building an infobox[edit source]
For an infobox to be built without errors, certain essential functions must be called before others. The following table details groups of functions and their priorities. The lower the number, the higher the priority. The functions setHeaderTextColor()
and setHeaderBackgroundColor()
are not required, but their CSS changes will not be applied if called later. In addition, the functions that add rows to the table, addHeader()
, addImage()
, and addRow()
are not all required, but is it recommended to use at least addHeader()
and addRow()
.
Priority | Functions |
---|---|
1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
|
Import the module[edit source]
local InfoboxBuilder = require('Module:InfoboxBuilder')
Unpack the frame arguments[edit source]
function p.main(frame)
local args = frame:getParent().args
...
Create the infobox object[edit source]
local infobox = InfoboxBuilder.new()
Set the infobox name[edit source]
Setting the infobox name sets the template that the infobox links to inside of the navbar.
infobox:setName('Infobox')
Define the parameters[edit source]
When defining the parameters, the arguments will be processed when given a function or table. fn
is an optional processing function or table that will transform the raw argument value into a specific format. An optional default value for the raw argument can be set using the default
option.
An example of using fn
would be to have fn
be a function that splits a comma separated list into a table in Lua.
infobox:setParams {
...
}
Pass in the arguments[edit source]
infobox:setArgs(args)
Process the arguments[edit source]
Processing the arguments will set default value (if it exists) and turn the raw argument passed in from setArgs(args) into a processed format for each parameter. This step is required or else the infobox will not work.
infobox:processArgs()
Specify a category map[edit source]
A category map can be optionally set. This uses the processed argument and generates the correct categories.
infobox:setCategoryMap({
...
})
Prepare[edit source]
Create the look of the infobox by adding headers, images, or rows. If the values shown in these cells use values from parameters, an optional postprocessing function or table fn
will transform the processed arguments for display purposes.
-- add a header or subheader
infobox:addHeader(
{...},
{...}
)
-- add an image
infobox:addImage(
{...},
{...}
)
-- add a row
infobox:addRow(
{...},
{...}
)
Build[edit source]
To build the infobox from data into an HTML table, call the tostring() function.
infobox:tostring()
Get the categories from the category map[edit source]
To get the categories, call the getCategories()
function.
infobox:getCategories()
Functions[edit source]
For the following functions, assume an InfoboxBuilder object called "infobox" already exists.
local infobox = InfoboxBuilder.new()
Public functions[edit source]
new[edit source]
This function is required.
InfoboxBuilder.new()
Creates a new InfoboxBuilder object.
setName[edit source]
This function is required.
This function is chainable.
infobox:setName(arg)
- arg
arg
should be a string
. Setting the infobox name will link the navbar to the correct template page and template talk page.
setHeaderTextColor[edit source]
This function is optional.
This function is chainable.
infobox:setHeaderTextColor(arg)
- arg
arg
should be a string
that contains a valid CSS color (hex code, rgb value, hsl value, etc.). Calling this function will change the color of the text in the infobox's headers and subheaders. The changes will not apply to headers added before this function is called, so it is recommended to call this function early.
setHeaderBackgroundColor[edit source]
This function is optional.
This function is chainable.
infobox:setHeaderBackgroundColor(arg)
- arg
arg
should be a string
that contains a valid CSS color (hex code, rgb value, hsl value, etc.). Calling this function will change the background color of the infobox's headers and subheaders. The changes will not apply to headers added before this function is called, so it is recommended to call this function early.
setParams[edit source]
This function is required.
This function is chainable.
infobox:setParams(...)
This function sets the valid parameters, their default values, and their formatting.
The arguments passed in should be tables of format:
{
name = <paramName>,
fn = <processingFn>,
default = <default>
}
- paramName
paramName
should be a valid string
that is unique. This name serves the key used to grab the raw values from the args
table passed in from setArgs()
. It also serves as the key for each parameter and will be referenced later.
- processingFn
processingFn
should be a function
or a table
that transforms the raw value of the argument passed in. This value is optional.
A collection of predefined processing functions can be found at Module:ProcessingFunctions.
- default
default
should be a string that serves as the default value if no raw value is present for the key in the args
table. This value is optional.
setArgs[edit source]
This function is required.
This function is chainable.
infobox:setArgs(args)
- args
args
should be a table
with key value pairs representing parameter names and values.
getRawArgs[edit source]
infobox:getRawArgs()
This function returns the "private" rawArgs
associative array containing the raw values passed in from setArgs()
.
getProcessedArgs[edit source]
infobox:getProcessedArgs()
This function returns the "private" procArgs
associative array after being processed.
getArgs[edit source]
infobox:getArgs(which)
- which
which
should be a string
that is either "raw" or "processed" for the raw argument values or processed argument values, respectively.
This function returns the "private" rawArgs
or procArgs
associative arrays depending on the value of which
.
setCategoryMap[edit source]
This function is optional.
This function is chainable.
infobox:setCategoryMap(catMap)
- catMap
catMap
should be a table
of table
s, where the key of the outer table corresponds with a parameter name and the key of the inner tables correspond with possible values of the associated parameter. The inner table values should be the category name related to each parameter value.
getCategories[edit source]
infobox:getCategories()
This function returns a string
with autogenerated categories in wikitext form.
processArgs[edit source]
This function is required.
This function is chainable.
infobox:processArgs()
This function processes the all the arguments passed in with the given processing functions defined when setting parameters.
addHeader[edit source]
This function is optional, but recommended.
This function is chainable.
infobox:addHeader(arg, options)
This functions adds a header or subheader to the infobox, depending on the option set.
- arg
arg
should be a table
of the following format:
{
tag = <tag>,
content = <content>,
fn = <displayFn>,
attr = <attr>,
colspan = <colspan>,
rowspan = <rowspan>,
css = <css>
}
- tag
tag
should be a string
of value "argth" or "th".
- content
When tag
is set to "th", content
should contain the wikitext that will show up.
When tag
is set to "argth", content
should be a string
or table
of parameter names. This value will be passed into displayFn
if it is set.
- displayFn
displayFn
should be a function
that transforms one or more processed arguments (based on content
into something that can be displayed (ex. an HTML list). The order of the parameters in this function is the same as the order of content
, if content
is a table
. This value is optional.
A collection of predefined display functions can be found at Module:DisplayFunctions.
- attr
attr
should be a table
containing HTML attributes. The value gets passed into the mw.html:attr() function. This value is optional.
- colspan
colspan
should be a number
or string
denoting the number of columns this header spans. This value is optional.
- rowspan
rowspan
should be a number
or string
denoting the number of rows this header spans. This value is optional.
- css
css
should be a table
of CSS names and values. The value gets passed into the mw.html:css() function. This value is optional.
- options
options
should be a table
of the following format:
{
hideIfEmpty = <hideIfEmpty>,
subheader = <subheader>
}
- hideIfEmpty
hideIfEmpty
should be a table
containing strings of parameter names. If all values for those parameters are empty, then the header or subheader is hidden. This value is optional.
- subheader
subheader
should be a boolean
denoting whether the header should be a subheader or not. The default value is false. This value is optional.
addImage[edit source]
This function is optional, but recommended.
This function is chainable.
infobox:addImage(cols, options)
This function adds a single image or multiple images inside of a row. For multiple images, it selectively hides all but one image using TabberNeue.
- cols
cols
should be a table
that is a numeric array. Each entry in this table should have the following format:
{
tag = <tag>,
content = <content>,
fn = <displayFn>,
tabName = <tabName>,
required = <required>
}
- tag
tag
should be a string
of value "argtd" or "td".
- content
When tag
is set to "td", content
should be a string
that shows up as the wikitext.
When tag
is set to "argtd", content
should be a string
or table
of parameter names. This value will be passed into displayFn
if it is set.
- displayFn
displayFn
should be a function
that transforms one or more processed arguments (based on content
into something that can be displayed (ex. an HTML list). The order of the parameters in this function is the same as the order of content
, if content
is a table
. This value is optional.
- tabName
tabName
should be a string
if there are multiple images. The value of this does nothing if there's only one image.
- required
required
should be a boolean
if the tab is required. This means that even if no value is provided, the tab will show up with a '?'.
- options
options
should be a table
of the following format:
{
hideIfEmpty = <hideIfEmpty>
}
- hideIfEmpty
hideIfEmpty
should be a table
containing strings of parameter names. If all values for those parameters are empty, then the image section is hidden. This value is optional.
addRow[edit source]
This function is optional, but recommended.
This function is chainable.
infobox:addRow(cols, options)
This function adds anywhere from 1 to 30 cells to a row. The colspan for each cell is automatically set to be evenly split so that all cells are the same width. The exception is when there are two cells, where the first cell spans 12 columns and the second cell spans 18 cells.
- cols
cols
should be a table
that is a numeric array. Each entry in this table should have the following format:
{
tag = <tag>,
content = <content>,
fn = <displayFn>,
attr = <attr>,
colspan = <colspan>,
rowspan = <rowspan>,
css = <css>,
class = <class>,
cssFns = <cssFns>,
classFns = <classFns>
}
- tag
tag
should be a string
of value "argth", "argtd", "th", or "td".
- content
When tag
is set to "td" or "th", content
should contain the wikitext that will show up.
When tag
is set to "argtd" or "argth", content
should be a string
or table
of parameter names. This value will be passed into displayFn
if it is set.
- displayFn
displayFn
should be a function
that transforms one or more processed arguments (based on content
into something that can be displayed (ex. an HTML list). The order of the parameters in this function is the same as the order of content
, if content
is a table
. This value is optional.
A collection of predefined display functions can be found at Module:DisplayFunctions.
- attr
attr
should be a table
containing HTML attributes. The value gets passed into the mw.html:attr() function. This value is optional.
- colspan
colspan
should be a number
or string
denoting the number of columns this header spans. This value is optional.
- rowspan
rowspan
should be a number
or string
denoting the number of rows this header spans. This value is optional.
- css
css
should be a table
of CSS names and values. The value gets passed into the mw.html:css() function. This value is optional.
- class
class
should be either a string
with a class name or table
(numeric array) containing class names. Each class name gets passed into the mw.html:addClass() function. This value is optional.
- cssFns
cssFns
should be a table
of functions. Each function takes the processed value of parameter content
as input and should output a valid CSS table
. This value only applies to cells with tag "argth" or "argtd". This value is optional.
- classFns
classFns
should be a table
of functions. Each function takes the processed value of parameter content
as input and should output a class name string
. This value only applies to cells with tag "argth" or "argtd". This value is optional.
- options
options
should be a table
of the following format:
{
hideIfEmpty = <hideIfEmpty>,
defaultCss = <defaultCss>
}
- hideIfEmpty
hideIfEmpty
should be a table
containing strings of parameter names. If all values for those parameters are empty, then the cell is hidden. This value is optional.
- defaultCss
defaultCss
should be a table
of CSS names and values. This CSS applies to all cells in this row. This value is optional.
tostring[edit source]
This function is required.
infobox:tostring()
This function "finishes" the infobox and returns an output HTML table with all styles automatically applied from Template:Infobox/styles.css. In order to generate an infobox, this function must be called.
Private functions[edit source]
While these are not necessarily "private", these functions are not intended to be called externally.
getContent[edit source]
infobox:getContent(paramName)
Gets the content for display for a specified parameter. If the value for a parameter has not been postprocessed, then the dFunc
for that parameter, if it exists, will be called.
shouldShow[edit source]
infobox:shouldShow(paramNames)
This is a helper function to tell if a certain cell should be visible depending on the parameter names given. If all values for the parameters given have no value, then a cell should not show.
addSpacer[edit source]
infobox:addSpacer()
This function sets up the 30 column layout by inserting an empty row. It also serves as a spacer.
addLinks[edit source]
infobox:addLinks()
This function adds the navbar at the end of the infobox. This navbar contains links to the template page and the template talk page for this infobox. This uses the page using the value passed in from the setName()
function.