Template:Campaignbox/doc

Revision as of 02:56, 25 February 2008 by imported>Kirill Lokshin (moved Wikipedia:WikiProject Military history/Campaignboxes to Template:Campaign/doc: Standard doc form)
Jump to navigation Jump to search

Template:Template doc page

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}}

For particular combinations of the relative sizes of the infobox and the lead section, the presence of a campaignbox may cause bunched up edit links.

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

A campaignbox template 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     =
| raw_name =
| battles  =
}}
  • name – 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.
  • raw_name – the actual name of the created template (i.e. "Campaignbox XXX"); this can be easily produced by using {{subst:PAGENAME}}.
  • battles – a chronological, en-dash separated list of battles and operations in the campaign, linked as [[Battle of YYYY|YYYY]]; non-breaking spaces ( ) should be used to ensure that multi-word names do not split over multiple lines.

For example:

{{campaign
| name     = [[Italian War of 1542-46]]
| raw_name = Campaignbox Italian War of 1542–1546
| battles  = [[Siege of Nice|Nice]] – 
[[Battle of Ceresole|Ceresole]] – 
[[Battle of Serravalle|Serravalle]] – 
[[Siege of St. Dizier (1544)|St. Dizier]] – 
[[Siege of Boulogne|Boulogne]] – 
[[Battle of the Solent|Solent]]
}}

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.

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.

Articles other than those about military conflicts—such as those dealing with personnel or military units—may use the campaignbox formatting to create lists of battles or wars in which the subject participated. In this case, the box should be created by including {{campaign}} directly in the article, without creating a separate template.Template:TOCright
Campaignboxes are generally listed here in chronological order by the START of the conflict, with some subdivision by theater in the case of extremely complicated conflicts.

Existing campaignboxes may be browsed through Category:Campaignboxes, which is automatically generated from the meta-template transclusion.