Template:Campaignbox/doc

Usage

Campaignboxes

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

The campaignbox should generally be included directly after the infobox template, if one is present:

{{infobox military conflict
...
}}
{{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 {{campaign}}, as shown below:

{{campaign
| name    = 
| title   = 
| battles = 
| notes   = 
}}

name

the actual name of the created template (i.e. "Campaignbox XXX"); this can be easily produced by using {{subst:PAGENAME}}. deprecated: older usage is raw_name.

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. deprecated: older usage is name, which assumes raw_name, above.

battles

a chronological list of battles and operations in the campaign, linked as [[Battle of YYYY|YYYY]]. {{Flatlist}} provides an accessible and semantically valid method (using an HTML list) of separating items. (Older usage is an en-dash separated list using non-breaking spaces ( ) to ensure that multi-word names do not split over multiple lines. In most case, non-breaking spaces and related templates ({{nowrap}} et al) are no longer appropriate, as links in such navigation boxes now inherit white-space: nowrap; from their containing box.

notes

optional – any needed explanatory notes for the list of operations; this field should be used sparingly.

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.