Help:Infoboxes

From The Coppermind
Revision as of 14:02, 30 October 2018 by Fbstj (talk | contribs) (+clarity around line order)
Jump to navigation Jump to search

Infoboxes are templates which display a list of properties about an article to the right of the introductory paragraphs. The properties shown are often links to other articles and may responsible for adding a page to a particular category. The infobox may also display an image depicting the article contents above the other information. This article will describe the general layout of infoboxes and include examples and descriptions of the most common properties.

The vast majority of content articles include one of the infobox templates, and the information is always provided in the first few lines of the article, and each of the `|property=value` lines will produce an equivalent row in the infobox. For a list of all infobox templates see category: infoboxes. The properties passed to the infobox should each be on their own line and should be listed in order of their appearance on the final rendered page.

{{infobox-name|title=better title
|image=example.jpg
|region=Final Empire
|earth=Reckoners
|world=Scadrial
|universe=Cosmere
|setting=Cosmere
|books=[[Bibliography]]
}}

Some of the properties will show the exact content passed (eg |books=) and may expect values generated from tag templates; others will turn the passed words into a link and may add the article to the category passed (eg |universe=Comsere will link to Cosmere and add the page to category: cosmere); some of the most complex cases, particularly in the {{character}} template, will run the item through one of the tag templates to generate a specific link & category from a list. The most complex cases will usually include a `-raw`-suffixed or `raw-`-prefixed variant of the property which acts like the more simple properties and requires the article to provide all the links & categories itself.

Some of the other properties may do more complex things specific to that template.

Common Parameters

|image=
Many infoboxes have has the ability to show an image of the subject by providing the filename, eg |image=lifeform.jpg. This parameter should be on the first line after the opening {{infobox-template as the image is placed at the top of the page. The filename will be passed to {{row/image+artist}} and will show the image and provide attribution to the artist.
|books=
Most infoboxes have a books parameter is required and should provide links to the books or series which the subject is featured in. The Featured In line appears at the bottom of the infobox, and so the line should be the last before the closing }} line.

Location & Setting

To indicate the setting within which the subject matter is discussed, the following parameters are accepted. At least one of these should be provided, and they should be provided in most-to-least specific order, as they are in the above list.

|world=
The world parameter should provide the name of the planet the subject is located on. This will generate a link to the planet passed and may categorise the article in an appropriate planet category.
|earth=
If the setting is an alternative earth, the earth parameter should be used instead, and should provide the series name (such as |earth=Alcatraz which will create a link to Earth (Alcatraz) or |earth=Reckoners to link to Earth (Reckoners)) and may categorise the article in an appropriate category.
|universe=
If neither world or earth are sufficient, then a universe can be provided to describe a more generic setting.
|region=
To indicate a more specific area or region the subject is from, provide the region parameter

Special parameters

|title=
On some articles, particularly ones that clash with other titles and have been disambiguated, the title at the top of the infobox can be changed to show the proper subject title. This also may set the category key and so may change the location of the article in any category listings.
When using {{character}} there is a special |unnamed=y parameter which will change the title to Unknown and add the article to category: unnamed characters otherwise you can pass |name= to change the title rather than |title=.