Module:Infobox/Config/Documentation

From Zelda Wiki, the Zelda encyclopedia
Jump to navigation Jump to search

This is the documentation page for Module:Infobox/Config

This page defines the parameters that many infoboxes share.

The parameters for each specific infobox are declared on subpages of this page. These pages may opt in to (or opt out of) the parameters defined here. See Category:Infobox configuration pages for a list of such pages.

Schemahide ▲
ConfigBasePage
baseParams
Defines the essential parameters that all infoboxes share.
param
The name of the template parameter.
descr
A description of the parameter for the infobox template's documentation page.
optInParams
Defines parameters that are common across several infoboxes. Infobox configurations receive these parameters by setting a certain "opt-in" property to a certain value as defined in optInDefaults below.
<paramKey>
The string used in optInDefaults to reference a specific opt-in parameter.
param
The name of the template parameter corresponding to the infobox field.
[label]

The label for the infobox field, i.e. the header text displayed in the left column.

Can be left blank for special fields that have no label, where the value spans the width of the infobox.

descr
A description of the infobox field for the infobox template's documentation.
optInDefaults
Defines properties that can be used in infobox config to opt in to some of the paramers in optInParams.