Template:Infobox/doc: Difference between revisions

From HasanistanPedia
Jump to navigation Jump to search
HasanistanPedia>OIMGov
m (1 revision imported)
 
m (1 revision imported)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{distinguish|Template:Userbox}}
{{distinguish|Template:Userbox}}
{{Documentation subpage}}
{{#ifeq:{{SUBPAGENAME}}|sandbox||{{High-use}}}}
<includeonly>{{#ifeq:{{#titleparts:{{PAGENAME}}|1|2}}|old | |{{High-risk|2900000+}}{{Lua|Module:Infobox}}}}</includeonly>
{{Lua|Module:Infobox}}
{{Parameter names example
{{Parameter names example
  |name={{PAGENAME}} <!--|child |subbox |decat--> |title |above |subheader |subheader1 |subheader2={{{subheader2}}}<br/>......
  |name={{PAGENAME}} <!--|child |subbox |decat--> |title |above |subheader |subheader1 |subheader2={{{subheader2}}}<br/>......
Line 18: Line 20:


== Usage ==
== 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.
{{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:
<syntaxhighlight lang="wikitext">
{{Infobox
| name    = {{{name|{{PAGENAME}}}}}
| image    = {{{image|}}}
| caption1 = {{{caption|}}}


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.
| label1  = Former names
|  data1  = {{{former_names|}}}
 
| header2  = General information
 
| label3  = Status
|  data3  = {{{status|}}}
... <!-- etc. -->
}}
</syntaxhighlight>


== Optional control parameters ==
== Optional control parameters ==
; 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.
; name : If this parameter is present, "view/talk/edit" links will be added to the bottom of the infobox pointing to the named page, prefixed by <code>Template:</code> if no namespace is specified. 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 to the template code rather than the data in the infobox 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.
; 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.
; subbox :  See the [[#Subboxes|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".
; subbox :  See the [[#Subboxes|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.
; 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|hiding headers when all its data fields are empty]]" section for more details.


== Content parameters ==
== Content parameters ==


=== Title ===
=== 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 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):
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 [[Wikipedia:Manual of Style/Accessibility#Tables|accessibility reasons]], this is the most recommended alternative.
; 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.
Line 45: Line 64:
  | header = (the rest of the infobox goes here)
  | header = (the rest of the infobox goes here)
}}
}}
<pre style="overflow:auto">
<syntaxhighlight lang="wikitext" style="overflow:auto">
{{Infobox
{{Infobox
  | name = {{subst:PAGENAME}}
  | name = {{subst:PAGENAME}}
Line 52: Line 71:
  | header = (the rest of the infobox goes here)
  | header = (the rest of the infobox goes here)
}}
}}
</pre>{{clear}}
</syntaxhighlight>{{clear}}


{{Infobox
{{Infobox
Line 61: Line 80:
  | header = (the rest of the infobox goes here)
  | header = (the rest of the infobox goes here)
}}
}}
<pre style="overflow:auto">
<syntaxhighlight lang="wikitext" style="overflow:auto">
{{Infobox
{{Infobox
  | name = {{subst:PAGENAME}}
  | name = {{subst:PAGENAME}}
Line 69: Line 88:
  | header = (the rest of the infobox goes here)
  | header = (the rest of the infobox goes here)
}}
}}
</pre>{{clear}}
</syntaxhighlight>{{clear}}


=== Illustration images ===
=== Illustration images ===
Line 91: Line 110:
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:
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 style="overflow:auto">
<syntaxhighlight lang="wikitext" style="overflow:auto">
  | header3  = Section 1
  | header3  = Section 1
  |  label5  = Label A
  |  label5  = Label A
Line 100: Line 119:
  |  label12 = Label D
  |  label12 = Label D
  |  data12 = Data D
  |  data12 = Data D
</pre>{{clear}}
</syntaxhighlight>{{clear}}


It is also possible to automatically renumber parameter names by using [[User:Frietjes/infoboxgap.js]] or [[Module:IncrementParams]].
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 ====
==== 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:
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:


<pre style="overflow:auto">
<syntaxhighlight lang="wikitext" style="overflow:auto">
  |  label5 = Population
  |  label5 = Population
  |  data5 = {{{population|}}}
  |  data5 = {{{population|}}}
</pre>{{clear}}
</syntaxhighlight>{{clear}}


This way if an article doesn't define the population parameter in its infobox the row won't be displayed.
This way if an article doesn't define the population parameter in its infobox the row won't be displayed.
Line 116: Line 137:
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'":
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'":


<pre style="overflow:auto">
<syntaxhighlight lang="wikitext" style="overflow:auto">
  |  label6 = Mass
  |  label6 = Mass
  |  data6 = {{ #if: {{{mass|}}} | {{{mass}}} kg }}
  |  data6 = {{ #if: {{{mass|}}} | {{{mass}}} kg }}
</pre>{{clear}}
</syntaxhighlight>{{clear}}


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


==== Hiding headers when all data fields are hidden ====
==== Hiding headers when all its data fields are empty ====
You can also make headers optional in a similar way. Consider this example:
You can also make headers automatically hide when their section is empty (has no data-row showing).
 
Consider this situation:
{{Infobox
{{Infobox
  | title  = Example of an undesirable header
  | title  = Example: header with & without data
  | header1 = Undesirable header
| headerstyle = background:lightgrey
  |  label2 = Item 1      |  data2 =
 
  |  label3 = Item 2      |  data3 =
  | header1 = Header1 with empty section
  |  label4 = Item 3      |  data4 =
  |  label2 = label2 text |  data2 =
  | header5 = Static header
  |  label3 = label3 text |  data3 =
  |  label6 = Static item |  data6 = Static value
  |  label4 = label4 text |  data4 =
 
  | header5 = Header5 with data below
  |  label6 = label6 text |  data6 = Some value
}}
}}
<pre style="overflow:auto">
<syntaxhighlight lang="wikitext" style="overflow:auto">
{{Infobox
{{Infobox
  | title  = Example of an undesirable header
  | title  = Example: header with & without data
  | header1 = Undesirable header
| headerstyle = background:lightgrey
  |  label2 = Item 1      |  data2 =
 
  |  label3 = Item 2      |  data3 =
  | header1 = Header1 with empty section
  |  label4 = Item 3      |  data4 =
  |  label2 = label2 text |  data2 =
  | header5 = Static header
  |  label3 = label3 text |  data3 =
  |  label6 = Static item |  data6 = Static value
  |  label4 = label4 text |  data4 =
 
  | header5 = Header5 with data below
  |  label6 = label6 text |  data6 = Some value
}}
}}
</pre>{{clear}}
</syntaxhighlight>{{clear}}
 
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
| autoheaders = y
| headerstyle = background:lightgrey
 
| header1 = Header1 with empty section
|  label2 = label2 text |  data2 =
|  label3 = label3 text |  data3 =
|  label4 = label4 text |  data4 =


If you want the first header to appear only if one or more of the data fields that fall under it are filled, one could use the following pattern as an example of how to do it:
| header5 = Header5 with data below
|  label6 = label6 text |  data6 = Some value
}}


<syntaxhighlight lang="wikitext" style="overflow:auto">
{{Infobox
{{Infobox
  | title  = Example of an optional header
  | title  = Example: header with & without data
  | header1 = {{ #if: {{{item1|}}}{{{item2|}}}{{{item3|}}} | Optional header }}
| autoheaders = y
  |  label2 = Item 1      |  data2 = {{{item1|}}}
  | headerstyle = background:lightgrey
  |  label3 = Item 2      |  data3 = {{{item2|}}}
 
  |  label4 = Item 3      |  data4 = {{{item3|}}}
| header1 = Header1 with empty section
  | header5 = Static header
  |  label2 = label2 text |  data2 =
  |  label6 = Static item |  data6 = Static value
  |  label3 = label3 text |  data3 =
  |  label4 = label4 text |  data4 =
 
  | header5 = Header5 with data below
  |  label6 = label6 text |  data6 = Some value
}}
}}
<pre style="overflow:auto">
</syntaxhighlight>{{clear}}
 
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 {{para|data|2=&lt;span style="background:yellow;">&lt;/span>}}, this will be treated as non-empty (having data).
 
If {{para|autoheaders|y}} but there are items that you ''do not'' want to trigger a header, place {{para|headerX|_BLANK_}}. This will serve as an empty header and separate it from the subsequent items.
 
{{Infobox
{{Infobox
  | title  = Example of an optional header
  | title  = Example: blank header with & without data
  | header1 = {{ #if: {{{item1|}}}{{{item2|}}}{{{item3|}}} | Optional header }}
  | autoheaders = y
  |  label2 = Item 1      |  data2 = {{{item1|}}}
| headerstyle = background:lightgrey
  |  label3 = Item 2      |  data3 = {{{item2|}}}
 
  |  label4 = Item 3      |  data4 = {{{item3|}}}
| header1 = Header1 with empty section
  | header5 = Static header
  |  label2 = label2 text |  data2 =
  |  label6 = Static item |  data6 = Static value
  |  label3 = label3 text |  data3 =
  |  label4 = label4 text |  data4 =
 
  | header5 = _BLANK_
  |  label6 = label6 text |  data6 = Some value, but does not trigger header1 or show header5
}}
}}
</pre>{{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 row appears before the next static content. The trick to this is that the "#if" 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.
<syntaxhighlight lang="wikitext" style="overflow:auto">
{{Infobox
| title  = Example: header with & without data
| autoheaders = y
| headerstyle = background:lightgrey


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 "autohide header1 = yes", for example, would remove the need to perform the "#if" test so that we can just to define "header1 = Optional header"),
| 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
}}
</syntaxhighlight>{{clear}}


=== Footer ===
=== Footer ===
Line 186: Line 256:


=== CSS styling ===
=== CSS styling ===
{{div col}}
; bodystyle : Applies to the infobox table as a whole
; 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.
; titlestyle : Applies only to the title caption. Adding a background color is usually inadvisable since the text is rendered "outside" the infobox.
Line 193: Line 264:
; rowstyle(n) : This parameter is inserted into the <code>style</code> attribute for the specified row.
; rowstyle(n) : This parameter is inserted into the <code>style</code> attribute for the specified row.
; headerstyle : Applies to all header cells
; headerstyle : Applies to all header cells
; subheaderstyle : Applies to all subheader cells
; labelstyle : Applies to all label cells
; labelstyle : Applies to all label cells
; datastyle : Applies to all data cells
; datastyle : Applies to all data cells
; belowstyle : Applies only to the below cell
; belowstyle : Applies only to the below cell
{{div col end}}


=== HTML classes and microformats ===
=== HTML classes and microformats ===
{{div col}}
; bodyclass : This parameter is inserted into the <code>class</code> attribute for the infobox as a whole.
; 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.
; titleclass : This parameter is inserted into the <code>class</code> attribute for the infobox's '''title''' caption.
Line 214: Line 288:
-->
-->
; belowclass : This parameter is inserted into the <code>class</code> attribute for the infobox's '''below''' cell.
; belowclass : This parameter is inserted into the <code>class</code> attribute for the infobox's '''below''' cell.
{{div col end}}


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.
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:
To flag an infobox as containing [[hCard]] information, for example, add the following parameter:


<pre style="overflow:auto">
<syntaxhighlight lang="wikitext" style="overflow:auto">
  | bodyclass = vcard
  | bodyclass = vcard
</pre>{{clear}}
</syntaxhighlight>{{clear}}


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


<pre style="overflow:auto">
<syntaxhighlight lang="wikitext" style="overflow:auto">
  | class1 = fn
  | class1 = fn
  | class2 = org
  | class2 = org
  | class3 = tel
  | class3 = tel
</pre>{{clear}}
</syntaxhighlight>{{clear}}


...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.
...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.
Line 237: Line 312:
== Examples ==
== 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 :
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 :
 
{{Suppress categories|
{{Infobox
{{Infobox
  |name        = Infobox/doc
  |name        = Infobox/doc
Line 243: Line 318:


  |titlestyle  =  
  |titlestyle  =  
  |abovestyle = background:#cfc;
  |abovestyle   = background:#cfc;
  |subheaderstyle =
  |subheaderstyle =
  |title        = Test Infobox
  |title        = Test Infobox
Line 278: Line 353:
  |below      = Below text
  |below      = Below text
}}
}}
<pre style="overflow:auto">
}}
<syntaxhighlight lang="wikitext">
{{Infobox
{{Infobox
  |name        = {{subst:PAGENAME}}
  |name        = Infobox/doc
  |bodystyle    =  
  |bodystyle    =  


  |titlestyle  =  
  |titlestyle  =  
  |abovestyle = background:#cfc;
  |abovestyle   = background:#cfc;
  |subheaderstyle =
  |subheaderstyle =
  |title        = Test Infobox
  |title        = Test Infobox
Line 293: Line 369:
  |imagestyle  =  
  |imagestyle  =  
  |captionstyle =  
  |captionstyle =  
  | image     = [[File:Example-serious.jpg|200px|alt=Example alt text]]
  |image       = [[File:Example-serious.jpg|200px|alt=Example alt text]]
  |caption      = Caption displayed below Example-serious.jpg
  |caption      = Caption displayed below File:Example-serious.jpg


  |headerstyle  = background:#ccf;
  |headerstyle  = background:#ccf;
Line 319: Line 395:
  |below      = Below text
  |below      = Below text
}}
}}
</pre>{{clear}}
</syntaxhighlight>
 
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:
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:


{{Infobox
{{Infobox
Line 353: Line 428:
  |below = Below text
  |below = Below text
}}
}}
<pre style="overflow: auto">
<syntaxhighlight lang="wikitext">
{{Infobox
{{Infobox
  |name        = {{subst:PAGENAME}}
  |name        = Infobox/doc
  |bodystyle  = width:20em
  |bodystyle  = width:20em


Line 384: Line 459:
  |below = Below text
  |below = Below text
}}
}}
</pre>{{clear}}
 
</syntaxhighlight>


== Embedding ==
== Embedding ==
<!--Linked from [[Template:Subinfobox bodystyle/doc]]-->
<!--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 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 <code><nowiki>{{infobox}}</nowiki></code>.
One infobox template can be embedded into another using the {{para|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 <code><nowiki>{{infobox}}</nowiki></code>.


{{Infobox
{{Infobox
Line 405: Line 481:
  | below = Below text
  | below = Below text
}}
}}
<pre style="overflow:auto">
<syntaxhighlight lang="wikitext" style="overflow:auto">
{{Infobox
{{Infobox
  | title = Top level title
  | title = Top level title
Line 421: Line 497:
  | below = Below text
  | below = Below text
}}
}}
</pre>{{clear}}
</syntaxhighlight>{{clear}}


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
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
Line 440: Line 516:
  | below = Below text
  | below = Below text
}}
}}
<pre style="overflow:auto">
<syntaxhighlight lang="wikitext" style="overflow:auto">
{{Infobox
{{Infobox
  | title = Top level title
  | title = Top level title
Line 456: Line 532:
  | below = Below text
  | below = Below text
}}
}}
</pre>{{clear}}
</syntaxhighlight>{{clear}}


or,
or,
Line 475: Line 551:
  | below = Below text
  | below = Below text
}}
}}
<pre style="overflow:auto">
<syntaxhighlight lang="wikitext" style="overflow:auto">
{{Infobox
{{Infobox
  | title = Top level title
  | title = Top level title
Line 491: Line 567:
  | below = Below text
  | below = Below text
}}
}}
</pre>{{clear}}
</syntaxhighlight>{{clear}}


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.
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.


[[Wikipedia:WikiProject Infoboxes/embed]] includes some links to Wikipedia articles which include infoboxes embedded within other infoboxes.
[[Wikipedia:WikiProject Infoboxes/embed]] includes some links to Wikipedia articles which include infoboxes embedded within other infoboxes.
Line 519: Line 595:
  | header6 = Main 6
  | header6 = Main 6
}}
}}
<pre style="overflow:auto">
<syntaxhighlight lang="wikitext" style="overflow:auto">
{{Infobox
{{Infobox
  | headerstyle = background-color:#eee;
  | headerstyle = background-color:#eee;
Line 539: Line 615:
  | header6 = Main 6
  | header6 = Main 6
}}
}}
</pre>{{clear}}
</syntaxhighlight>{{clear}}


Similar embedding techniques may be used within content parameters of some other templates generating tables (such as [[:Template:Sidebar|Sidebar]]) :
Similar embedding techniques may be used within content parameters of some other templates generating tables (such as [[:Template:Sidebar|Sidebar]]) :
Line 561: Line 637:
  | heading5 = Heading 5
  | heading5 = Heading 5
}}
}}
<pre style="overflow:auto">
<syntaxhighlight lang="wikitext" style="overflow:auto">
{{Sidebar
{{Sidebar
  | navbar = off
  | navbar = off
Line 580: Line 656:
  | heading5 = Heading 5
  | heading5 = Heading 5
}}
}}
</pre>{{clear}}
</syntaxhighlight>{{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.
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.
Line 590: Line 666:
(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.)
(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.)


<pre style="overflow:auto">
<syntaxhighlight lang="wikitext" style="overflow:auto">
{{Infobox
{{Infobox
| name          = {{subst:PAGENAME}}
| name          = {{subst:PAGENAME}}
Line 596: Line 672:
| subbox        = {{{subbox|}}}
| subbox        = {{{subbox|}}}
| italic title  = {{{italic title|no}}}
| italic title  = {{{italic title|no}}}
| templatestyles =
| child templatestyles =
| grandchild templatestyles =
| bodystyle      =  
| bodystyle      =  


Line 679: Line 758:
| below          =  
| below          =  
}}
}}
</pre>{{clear}}
</syntaxhighlight>{{clear}}
{{Help:Infobox/user style}}
{{Help:Infobox/user style}}


== Porting to other MediaWikis ==
== Porting to other MediaWikis ==
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.
The infobox template requires the [[:mw:Extension:Scribunto|Scribunto]] and [[:mw:Extension:TemplateStyles|TemplateStyles]] extensions. [[Wikipedia:WikiProject Transwiki|WikiProject Transwiki]] has a version of this template that has been modified to work on other MediaWikis.
 
== TemplateData ==
{{TemplateData header}}
<templatedata>
{
"description": "This template is intended as a meta template, a template used for constructing other templates. In general, it is not meant for use directly in an article but can be used on a one-off basis if required.",
"format": "{{_\n| ________________ = _\n}}\n",
"params": {
"title": {
"label": "Title",
"description": "Title displayed above the infobox",
"type": "string",
"suggested": true
},
"image": {
"label": "Image",
"description": "Image illustrating the topic.  Use full image syntax.",
"type": "content",
"suggested": true,
"example": "[[File:example.png|200px|alt=Example alt text]]"
},
"caption": {
"label": "Caption",
"description": "caption for the image",
"type": "content",
"suggested": true
}
},
"paramOrder": [
"title",
"image",
"caption"
]
}
</templatedata>
 
 
==Tracking categories==
* {{Category link with count|Articles with missing Wikidata information}}
* {{Category link with count|Articles using infobox templates with no data rows}}
* {{Category link with count|Pages using embedded infobox templates with the title parameter}}


==See also==
==See also==
* [[Module:Infobox]], the [[WP:LUA|Lua]] module on which this template is based
* [[Module:Infobox]], the [[WP:LUA|Lua]] module on which this template is based
* [[Special:Permalink/558855956|Template:Infobox/old]], the previous ParserFunctions implementation
* [[Module:Check for unknown parameters]]
* {{tl|Infobox3cols}}
* {{tl|Infobox3cols}}
* {{tl|Navbox}} and {{tl|Sidebar}}
* {{tl|Navbox}} and {{tl|Sidebar}}
* [[Wikipedia:List of infoboxes|List of infoboxes]]
* [[Wikipedia:List of infoboxes|List of infoboxes]]
* Maintenance categories:
* [[:Module:InfoboxImage]]
** [[:Category:Articles which use infobox templates with no data rows]]
 
** [[:Category:Pages which use embedded infobox templates with the title parameter]]
<includeonly>{{Sandbox other||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Infobox templates| ]]
[[Category:Infobox templates| ]]
[[Category:Wikipedia metatemplates|Infobox]]
[[Category:Wikipedia metatemplates|Infobox]]
[[Category:Templates generating microformats]]
[[Category:Templates generating microformats]]
[[Category:Templates that add a tracking category]]
[[Category:Templates based on the Infobox Lua module]]
}}</includeonly>
}}</includeonly>

Latest revision as of 12:57, 22 December 2023

Not to be confused with Template:Userbox.
{{{title}}}
{{{above}}}
{{{subheader}}}
{{{subheader2}}}
......
{{{image}}}
{{{caption}}}
{{{image2}}}
{{{caption2}}}
......
{{{header1}}}
( or )
{{{label1}}}{{{data1}}}
( or )
{{{data1}}}
{{{header2}}}
( or )
{{{label2}}}{{{data2}}}
( or )
{{{data2}}}
( etc )
{{{below}}}

This template 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: <syntaxhighlight lang="wikitext">

General information
Status...

</syntaxhighlight>

Optional control parameters

name
If this parameter is present, "view/talk/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

<syntaxhighlight lang="wikitext" style="overflow:auto"> Lua error in Module:Navbar at line 58: Invalid title {{subst:PAGENAME}}.

</syntaxhighlight>

Text in uppermost cell of infobox
Subheader of the infobox
Second subheader of the infobox

<syntaxhighlight lang="wikitext" style="overflow:auto"> Lua error in Module:Navbar at line 58: Invalid title {{subst:PAGENAME}}.

</syntaxhighlight>

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:

<syntaxhighlight lang="wikitext" style="overflow:auto"> 

| header3  = Section 1
|  label5  = Label A
|   data5  = Data A
|  label7  = Label C
|   data7  = Data C
| header10 = Section 2
|  label12 = Label D
|   data12 = Data D

</syntaxhighlight>

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:

<syntaxhighlight lang="wikitext" style="overflow:auto"> 

|  label5 = Population
|   data5 =

</syntaxhighlight>

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'":

<syntaxhighlight lang="wikitext" style="overflow:auto"> 

|  label6 = Mass
|   data6 =

</syntaxhighlight>

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 textSome value

<syntaxhighlight lang="wikitext" style="overflow:auto">

Example: header with & without data
Header1 with empty section
Header5 with data below
label6 textSome value

</syntaxhighlight>

If you want hide the header when no |dataN= values are present, use |autoheaders=y:

Example: header with & without data
Header5 with data below
label6 textSome value

<syntaxhighlight lang="wikitext" style="overflow:auto">

Example: header with & without data
Header5 with data below
label6 textSome value

</syntaxhighlight>

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=y 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 textSome value, but does not trigger header1 or show header5

<syntaxhighlight lang="wikitext" style="overflow:auto">

Example: header with & without data
label6 textSome value, but does not trigger header1 or show header5

</syntaxhighlight>

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:

<syntaxhighlight lang="wikitext" style="overflow:auto"> 

| bodyclass = vcard

</syntaxhighlight>

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

<syntaxhighlight lang="wikitext" style="overflow:auto"> 

| class1 = fn
| class2 = org
| class3 = tel

</syntaxhighlight>

...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
Example alt text
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

<syntaxhighlight lang="wikitext">

Test Infobox
Above text
Subheader above image
Second subheader
Example alt text
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

</syntaxhighlight> 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 1Data 1
Label 2Data 2
Label 3Data 3
Header 4
Label 5Data 5: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Below text

<syntaxhighlight lang="wikitext">

Test Infobox
Label 1Data 1
Label 2Data 2
Label 3Data 3
Header 4
Label 5Data 5: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Below text

</syntaxhighlight>

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.1Data 1.1
Second subsection
Label 2.1Data 2.1
Below text

<syntaxhighlight lang="wikitext" style="overflow:auto">

Top level title
First subsection
Label 1.1Data 1.1
Second subsection
Label 2.1Data 2.1
Below text

</syntaxhighlight>

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.1Data 1.1
Second subsection
Label 2.1Data 2.1
Below text

<syntaxhighlight lang="wikitext" style="overflow:auto">

Top level title
First subsection
Label 1.1Data 1.1
Second subsection
Label 2.1Data 2.1
Below text

</syntaxhighlight>

or,

Top level title
First subsection
Label 1.1Data 1.1
Second subsection
Label 2.1Data 2.1
Below text

<syntaxhighlight lang="wikitext" style="overflow:auto">

Top level title
First subsection
Label 1.1Data 1.1
Second subsection
Label 2.1Data 2.1
Below text

</syntaxhighlight>

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-3Data 3-3
Label 4-1Data 4-1
Label 5Data 5
Main 6

<syntaxhighlight lang="wikitext" style="overflow:auto">

Main 1
Main 2
Sub 3-1
Sub 3-2
Label 3-3Data 3-3
Label 4-1Data 4-1
Label 5Data 5
Main 6

</syntaxhighlight>

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-3Data 3-3
Label 4-1Data 4-1
Heading 5

<syntaxhighlight lang="wikitext" style="overflow:auto">

Heading 1
Heading 2
Sub 3-1
Sub 3-2
Label 3-3Data 3-3
Label 4-1Data 4-1
Heading 5

</syntaxhighlight>

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.)

<syntaxhighlight lang="wikitext" style="overflow:auto"> Lua error in Module:Navbar at line 58: Invalid title {{subst:PAGENAME}}.

</syntaxhighlight>

Infoboxes and user style

Users can have user CSS that hides any infoboxes in their own browsers.

To hide all infoboxes, add the following to Special:MyPage/common.css (for all skins, or Special:MyPage/skin.css for just the current skin), on a line by itself: <syntaxhighlight lang="css">div.mw-parser-output .infobox { display: none; }</syntaxhighlight>

Alternatively, you can add the following code to your common.js or into a browser user script that is executed by an extension like Greasemonkey:

<syntaxhighlight lang="js">$('.infobox').hide();</syntaxhighlight>

Be aware that although, per WP:Manual of Style/Infoboxes, all information in an infobox ideally should also be found in the main body of an article, there isn't perfect compliance with this guideline. For example, the full taxonomic hierarchy in {{Taxobox}}, and the OMIM and other medical database codes of {{Infobox disease}} are often not found in the main article content. The infobox is also often the location of the most significant, even only, image in an article. There is a userscript which removes infoboxes but moves the images contained to separate thumbnails: User:Maddy from Celeste/disinfobox.js.

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

<templatedata> { "description": "This template is intended as a meta template, a template used for constructing other templates. In general, it is not meant for use directly in an article but can be used on a one-off basis if required.", "format": "Template:\n\n", "params": { "title": { "label": "Title", "description": "Title displayed above the infobox", "type": "string", "suggested": true }, "image": { "label": "Image", "description": "Image illustrating the topic. Use full image syntax.", "type": "content", "suggested": true, "example": "Example alt text" }, "caption": { "label": "Caption", "description": "caption for the image", "type": "content", "suggested": true } }, "paramOrder": [ "title", "image", "caption" ] } </templatedata>


Tracking categories

See also


Retrieved from "https://wiki.hasanistan.world/hasanistanpedia/index.php?title=Template:Infobox/doc&oldid=21878"