Citizendium - a community developing a quality, comprehensive compendium of knowledge, online and free.
Click here to join and contribute
CZ thanks our previous donors. Donate here. Treasurer's Financial Report

Difference between revisions of "Template:Infobox/doc"

From Citizendium
Jump to: navigation, search
m
Line 1: Line 1:
This template is mainly intended to be used for the creation of other infoboxes.<br />
+
This template is mainly intended to be used for the creation of other infoboxes, and all infoboxes should use it. See {{tl|Infobox Software}} for an example.
It is recommended that all infoboxes be based on this template.<br />
+
It can, however, equally well be used to create one-off infoboxes on individual articles.
See {{tl|Infobox Software}} for an example.
+
 
+
It can, however, equally well be used to create one-off infoboxes on pages which are unique enough not to need an infobox template for that type of page.
+
  
 
==== Usage ====
 
==== Usage ====
CSS styles such as <code>background</code> can optionally be defined using the following variables.
+
The following parameters can be used in the creation of infoboxes. Both are optional, but the '''title''' should normally be specified.
* '''<code>style</code>''' (styles which will apply to the entire infobox)
+
 
* '''<code>labelstyle</code>''' (styles which should be applied to every label in the entire infobox)
+
;title
* '''<code>datastyle</code>''' (styles which should be applied to every data cell in the entire infobox)
+
:Defines the title for the infobox.
These styles can be overridden on a per-cell basis using the per-cell style variables [[#Example|below]].<br />
+
 
Each style should end with a semicolon ( ''';''' ), as seen [[#Example|below]].
+
;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 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.
 +
 
 +
;<nowiki>#</nowiki>_label
 +
:The label for the row. If there is no data, the label will not be shown. A full-width label, or header, can be made by setting the data parameter for the same row to <nowiki>---</nowiki> (three hyphens).
 +
 
 +
;<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 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.
  
The title of the infobox is defined by the '''<code>title</code>''' variable.<br />
+
;datastyle
The subtitle  is defined by the '''<code>subtitle</code>''' variable.
+
:CSS which applies to every data cell in the infobox.
  
Each row is defined using a combination of the following variables.
+
;<nowiki>#</nowiki>_labelstyle
*'''<code>#_label</code>'''
+
:CSS which only applies to the label with the same number. This overrides the general '''labeltitle''' parameter.
*'''<code>#_labelstyle</code>'''
+
*'''<code>#_data</code>'''
+
*'''<code>#_datastyle</code>'''
+
The # in the above variables must be replaced by the row number, as seen [[#Example|below]] (''eg'' '''<code>1_label</code>''' and  '''<code>1_data</code>''' for the first row, etc).
+
  
The data variables can be used alone to create a full-width data row without a label.<br />
+
;<nowiki>#</nowiki>_datastyle
A centred bold header, without data, can be created by setting the data variable to '''<code>---</code>'''.<br />
+
:CSS which only applies to the data cell with the same number.  This overrides the general '''datatitle''' parameter.
If no label or data style is designated the default styles will be used.
+
  
Up to 25 different rows can be defined.
 
  
All variables are optional, though it is clearly pointless to create an infobox with no data whatsoever.
 
  
 
==== Example ====
 
==== Example ====

Revision as of 07:45, 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

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 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 there is no data, the label will not be shown. 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. A full-width data row, with no label, can be shown simply by leaving the label 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.


Example

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