Difference between revisions of "Template:Infobox treaty/TemplateData"

From Wikispooks
Jump to navigation Jump to search
m (1 revision)
 
m (Text replacement - "image_size" to "image_width")
 
Line 29: Line 29:
 
"required": false
 
"required": false
 
},
 
},
"image_size": {
+
"image_width": {
 
"label": "Image size",
 
"label": "Image size",
 
"description": "Image width for “image”, eg “200px”.",
 
"description": "Image width for “image”, eg “200px”.",

Latest revision as of 06:13, 26 October 2014

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Infobox treaty

<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": "string/line", "required": true, "default": "The article name" }, "long_name" : { "label": "Long name", "description": "The official long name of the treaty.", "type": "string", "required": false }, "rep": { "label": "Representative image", "description": "Wikicode for an image to represent the treaty.", "type": "content", "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_width": { "label": "Image size", "description": "Image width for “image”, eg “200px”.", "type": "string/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": "string/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": "string/line", "required": false }, "date_signed": { "label": "Date signed", "description": "The date the treaty was signed. Use the template “Start date” to provide this information.", "type": "string/line", "required": false }, "location_signed": { "label": "Location signed", "description": "The location where the treaty was signed. This should usually include wikilinks.", "type": "string/line", "required": false }, "date_sealed": { "label": "Date sealed", "description": "The date the treaty was sealed.", "type": "string/line", "required": false }, "date_effective": { "label": "Date effective", "description": "The date the treaty came into effect.", "type": "string/line", "required": false }, "condition_effective": { "label": "Condition effective", "description": "The conditions under which the treaty came into effect. For example: Ratification by three signatories.", "type": "string/line", "required": false }, "date_expiry": { "label": "Date expired", "description": "The date the treaty expired. Use the template “End date” to provide this information.", "type": "string/line", "required": false, "aliases": [ "date_expiration" ] }, "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": "string/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 TS YYY”", "type": "string/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": "string/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": "string/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": "string/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": "string/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 } } }</TemplateData>