Editing Template:Infobox treaty/doc

{{Documentation subpage}}
<!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])-->
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Check for unknown parameters}}

== Usage ==
{{Parameter names example | name | long_name | rep | image | image_size | border | alt | caption | type | context | date_drafted | date_signed | location_signed | date_sealed | date_ratified | date_effective | condition_effective | replaces | replaced_by | date_expiration | date_expiry | provisional_application | mediators | negotiators | original_signatories | signatories | parties | ratifiers | depositor | depositories | citations | language | languagesclass | languages | wikisource | wikisource1 | wikisource2 | wikisource3 | wikisource4 | wikisource5 | footnotes }}

<syntaxhighlight lang="wikitext" style="overflow:auto; white-space:pre;">
{{Infobox treaty
| name                    = 
| long_name               = 
| image                   = <!-- Example.png -->
| image_size              = <!-- 200px -->
| alt                     = <!-- alt-text here for accessibility; see [[MOS:ACCESS]] -->
| caption                 = <!-- Example caption for either image style -->
| type                    = 
| context                 = 
| date_drafted            = 
| date_signed             = <!-- {{Start date|YYYY|MM|DD}} -->
| location_signed         = 
| date_sealed             = 
| date_ratified           = <!-- If 3 or more, type 'Multiple dates' linking to a section or footnote -->
| date_effective          = 
| condition_effective     = 
| amendment               = 
| replaces                =
| replaced_by             =
| date_expiration         = <!-- {{End date|YYYY|MM|DD}} OR: -->
| date_expiry             = <!-- {{End date|YYYY|MM|DD}} -->
| provisional_application = 
| mediators               = <!-- format this as a bullet list -->
| negotiators             = <!-- format this as a bullet list -->
| original_signatories    = <!-- format this as a bullet list -->
| signatories             = <!-- format this as a bullet list -->
| parties                 = <!-- format this as a bullet list -->
| membership              = <!-- format this as a bullet list -->
| ratifiers               = <!-- format this as a bullet list -->
| depositor               = <!-- OR: -->
| depositories            = <!-- format this as a bullet list -->
| citations               = <!-- format as XX [[Article on Treaty Series|TS]] YYY -->
| language                = <!-- OR: -->
| languages               = <!-- format this as a bullet list -->
| wikisource              = <!-- OR: -->
| wikisource1             = <!-- Up to 5 wikisource variables may be specified -->
| wikisource2             = 
| wikisource3             = 
| wikisource4             = 
| wikisource5             = 
| footnotes               = 
}}
</syntaxhighlight>
{{clear}}

== Example ==
{{Infobox treaty
| name                = Treaty of Versailles
| long_name           = Treaty of Peace between the Allied and Associated Powers and Germany
| image               = Treaty of Versailles, English version.jpg
| image_size          = 180px
| alt                 = 
| caption             = Front page of the version in English
| type                = 
| date_drafted        = 
| date_signed         = {{Start date|1919|06|28|df=y}}
| location_signed     = [[Palace of Versailles|Versailles]], France
| date_sealed         = 
| date_ratified       = 
| date_effective      = 10 January 1920
| condition_effective = [[Ratification]] by Germany and three Principal Allied Powers
| date_expiration     = 
| negotiators         = 
| parties             = 
* {{flag icon|Germany|Weimar}} [[Weimar Republic|German Reich]] <hr/>
* {{flag|British Empire}}
* {{flag icon|France}} [[French Third Republic|France]]
* {{flag|United States|1912}}
| depositor           = French Government
| citations           = 
| languages           = 
* [[French language|French]]
* [[English language|English]]
| wikisource          = Treaty of Versailles
}}

<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Infobox treaty
| name                = Treaty of Versailles
| long_name           = Treaty of Peace between the Allied and Associated Powers and Germany
| image               = Treaty of Versailles, English version.jpg
| image_size          = 180px
| alt                 = 
| caption             = Front page of the version in English
| type                = 
| date_drafted        = 
| date_signed         = {{Start date|1919|06|28|df=y}}
| location_signed     = [[Palace of Versailles|Versailles]], France
| date_sealed         = 
| date_ratified       = 
| date_effective      = 10 January 1920
| condition_effective = [[Ratification]] by Germany and three Principal Allied Powers
| date_expiration     = 
| negotiators         = 
| parties             = 
* {{flag icon|Germany|Weimar}} [[Weimar Republic|German Reich]] <hr/>
* {{flag|British Empire}}
* {{flag icon|France}} [[French Third Republic|France]]
* {{flag|United States|1912}}
| membership          =
| depositor           = French Government
| citations           = 
| languages           = 
* [[French language|French]]
* [[English language|English]]
| wikisource          = Treaty of Versailles
}}
</syntaxhighlight>
{{clear}}

== Tracking category ==
* {{clc|Pages using Infobox treaty with unknown parameters}}

== Microformat ==
{{UF-hcal-geo}}
<!--
Link to TemplateData information; see [[Wikipedia:VisualEditor/TemplateData]] for more information
-->== TemplateData ==
{{TemplateData header}}
<TemplateData>{
	"description": "Provides a consistent layout for summary information about treaties and international agreements, to appear at the top right of article pages.",
	"params": {
		"name": {
			"label": "Name",
			"description": "Short name of the treaty.",
			"type": "line",
			"required": true,
			"default": "The article name"
		},
		"long_name": {
			"label": "Long name",
			"description": "The official long name of the treaty.",
			"type": "string",
			"required": false
		},
		"image": {
			"label": "Image",
			"description": "Filename for an image to represent the treaty (without the “File:” prefix).",
			"type": "wiki-page-name",
			"required": false
		},
		"image_size": {
			"label": "Image size",
			"description": "Image width for “image”, eg “200px”.",
			"type": "line",
			"required": false,
			"default": "frameless",
			"aliases": [
				"image_width"
			]
		},
		"image_alt": {
			"label": "Image alternative text",
			"description": "Accessible alternative text for “image”.",
			"type": "string",
			"required": false,
			"aliases": [
				"alt"
			]
		},
		"border": {
			"label": "Image border",
			"description": "Border for “image”. “yes” if a border should be applied to the image.",
			"type": "string",
			"required": false,
			"default": "no"
		},
		"caption": {
			"label": "Image caption",
			"description": "Caption, either for “image” or for “rep”. If both parameters are supplied, the caption will appear twice.",
			"type": "line",
			"required": false
		},
		"type": {
			"label": "Treaty type",
			"description": "Type of the treaty.",
			"type": "content",
			"required": false
		},
		"context": {
			"label": "Treaty context",
			"description": "Historical context for the treaty.",
			"type": "content",
			"required": false
		},
		"date_drafted": {
			"label": "Date drafted",
			"description": "The date the treaty was drafted.",
			"type": "line",
			"required": false
		},
		"date_signed": {
			"label": "Date signed",
			"description": "The date the treaty was signed. Use the template “Start date” to provide this information. This is usually the date of the initial agreement in principle, signed by a senior minister rather than the Head of State, prior to ratification.",
			"type": "line",
			"required": false
		},
		"location_signed": {
			"label": "Location signed",
			"description": "The location where the treaty was signed. This should usually include wikilinks.",
			"type": "line",
			"required": false
		},
		"date_sealed": {
			"label": "Date sealed",
			"description": "The date the treaty was sealed. This is the date of the formal event where the parties affix their States' or Organizations' Great Seals.",
			"type": "line",
			"required": false
		},
		"date_ratified": {
			"label": "Date ratified",
			"description": "The date(s) the treaty was ratified. If there is more than one date: For bilateral treaties, list the ratification dates for each party. For multilateral treaties (three or more parties), create a table in the body and wikilink it to the words 'Multiple dates' here; alternatively, you may add a footnote next to 'Multiple dates.'",
			"type": "line",
			"required": false
		},
		"date_effective": {
			"label": "Date effective",
			"description": "The date the treaty came into effect.",
			"type": "line",
			"required": false
		},
		"condition_effective": {
			"label": "Condition effective",
			"description": "The conditions under which the treaty came into effect.",
			"example": "Ratification by three signatories.",
			"type": "line",
			"required": false
		},
		"date_expiry": {
			"label": "Date expired",
			"description": "The date the treaty expired. Use the template “End date” to provide this information.",
			"type": "line",
			"required": false,
			"aliases": [
				"date_expiration"
			]
		},
		"provisional_application": {
			"label": "Provisional application",
			"type": "content",
			"required": false
		},
		"mediators": {
			"label": "Mediators",
			"description": "The people or countries who helped mediate the treaty. This should be formatted as a bullet list; flag icons might also be appropriate.",
			"type": "content",
			"required": false
		},
		"negotiators": {
			"label": "Negotiators",
			"description": "The people or countries who helped negotiate the treaty. This should be formatted as a bullet list; flag icons might also be appropriate.",
			"type": "content",
			"required": false
		},
		"original_signatories": {
			"label": "Original signatories",
			"description": "The people who *originally* signed the treaty. This should be formatted as a bullet list with flag icons.",
			"type": "content",
			"required": false
		},
		"signatories": {
			"label": "Signatories",
			"description": "The people who signed the treaty. This should be formatted as a bullet list with flag icons.",
			"type": "content",
			"required": false
		},
		"parties": {
			"label": "Parties",
			"description": "The countries who are/were party to the treaty. This should be formatted as a bullet list with flag icons.",
			"type": "content",
			"required": false
		},
		"ratifiers": {
			"label": "Ratifiers",
			"description": "The countries who ratified the treaty. This should be formatted as a bullet list with flag icons.",
			"type": "content",
			"required": false
		},
		"depositor": {
			"label": "Depositor",
			"description": "The depositor for the treaty, if there is only one. This should usually include wikilinks.",
			"type": "line",
			"required": false
		},
		"depositories": {
			"label": "Depositories",
			"description": "The depositories for the treaty, if there are more than one. This should be formatted as a bullet list and should usually include flag icons and wikilinks.",
			"type": "content",
			"required": false
		},
		"citations": {
			"label": "Citations",
			"description": "The citation(s) for the treaty. This should be a link to a Treaty series article, formatted as “XX [[Article on Treaty Series|TS]] YYY”",
			"type": "line",
			"required": false
		},
		"language": {
			"label": "Language",
			"description": "The language of the treaty text, if there is only one. This should usually include a wikilink.",
			"type": "line",
			"required": false
		},
		"languages": {
			"label": "Languages",
			"description": "The languages of the treaty text, if there is more than one. This should be formatted as a bullet list and should usually include wikilinks.",
			"type": "content",
			"required": false
		},
		"languagesclass": {
			"label": "Languages CSS class",
			"description": "The stylesheet class for the list of languages. Ordinarily, this should include “hlist” to allow for formatting an bullet list without bullets.",
			"type": "line",
			"required": false,
			"default": "hlist"
		},
		"wikisource": {
			"label": "Wikisource link",
			"description": "Link to the treaty text on Wikisource, if only one link is required. Use “wikisource1” to “wikisource5” if more than one link is required.",
			"type": "wiki-page-name",
			"required": false
		},
		"wikisource1": {
			"label": "Wikisource link #1",
			"description": "Link to a treaty text on Wikisource, if more than one link is required. Use “wikisource” if only one link is required.",
			"type": "wiki-page-name",
			"required": false
		},
		"wikisource2": {
			"label": "Wikisource link #2",
			"inherits": "wikisource1"
		},
		"wikisource3": {
			"label": "Wikisource link #3",
			"inherits": "wikisource1"
		},
		"wikisource4": {
			"label": "Wikisource link #4",
			"inherits": "wikisource1"
		},
		"wikisource5": {
			"label": "Wikisource link #5",
			"inherits": "wikisource1"
		},
		"footnotes": {
			"label": "Footnotes",
			"description": "Any footnotes, formatted if necessary.",
			"type": "content",
			"required": false
		},
		"Replaces": {},
		"Replaced_by": {}
	},
	"paramOrder": [
		"name",
		"long_name",
		"image",
		"image_size",
		"image_alt",
		"border",
		"caption",
		"type",
		"context",
		"date_drafted",
		"date_signed",
		"location_signed",
		"date_sealed",
		"date_ratified",
		"date_effective",
		"condition_effective",
		"date_expiry",
		"Replaces",
		"Replaced_by",
		"provisional_application",
		"mediators",
		"negotiators",
		"original_signatories",
		"signatories",
		"parties",
		"ratifiers",
		"depositor",
		"depositories",
		"citations",
		"language",
		"languages",
		"languagesclass",
		"wikisource",
		"wikisource1",
		"wikisource2",
		"wikisource3",
		"wikisource4",
		"wikisource5",
		"footnotes"
	],
	"format": "block"
}</TemplateData>
<includeonly>{{Sandbox other||
<!--Categories below this line, please; interwikis at Wikidata-->
[[Category:History and events infobox templates|Treaty]]
[[Category:Law infobox templates|Treaty]]
[[Category:Embeddable templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>