Template:Infobox/doc: Difference between revisions

For <code><nowiki>[[Template:Infobox sometopic]]</nowiki></code>, template code then looks like this, simplified:

{{Infobox

| name    = {{{name|{{PAGENAME}}}}}

... <!-- etc. -->

}}

== Optional control parameters ==

  | header = (the rest of the infobox goes here)

}}

{{Infobox

  | name = {{subst:PAGENAME}}

  | header = (the rest of the infobox goes here)

}}

{{Infobox

  | header = (the rest of the infobox goes here)

}}

{{Infobox

  | name = {{subst:PAGENAME}}

  | header = (the rest of the infobox goes here)

}}

=== Illustration images ===

To allow flexibility when the layout of an infobox is changed, it may be helpful when developing an infobox to use non-contiguous numbers for header and label/data rows. Parameters for new rows can then be inserted in future without having to renumber existing parameters. For example:

  | header3  = Section 1

  |  label5  = Label A

  |  label12 = Label D

  |  data12 = Data D

It is also possible to automatically renumber parameter names by using [[User:Frietjes/infoboxgap.js]] or [[Module:IncrementParams]].

A row with a label but no data is not displayed. This allows for the easy creation of optional infobox content rows. To make a row optional use a parameter that defaults to an empty string, like so:

  |  label5 = Population

  |  data5 = {{{population|}}}

This way if an article doesn't define the population parameter in its infobox the row won't be displayed.

For more complex fields with pre-formatted contents that would still be present even if the parameter wasn't set, you can wrap it all in an "#if" statement to make the whole thing vanish when the parameter is not used. For instance, the "#if" statement in the following example reads "#if:the parameter ''mass'' has been supplied |then display it, followed by 'kg'":

  |  label6 = Mass

  |  data6 = {{ #if: {{{mass|}}} | {{{mass}}} kg }}

For more on #if, see [[meta:ParserFunctions##if:|here]].

  |  label6 = label6 text |  data6 = Some value

}}

{{Infobox

  | title  = Example: header with & without data

  |  label6 = label6 text |  data6 = Some value

}}

If you want hide the header when no {{para|data''N''}} values are present, use '''{{para|autoheaders|y}}''':

}}

{{Infobox

  | title  = Example: header with & without data

}}

{{Infobox

  | title  = Example: header with & without data

To flag an infobox as containing [[hCard]] information, for example, add the following parameter:

  | bodyclass = vcard

And for each row containing a data cell that's part of the vcard, add a corresponding class parameter:

  | class1 = fn

  | class2 = org

  | class3 = tel

...and so forth. "above" and "title" can also be given classes, since these are usually used to display the name of the subject of the infobox.

  | below = Below text

}}

{{Infobox

  | title = Top level title

  | below = Below text

}}

Note, in the examples above, the child infobox is placed in a <code>data</code> field, not a <code>header</code> field.  Notice that the section subheadings are not in bold font if bolding is not explicitly specified. To obtain bold section headings, place the child infobox in a '''header''' field (but not in a '''label''' field because it would not be displayed!), either using

  | below = Below text

}}

{{Infobox

  | title = Top level title

  | below = Below text

}}

or,

  | below = Below text

}}

{{Infobox

  | title = Top level title

  | below = Below text

}}

Note that omitting the {{para|title}} parameter, and not including any text preceding the embedded infobox, may result in spurious blank table rows, creating gaps in the visual presentation. The garbage output can be suppressed using {{para|rowstyleN|display: none}}, replacing N with the data/header number.

(Note: there is no limit to the number of possible rows; only 20 are given below since infoboxes larger than that will be relatively rare. Just extend the numbering as needed. The microformat "class" parameters are also omitted as they are not commonly used.)

{{Infobox

| name          = {{subst:PAGENAME}}

| below          =  

}}

{{Help:Infobox/user style}}