Difference between revisions of "Template:Infobox/doc"

From Freeside Atlanta
Jump to navigation Jump to search
m (1 revision: Infobox)
 
Line 2: Line 2:
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
{{distinguish|Template:Userbox}}
{{distinguish|Template:Userbox}}
<includeonly>{{high-risk|1,300,000+}}</includeonly>
This template is intended as a meta-template: a template used for constructing other templates. 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 an introduction to infoboxes and information on how to design them. See [[:Category:Infobox templates]] for specific infobox templates.
This template is intended as a meta-template: a template used for constructing other templates. 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 an introduction to infoboxes and information on how to design them. See [[:Category:Infobox templates]] for specific infobox templates.


Line 10: Line 11:


==== Number ranges ====
==== Number ranges ====
Row numbers may be from 1 to 99 (for situations where more than 99 rows are required, see [[#Embedding|Embedding]] 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:
There is no limit on the number of rows available for use. 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>|header3  = Section 1
<pre>|header3  = Section 1
|label5  = Label A
|label5  = Label A
Line 19: Line 20:
|label12  = Label D
|label12  = Label D
|data12  = Data D</pre>
|data12  = Data D</pre>
It is not recommended to have parameters numbered more than 20 apart. This is due to limitations in processing references and reference lists in the [[WP:Lua|Lua]] programming language on Wikipedia. Parameters numbered more than 20 apart will still be processed, but extra care must be taken if these parameters could contain references or reference lists. In this case, for the references to display properly, the parameters that could contain reference lists (usually {{para|below}}) must appear after the parameters that could contain references. If parameters are numbered less than 20 apart, this is handled automatically by the template.


=== Parameters ===
=== Parameters ===
Line 283: Line 286:


===Embedding===
===Embedding===
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 more well defined logical sections.
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 more well defined logical sections. Previously, it was necessary to use embedding in order to create infoboxes with more than 99 rows, but there is now no limit to the number of rows that can be defined in a single instance of <code><nowiki>{{infobox}}</nowiki></code>.
{{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
}}
<pre style="overflow:auto">
{{Infobox
{{Infobox
| title = Top level title
| title = Top level title
Line 293: Line 314:
}}
}}
| data2 = {{Infobox
| data2 = {{Infobox
  | child = yes
  | title = Second subsection
  | label1= Label 2.1
  | data1 = Data 2.1
}}
|belowstyle =
|below = Below text
}}
</pre>
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, either using
{{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
   | child = yes
   | title = Second subsection
   | title = Second subsection
Line 304: Line 344:
{{Infobox
{{Infobox
| title = Top level title
| title = Top level title
| data1 = {{Infobox
| header1 = {{Infobox
   | child = yes
   | child = yes
   | title = First subsection
   | title = First subsection
Line 310: Line 350:
   | data1 = Data 1.1
   | data1 = Data 1.1
}}
}}
| data2 = {{Infobox
| header2 = {{Infobox
   | child = yes
   | child = yes
   | title = Second subsection
   | title = Second subsection
Line 320: Line 360:
}}
}}
</pre>
</pre>
Note, in the examples above, the child infobox is placed in a <code>data</code> field, not a <code>header</code> field.  The title will be enclosed in {{tag|b}} bold tags, which can create a "double bolding effect" in some browsers if the child infobox is placed in a <code>header</code> field.  To place the child infobox in a header field and avoid the double bolding effect, use
or,
{{Infobox
{{Infobox
| title = Top level title
| title = Top level title
| header1 = First subsection
| header1 = First subsection
   {{Infobox
   {{Infobox|decat=yes
   | child = yes
   | child = yes
   | label1= Label 1.1
   | label1= Label 1.1
Line 330: Line 370:
}}
}}
| header2 = Second subsection
| header2 = Second subsection
   {{Infobox
   {{Infobox|decat=yes
   | child = yes
   | child = yes
   | label1= Label 2.1
   | label1= Label 2.1
Line 355: Line 395:
|belowstyle =  
|belowstyle =  
|below = Below text
|below = Below text
}}
</pre>
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.
===Subboxes===
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.
{{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
}}
<pre style="overflow:auto">
{{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
}}
</pre>
{{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
}}
<pre style="overflow:auto">
{{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
}}
}}
</pre>
</pre>


=== Full blank syntax ===
=== Full blank syntax ===
(Note: the template currently handles up to 99 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;">
<pre style="overflow:auto;">
Line 448: Line 580:


=== Porting to other MediaWikis ===
=== Porting to other MediaWikis ===
The infobox template requires the tidy extension to be installed, and may not work with other MediaWikis. The [[Wikipedia:WikiProject Transwiki]] has a version of Infobox that has been modified to work on 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.


=== See also ===
=== See also ===
* [[Module:Infobox]]
* {{tl|infobox3cols}}
* {{tl|infobox3cols}}
* {{tl|Navbox}}


<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
Line 458: Line 592:
[[Category:Wikipedia metatemplates|Infobox]]
[[Category:Wikipedia metatemplates|Infobox]]


[[als:Vorlage:Infobox]]
[[ar:قالب:قالب معلومات]]
[[be:Шаблон:Картка]]
[[be-x-old:Шаблён:Картка]]
[[bg:Шаблон:Infobox]]
[[bn:টেমপ্লেট:তথ্যছক]]
[[bs:Šablon:Infokutija]]
[[ca:Plantilla:Infotaula]]
[[cs:Šablona:Infobox]]
[[csb:Szablóna:Infobox]]
[[cy:Nodyn:Gwybodlen3]]
[[da:Skabelon:Infoboks-en]]
[[de:Vorlage:Infobox]]
[[el:Πρότυπο:Πλαίσιο πληροφοριών]]
<!-- [[en:Template:Infobox]] -->
<!-- [[en:Template:Infobox]] -->
[[eo:Ŝablono:Informkesto]]
[[es:Plantilla:Ficha]]
[[et:Mall:Infobox]]
[[fa:الگو:دادان]]
[[fi:Malline:Tietolaatikko]]
[[fr:Modèle:Infobox]]
[[ga:Teimpléad:Bosca sonraí]]
[[gl:Modelo:Infobox]]
[[hsb:Předłoha:Infokašćik]]
[[hu:Sablon:Infobox]]
[[hy:Կաղապար:Տեղեկաքարտ]]
[[ia:Patrono:Infobox]]
[[id:Templat:Infobox]]
[[is:Snið:Infobox]]
[[it:Template:Infobox]]
[[ja:Template:Infobox]]
[[ka:თარგი:ინფოდაფა]]
[[kk:Үлгі:Инфобокс]]
[[km:ទំព័រគំរូ:ប្រអប់ព័ត៌មាន]]
[[ko:틀:정보상자]]
[[ltg:Taiss:Infoskreine]]
[[lv:Veidne:Infobox]]
[[mhr:Кышкар:Аҥа]]
[[mk:Шаблон:Infobox]]
[[ms:Templat:Infobox]]
[[nn:Mal:Infoboks]]
[[no:Mal:Infoboks]]
[[os:Шаблон:Infobox]]
[[pt:Predefinição:Info]]
[[ro:Format:Infobox]]
[[ru:Шаблон:Карточка]]
[[si:සැකිල්ල:තොරතුරුකොටුව]]
[[sk:Šablóna:Infobox]]
[[sl:Predloga:Infopolje]]
[[sv:Mall:Infobox]]
[[th:แม่แบบ:กล่องข้อมูล]]
[[tpi:Template:Infobok]]
[[tr:Şablon:Bilgi kutusu]]
[[uk:Шаблон:Картка]]
[[ur:Template:Infobox]]
[[vi:Bản mẫu:Infobox]]
[[zh:Template:Infobox]]
}}</includeonly>
}}</includeonly>

Latest revision as of 16:24, 8 June 2013

{{#ifeq: doc | doc 

 |

{{ 

   #ifeq: show | show
   | {{#invoke:Message box|mbox}}
   }}{{
   #if: 
   | 
   | {{#ifexist:Template:Infobox|[[Category:{{
     #switch: Template
     | Template  = Template
     | Module  = Module
     | User      = User
     | #default  = Wikipedia
   }} documentation pages]]|}}
 }}

| }}

Not to be confused with Template:Userbox{{ 
   #if: 
   | , [[:{{{2}}}]], {{
     #if: 
     | [[:{{{3}}}]], or [[:{{{4}}}]]
     | or [[:{{{3}}}]]
   }}
   | {{
     #if: 
     |  or [[:{{{2}}}]]
   }}
}}.

This template is intended as a meta-template: a template used for constructing other templates. 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 an introduction to infoboxes and information on how to design them. See Category:Infobox templates for specific infobox templates.

Usage

Usage is similar to {{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.

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.

Number ranges

There is no limit on the number of rows available for use. 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 B
|label7   = Label C
|data7    = Data C
|header10 = Section 2
|label12  = Label D
|data12   = Data D

It is not recommended to have parameters numbered more than 20 apart. This is due to limitations in processing references and reference lists in the Lua programming language on Wikipedia. Parameters numbered more than 20 apart will still be processed, but extra care must be taken if these parameters could contain references or reference lists. In this case, for the references to display properly, the parameters that could contain reference lists (usually |{{#if:below|below=}}) must appear after the parameters that could contain references. If parameters are numbered less than 20 apart, this is handled automatically by the template.

Parameters

View/discuss/edit links

name
If this parameter is present, "view/discuss/edit" links will be added to the bottom of the infobox, pointing to the named template. You can use {{subst:PAGENAME}}.
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.

Title

{{#ifeq:|yes||

{{#if:Text in caption over infobox|}}{{#if:|}}

}}{{#ifeq:|yes|Text in caption over infobox}}{{#if:Subheader of the infobox|{{#if:

|
|{{#if:Subheader of the infobox
|{{#if: | }} }} }}{{#if:|{{#if: |
|{{#if:{{{subheader2}}}
|{{#if: | }} }} }}{{#if:|{{#if: |
|{{#if:{{{image1}}} {{#if:|
{{{caption1}}}}}
|{{#if: | }} }} }}{{#if:|{{#if: |
|{{#if:{{{image2}}}{{#if:|
{{{caption2}}}}}
|{{#if: | }} }} }}{{#if:|{{#if: |
|{{#if:{{{image3}}}{{#if:|
{{{caption3}}}}}
|{{#if: | }} }} }}{{#if: |
|{{#if:(the rest of the infobox goes here)
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if: |
|{{#if:
|{{#if: | }} }}{{#if:|}}{{#if:|}} {{#ifeq:|yes||
Text in caption over infobox
{{{above}}}
{{{header}}}
{{{label}}} | 
 }}
Subheader of the infobox
{{{header}}}
{{{label}}} | 
 }}
{{{subheader2}}}
{{{header}}}
{{{label}}} | 
 }}
{{{image1}}} {{#if:|
{{{caption1}}}}}
{{{header}}}
{{{label}}} | 
 }}
{{{image2}}}{{#if:|
{{{caption2}}}}}
{{{header}}}
{{{label}}} | 
 }}
{{{image3}}}{{#if:|
{{{caption3}}}}}
| 
 }}
(the rest of the infobox goes here)
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}
| 
 }}

{{{below}}}

{{#if:1||This box: }}{{#if:|[}}
  • [[{{#switch: 
    |#default =  
| = 
   {{#ifeq:  | 
     | Template:{{{name}}}            
     |       
   }}
    }}|{{#if:1|v|view}}]]
  • [[|{{#if:1|t|talk}}]]
    • {{#if:||
  • [{{fullurl:{{#switch: |#default = | = {{#ifeq: | | Template:{{{name}}} | }} }}|action=edit}} {{#if:1|e|edit}}]
    • }}
{{#if:|]}}

}}{{#switch:¬ 

|¬|no       = 
||force|yes =

}}{{#switch: 

 {{#if: 
 | {{{demospace}}}    
 | {{#ifeq:Template|
   | main
   | other
   }} 
 }}

| main = {{#ifeq:|yes||{{#ifeq:|yes|{{#if:Text in caption over infobox|}}}}{{#if:(the rest of the infobox goes here)||}}}} | other | #default = }} Template:Infobox

There are two different ways to put a title on an infobox. One contains the title inside the infobox's border, the other puts it on top as a caption. 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 top of the table.
above
Text to put within the uppermost cell of the table.

Optional content

subheader, subheader2
additional title fields which fit below {{{title}}} and {{{above}}}.
image, image2
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, caption2
Text to put underneath the images.
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.
below
Text to put in the bottom cell. The bottom cell is intended for footnotes, see-also, and other such information.
child
See the embedding section for details.

Note: for any given value for (n), not all combinations of parameters are permitted. The presence of a Template:Para will cause the corresponding Template:ParaTemplate:Para (and Template:Para, see below) to be ignored; the absence of a Template:Para will cause the corresponding Template:Para to be ignored. Valid combinations for any single row are:

See the rendering of header4, label4, and data4 in the examples section below.

Optional 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:large; since this cell is usually used for a title, if you want to use the above cell for regular-sized text include "font-size:medium;" 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.
headerstyle
Applies to all header cells
labelstyle
Applies to all label cells
datastyle
Applies to all data cells
belowstyle
Applies only to the below cell

HTML classes

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.
aboverowclass
This parameter is inserted into the "class" attribute for the complete table row the "above" cell is on.
subheaderclass
This parameter is inserted into the "class" attribute for the infobox's subheader.
subheaderrowclass
This parameter is inserted into the "class" attribute for the complete table row the subheader is on.
imageclass
This parameter is inserted into the "class" attribute for the image.
imagerowclass1, imagerowclass2
These parameters are inserted into the "class" attribute for the complete table row the respective images are on.
rowclass(n)
This parameter is inserted into the "class" attribute for the specified row including the label or other explanatory text.
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.

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

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 Template:Para from the infobox.
  • Turn off by default but allow some instances to be made italic by passing Template:Para
  • Do not make any titles italic by not passing the parameter at all.

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

You can also make headers optional in a similar way. If you want a 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: 

{{Infobox
|name    = {{subst:PAGENAME}}
|title   = Example of an optional header
|header1 = {{#if:{{{item_one|}}}{{{item_two|}}}{{{item_three|}}}|Optional header}}
|label2  = Item one
|data2   = {{{item_one|}}}
|label3  = Item two
|data3   = {{{item_two|}}}
|label4  = Item three
|data4   = {{{item_three|}}}
}}

header1 will be shown if any of item_one, item_two, or item_three is defined. If none of the three parameters are defined the header won't be shown.

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 item_one, item_two and item_three are undefined will the if statement fail.

Examples

Template:Infobox 

{{Infobox
|name         = Infobox/doc
|bodystyle    = 
|title        = Test Infobox
|titlestyle   = 

|image        = [[File:example.png|200px|alt=Example alt text]]
|imagestyle   = 
|caption      = Caption for example.png
|captionstyle = 
|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
}}

Notice how when a label is defined without an accompanying data cell the row doesn't appear in the displayed infobox, and when a header is defined on the same row as a data cell all of them are displayed.

Template:Clear For this example, Template:Nowrap and Template:Nowrap

Template:Infobox 

{{Infobox
|bodystyle   = width:20em;
|name        = Infobox/doc
|title       = Test Infobox
|titlestyle  = 
|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
}}

Template:Clear

Embedding

One infobox template can be embedded into another using the Template:Para parameter. This feature can be used to create a modular infobox, or to create more well defined logical sections. Previously, it was necessary to use embedding in order to create infoboxes with more than 99 rows, but there is now no limit to the number of rows that can be defined in a single instance of {{infobox}}. Template:Infobox 

{{Infobox
| title = Top level title
| data1 = {{Infobox
  | child = yes
  | title = First subsection
  | label1= Label 1.1
  | data1 = Data 1.1
}}
| data2 = {{Infobox
  | 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, either using Template:Infobox 

{{Infobox
| title = Top level title
| header1 = {{Infobox
  | child = yes
  | title = First subsection
  | label1= Label 1.1
  | data1 = Data 1.1
}}
| header2 = {{Infobox
  | child = yes
  | title = Second subsection
  | label1= Label 2.1
  | data1 = Data 2.1
}}
|belowstyle = 
|below = Below text
}}

or, Template:Infobox 

{{Infobox
| title = Top level title
| header1 = First subsection
  {{Infobox
  | child = yes
  | label1= Label 1.1
  | data1 = Data 1.1
}}
| header2 = Second subsection
  {{Infobox
  | child = yes
  | label1= Label 2.1
  | data1 = Data 2.1
}}
|belowstyle = 
|below = Below text
}}

Note that omitting the Template:Para parameter, and not including any text preceding the embedded infobox, may result in spurious blank table rows, creating gaps in the visual presentation.

Subboxes

An alternative method for embedding is to use Template:Para, 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. Template:Infobox 

{{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
}}

Template:Sidebar 

{{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
}}

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}}
|bodystyle    = 
|title        = 
|titlestyle   = 
|above        = 
|abovestyle   = 

|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 = 
}}

Porting to other MediaWikis

The infobox template requires the Scribunto extension and HTMLTidy to be installed. It may not work with other MediaWikis. WikiProject Transwiki has a version of this template that has been modified to work on other MediaWikis.

See also


Retrieved from "https://wiki.freesideatlanta.org/index.php?title=Template:Infobox/doc&oldid=1196"