Difference between revisions of "Template:Infobox military conflict/doc"

From ShadowHaven Reloaded
Jump to navigation Jump to search
Tag: visualeditor-wikitext
(Blanked the page)
Tags: Blanking visualeditor
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
==Usage==


A military conflict infobox (sometimes referred to as a warbox) may be used to summarize information about a particular military conflict (a battle, campaign, war, or group of related wars) in a standard manner. 
The infobox should be added using the [[:Template:infobox military conflict]] template, as shown below:
<div style="width:250px;background:#dddddd;border: 1px solid black;padding:0.5em  1em 0.5em 1em"><pre>
{{Infobox military conflict
| conflict    =
| width      =
| partof      =
| image      =
| caption    =
| date        =
| place      =
| coordinates =
| map_type    =
| map_relief  =
| latitude    =
| longitude  =
| map_size    =
| map_marksize =
| map_caption =
| map_label  =
| territory  =
| result      =
| status      =
| combatants_header =
| combatant1  =
| combatant2  =
| combatant3  =
| commander1  =
| commander2  =
| commander3  =
| units1      =
| units2      =
| units3      =
| strength1  =
| strength2  =
| strength3  =
| casualties1 =
| casualties2 =
| casualties3 =
| notes      =
| campaignbox =
}}
</pre></div>
'''Note''': When using parameters, avoid the ambiguous abbreviation "N/A", and instead use "unknown" or "none". All subjective or qualitative judgements and numerical quantities or statistics must be cited to a reliable source (see ((WP:MILMOS#CITE))).
===Parameters===
* '''conflict''' – the name of the conflict being described (e.g. "Battle of Lützen" or "World War I").
* '''width''' - ''optional'' - the width of the infobox, e.g. "400px"; defaults to: "315px".
* '''partof''' – ''optional'' – the larger conflict containing the event described in the article.  For battles or campaigns, this should be the war during which the event takes place; for particularly large wars, this may include a theatre (e.g. "the Eastern Front of World War II").  For wars, the parameter may be used to link to a larger group of wars (e.g. the ((Italian War of 1521–26)) to the ((Italian Wars))).  It may be necessary to insert "the" before the name of the war for proper grammar.
* '''image''' – ''optional'' – an image for the warbox.  The image must be given in the form <nowiki>([[File:Example.jpg|300px|alt=Example alt text]]</nowiki>; in particular, the ''thumb'' attribute must '''not''' be selected.
* '''image_size''' – ''optional'' – a size for the image.
* '''caption''' – ''optional'' – the text to be placed below the image. 
* '''date''' – ''optional'' – the date of the conflict described.  Convention is to give the actual date for battles and the years for wars, but this does not always apply.
* '''place''' – the location of the conflict.  For conflicts covering a wide area, a general description (e.g. "France", or "Europe", or "Worldwide") may be used.
* '''coordinates''' Unused for our purposes
* '''map_type''' Unused for our purposes
* '''map_relief''' Unused for our purposes
* '''latitude''' Unused for our purposes
* '''longitude''' Unused for our purposes
* '''map_size''' Unused for our purposes
* '''map_mark''' Unused for our purposes 
* '''map_marksize''' Unused for our purposes
* '''map_caption''' Unused for our purposes
* '''map_label''' Unused for our purposes
* '''territory''' – ''optional'' – any changes in territorial control as a result of the conflict; this should not be used for overly lengthy descriptions of the peace settlement.
* '''action''' – ''optional'' – In case of Coup d'État, short description of ''modus operandi'', e.g. "...marched over the city...", "...dissolving the Congress of the Republic...", "...take the government hostage ...", "...put the country under military control ...", etc.
* '''result''' – ''optional'' – this parameter may use one of several standard terms: "X victory", "Decisive X victory" or "Inconclusive". The choice of term should reflect what the sources say. In cases where the standard terms do not accurately describe the outcome, a link to the section of the article where the result is discussed in detail (such as "See the 'Aftermath' section") should be used instead of introducing non-standard terms like "marginal" or "tactical" or contradictory statements like "decisive tactical victory but strategic defeat". It is better to omit this parameter altogether than to engage in ((WP:NOR|speculation)) about which side won or by how much.
* '''status''' – ''optional'' – for ongoing conflicts, the current status of the conflict.  This should not be used if a final result (above) is provided.
* '''combatants_header''' – ''optional'' – sets the header text for the combatants section. Default is "Belligerents". In case of Coup d'État, use "Government-Insurgents&nbsp;&nbsp;&nbsp;"
* '''combatant1'''/'''combatant2'''/'''combatant3''' – ''optional'' – the parties participating in the conflict.  This is most commonly the countries whose forces took part in the conflict; however, larger groups (such as alliances or international organizations) or smaller ones (such as particular units, formations, or groups) may be indicated if doing so improves reader understanding.  When there is a large number of participants, it may be better to list only the three or four major groups on each side of the conflict, and to describe the rest in the body of the article.  The '''combatant3''' field may be used if a conflict has three distinct "sides", and should be left blank on other articles.  Combatants should be listed in order of importance to the conflict, be it in terms of military contribution, political clout, or a recognized chain of command.  If differing metrics can support alternative lists, then ordering is left to the editors of the particular article.
** '''combatant1a'''/'''combatant2a'''/'''combatant3a''' – ''optional'' – in cases where the parties significantly changed over the course of the conflict, these subsidiary fields may be used to provide additional rows for the '''combatant''N''''' fields (above).
** '''combatant1b'''/'''combatant2b'''/'''combatant3b''' – ''optional'' – additional row, as above.
** '''combatant1c'''/'''combatant2c'''/'''combatant3c''' – ''optional'' – additional row, as above.
** '''combatant1d'''/'''combatant2d'''/'''combatant3d''' – ''optional'' – additional row, as above.
* '''commander1'''/'''commander2'''/'''commander3''' – ''optional'' – the commanders of the military forces involved.  For battles, this should include military commanders (and other officers as necessary).  For wars, only prominent or notable leaders  should be listed, with an upper limit of about seven per combatant column recommended.  Ranks and position titles should be omitted. The '''commander3''' field can only be used if the '''combatant3''' field is set. 
* '''units1'''/'''units2'''/'''units3''' – ''optional'' – the units or formations involved.  If a large number of distinct formations is present, it may be better to reference an order of battle in the body of the article than to include the entire list in this field.  The '''units3''' field can only be used if the '''combatant3''' field is set.
* '''strength1'''/'''strength2''' – ''optional'' – the numerical strength of the units involved.
:* '''polstrength1'''/'''polstrength2''' – ''optional'' – In case of Coup d'Etat, political organizations that supported the government (1) respective the insurgents (2).
:* '''milstrength1'''/'''milstrength2''' – ''optional'' – In case of Coup d'Etat, military units that supported the government (1) respective the insurgents (2).
* '''strength3''' – ''optional'' – if '''combatant3''' is set, this is a third strength field identical to the two above; if it is '''''not''''' set, this is an alternate combined field for use where only the total participation in a conflict is known.
* '''casualties1'''/'''casualties2''' – ''optional'' – casualties suffered, including dead, wounded, missing, captured, and civilian deaths. Terms such as "dead" (or "killed"), "wounded", or "captured" should be used in place of abbreviations such as "KIA" or "POW".
* '''casualties3''' – ''optional'' – if '''combatant3''' is set, this is a third casualty field identical to the two above; if it is '''''not''''' set, this is an alternate combined field for use where only the total casualties of a conflict are known, or where civilian casualties cannot be directly attributed to either side.
* '''notes''' – ''optional'' – optional field for further notes; this should only be used in exceptional circumstances.
* '''campaignbox''' – ''optional'' – optional field for appending a ((WP:CAMPAIGN|campaignbox template)) to the bottom of the infobox, which allows both boxes to float as a single element (useful if there are subsequent left floating images, which would otherwise not be able to float above the campaign box); the template must be specified in the format <nowiki>{{Campaignbox XYZ}}</nowiki>.
<noinclude>((Category:WikiProject Military history template instructions|Military conflict infobox))
</noinclude>{{Campaign/doc|noheader=yes}}<!--
-->{{Operational plan/doc|noheader=yes}}
==TemplateData==
{{TemplateData header}}
<templatedata>
{
"description": "Summarize information about a particular military conflict (a battle, campaign, war, or group of related wars).",
"params": {
"conflict": {
"label": "Conflict",
"description": "The name of the conflict being described.",
"type": "string/line",
"required": true
},
"width": {
"label": "Width",
"description": "Width of the infobox.",
"type": "string",
"default": "315px",
"required": false
},
"partof": {
"label": "Part of",
"description": "The larger conflict containing the event described in the article.",
"type": "wiki-page-name",
"required": false
},
"image": {
"label": "Image",
"description": "An image for the warbox given in the form Example.jpg.",
"type": "string",
"required": false
},
"image_size": {
"label": "Image size",
"description": "The size of the image",
"type": "string",
"required": false
},
"caption": {
"label": "Caption",
"description": "The text to be placed below the image.",
"type": "string",
"required": false
},
"date": {
"label": "Date",
"description": "The date of the conflict described. Convention is to give the actual date for battles and the years for wars, but this does not always apply.",
"type": "string",
"required": false
},
"place": {
"label": "Place",
"description": "The location of the conflict.",
"type": "string",
"required": true
},
"coordinates": {
"label": "Coordinates",
"description": "The location of the structure, given as a coordinate pair by using {{coord}} with display=inline,title.",
"type": "string",
"required": false
},
"map_type": {
"label": "Map Type",
"description": "The base map to be used for the location map, e.g. \"Scotland\"; see {{location map}} for more details.",
"type": "string",
"required": false
},
"map_relief": {
"label": "Map Relief",
"description": "\"yes\" if the location map is a relief map.",
"type": "string",
"required": false
},
"latitude": {
"label": "Latitude",
"description": "Latitude for placing the marker on the location map.",
"type": "number",
"required": false
},
"longitude": {
"label": "Longitude",
"description": "Longitude for placing the marker on the location map.",
"type": "number",
"required": false
},
"map_size": {
"label": "Map Size",
"description": "Width of the location map in pixels (px).",
"type": "number",
"default": "220",
"required": false
},
"map_mark": {
"label": "Map Marker",
"description": "File to use as the location map marker.",
"type": "string",
"default": "red_pog.svg",
"required": false
},
"map_marksize": {
"label": "Map Marker Size",
"description": "Width of the location map marker in pixels (px).",
"type": "number",
"default": "8",
"required": false
},
"map_caption": {
"label": "Map Caption",
"description": "Caption displayed below the location map.",
"type": "string",
"default": "Location within {{{map_type}}}",
"required": false
},
"map_label": {
"label": "Map Label",
"description": "The label placed next to the marker on the location map.",
"type": "string/line",
"required": false
},
"territory": {
"label": "Territory",
"description": "Any changes in territorial control as a result of the conflict; this should not be used for overly lengthy descriptions of the peace settlement.",
"type": "string",
"required": false
},
"result": {
"label": "Result",
"description": "this parameter may use one of several standard terms: \"X victory\", \"Decisive X victory\" or \"Inconclusive\". The choice of term should reflect what the sources say. In cases where the standard terms do not accurately describe the outcome, a link to the section of the article where the result is discussed in detail (such as \"See the 'Aftermath' section\") should be used instead of introducing non-standard terms like \"marginal\" or \"tactical\" or contradictory statements like \"decisive tactical victory but strategic defeat\". It is better to omit this parameter altogether than to engage in speculation about which side won or by how much.",
"type": "string/line",
"required": false
},
"gm": {
"label": "GM",
"description": "This is the GM who did the run",
"type": "string/line",
"required": false
},
"status": {
"label": "Status",
"description": "For ongoing conflicts, the current status of the conflict.",
"type": "string/line",
"required": false
},
"combatants_header": {
"label": "\"Combatants\" Header Text",
"description": "Sets the header text for the combatants section.",
"type": "string/line",
"default": "Belligerents",
"required": false
},
"combatant1": {
"label": "Combatant 1",
"description": "A party participating in the conflict.",
"type": "string",
"required": false
},
"combatant2": {
"label": "Combatant 2",
"description": "A party participating in the conflict.",
"type": "string",
"required": false
},
"combatant3": {
"label": "Combatant 3",
"description": "A party participating in the conflict. (only if the conflict has three distinct \"sides\")",
"type": "string",
"required": false
},
"combatant1a": {
"label": "Combatant 1a",
"description": "In cases where the parties significantly changed over the course of the conflict, this field may be used to provide additional rows for the Combatant 1 field.",
"type": "string",
"required": false
},
"combatant2a": {
"label": "Combatant 2a",
"description": "In cases where the parties significantly changed over the course of the conflict, this field may be used to provide additional rows for the Combatant 2 field.",
"type": "string",
"required": false
},
"combatant3a": {
"label": "Combatant 3a",
"description": "In cases where the parties significantly changed over the course of the conflict, this field may be used to provide additional rows for the Combatant 3 field.",
"type": "string",
"required": false
},
"combatant1b": {
"label": "Combatant 1b",
"description": "In cases where the parties significantly changed over the course of the conflict, this field may be used to provide additional rows for the Combatant 1 field.",
"type": "string",
"required": false
},
"combatant2b": {
"label": "Combatant 2b",
"description": "In cases where the parties significantly changed over the course of the conflict, this field may be used to provide additional rows for the Combatant 2 field.",
"type": "string",
"required": false
},
"combatant3b": {
"label": "Combatant 3b",
"description": "In cases where the parties significantly changed over the course of the conflict, this field may be used to provide additional rows for the Combatant 3 field.",
"type": "string",
"required": false
},
"combatant1c": {
"label": "Combatant 1c",
"description": "In cases where the parties significantly changed over the course of the conflict, this field may be used to provide additional rows for the Combatant 1 field.",
"type": "string",
"required": false
},
"combatant2c": {
"label": "Combatant 2c",
"description": "In cases where the parties significantly changed over the course of the conflict, this field may be used to provide additional rows for the Combatant 2 field.",
"type": "string",
"required": false
},
"combatant3c": {
"label": "Combatant 3c",
"description": "In cases where the parties significantly changed over the course of the conflict, this field may be used to provide additional rows for the Combatant 3 field.",
"type": "string",
"required": false
},
"combatant1d": {
"label": "Combatant 1d",
"description": "In cases where the parties significantly changed over the course of the conflict, this field may be used to provide additional rows for the Combatant 1 field.",
"type": "string",
"required": false
},
"combatant2d": {
"label": "Combatant 2d",
"description": "In cases where the parties significantly changed over the course of the conflict, this field may be used to provide additional rows for the Combatant 2 field.",
"type": "string",
"required": false
},
"combatant3d": {
"label": "Combatant 3d",
"description": "In cases where the parties significantly changed over the course of the conflict, this field may be used to provide additional rows for the Combatant 3 field.",
"type": "string",
"required": false
},
"commander1": {
"label": "Commander of Combatant 1",
"description": "The commanders of the military forces of Combatant (1) involved.",
"type": "string",
"required": false
},
"commander2": {
"label": "Commander of Combatant 2",
"description": "The commanders of the military forces of Combatant 2 involved.",
"type": "string",
"required": false
},
"commander3": {
"label": "Commander of Combatant 3",
"description": "The commanders of the military forces of Combatant 3 involved.",
"type": "string",
"required": false
},
"units1": {
"label": "Units of Combatant 1",
"description": "The units or formations of Combatant 1 involved. If a large number of distinct formations is present, it may be better to reference an order of battle in the body of the article than to include the entire list in this field.",
"type": "string",
"required": false
},
"units2": {
"label": "Units of Combatant 2",
"description": "The units or formations of Combatant 2 involved. If a large number of distinct formations is present, it may be better to reference an order of battle in the body of the article than to include the entire list in this field.",
"type": "string",
"required": false
},
"units3": {
"label": "Units of Combatant 3",
"description": "The units or formations of Combatant 3 involved. If a large number of distinct formations is present, it may be better to reference an order of battle in the body of the article than to include the entire list in this field.",
"type": "string",
"required": false
},
"strength1": {
"label": "Strength of Combatant 1",
"description": "The numerical strength of Combatant 1.",
"type": "string",
"required": false
},
"strength2": {
"label": "Strength of Combatant 2",
"description": "The numerical strength of Combatant 2.",
"type": "string",
"required": false
},
"strength3": {
"label": "Strength of Combatant 3",
"description": "If Combatant 3 is set, this field is for the numerical strength of Combatant 3.  If Combatant 3 is not set, this is an alternate combined field for use where only the total participation in a conflict is known.",
"type": "string",
"required": false
},
"casualties1": {
"label": "Casualties of Combatant 1",
"description": "Casualties suffered by Combatant 1, including dead, wounded, missing, captured, and civilian deaths. Terms such as \"dead\" (or \"killed\"), \"wounded\", or \"captured\" should be used in place of abbreviations such as \"KIA\" or \"POW\".",
"type": "string",
"required": false
},
"casualties2": {
"label": "Casualties of Combatant 2",
"description": "Casualties suffered by Combatant 2, including dead, wounded, missing, captured, and civilian deaths. Terms such as \"dead\" (or \"killed\"), \"wounded\", or \"captured\" should be used in place of abbreviations such as \"KIA\" or \"POW\".",
"type": "string",
"required": false
},
"casualties3": {
"label": "Casualties of Combatant 3",
"description": "If Combatant 3 is set, this field is for the casualties suffered by Combatant 3, including dead, wounded, missing, captured, and civilian deaths. Terms such as \"dead\" (or \"killed\"), \"wounded\", or \"captured\" should be used in place of abbreviations such as \"KIA\" or \"POW\". If combatant3 is not set, this is an alternate combined field for use where only the total casualties of a conflict are known, or where civilian casualties cannot be directly attributed to either side.",
"type": "string",
"required": false
},
"notes": {
"label": "Notes",
"description": "Optional field for further notes; this should only be used in exceptional circumstances.",
"type": "string",
"required": false
},
"campaignbox": {
"label": "Campaignbox",
"description": "Optional field for appending a campaignbox template to the bottom of the infobox, which allows both boxes to float as a single element (useful if there are subsequent left floating images, which would otherwise not be able to float above the campaign box); the template must be specified in the format {{Campaignbox XYZ}}.",
"type": "string",
"required": false
}
},
"format": "block"
}
</templatedata>
==See also==
*[[:Template:Infobox military operation]]

Latest revision as of 02:36, 27 April 2020

Retrieved from "https://shreloaded.net/index.php?title=Template:Infobox_military_conflict/doc&oldid=35211"