Difference between revisions of "Template:Infobox"
From Twinsuniverse
J McKalling (Talk | contribs) (improved code with a #loop and updated documentation) |
J McKalling (Talk | contribs) (updated documentation) |
||
| Line 23: | Line 23: | ||
}}</includeonly><noinclude> | }}</includeonly><noinclude> | ||
This template is used to show an infobox for a page. It should be the first of the page, before the general description. | This template is used to show an infobox for a page. It should be the first of the page, before the general description. | ||
| − | This template also uses | + | This template also uses the {{templatelink|Infobox/row}} template for rendering a title, an optional {{templatelink|articleimage}}, and 30 optional rows of custom data headings. |
| + | |||
| + | |||
| + | '''''Note''': This template provides the main functionality of the {{templatelink|Infobox}}, whereas the latter further automates the theme selection. These may be merged later.'' | ||
==Parameters== | ==Parameters== | ||
* '''infoboxname''': The name of the infobox calling this template, for the link to documentation (case sensitive, defaults to no documentation link displayed) | * '''infoboxname''': The name of the infobox calling this template, for the link to documentation (case sensitive, defaults to no documentation link displayed) | ||
| − | * '''title''': | + | * '''title''': The title to use in the top heading of the infobox (optional, defaults to <nowiki>{{PAGENAME}}</nowiki>) |
| − | * '''float''': | + | * '''float''': Whether the infobox should float to the right (any value will do, defaults to no float) |
| − | * '''mainstyle''': | + | * '''mainstyle''': The CSS statements to use for the theme colours of the main infobox rectangle (optional, defaults to stylesheet colours) |
| − | * '''headstyle''': | + | * '''headstyle''': The CSS statements to use for the theme colours of the full-width headings (optional, defaults to stylesheet colours) |
| − | * '''leadstyle''': | + | * '''leadstyle''': The CSS statements to use for the theme colours of the alternate full-width headings (optional, defaults to stylesheet colours) |
| − | * '''datastyle''': | + | * '''datastyle''': The CSS statements to use for the theme colours of the data cells (optional, defaults to stylesheet colours) |
| − | * '''class''': | + | * '''class''': One of the theme titles on the [[Template:Infobox/themes|themes]] subpage, or a custom class (lowercase, multiple values are space-delimited, defaults to no class) |
| − | * '''image''': | + | * '''image''': The filename of the image to use as the infobox's article image (case sensitive, defaults to a default image) |
| − | * '''imagecaption''': | + | * '''imagecaption''': The text to show in the tooltip when the article image is hovered (case sensitive, defaults to <nowiki>'Image for article: {{PAGENAME}}'</nowiki>) |
| − | * '''noimage''': | + | * '''noimage''': Whether the article image should be absent altogether (any value will do, defaults to false) |
| − | * '''nocat''': | + | * '''nocat''': Whether or not to suppress categorization by the {{templatelink|articleimage}} template (defaults to false, which means auto categorization). |
| − | + | ||
==Syntax== | ==Syntax== | ||
Revision as of 17:03, 3 June 2014
This template is used to show an infobox for a page. It should be the first of the page, before the general description. This template also uses the {{Infobox/row}} template for rendering a title, an optional {{articleimage}}, and 30 optional rows of custom data headings.
Note: This template provides the main functionality of the {{Infobox}}, whereas the latter further automates the theme selection. These may be merged later.
Parameters
- infoboxname: The name of the infobox calling this template, for the link to documentation (case sensitive, defaults to no documentation link displayed)
- title: The title to use in the top heading of the infobox (optional, defaults to {{PAGENAME}})
- float: Whether the infobox should float to the right (any value will do, defaults to no float)
- mainstyle: The CSS statements to use for the theme colours of the main infobox rectangle (optional, defaults to stylesheet colours)
- headstyle: The CSS statements to use for the theme colours of the full-width headings (optional, defaults to stylesheet colours)
- leadstyle: The CSS statements to use for the theme colours of the alternate full-width headings (optional, defaults to stylesheet colours)
- datastyle: The CSS statements to use for the theme colours of the data cells (optional, defaults to stylesheet colours)
- class: One of the theme titles on the themes subpage, or a custom class (lowercase, multiple values are space-delimited, defaults to no class)
- image: The filename of the image to use as the infobox's article image (case sensitive, defaults to a default image)
- imagecaption: The text to show in the tooltip when the article image is hovered (case sensitive, defaults to 'Image for article: {{PAGENAME}}')
- noimage: Whether the article image should be absent altogether (any value will do, defaults to false)
- nocat: Whether or not to suppress categorization by the {{articleimage}} template (defaults to false, which means auto categorization).
Syntax
Copy and paste the following for quick use:
{{infobox
|class=
|image=
|imagecaption=
}}
Example
... this template is still under documentation
