1,588
edits
Changes
m
{{documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
To insert an image somewhere other than at the top of the infobox, or to insert freeform data, use a row with only a data field| label3 = Status| data3 = {{{status|}}}... <!-- etc. -->}}</pre>
=== Optional control parameters ===
=== Content parameters ===
==== Title ====
==== Illustration images ====; image(n) : images to display at the top of the template. Use full image syntax, for example <nowiki>[[File:example.png|200px|alt=Example alt text]]</nowiki>. Image is centered by default. See [[WP:ALT]] for more on alt text. Image parameters should not be numbered more than 10 apart.
==== Main data ====; header(n) : Text to use as a header in row n. Header and data parameters should not be numbered more than 50 apart.
===== Number ranges =====
Note that although there is no limitation on the number of rows available, row parameters should not be numbered more than 50 apart. See the [[#Limitations]] section below for more details. ===== Making data fields optional =====
===== Hiding headers when all data fields are hidden =====
==== Footer ====
=== Presentation parameters ===
==== Italic titles ====
==== CSS styling ====
==== HTML classes and microformats ====; bodyclass : This parameter is inserted into the <code>class</code> attribute for the infobox as a whole.; titleclass : This parameter is inserted into the <code>class</code> attribute for the infobox's '''title''' caption.
=== Examples ===
=== Embedding ===
=[[Wikipedia:WikiProject Infoboxes/embed]] includes some links to Wikipedia articles which include infoboxes embedded within other infoboxes. == Subboxes ===
=== Limitations ===Previously, the number of rows available to this template was limited to 99. This restriction has been lifted now that the template has been ported to a [[WP:Lua|Lua module]], but to maintain backwards compatibility there is now a limit on the number of rows apart by which parameters will be detected. If parameters are numbered more than 50 apart, the later parameters may be ignored (depending on the exact numbers involved), and if parameters are numbered more than 100 apart, the later parameters will definitely be ignored. For example, this code will display properly: {{Infobox | header3 = Section 1 | label48 = Label A | data48 = Data A | data92 = Data B | label136 = Label C | data136 = Data C | header177 = Section 2 | label215 = Label D | data215 = Data D}}<div style="overflow:auto"> <nowiki>{{</nowiki>Infobox | header<b style="color:black;background:#AFA">3</b> = Section 1 | label<b style="color:black;background:#AFA">48</b> = Label A | data<b style="color:black;background:#AFA">48</b> = Data A | data<b style="color:black;background:#AFA">92</b> = Data B | label<b style="color:black;background:#AFA">136</b> = Label C | data<b style="color:black;background:#AFA">136</b> = Data C | header<b style="color:black;background:#AFA">177</b> = Section 2 | label<b style="color:black;background:#AFA">215</b> = Label D | data<b style="color:black;background:#AFA">215</b> = Data D <nowiki>}}</nowiki></div>{{clear}} But in this code, only Section 1, Label A and Data A will be displayed, because Data B is numbered too far away from Data A (and then all the rest is ignored): {{Infobox | header3 = Section 1 | label48 = Label A | data48 = Data A | data102 = Data B | label103 = Label C | data103 = Data C | header115 = Section 2 | label120 = Label D |data120 = Data D}}<div style="overflow:auto"> <nowiki>{{</nowiki>Infobox | header<b style="color:black;background:#AFA">3</b> = Section 1 | label<b style="color:black;background:#AFA">48</b> = Label A | data<b style="color:black;background:#AFA">48</b> = Data A | data<b style="color:black;background:#FAA">102</b> = Data B | label<b style="color:black;background:#AFA">103</b> = Label C | data<b style="color:black;background:#AFA">103</b> = Data C | header<b style="color:black;background:#AFA">115</b> = Section 2 | label<b style="color:black;background:#AFA">120</b> = Label D | data<b style="color:black;background:#AFA">120</b> = Data D <nowiki>}}</nowiki></div>{{clear}} Note that parameter values may be blank - parameters are counted unless they are completely absent, in header() and data(n), from the template invocation: {{Infobox | header3 = Section 1 | label48 = Label A | data48 = Data A | data70 = | data102 = Data B | label103 = Label C | data103 = Data C | header115 = Section 2 | label120 = Label D |data120 = Data D}}<div style="overflow:auto"> <nowiki>{{</nowiki>Infobox | header<b style="color:black;background:#AFA">3</b> = Section 1 | label<b style="color:black;background:#AFA">48</b> = Label A | data<b style="color:black;background:#AFA">48</b> = Data A | data<b style="color:black;background:#AFA">70</b> = | data<b style="color:black;background:#AFA">102</b> = Data B | label<b style="color:black;background:#AFA">103</b> = Label C | data<b style="color:black;background:#AFA">103</b> = Data C | header<b style="color:black;background:#AFA">115</b> = Section 2 | label<b style="color:black;background:#AFA">120</b> = Label D | data<b style="color:black;background:#AFA">120</b> = Data D <nowiki>}}</nowiki></div>{{clear}} If only '''label(n)''' is specified (even with a non-empty value) but neither '''header(n)''' nor '''data(n)''', the parameter is ignored and considered as if it was missing: {{Infobox | header3 = Section 1 | label48 = Label A | data48 = Data A | label70 = Dummy label | data102 = Data B | label103 = Label C | data103 = Data C | header115 = Section 2 | label120 = Label D |data120 = Data D}}<div style="overflow:auto"> <nowiki>{{</nowiki>Infobox | header<b style="color:black;background:#AFA">3</b> = Section 1 | label<b style="color:black;background:#AFA">48</b> = Label A | data<b style="color:black;background:#AFA">48</b> = Data A | <b style="color:black;background:#FAA">label70</b> = Dummy label | data<b style="color:black;background:#AFA">102</b> = Data B | label<b style="color:black;background:#AFA">103</b> = Label C | data<b style="color:black;background:#AFA">103</b> = Data C | header<b style="color:black;background:#AFA">115</b> = Section 2 | label<b style="color:black;background:#AFA">120</b> = Label D | data<b style="color:black;background:#AFA">120</b> = Data D <nowiki>}}</nowiki></div>{{clear}} There are also similar limitations for '''image(n)''' and '''subheader(n)''' parameters: in those cases, parameters should not be numbered more than 10 apart. === Porting to other MediaWikis ===
===See also===* [[Module:Infobox]], the [[WP:LUA|Lua]] module on which this template is based.* [https://en.wikipedia.org/w/index.php?title=Template[Special:InfoboxPermalink/old&oldid=558855956 |Template:Infobox/old]], the previous ParserFunctions implementation.* [[Module:Check for unknown parameters]]
427 revisions imported
{{distinguish|Template:Userbox}}
{{Documentation subpage}}<includeonly>{{#ifeq: {{#titleparts: {{PAGENAME}} | 1 | 2 }} | old | <!-- null --> | {{highHigh-riskuse|23,000,000+}}{{luaLua|Module:Infobox}} }}</includeonly>{{Parameter names example |name={{PAGENAME}} <!--|child |subbox |decat--> |title |above |subheader |subheader1 |subheader2={{{subheader2}}}<br/>...... |image|caption |image1|caption1 |image2|caption2={{{caption2}}}<br/>...... |header1=<div style="border-top:1px dashed #ccc;">{{{header1}}}<br/>{{nobold|( ''or'' )}}</div> |label2={{{label1}}} |data2={{{data1}}} |data3=( ''or'' ) |data4=<div style="padding-bottom:0.25em;border-bottom:1px dashed #ccc;">{{{data1}}}</div> |header5={{{header2}}}<br/><div style="padding:0.75em 0 0.5em;">{{nobold|( ''or'' )}}</div> |label6={{{label2}}} |data6={{{data2}}} |data7=( ''or'' ) |data8=<div style="padding-bottom:0.25em;border-bottom:1px dashed #ccc;">{{{data2}}}</div> |data9=<div style="padding:0.75em 0 0.5em;">( ''etc'' )</div> |below}} This template is intended as a meta-template: a template used for constructing other templates. It '''Note''': In general, it is not meant for use directly in an article, but can be used on a one-off basis if required. See [[Help:Infobox]] for contains an introduction to infoboxes about the recommended content and information on how to design themof 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 infobox templatesinfoboxes. == Usage =={{tlf|Infobox}} is a meta-template: used to organise an actual <nowiki>{{Infobox sometopic}}</nowiki> template (like {{tl|Infobox building}}). For <code><nowiki>[[Template:Infobox sometopic]]</nowiki></code>, template code then looks like this, simplified:<pre>{{Infobox| name = {{{name|{{PAGENAME}}}}}| image = {{{image|}}}| caption1 = {{{caption|}}}}}} | label1 = Former names| data1 = {{{former_names|}}}
| header2 === Usage ===Usage is similar to {{tl|navbox}}, but with an additional distinction. Each row on the table can contain either a header, or a label/data pair, or just a data cell. These are mutually exclusive states so if you define a row with both a header and a label/data pair, the label/data pair is ignored.General information
; name : If this parameter is present, "view/discuss/edit" links will be added to the bottom of the infobox, pointing to the named page. You may use the value <nowiki>{{subst:PAGENAME}}</nowiki>; however this is rarely what you want, because it will send users clicking these links in an infobox in an article to the template code rather than the data in the infobox that they probably want to change.
; child : See the [[#Embedding|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.
; 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.
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 as a caption it on top of the table. You can use both of them together if you like, or just one or the other, or even 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 [[Wikipedia:Manual of Style/Accessibility#Tables|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. Subheader parameters should not be numbered more than 10 apart.
Examples:
</pre>{{clear}}
; caption(n) : Text to put underneath the images.
; label(n) : Text to use as a label in row n.
; data(n) : Text to display as data in row n. Header and data parameters should not be numbered more than 50 apart.
Note: for any given value for (n), not all combinations of parameters are permitted. The presence of a {{para|header''(n)''}} will cause the corresponding {{para|data''(n)''}} (and {{para|rowclass''(n)''}} {{para|label''(n)''}}, see below) to be ignored; the absence of a {{para|data''(n)''}} will cause the corresponding {{para|label''(n)''}} to be ignored. Valid combinations for any single row are:
See the rendering of header4, label4, and data4 in the [[#Examples|Examples]] section below.
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:
</pre>{{clear}}
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:
For more on #if, see [[meta:ParserFunctions##if:|here]].
You can also make headers optional in a similar way. Consider this example:
{{Infobox
| label6 = Static item | data6 = Static value
}}
<pre source lang="moin" style="overflow:auto">
{{Infobox
| title = Example of an optional header
| label6 = Static item | data6 = Static value
}}
</presource>{{clear}}
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 emty empty row appears before the next static content. The trick to this is that the "<code>#if" </code> returns false only if there is nothing whatsoever in the conditional section, so only if all three of item1, item2 and item3 are undefined will the if statement fail.
Note that such trick may be sometimes very complex to test if there are many data items whose value depends on complex tests (or when a data row is generated by a recursive invokation of this template as a [[#Subboxes|subbox]]). Ideally, the Lua module supporting this template should now support a new way to make each header row autohideable by detecting if there is at least one non-empty data row after that header row (a parameter like "{{para|autohide header1 = | yes"}}, for example, would remove the need to perform the "<code>#if" </code> test so that we can just to define "{{para|header1 = | Optional header"}}),
; below : Text to put in the bottom cell. The bottom cell is intended for footnotes, see-also, and other such information.
Titles of articles with infoboxes may be made italic, in line with [[WP:ITALICTITLE]], by passing the <code>italic title</code> parameter.
* Do not make any titles italic by not passing the parameter at all.
; 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.
; 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 <code>style</code> attribute for the specified row.
; headerstyle : Applies to all header cells
; labelstyle : Applies to all label cells
; belowstyle : Applies only to the below cell
<!-- currently not implemented in Lua module
; aboverowclass : This parameter is inserted into the <code>class</code> attribute for the complete table row the '''above''' cell is on.
-->
; aboveclass : This parameter is inserted into the <code>class</code> attribute for the infobox's '''above''' cell.; subheaderrowclass(n) : This parameter is inserted into the <code>class</code> attribute for the complete table row the '''subheader''' is on.; subheaderclass(n) : This parameter is inserted into the <code>class</code> attribute for the infobox's '''subheader'''.; imagerowclass(n) : These parameters are inserted into the <code>class</code> attribute for the complete table row their respective '''image''' is on.; imageclass : This parameter is inserted into the <code>class</code> attribute for the '''image'''.; rowclass(n) : This parameter is inserted into the <code>class</code> attribute for the specified row including the '''label''' and '''data''' cells.; class(n) : This parameter is inserted into the <code>class</code> attribute for the '''data''' cell of the specified row. If there's no '''data''' cell it has no effect.
<!-- currently not implemented in Lua module
; belowrowclass : This parameter is inserted into the <code>class</code> attribute for the complete table row the '''below''' cell is on.
-->
; belowclass : This parameter is inserted into the <code>class</code> 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 beig used for microformats.
See [[Wikipedia:WikiProject Microformats]] for more information on adding microformat information to Wikipedia, and [[microformat]] for more information on microformats in general.
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 :
|titlestyle =
|abovestyle = background:#cfc;
|subheaderstyle =
|title = Test Infobox
|imagestyle =
|captionstyle =
|image = [[File:exampleExample-serious.pngjpg|200px|alt=Example alt text]] |caption = Caption displayed below exampleFile:Example-serious.pngjpg
|headerstyle = background:#ccf;
|below = Below text
}}
<pre source lang="Sass" style="overflow:auto" highlight="15">
{{Infobox
|name = {{subst:PAGENAME}}
|titlestyle =
|abovestyle = background:#cfc;
|subheaderstyle =
|title = Test Infobox
|imagestyle =
|captionstyle =
| image = [[File:exampleExample-serious.pngjpg|200px|alt=Example alt text]] |caption = Caption displayed below exampleExample-serious.pngjpg
|headerstyle = background:#ccf;
|below = Below text
}}
</presource>{{clear}}
For this example, the '''{{para|bodystyle''' }} and '''{{para|labelstyle''' }} parameters are used to adjust the infobox width and define a default width for the column of labels:
{{Infobox
|below = Below text
}}
<pre source lang="sass" highlight="3,9" style="overflow: auto">
{{Infobox
|name = {{subst:PAGENAME}}
|below = Below text
}}
</presource>{{clear}}
<!--Linked from [[Template:Subinfobox bodystyle/doc]]-->
One infobox template can be embedded into another using the {{para|child}} parameter or the {{para|embed}} parameter. This feature can be used to create a modular infobox, or to create more well better-defined logical sections. PreviouslyLong ago, it was necessary to use embedding in order to create infoboxes with more than 99 rows, ; but nowadays there is now 's no limit to the number of rows that can be defined in a single instance of <code><nowiki>{{infobox}}</nowiki></code>.
{{Infobox
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.
An alternative method for embedding is to use {{para|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.
| header6 = Main 6
}}
<pre source lang="sass" style="overflow:auto">
{{Infobox
| headerstyle = background-color:#eee;
| header6 = Main 6
}}
</presource>{{clear}}
Similar embedding technics techniques may be used within content parameters of some other templates generating tables (such as [[:Template:Sidebar|Sidebar]]) :
{{Sidebar
| heading5 = Heading 5
}}
<pre source lang="sass" style="overflow:auto">
{{Sidebar
| navbar = off
| heading5 = Heading 5
}}
</presource>{{clear}}
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 {{tlx|nbsp}} may be used with {{tlx|wbr}} and {{tlx|nowrap}} to control line-breaking in bulletless lists embedded in infoboxes (e.g. cast list in {{tlx|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.)
| data20 =
| belowstyle =
| below =
}}
</pre>{{clear}}
{{Help:Infobox/user style}}
The infobox template requires the [[:mw:Extension:Scribunto|Scribunto]] extension and [[mw:Manual:Using content from Wikipedia#HTMLTidy|HTMLTidy]] to be installed. It may not work with other MediaWikis. [[Wikipedia:WikiProject Transwiki|WikiProject Transwiki]] has a version of this template that has been modified to work on other MediaWikis.
* {{tl|Infobox3cols}}
* {{tl|Navbox}} and {{tl|Sidebar}}
* [[Wikipedia:List of infoboxes|List of infoboxes]]
* [[:Module:InfoboxImage]]* Maintenance categories:** [[:Category:Articles which use infobox templates with no data rows]] ({{PAGESINCATEGORY:Articles which use infobox templates with no data rows|pages}})** [[:Category:Pages which use embedded infobox templates with the title parameter]] ({{PAGESINCATEGORY:Pages which use embedded infobox templates with the title parameter|pages}})<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
[[Category:Infobox templates| ]]
[[Category:Wikipedia metatemplates|Infobox]]
[[Category:Templates generating microformats]]
[[Category:Lua-based infobox templates]]}}</includeonly> ==Tracking categories==* {{clc|Articles with missing Wikidata information}}