Template:Infobox/doc View history

Template documentation pages
VisualWikitext
No edit summary
No edit summary
Line 1: Line 1:
{{doc subpage}}
{{doc subpage}}
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
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 [[w:Help:Infobox|Help:Infobox]] for an introduction to infoboxes and information on how to design them. See [[:Category:Infobox templates]] for specific infobox templates.
TThis template is intended as a meta-template, that is, a template that's used when constructing other templates. It's not meant for use directly in an article. See [[Help:Infobox]] for information on how to craft infoboxes in general.


=== Usage ===
Usage is similar to {{tl|navbox}}, but with an additional distinction. Each row on the table can either be a "header", or it can have a label/data pair, or it can just be a data cell. These are mutually exclusive states so if you define a row to be both a header and a label/data pair, the label/data pair is overridden.
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.


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.
Note that if you want to insert an image elsewhere other than the top of the infobox, or insert other "freeform" data, using a row with just a "data" field allows for that sort of thing.


==== Number ranges ====
===Parameters===
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
|label5  = Label A
|data5    = Data B
|label7  = Label C
|data7    = Data C
|header10 = Section 2
|label12  = Label D
|data12  = Data D</pre>


=== Parameters ===
Mandatory:
====View/discuss/edit links====
;name : The template page name that the "view/discuss/edit" links should point to. You can use <nowiki>{{subst:PAGENAME}}</nowiki>.
;name : The template page name that the "view/discuss/edit" links should point to. You can use <nowiki>{{subst:PAGENAME}}</nowiki>. If this parameter is omitted the view/discuss/edit links will not be displayed.
;title : A title to put in the titlebar at the top.
If no name or title are given, the pagename is used.  
Optional content:


====Title====
; image : An image to display at the top of the template. Use full image syntax, for example <nowiki>[[Image:example.png|200px]]</nowiki>. Image is centered by default.
{{Infobox
;caption : Text to put underneath the image.
|title = Text in caption over infobox
|subheader = Subheader of the infobox
|data1 = (the rest of the infobox goes here)
}}
{{Infobox
|above = Text in uppermost cell of infobox
|subheader = Subheader of the infobox
|subheader2 = 2<sup>nd</sup> subheader of the infobox
|data1 = (the rest of the infobox goes here)
}}
 
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 between {{{title}}} and {{{above}}}.
;image, image2 : 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.
;caption1, caption2 : Text to put underneath the images.
;header(n) : Text to use as a header in row n.
;header(n) : Text to use as a header in row n.
;label(n): Text to use as a label in row n.
;label(n): Text to use as a label in row n.
Line 49: Line 22:
;below: Text to put in the bottom cell. The bottom cell is intended for footnotes, see-also, and other such information.
;below: Text to put in the bottom cell. The bottom cell is intended for footnotes, see-also, and other such information.


Note: currently, headers, labels and data items with the same n-value are mutually exclusive; only the header will be displayed. See the rendering of header4, label4, and data4 in the examples section below.


====Optional CSS styling====
Optional CSS styling:
 
;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 cell
;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 (including the caption)
;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 caption
;captionstyle : Applies to the text of the image caption.
;headerstyle : Applies to all header cells
;headerstyle : Applies to all header cells
;labelstyle : Applies to all label cells
;labelstyle : Applies to all label cells
Line 62: Line 34:
;belowstyle : Applies only to the below cell
;belowstyle : Applies only to the below cell


==== HTML classes ====
===Making fields optional===
;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; it is in particular used in conjunction with {{tl|Image class names}}.
; imagerowclass1, imagerowclass1 : 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 ====
A row with a label but no data is not displayed. This allows for optional infobox contents. To make a field optional, use a parameter that defaults to an empty string, like so:
 
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 [[w:hCard|hCard]] information, for example, add the following parameter:


<pre>
<pre>
|bodyclass = vcard
|data5={{{population|}}}
</pre>
</pre>


And for each row containing a data cell that's part of the vcard, add a corresponding class parameter:
For more complex fields with preformatted contents that would still be present if a parameter was unset, you can wrap it all in a simple "if" statement to make the whole thing vanish when not used. Example:


<pre>
<pre>
|class1 = fn
|data5= {{#if: {{{mass|}}} | {{{mass}}} kg}}
|class2 = org
|class3 = tel
</pre>
</pre>
...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.
===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:
<pre>
|label5 = Population
|data5  = {{{population|}}}
</pre>
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'":
<pre>
|label6 = Mass
|data6  = {{#if:{{{mass|}}}|{{{mass}}} kg}}
</pre>
For more on #if, see [[m:ParserFunctions##if:|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:
<pre style="overflow:auto;">{{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|}}}
}}</pre>
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===
===Examples===
Line 149: Line 67:
|data1  =  
|data1  =  
|header2 =  
|header2 =  
|label2  = Label defined alone
|label2  = Label defined alone does not display (needs data, or is suppressed)
|data2  =  
|data2  =  
|header3 =
|header3 =
|label3  =  
|label3  =  
|data3  = Data defined alone
|data3  = Data defined alone
|header4 = All three defined (header)
|header4 = All three defined (header, label, data, all with same number)
|label4  = All three defined (label)
|label4  = does not display (same number as a header)
|data4  = All three defined (data)
|data4  = does not display (same number as a header)
|header5 =
|header5 =
|label5  = Label and data defined (label)
|label5  = Label and data defined (label)
Line 183: Line 101:
|data1  =  
|data1  =  
|header2 =  
|header2 =  
|label2  = Label defined alone
|label2  = Label defined alone does not display (needs data, or is suppressed)
|data2  =  
|data2  =  
|header3 =
|header3 =
|label3  =  
|label3  =  
|data3  = Data defined alone
|data3  = Data defined alone
|header4 = All three defined (header)
|header4 = All three defined (header, label, data, all with same number)
|label4  = All three defined (label)
|label4  = does not display (same number as a header)
|data4  = All three defined (data)
|data4  = does not display (same number as a header)
|header5 =
|header5 =
|label5  = Label and data defined (label)
|label5  = Label and data defined (label)
Line 199: Line 117:
}}</pre>
}}</pre>


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 the header takes precedence.
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.


{{clear}}
{{clear}}
Line 232: Line 150:
|below = Below text
|below = Below text
}}
}}
<pre style="overflow: auto">
{{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
}}
</pre>
{{clear}}
{{clear}}


=== Full blank syntax ===
===Embedding===
(Note: the template currently handles up to 80 rows; only 20 are included here 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.)
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.
{{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
}}
<pre style="overflow:auto">
{{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
}}
</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
{{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
}}
<pre style="overflow:auto">
{{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
}}
</pre>


<pre>
==Full blank declaration==
(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.)
 
<pre style="overflow:auto;">
{{Infobox
{{Infobox
|name        = {{subst:PAGENAME}}
|name        = {{subst:PAGENAME}}
Line 324: Line 347:
}}</pre>
}}</pre>


==See also==
* {{tl|start infobox page}}
* {{tl|infobox3cols}}
=== See also ===
=== See also ===
* {{tl|start infobox page}}
* {{tl|start infobox page}}

Revision as of 04:00, 12 February 2016

 This is a documentation subpage for Template:Infobox.
It contains usage information, categories and other content that is not part of the original template page.

TThis template is intended as a meta-template, that is, a template that's used when constructing other templates. It's not meant for use directly in an article. See Help:Infobox for information on how to craft infoboxes in general.

Usage is similar to {{navbox}}, but with an additional distinction. Each row on the table can either be a "header", or it can have a label/data pair, or it can just be a data cell. These are mutually exclusive states so if you define a row to be both a header and a label/data pair, the label/data pair is overridden.

Note that if you want to insert an image elsewhere other than the top of the infobox, or insert other "freeform" data, using a row with just a "data" field allows for that sort of thing.

Parameters

Mandatory:

name
The template page name that the "view/discuss/edit" links should point to. You can use {{subst:PAGENAME}}.
title
A title to put in the titlebar at the top.

If no name or title are given, the pagename is used. Optional content:

image
An image to display at the top of the template. Use full image syntax, for example [[Image:example.png|200px]]. Image is centered by default.
caption
Text to put underneath the image.
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.


Optional CSS styling:

bodystyle
Applies to the infobox table as a whole
titlestyle
Applies only to the title cell
imagestyle
Applies to the cell the image is in (including the caption)
captionstyle
Applies to the text of the 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

Making fields optional

A row with a label but no data is not displayed. This allows for optional infobox contents. To make a field optional, use a parameter that defaults to an empty string, like so: 

|data5={{{population|}}}

For more complex fields with preformatted contents that would still be present if a parameter was unset, you can wrap it all in a simple "if" statement to make the whole thing vanish when not used. Example: 

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

Examples

No Title
[[File:|250px]]
Caption for example.png

Family

Arlyn (Mother) Gilbert Sr. (Father) Gilbert Jr. (Brother) Shane (Sister) Martin (Grandfather) Amada (Grandmother) Restituta (Grandmother-in-Law) Bienvenido (Grandfather-in-Law) Librada (Great Grandmother-in-Law) Maximo (Great Grandfather-in-Law) 


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

For this example, bodystyle = width:20em; and labelstyle = width:33%;

No Title

Family

Arlyn (Mother) Gilbert Sr. (Father) Gilbert Jr. (Brother) Shane (Sister) Martin (Grandfather) Amada (Grandmother) Restituta (Grandmother-in-Law) Bienvenido (Grandfather-in-Law) Librada (Great Grandmother-in-Law) Maximo (Great Grandfather-in-Law) 

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

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 more well defined logical sections.

No Title

Family

Arlyn (Mother) Gilbert Sr. (Father) Gilbert Jr. (Brother) Shane (Sister) Martin (Grandfather) Amada (Grandmother) Restituta (Grandmother-in-Law) Bienvenido (Grandfather-in-Law) Librada (Great Grandmother-in-Law) Maximo (Great Grandfather-in-Law) 

{{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. The title will be enclosed in <b>...</b> bold tags, which can create a "double bolding effect" in some browsers if the child infobox is placed in a header field. To place the child infobox in a header field and avoid the double bolding effect, use

No Title

Family

Arlyn (Mother) Gilbert Sr. (Father) Gilbert Jr. (Brother) Shane (Sister) Martin (Grandfather) Amada (Grandmother) Restituta (Grandmother-in-Law) Bienvenido (Grandfather-in-Law) Librada (Great Grandmother-in-Law) Maximo (Great Grandfather-in-Law) 

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

Full blank declaration

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

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

See also

See also


Retrieved from "https://www.waze.com/wiki/USA/index.php?title=Template:Infobox/doc&oldid=136997"