Template:Infobox/doc: Difference between revisions

From Random Island Wiki
Jump to navigation Jump to search
>Bryan Derksen
(a section on optional fields)
>Bryan Derksen
m (a note on the current capacity of the template)
Line 268: Line 268:
}}
}}
</pre>
</pre>
Note that the template in its current form can handle up to 40 rows, only 20 are included in this blank template in order to make it easier to use.


==See also==
==See also==

Revision as of 01:41, 25 January 2008

Usage

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

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

Test Infobox
Caption for example.png
Header defined alone
Data defined alone
All three defined (header)
Label and data defined (label)Label and data defined (data)
Below text
{{Infobox
|name=Infobox/doc

|title=Test Infobox

|image=[[Image:example.png|200px]]
|caption=Caption for example.png

|header1=Header defined alone
|label1=
|data1=

|header2=
|label2= Label defined alone
|data2=

|header3=
|label3=
|data3= Data defined alone

|header4= All three defined (header)
|label4= All three defined (label)
|data4= All three defined (data)

|header5=
|label5= Label and data defined (label)
|data5= Label and data defined (data)

|below= Below text
}}


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

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


Full blank declaration

{{Infobox
|name={{subst:PAGENAME}}
|bodystyle=
|titlestyle=
|imagestyle=
|captionstyle=
|headerstyle=
|labelstyle=
|datastyle=
|belowstyle=

|title=

|image=
|caption=

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

|below=
}}

Note that the template in its current form can handle up to 40 rows, only 20 are included in this blank template in order to make it easier to use.

See also