Template:Infobox/doc: Difference between revisions
imported>Caesar Schinas No edit summary |
imported>Caesar Schinas No edit summary |
||
Line 2: | Line 2: | ||
It can, however, equally well be used to create one-off infoboxes on individual articles. | It can, however, equally well be used to create one-off infoboxes on individual articles. | ||
=== Usage === | |||
The following parameters can be used in the creation of infoboxes. Both are optional, but the '''title''' should normally be specified. | An infobox consists of a title, an optional subtitle, and several rows of data, each consisting of a label and a data cell. Examples can be seen [[#Example|below]]. | ||
The following parameters can be used in the creation of infoboxes. Both are ''optional'', but the '''title''' should normally be specified. | |||
;title | ;title | ||
Line 12: | Line 14: | ||
Each row in the infobox can be defined using a combination of the following parameters, replacing the # by the number of the row (the row number is necessary for technical reasons; it will not be shown in the infobox). These parameters are optional, though it is clearly pointless to create an infobox with no data whatsoever.<br /> | Each row in the infobox can be defined using a combination of the following parameters, replacing the # by the number of the row (the row number is necessary for technical reasons; it will not be shown in the infobox). These parameters are all ''optional'', though it is clearly pointless to create an infobox with no data whatsoever.<br /> | ||
It is currently only possible to create infoboxes with up to 25 rows, though this can easily be changed in the future. | It is currently only possible to create infoboxes with up to 25 rows, though this can easily be changed in the future. | ||
;<nowiki>#</nowiki>_label | ;<nowiki>#</nowiki>_label | ||
:The label for the row. If | :The label for the row. | ||
:If this parameter is blank or not defined, the label will be hidden and the data cell will occupy the full width of the row. | |||
:A full-width label, or header, can be made by setting the '''data''' parameter for the same row to three hyphens ( '''<nowiki>---</nowiki>''' ). | |||
;<nowiki>#</nowiki>_data | ;<nowiki>#</nowiki>_data | ||
:The data for the row. A full-width data row, with no label, can be shown simply by leaving the label blank or not defining it. | :The data for the row. | ||
:If this parameter is blank or not defined, the entire row will be hidden, including the label. | |||
:This feature can be taken advantage of in infoboxes based on this template to make their own parameters optional, by defining them as follows : <code> 1_data = <nowiki>{{{param|}}}</nowiki> </code>. | |||
:A full-width data row, with no label, can be shown simply by leaving the '''label''' parameter for the same row blank or not defining it. | |||
The following optional parameters allow [[CSS]] styles to be applied to the infobox. Each style parameter should end with a semicolon ( ''';''' ). | The following ''optional'' parameters allow [[CSS]] styles to be applied to the infobox. Each style parameter should end with a semicolon ( ''';''' ). | ||
;style | ;style | ||
:CSS which applies to the entire infobox. | :CSS which applies to the entire infobox. | ||
Line 46: | Line 53: | ||
==== | === Examples === | ||
The following example illustrates the basic syntax for the creation of a simple, standard, infobox. | |||
{{Infobox | |||
| title = This is the title | |||
| 1_label = Row 1 Label | |||
| 1_data = Row 1 Data | |||
| 2_label = Row 2 Label | |||
| 2_data = Row 2 Data | |||
}} | |||
<pre> | |||
{{Infobox | |||
| title = This is the title | |||
| 1_label = Row 1 Label | |||
| 1_data = Row 1 Data | |||
| 2_label = Row 2 Label | |||
| 2_data = Row 2 Data | |||
}} | |||
</pre> | |||
The following more complex example illustrates the usage of styles, headers, and full-width data rows. | |||
{{Infobox | {{Infobox | ||
| style = background:#ccf; | | style = background:#ccf; border:1px dashed #00f; | ||
| labelstyle = background:#99f; color:#00f; | | labelstyle = background:#99f; color:#00f; | ||
| datastyle = background:#eef; color:#009; | | datastyle = background:#eef; color:#009; |
Revision as of 02:40, 6 May 2009
This template is mainly intended to be used for the creation of other infoboxes, and all infoboxes should use it. See {{Infobox Software}} for an example. It can, however, equally well be used to create one-off infoboxes on individual articles.
Usage
An infobox consists of a title, an optional subtitle, and several rows of data, each consisting of a label and a data cell. Examples can be seen below.
The following parameters can be used in the creation of infoboxes. Both are optional, but the title should normally be specified.
- title
- Defines the title for the infobox.
- subtitle
- Defines the subtitle for the infobox.
Each row in the infobox can be defined using a combination of the following parameters, replacing the # by the number of the row (the row number is necessary for technical reasons; it will not be shown in the infobox). These parameters are all optional, though it is clearly pointless to create an infobox with no data whatsoever.
It is currently only possible to create infoboxes with up to 25 rows, though this can easily be changed in the future.
- #_label
- The label for the row.
- If this parameter is blank or not defined, the label will be hidden and the data cell will occupy the full width of the row.
- A full-width label, or header, can be made by setting the data parameter for the same row to three hyphens ( --- ).
- #_data
- The data for the row.
- If this parameter is blank or not defined, the entire row will be hidden, including the label.
- This feature can be taken advantage of in infoboxes based on this template to make their own parameters optional, by defining them as follows :
1_data = {{{param|}}}
. - A full-width data row, with no label, can be shown simply by leaving the label parameter for the same row blank or not defining it.
The following optional parameters allow CSS styles to be applied to the infobox. Each style parameter should end with a semicolon ( ; ).
- style
- CSS which applies to the entire infobox.
- titlestyle
- CSS which applies to the title.
- subtitlestyle
- CSS which applies to the subtitle.
- labelstyle
- CSS which applies to every label or header in the infobox.
- datastyle
- CSS which applies to every data cell in the infobox.
- #_labelstyle
- CSS which only applies to the label with the same number. This overrides the general labeltitle parameter.
- #_datastyle
- CSS which only applies to the data cell with the same number. This overrides the general datatitle parameter.
Examples
The following example illustrates the basic syntax for the creation of a simple, standard, infobox.
This is the title | |
---|---|
Row 1 Label | Row 1 Data |
Row 2 Label | Row 2 Data |
{{Infobox | title = This is the title | 1_label = Row 1 Label | 1_data = Row 1 Data | 2_label = Row 2 Label | 2_data = Row 2 Data }}
The following more complex example illustrates the usage of styles, headers, and full-width data rows.
This is the title | |
---|---|
This is the subtitle | |
1 A Header | |
2 A Label | 2 Some Data |
3 Another Label | 3 Some more Data |
4 A Header | |
6 Some data only that expands across both columns | |
7 A Header | |
8 A Label | 8 Some Data |
9 Another Label | 9 Some more Data |
10 Another Label | 10 Some more Data |
11 A Header | |
12 Some data only that expands across both columns |
{{Infobox | style = background:#ccf; | labelstyle = background:#99f; color:#00f; | datastyle = background:#eef; color:#009; | title = This is the title | titlestyle = color:#f00; | subtitle = This is the subtitle | subtitlestyle = color:#00f; | 1_label = 1 A Header | 1_data = --- | 2_label = 2 A Label | 2_data = 2 Some Data | 3_label = 3 Another Label | 3_data = 3 Some more Data | 4_label = 4 A Header | 4_data = --- | 5_label = 5 A Label only (doesn't work...) | 6_data = 6 Some data only that expands across both columns | 7_label = 7 A Header | 7_labelstyle = background:lightgrey; | 7_data = --- | 8_label = 8 A Label | 8_labelstyle = background:lightblue; font-style:italic; | 8_data = 8 Some Data | 9_label = 9 Another Label | 9_data = 9 Some more Data | 9_datastyle = background:lightgreen; font-style:italic; | 10_label = 10 Another Label | 10_labelstyle = background:lightblue; | 10_data = 10 Some more Data | 10_datastyle = background:lightgreen; | 11_label = 11 A Header | 11_data = --- | 12_data = 12 Some data only that expands across both columns | 12_datastyle = background:lightgreen; font-style:italic; border:1px solid red; }}