Help:Infobox
 | This help page is a how-to guide. It details processes or procedures of some aspect(s) of our norms and practices. |
An infobox is a fixed-format table usually added to the top right-hand corner of articles to consistently present a summary of some unifying aspect that the articles share and sometimes to improve navigation to other interrelated articles. Many infoboxes also emit structured metadata which is sourced by DBpedia and other third party re-users.
What infoboxes do
Infobox templates contain important facts and statistics of a type which are common to related articles. For instance, all animals have a scientific classification (species, family and so on), as well as a conservation status. Adding {{Infobox road}} to articles on highways therefore makes it easier to quickly find such information and to compare it with that of other articles.
Infobox templates are like fact sheets, or sidebars, in magazine articles. They quickly summarize important points in an easy-to-read format. However, they are not "statistics" tables in that they (generally) only summarize material from an article—the information should still be present in the main text, partly because it may not be possible for some readers to access the contents of the infobox. In particular, if infobox templates hide long columns of data inside collapsing tables, then readers using assistive technology may miss their presence entirely.
Many infoboxes also emit metadata such as microformats.
What should an infobox contain?
In general, data in infobox templates should be:
- Comparable. If a lot of different subjects all share a common attribute (for instance, all people have a name and a date of birth), then it is useful to be able to compare these across different pages. This also implies that where possible, material should be presented in a standard format.
- Concise. Infobox templates are "at-a-glance", and used for quickly checking facts.
- Materially relevant to the subject.
- Already cited elsewhere in the article. Infoboxes, like the introduction to the article, should primarily contain material that is expanded on and supported by citations to reliable sources elsewhere in the article. However, if necessary (e.g., because the article is currently incomplete), it is possible to include footnotes in infoboxes.
What should an infobox not contain?
In general, data in infobox templates should not have:
- Excessive length. Long bodies of text, or very detailed statistics, belong in the article body.
- Trivial details. A common problem is including material in the infobox which is trivial and would not otherwise be included in the article body: for example, a fictional character's blood type may be referenced in passing in a work, but it is not especially useful to understanding the subject. Infobox templates should not be used for details that are too trivial to include in the article body (there are some exceptions, such as chemical properties).
Adding an infobox to an article
Infoboxes should be placed at the top of an article after any disambiguation links and maintenance tags.
The infobox documentation page usually contains a convenient "blank" template that can be copied directly into the target article. The template consists of opening ({{) and closing (}}) double braces that contain the name of the infobox and a list of parameters without values. An editor then fills in the value for each of the parameters to the right of the corresponding equals sign.
For example:
{{Infobox road
| country =
| type =
| route =
...
| website =
}}might be filled out like this:
{{Infobox person
| name = Casanova
| image = Casanova self portrait.jpg
| caption = A self-portrait of Casanova
...
| website =
}}In this example, the names of the parameters ("name", "image", "caption", "website") are fixed in the design of the infobox and described in its documentation. A parameter that is misspelled, falsely capitalized, or is not supported by the infobox implementation does not display at all. To find out exactly which parameters are functional, look at the infobox's template page. Anything not listed there will be ignored, even if it works in some other infobox. If you believe that another parameter needs to be added to a given infobox template, then suggest that on the infobox's talk page.
The infobox documentation describes which parameters are required and which are optional. Required parameters display between triple braces (for example, {{{requiredparametername}}}) when previewed or published. Optional parameters may be left empty or omitted entirely.
Troubleshooting
If you added an infobox and it didn't display correctly, here are the common errors:
- You used a made-up or invalid parameter. You can only use parameters that have been pre-programmed into this infobox template.
- You misspelled the parameter name or omitted necessary punctuation (e.g., leaving out the underscore in
birth_place). - You capitalized the parameter name. Parameters are case sensitive. Nearly all infoboxes use lowercase parameter labels.
- You included the prefix
File:before the image name (or you didn't, and it's one of the templates that requires it). - You used the parameter name more than once: only the final instance displays.
Adding an image to an infobox
Images are generally specified using the image and caption parameters. However, the template may use a different name for this parameter. For example, {{Infobox album}} uses "Cover" instead of "image" and "Caption" instead of "caption".
The image parameter sometimes requires the Help:Extended image syntax; other times it requires only the image file name depending on the tastes of the editor who created the infobox. An editor can determine this either by experimenting (using the "preview" function) or by consulting the infobox template documentation.
Many images in infoboxes should have a special text alternative for people who cannot see the image.
Combining multiple infoboxes
If an article requires two or more infoboxes it is often possible to combine them into one, by including the others as a module (or child-, or sub-template) of the first. Alternately, it can be useful to use {{stack}} as a container for them to prevent layout problems with other images and floating elements in the article.
Designing an infobox
It is a good idea to seek the opinions of other editors before embarking on a design of a new infobox or redesign of an existing one. Most requirements are already met by an existing infobox and most of the remainder can be met with a tweak. Unnecessary duplication leads to clutter and article divergence. Prototype your new design in your own user space.
Deleting an infobox
Requests to delete an infobox should be brought to the attention at AARoads:Deletion requests and at The Interchange. A template may be merged with another rather than deleted outright.
Infoboxes and user style
Users can have user CSS that hides any infoboxes in their own browsers.
To hide all infoboxes, add the following to Special:MyPage/common.css (for all skins, or Special:MyPage/skin.css for just the current skin), on a line by itself:
div.mw-parser-output .infobox { display: none; }
Alternatively, you can add the following code to your common.js or into a browser user script that is executed by an extension like Greasemonkey:
$('.infobox').hide();