Template:Infobox - Wikipedia

Template:Infobox - Wikipedia
Jump to content
Wikipedia ལས།
Template documentation
view
edit
history
purge
Not to be confused with
Template:Userbox
This template is used on
approximately
༣,༢༩༠,༠༠༠
pages, or roughly 57267% of all pages
To avoid major disruption and server load, any changes should be tested in the template's
/sandbox
or
/testcases
subpages, or in your own
user subpage
. The tested changes can be added to this page in a single edit. Consider discussing changes on the
talk page
before implementing them.
This template uses
Lua
Module:Infobox
sandbox
title
above
subheader
{{{subheader2}}}
......
image
caption
image2
{{{caption2}}}
......
{{{header1}}}
or
{{{label1}}}
{{{data1}}}
or
{{{data1}}}
{{{header2}}}
or
{{{label2}}}
{{{data2}}}
or
{{{data2}}}
etc
below
Template:Infobox
is intended as a meta template: a template used for constructing other templates.
Note
: In general, it is not meant for use directly in an article, but can be used on a one-off basis if required.
Help:Infobox
contains an introduction about the recommended content and design of infoboxes;
Wikipedia:Manual of Style/Infoboxes
contains additional style guidelines. See
WP:List of infoboxes
and
Category:Infobox templates
for lists of prepared topic-specific infoboxes.
Usage
ཞུན་དག
Infobox
is a meta-template: used to organise an actual {{Infobox sometopic}} template (like
Infobox building
).
For
[[Template:Infobox sometopic]]
, template code then looks like this, simplified:
{{
Infobox
name
{{{
name
|{{
PAGENAME
}}}}}
image
{{{
image
|}}}
caption1
{{{
caption
|}}}
label1
Former names
data1
{{{
former_names
|}}}
header2
General information
label3
Status
data3
{{{
status
|}}}
...

}}
Optional control parameters
ཞུན་དག
name
If this parameter is present, "view, talk and edit" links will be added to the bottom of the infobox pointing to the named page, prefixed by
Template:
if no namespace is specified. You may use the value {{subst:PAGENAME}}; however, this is rarely what you want because it will send users clicking these links in an infobox to the template code rather than the data in the infobox they probably want to change.
child
See the
Embedding
section for details. If this is set to "yes", this child infobox should be titled but have no name parameter. This parameter is empty by default, set it to "yes" to activate it.
subbox
See the
Subboxes
section for details. If this is set to "yes", this subbox should be titled but have no name parameter. This parameter is empty by default, set to "yes" to activate it. It has no effect if the
child
parameter is also set to "yes".
decat
If this is set to "yes", the current page will not be autocategorized in a maintenance category when the generated infobox has some problems or no visible data section. Leave empty by default or set to "yes" to activate it.
autoheaders
If this is set to any non-blank value, headers which are not followed by data fields are suppressed. See the "
hiding headers when all its data fields are empty
" section for more details.
Content parameters
ཞུན་དག
Title
ཞུན་དག
There are two different ways to put a title on an infobox. One contains the title inside the infobox's border in the uppermost cell of the table, the other puts it as a caption on top of the table. You can use them both together, or just one or the other, or neither (though this is not recommended):
title
Text to put in the caption over the top of the table (or as section header before the whole content of this table, if this is a child infobox). For
accessibility reasons
, this is the most recommended alternative.
above
Text to put within the uppermost cell of the table.
subheader(n)
additional title fields which fit below
title
} and
above
}, but before images.
Examples:
Text in caption over infobox
Subheader of the infobox
{{
Infobox
name
{{
subst
PAGENAME
}}
title
Text in caption over infobox
subheader
Subheader of the infobox
header
(the rest of the infobox goes here)
}}
Text in uppermost cell of infobox
Subheader of the infobox
Second subheader of the infobox
{{
Infobox
name
{{
subst
PAGENAME
}}
above
Text in uppermost cell of infobox
subheader
Subheader of the infobox
subheader2
Second subheader of the infobox
header
(the rest of the infobox goes here)
}}
Illustration images
ཞུན་དག
image(n)
images to display at the top of the template. Use full image syntax, for example [[File:example.png|200px|alt=Example alt text]]. Image is centered by default. See
WP:ALT
for more on alt text.
caption(n)
Text to put underneath the images.
Main data
ཞུན་དག
header(n)
Text to use as a header in row n.
label(n)
Text to use as a label in row n.
data(n)
Text to display as data in row n.
Note: for any given value for (n), not all combinations of parameters are permitted. The presence of a
header
(n)
will cause the corresponding
data
(n)
(and
rowclass
(n)
label
(n)
, see below) to be ignored; the absence of a
data
(n)
will cause the corresponding
label
(n)
to be ignored. Valid combinations for any single row are:
class
(n)
header
(n)
rowclass
(n)
class
(n)
data
(n)
rowclass
(n)
label
(n)
class
(n)
data
(n)
See the rendering of header4, label4, and data4 in the
Examples
section below.
Number ranges
ཞུན་དག
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
| data5 = Data A
| label7 = Label C
| data7 = Data C
| header10 = Section 2
| label12 = Label D
| data12 = Data D
It is also possible to automatically renumber parameter names by using
User:Frietjes/infoboxgap.js
or
Module:IncrementParams
There is no upper limit on numbers but there must be at most 50 between each used number.
Making data fields optional
ཞུན་དག
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
here
Hiding headers when all its data fields are empty
ཞུན་དག
You can also make headers automatically hide when their section is empty (has no data-row showing).
Consider this situation:
Example: header with & without data
Header1 with empty section
Header5 with data below
label6 text
Some value
{{
Infobox
title
Example: header with & without data
headerstyle
background: lightgrey
header1
Header1 with empty section
label2
label2 text
data2
label3
label3 text
data3
label4
label4 text
data4
header5
Header5 with data below
label6
label6 text
data6
Some value
}}
If you want hide the header when no
data
values are present, use
autoheaders
Example: header with & without data
Header5 with data below
label6 text
Some value
{{
Infobox
title
Example: header with & without data
autoheaders
headerstyle
background: lightgrey
header1
Header1 with empty section
label2
label2 text
data2
label3
label3 text
data3
label4
label4 text
data4
header5
Header5 with data below
label6
label6 text
data6
Some value
}}
So, header1 will be shown if any of item1, item2, or item3 is defined. If none of the three parameters are defined the header won't be shown and no empty row appears before the next visible content.
Note: if the data has empty css elements, like
data
span style="background:yellow;">
/span>
, this will be treated as non-empty (having data).
If
autoheaders
but there are items that you
do not
want to trigger a header, place
headerX
_BLANK_
. This will serve as an empty header and separate it from the subsequent items.
Example: blank header with & without data
label6 text
Some value, but does not trigger header1 or show header5
{{
Infobox
title
Example: header with & without data
autoheaders
headerstyle
background: lightgrey
header1
Header1 with empty section
label2
label2 text
data2
label3
label3 text
data3
label4
label4 text
data4
header5
_BLANK_
label6
label6 text
data6
Some value, but does not trigger header1 or show header5
}}
Footer
ཞུན་དག
below
Text to put in the bottom cell. The bottom cell is intended for footnotes, see-also, and other such information.
Presentation parameters
ཞུན་དག
Italic titles
ཞུན་དག
Titles of articles with infoboxes may be made italic, in line with
WP:ITALICTITLE
, by passing the
italic title
parameter.
Turn on italic titles by passing
italic title
{{{italic title|}}}
from the infobox.
Turn off by default (notably because only Latin script may be safely rendered in this style and italic may be needed to distinguish foreign language from local English language only in that script, but would be difficult to read for other scripts) but allow some instances to be made italic by passing
italic title
{{{italic title|no}}}
Do not make any titles italic by not passing the parameter at all.
CSS styling
ཞུན་དག
bodystyle
Applies to the infobox table as a whole
titlestyle
Applies only to the title caption. Adding a background color is usually inadvisable since the text is rendered "outside" the infobox.
abovestyle
Applies only to the "above" cell at the top. The default style has font-size:125%; since this cell is usually used for a title, if you want to use the above cell for regular-sized text include "font-size:100%;" in the abovestyle.
imagestyle
Applies to the cell the image is in. This includes the text of the image caption, but you should set text properties with captionstyle instead of imagestyle in case the caption is moved out of this cell in the future.
captionstyle
Applies to the text of the image caption.
rowstyle(n)
This parameter is inserted into the
style
attribute for the specified row.
headerstyle
Applies to all header cells
subheaderstyle
Applies to all subheader cells
labelstyle
Applies to all label cells
datastyle
Applies to all data cells
belowstyle
Applies only to the below cell
HTML classes and microformats
ཞུན་དག
bodyclass
This parameter is inserted into the
class
attribute for the infobox as a whole.
titleclass
This parameter is inserted into the
class
attribute for the infobox's
title
caption.
aboveclass
This parameter is inserted into the
class
attribute for the infobox's
above
cell.
subheaderrowclass(n)
This parameter is inserted into the
class
attribute for the complete table row the
subheader
is on.
subheaderclass(n)
This parameter is inserted into the
class
attribute for the infobox's
subheader
imagerowclass(n)
These parameters are inserted into the
class
attribute for the complete table row their respective
image
is on.
imageclass
This parameter is inserted into the
class
attribute for the
image
rowclass(n)
This parameter is inserted into the
class
attribute for the specified row including the
label
and
data
cells.
class(n)
This parameter is inserted into the
class
attribute for the
data
cell of the specified row. If there's no
data
cell it has no effect.
belowclass
This parameter is inserted into the
class
attribute for the infobox's
below
cell.
This template supports the addition of microformat information. This is done by adding "class" attributes to various data cells, indicating what kind of information is contained within. Multiple class names may be specified, separated by spaces, some of them being used as selectors for custom styling according to a project policy or to the skin selected in user preferences, others being used for microformats.
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.
See
Wikipedia:WikiProject Microformats
for more information on adding microformat information to Wikipedia, and
microformat
for more information on microformats in general.
Examples
ཞུན་དག
Notice how the row doesn't appear in the displayed infobox when a
label
is defined without an accompanying
data
cell, and how all of them are displayed when a
header
is defined on the same row as a
data
cell. Also notice that
subheaders
are not bold by default like the
headers
used to split the main data section, because this role is meant to be for the
above
cell
Test Infobox
Above text
Subheader above image
Second subheader
Caption displayed below File:Example-serious.jpg
Header defined alone
Data defined alone
All three defined (header, label, data, all with same number)
Label and data defined (label)
Label and data defined (data)
Below text
{{
Infobox
name
Infobox/doc
bodystyle
titlestyle
abovestyle
background: #cfc;
subheaderstyle
title
Test Infobox
above
Above text
subheader
Subheader above image
subheader2
Second subheader
imagestyle
captionstyle
image
[[
File
Example-serious.jpg
200px
alt
Example alt text
]]
caption
Caption displayed below File:Example-serious.jpg
headerstyle
background: #ccf;
labelstyle
background: #ddf;
datastyle
header1
Header defined alone
label1
data1
header2
label2
Label defined alone does not display (needs data, or is suppressed)
data2
header3
label3
data3
Data defined alone
header4
All three defined (header, label, data, all with same number)
label4
does not display (same number as a header)
data4
does not display (same number as a header)
header5
label5
Label and data defined (label)
data5
Label and data defined (data)
belowstyle
background: #ddf;
below
Below text
}}
For this example, the
bodystyle
and
labelstyle
parameters are used to adjust the infobox width and define a default width for the column of labels:
Test Infobox
Label 1
Data 1
Label 2
Data 2
Label 3
Data 3
Header 4
Label 5
Data 5: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Below text
{{
Infobox
name
Infobox/doc
bodystyle
width: 20em
titlestyle
title
Test Infobox
headerstyle
labelstyle
width: 33%
datastyle
header1
label1
Label 1
data1
Data 1
header2
label2
Label 2
data2
Data 2
header3
label3
Label 3
data3
Data 3
header4
Header 4
label4
data4
header5
label5
Label 5
data5
Data 5: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
belowstyle
below
Below text
}}
Embedding
ཞུན་དག
One infobox template can be embedded into another using the
child
parameter. This feature can be used to create a modular infobox, or to create better-defined logical sections. Long ago, it was necessary to use embedding in order to create infoboxes with more than 99 rows; but nowadays there's no limit to the number of rows that can be defined in a single instance of
{{infobox}}
Top level title
First subsection
Label 1.1
Data 1.1
Second subsection
Label 2.1
Data 2.1
Below text
{{
Infobox
title
Top level title
data1
{{
Infobox
decat
yes
child
yes
title
First subsection
label1
Label 1.1
data1
Data 1.1
}}
data2
{{
Infobox
decat
yes
child
yes
title
Second subsection
label1
Label 2.1
data1
Data 2.1
}}
belowstyle
below
Below text
}}
Note, in the examples above, the child infobox is placed in a
data
field, not a
header
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
Top level title
First subsection
Label 1.1
Data 1.1
Second subsection
Label 2.1
Data 2.1
Below text
{{
Infobox
title
Top level title
header1
{{
Infobox
decat
yes
child
yes
title
First subsection
label1
Label 1.1
data1
Data 1.1
}}
header2
{{
Infobox
decat
yes
child
yes
title
Second subsection
label1
Label 2.1
data1
Data 2.1
}}
belowstyle
below
Below text
}}
or,
Top level title
First subsection
Label 1.1
Data 1.1
Second subsection
Label 2.1
Data 2.1
Below text
{{
Infobox
title
Top level title
header1
First subsection
{{
Infobox
decat
yes
child
yes
label1
Label 1.1
data1
Data 1.1
}}
header2
Second subsection
{{
Infobox
decat
yes
child
yes
label1
Label 2.1
data1
Data 2.1
}}
belowstyle
below
Below text
}}
Note that omitting the
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
rowstyleN
display: none
, replacing N with the data/header number.
Wikipedia:WikiProject Infoboxes/embed
includes some links to Wikipedia articles which include infoboxes embedded within other infoboxes.
Subboxes
ཞུན་དག
An alternative method for embedding is to use
subbox
yes
, which removes the outer border from the infobox, but preserves the interior structure. One feature of this approach is that the parent and child boxes need not have the same structure, and the label and data fields are not aligned between the parent and child boxes because they are not in the same parent table.
Main 1
Main 2
Sub 3-1
Sub 3-2
Label 3-3
Data 3-3
Label 4-1
Data 4-1
Label 5
Data 5
Main 6
{{
Infobox
headerstyle
background-color: #eee;
labelstyle
background-color: #eee;
header1
Main 1
header2
Main 2
data3
{{
Infobox
subbox
yes
headerstyle
background-color: #ccc;
labelstyle
background-color:#ddd;
header1
Sub 3-1
header2
Sub 3-2
label3
Label 3-3
data3
Data 3-3
}}
data4
{{
Infobox
subbox
yes
labelstyle
background-color: #ccc;
label1
Label 4-1
data1
Data 4-1
}}
label5
Label 5
data5
Data 5
header6
Main 6
}}
Similar embedding techniques may be used within content parameters of some other templates generating tables (such as
Sidebar
):
Heading 1
Heading 2
Sub 3-1
Sub 3-2
Label 3-3
Data 3-3
Label 4-1
Data 4-1
Heading 5
{{
Sidebar
navbar
off
headingstyle
background-color: #eee;
heading1
Heading 1
heading2
Heading 2
content3
{{
Infobox
subbox
yes
headerstyle
background-color: #ccc;
labelstyle
background-color: #ddd;
header1
Sub 3-1
header2
Sub 3-2
label3
Label 3-3
data3
Data 3-3
}}
content4
{{
Infobox
subbox
yes
labelstyle
background-color: #ccc;
label1
Label 4-1
data1
Data 4-1
}}
heading5
Heading 5
}}
Note that the default padding of the parent data cell containing each subbox is still visible, so the subboxes are slightly narrower than the parent box and there's a higher vertical spacing between standard cells of the parent box than between cells of distinct subboxes.
Controlling line-breaking in embedded bulletless lists
ཞུན་དག
Template
nbsp
may be used with
wbr
and
nowrap
to control line-breaking in bulletless lists embedded in infoboxes (e.g. cast list in
Infobox film
), to prevent wrapped long entries from being confused with multiple entries. See
Template:Wbr/doc#Controlling line-breaking in infoboxes
for details.
Full blank syntax
ཞུན་དག
(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
}}
child
{{{
child
|}}}
subbox
{{{
subbox
|}}}
italic title
{{{
italic title
no
}}}
templatestyles
child templatestyles
grandchild templatestyles
bodystyle
titlestyle
abovestyle
subheaderstyle
title
above
subheader
imagestyle
captionstyle
image
caption
image2
caption2
headerstyle
labelstyle
datastyle
header1
label1
data1
header2
label2
data2
header3
label3
data3
header4
label4
data4
header5
label5
data5
header6
label6
data6
header7
label7
data7
header8
label8
data8
header9
label9
data9
header10
label10
data10
header11
label11
data11
header12
label12
data12
header13
label13
data13
header14
label14
data14
header15
label15
data15
header16
label16
data16
header17
label17
data17
header18
label18
data18
header19
label19
data19
header20
label20
data20
belowstyle
below
}}
Help:Infobox/user style
Porting to other MediaWikis
ཞུན་དག
The infobox template requires the
Scribunto
and
TemplateStyles
extensions.
WikiProject Transwiki
has a version of this template that has been modified to work on other MediaWikis.
TemplateData
ཞུན་དག
This is the
TemplateData
for this template used by
TemplateWizard
VisualEditor
and other tools.
See a monthly parameter usage report
for
Template:Infobox
in articles
based on its TemplateData.
TemplateData for Infobox
Template parameters
Edit template data
This template has custom formatting.
Parameter
Description
Type
Status
name
name
Unknown
optional
child
child
Unknown
optional
subbox
subbox
Unknown
optional
italic title
italic title
Unknown
optional
templatestyles
templatestyles
Unknown
optional
child templatestyles
child templatestyles
Unknown
optional
grandchild templatestyles
grandchild templatestyles
Unknown
optional
bodystyle
bodystyle
Unknown
optional
titlestyle
titlestyle
Unknown
optional
abovestyle
abovestyle
Unknown
optional
subheaderstyle
subheaderstyle
Unknown
optional
Title
title
Title displayed above the infobox
String
suggested
above
above
Unknown
optional
subheader
subheader
Unknown
optional
imagestyle
imagestyle
Unknown
optional
captionstyle
captionstyle
Unknown
optional
Image
image
Image illustrating the topic. Use full image syntax.
Example
[[File:example.png|200px|alt=Example alt text]]
Content
suggested
Caption
caption
caption for the image
Content
suggested
image2
image2
Unknown
optional
caption2
caption2
Unknown
optional
headerstyle
headerstyle
Unknown
optional
labelstyle
labelstyle
Unknown
optional
datastyle
datastyle
Unknown
optional
header1
header1
Unknown
optional
label1
label1
Unknown
optional
data1
data1
Unknown
optional
header2
header2
Unknown
optional
label2
label2
Unknown
optional
data2
data2
Unknown
optional
header3
header3
Unknown
optional
label3
label3
Unknown
optional
data3
data3
Unknown
optional
header4
header4
Unknown
optional
label4
label4
Unknown
optional
data4
data4
Unknown
optional
header5
header5
Unknown
optional
label5
label5
Unknown
optional
data5
data5
Unknown
optional
header6
header6
Unknown
optional
label6
label6
Unknown
optional
data6
data6
Unknown
optional
header7
header7
Unknown
optional
label7
label7
Unknown
optional
data7
data7
Unknown
optional
header8
header8
Unknown
optional
label8
label8
Unknown
optional
data8
data8
Unknown
optional
header9
header9
Unknown
optional
label9
label9
Unknown
optional
data9
data9
Unknown
optional
header10
header10
Unknown
optional
label10
label10
Unknown
optional
data10
data10
Unknown
optional
header11
header11
Unknown
optional
label11
label11
Unknown
optional
data11
data11
Unknown
optional
header12
header12
Unknown
optional
label12
label12
Unknown
optional
data12
data12
Unknown
optional
header13
header13
Unknown
optional
label13
label13
Unknown
optional
data13
data13
Unknown
optional
header14
header14
Unknown
optional
label14
label14
Unknown
optional
data14
data14
Unknown
optional
header15
header15
Unknown
optional
label15
label15
Unknown
optional
data15
data15
Unknown
optional
header16
header16
Unknown
optional
label16
label16
Unknown
optional
data16
data16
Unknown
optional
header17
header17
Unknown
optional
label17
label17
Unknown
optional
data17
data17
Unknown
optional
header18
header18
Unknown
optional
label18
label18
Unknown
optional
data18
data18
Unknown
optional
header19
header19
Unknown
optional
label19
label19
Unknown
optional
data19
data19
Unknown
optional
header20
header20
Unknown
optional
label20
label20
Unknown
optional
data20
data20
Unknown
optional
belowstyle
belowstyle
Unknown
optional
below
below
Unknown
optional
Tracking categories
ཞུན་དག
Category:Articles with missing Wikidata information
(༠)
Category:Articles using infobox templates with no data rows
(༦)
Category:Pages using embedded infobox templates with the title parameter
(༡)
See also
ཞུན་དག
Module:Infobox
, the
Lua
module on which this template is based
Module:Check for unknown parameters
Infobox3cols
Navbox
and
Sidebar
List of infoboxes
Module:InfoboxImage
The above
documentation
is
transcluded
from
Template:Infobox/doc
edit
history
Editors can experiment in this template's
sandbox
edit
diff
and
testcases
edit
pages.
Add categories to the
/doc
subpage.
Subpages of this template
" ལས་ སླར་འདྲེན་འབད་ཡོདཔ།
སྡེ་ཚན་ ༩
Lua-based templates
དཔེ་པང་།
Sidebars with styles needing conversion
Templates using TemplateData
Infobox templates
Wikipedia metatemplates
Templates generating microformats
Templates that add a tracking category
Templates based on the Infobox Lua module
Template
Infobox
Add topic