Template:Campaignbox/doc

From Wikipedia, the free encyclopedia
Jump to: navigation, search

Usage

Campaignboxes

One common type of navigational template is the campaignbox template, which provides quick navigation among the battles in a campaign, front, theater, or war (or, more rarely, among several campaigns or wars).

The campaignbox should generally be included directly after the infobox template (or in its campaignbox parameter, if {{infobox military conflict}} is used), if one is present:

{{infobox military conflict
...
}}
{{campaignbox XXXX}}

{{infobox military conflict
...
|campaignbox={{campaignbox XXXX}}
}}

Articles may include multiple campaignboxes (which are typically stacked following the infobox). The most common scenario occurs when two levels of campaignboxes are present; for example, an article about a battle can include both a campaignbox listing the battle itself and an "enclosing" campaignbox listing the campaign, theater, or war during which the battle took place. Similarly, an article about a war can include both a campaignbox listing the war (among a series of wars) and a campaignbox for the war itself, listing the battles that took place during it.

Creating campaignboxes

Existing campaignboxes may be viewed through the automatically generated category. If a new one is necessary, it should be named Template:Campaignbox XXXX, where XXXX is the name of the campaign (or a shortened form of it), and should use {{campaignbox}}, as shown below:

{{campaignbox
| name    = 
| title   = 
| battles = 
| notes   = 
}}
name
The actual name of the created template (i.e. "Campaignbox XXX"); this can be produced by using {{subst:PAGENAME}}.
title
The name of the campaign or war, which should be linked to an article about the campaign if one exists. Dates should not be indicated unless needed for clarity. Note that long links may cause alignment problems; see the troubleshooting guide for a workaround.
battles
A chronological list of battles and operations in the campaign, linked as [[Battle of YYYY|YYYY]]. Assigning bodyclass=hlist or listclass=hlist provides a convenient and accessible method for separating the items; just use standard * bulleted list format.
notes
(optional) Any needed explanatory notes for the list of operations; this field should be used sparingly.
raw_name
(optional, deprecated) This parameter is present for backward compatibility, and overrides the use of the name and title in determining the template name. In creating a new campaignbox, both title and name should be specified, and this parameter should be omitted.

The following optional parameters are passed on to {{Military navigation}} or {{navbox}}, and affect the styling of the template. See their documentation pages for further details:

state
whether the box is fully visible or not
bodyclass
CSS style for the box body
listclass
CSS style for the box list

The use of special formatting (such as bolding or changes in font size) in the list of battles—particularly to mark battles as "important"—is generally discouraged; while there are a few cases where such approaches may be both helpful to the reader and sufficiently well-sourced that they do not constitute original research, they are both unnecessary and confusing in most circumstances. Similarly, dividing the list of battles into multiple blocks by inserting heading-like separations is not recommended in the average case; if such a division is needed, it is typically best accomplished by splitting the template into multiple campaignboxes.