Module:Infobox/Config/Documentation: Difference between revisions
< Module:Infobox | Config
PhantomCaleb (talk | contribs) No edit summary |
PhantomCaleb (talk | contribs) No edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
This page defines the parameters that infoboxes | 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. | 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. | ||
<noinclude>[[Category:Module Data Documentation]]</noinclude><includeonly>[[Category:Infobox configuration pages]]</includeonly> | {{Collapsible | ||
|header= Schema | |||
|content= {{#invoke:Documentation|Schema|ConfigBasePage|module= Module:Infobox/DocGen}} | |||
}} | |||
<noinclude>[[Category:Module Data Documentation]]</noinclude><includeonly>[[Category:Infobox configuration pages]]{{#invoke:Infobox/DocGen|ValidateBaseConfig}}</includeonly> | |||
Latest revision as of 19:46, 4 May 2024
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.
Schema
ConfigBasePagebaseParams- Defines the essential parameters that all infoboxes share.
optInParams- Defines parameters that are common across several infoboxes. Infobox configurations receive these parameters by setting an
optionproperty as defined below. <paramKey>- The string used in
optionsto 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.
options- Defines properties that can be used in infobox config to opt in to some of the paramers in
optInParams.