>Cedar101: /* Usage */ lang="wikitext"

2023-05-09T04:08:43Z

Usage: lang="wikitext"

New page

{{Documentation subpage}}

{{Lua|Module:Infobox|Module:Check for unknown parameters}}

== Usage ==

{{Parameter names example|_template=Infobox region symbols
|align|region_type|region|state|county|province|country
|noheader|island|islands|image_flag|image_flag_border|image_flag_size|flag_link
|image_seal|image_seal_size|seal_link|image_emblem|image_emblem_size|emblem_link
|image_arms|image_arms_size|emblem|nickname|motto|slogan|anthem
|poem|song|hymn|language|foundation_day|currency|calendar|animal|amphibian|bird
|butterfly|cactus|cat|crustacean|dog|domestic_animal|fish|flower|fruit|grass|horse|insect
|mammal|marsupial|mascot|mushroom|pet|plant|reptile|tree|vegetable|wildlife_animal
|beverage|colour|color|colors|costume|dance|dinosaur|dish|dress|drink|firearm|folk_dance
|food|fossil|game|instrument|gemstone|lake|mineral|rock|river|shell|ship|soil|sport
|sweet|confectionery|tartan|toy|other|image_route|image_quarter|image_quarter_size|quarter_release_date}}

<syntaxhighlight lang="wikitext" style="overflow: auto;">
{{Infobox region symbols
| embedded = 
| align =
| title =
| region_type =
| state =
| region = 
| county =
| province =
| country = 
| no_header = 
| island =
| image_flag = 
| image_flag_border =
| image_flag_size = 
| flag_link = 
| image_seal =
| image_seal_size = 
| seal_link =
| image_emblem =
| image_emblem_size =
| emblem_link =
| image_arms = 
| image_arms_size = 
| emblem =
| nickname =
| motto =
| poem =
| slogan =
| anthem =
| song =
| hymn =
| language =
| foundation_day =
| currency =
| calendar =
| mammal = 
| bird =
| fish =
| insect =
| butterfly =
| amphibian =
| cactus =
| cat =
| crustacean =
| dog =
| domestic_animal =
| flower =
| fruit =
| grass =
| horse =
| marsupial =
| mascot =
| mushroom =
| pet =
| plant =
| reptile =
| tree =
| vegetable =
| wildlife_animal =
| beverage =
| colour = 
| costume = 
| dance =
| dinosaur =
| food = 
| drink =
| firearm =
| folk_dance =
| fossil =
| game =
| gemstone =
| instrument =
| river = 
| mineral =
| rock =
| shell =
| ship =
| soil =
| sport =
| sweet = 
| tartan =
| toy =
| other =
| image_route = 
| image_quarter = 
| image_quarter_size = 
| quarter_release_date =
}}
</syntaxhighlight>

=== Linking ===
If the <code>country</code> parameter is set to <code>India</code> or <code>United States</code>, the template will use labels that link to country-specific lists of state symbols.

=== Embedding ===
When the infobox is embedded in another infobox, the default header colour will match {{tl|infobox settlement}}. For an island using {{tl|infobox islands}}, set {{para|island|yes}}.

==TemplateData==
{{TemplateData header}}
{{collapse top|title=TemplateData}}
<templatedata>
{ "description": "",
"params": { "embedded":
{ "label": "is child infobox",
"description": "Whether this infobox is embedded in another",
"type": "boolean",
"default": "false",
"required": false
},
"align":
{ "label": "alignment of box",
"description": "Alignment of infobox within page (left, center, right)",
"type": "string",
"required": false
},
"title":
{ "label": "forced title",
"description": "Overrides all defaults to force the title of the infobox",
"type": "string",
"required": false
},
"region_type":
{ "label": "type of region",
"description": "Kind of region, if not state/province/county/country",
"type": "string",
"required": false
},
"state":
{ "label": "name of state",
"description": "If region is a state, place name here",
"type": "string",
"required": false
},
"region":
{ "label": "name of region",
"description": "If a non-standard region, place name here",
"type": "string",
"required": false
},
"county":
{ "label": "name of county",
"description": "If region is a county, place name here",
"type": "string",
"required": false
},
"province":
{ "label": "name of province",
"description": "If region is a province, place name here",
"type": "string",
"required": false
},
"country":
{ "label": "name of country",
"description": "Name of country (even if a sub-region of a country), e.g. 'United States' even if this is about California",
"type": "string",
"required": false
},
"no_header":
{ "label": "suppress embedded header",
"description": "If embedded, no_header=yes suppresses the colored header bar",
"type": "boolean",
"default": "false",
"required": false
},
"island":
{ "label": "is region an island?",
"description": "whether the region is an island",
"type": "boolean",
"required": false
},
"image_flag":
{ "label": "filename for flag image",
"description": "flag image filename (no File:)",
"type": "string",
"required": false
},
"image_flag_border":
{ "label": "flag border",
"description": "whether the flag image should have a thin grey borders",
"type": "string",
"required": false
},
"image_flag_size":
{ "label": "flag image width",
"description": "width (e.g. 200px)",
"type": "string",
"default": "250px",
"required": false
},
"flag_link":
{ "label": "article on flag",
"description": "name of article about flag (defaults to 'Flag of (region)')",
"type": "string",
"required": false
},
"image_seal":
{ "label": "seal image",
"description": "seal image filename (no File:)",
"type": "string",
"required": false
},
"image_seal_size":
{ "label": "seal image width",
"description": "width (e.g., 200px)",
"default": "150px",
"type": "string",
"required": false
},
"seal_link":
{ "label": "article on seal",
"description": "name of article about seal (defaults to 'Seal of (region)')",
"type": "string",
"required": false
},
"image_emblem":
{ "label": "emblem image",
"description": "emblem image filename (no File:)",
"type": "string",
"required": false
},
"image_emblem_size":
{ "label": "emblem image width",
"description": "width (e.g., 200px)",
"default": "150px",
"type": "string",
"required": false
},
"emblem_link":
{ "label": "article on emblem",
"description": "name of article about emblem (defaults to 'Emblem of (region)')",
"type": "string",
"required": false
},
"image_arms":
{ "label": "image of coat of arms",
"description": "path to image of coat of arms",
"type": "string",
"required": false
},
"image_arms_size":
{ "label": "width of coat of arms image",
"description": "width (e.g., 200px)",
"default": "150px",
"type": "string",
"required": false
},
"emblem":
{ "label": "emblem text",
"description": "emblem of region",
"type": "string",
"required": false
},
"nickname":
{ "label": "nickname",
"description": "informal name for region",
"type": "string",
"required": false
},
"motto":
{ "label": "motto",
"description": "motto of region",
"type": "string",
"required": false
},
"poem":
{ "label": "poem",
"description": "poem of region",
"type": "string",
"required": false
},
"slogan":
{ "label": "slogan",
"description": "slogan for region",
"type": "string",
"required": false
},
"anthem":
{ "label": "anthem",
"description": "patriotic song for region",
"type": "string",
"required": false
},
"song":
{ "label": "song",
"description": "official song of region",
"type": "string",
"required": false
},
"hymn":
{ "label": "hymn",
"description": "religious song of region",
"type": "string",
"required": false
},
"language":
{ "label": "language",
"description": "official language(s) of region",
"type": "string",
"required": false
},
"foundation_day":
{ "label": "day of founding",
"description": "calendar day of founding of region (e.g., July 4)",
"type": "string",
"required": false
},
"currency":
{ "label": "currency",
"description": "official currency of region",
"type": "string",
"required": false
},
"calendar":
{ "label": "calendar",
"description": "calendar typically in use (e.g., Gregorian)",
"type": "string",
"required": false
},
"mammal":
{ "label": "mammal",
"description": "symbolic mammal of region",
"type": "string",
"required": false
},
"bird":
{ "label": "bird",
"description": "symbolic bird of region",
"type": "string",
"required": false
},
"fish":
{ "label": "fish",
"description": "symbolic fish of region",
"type": "string",
"required": false
},
"insect":
{ "label": "insect",
"description": "symbolic insect of region",
"type": "string",
"required": false
},
"butterfly":
{ "label": "butterfly",
"description": "symbolic butterfly of region",
"type": "string",
"required": false
},
"animal":
{ "label": "animal",
"description": "symbolic animal of region (to be used only if no other more specific animal type is used)",
"type": "string",
"required": false
},
"amphibian":
{ "label": "amphibian",
"description": "symbolic animal of region",
"type": "string",
"required": false
},
"cactus":
{ "label": "cactus",
"description": "symbolic cactus of region",
"type": "string",
"required": false
},
"cat":
{ "label": "cat breed",
"description": "symbolic cat breed of region",
"type": "string",
"required": false
},
"crustacean":
{ "label": "crustacean",
"description": "symbolic crustacean of region",
"type": "string",
"required": false
},
"dog":
{ "label": "dog breed",
"description": "symbolic dog breed of region",
"type": "string",
"required": false
},
"domestic_animal":
{ "label": "domestic animal",
"description": "symbolic domestic animal of region",
"type": "string",
"required": false
},
"flower":
{ "label": "flower",
"description": "symbolic flower of region",
"type": "string",
"required": false
},
"fruit":
{ "label": "fruit",
"description": "symbolic fruit of region",
"type": "string",
"required": false
},
"grass":
{ "label": "grass",
"description": "symbolic grass of region",
"type": "string",
"required": false
},
"horse":
{ "label": "horse breed",
"description": "symbolic horse breed of region",
"type": "string",
"required": false
},
"marsupial":
{ "label": "marsupial",
"description": "symbolic marsupial of region",
"type": "string",
"required": false
},
"mascot":
{ "label": "mascot",
"description": "mascot of the region",
"type": "string",
"required": false
},
"mushroom":
{ "label": "mushroom",
"description": "symbolic mushroom of region",
"type": "string",
"required": false
},
"pet":
{ "label": "pet",
"description": "symbolic pet type of region",
"type": "string",
"required": false
},
"plant":
{ "label": "plant",
"description": "symbolic plant of region",
"type": "string",
"required": false
},
"reptile":
{ "label": "reptile",
"description": "symbolic reptile of region",
"type": "string",
"required": false
},
"tree":
{ "label": "tree",
"description": "symbolic tree of region",
"type": "string",
"required": false
},
"vegetable":
{ "label": "vegetable",
"description": "symbolic vegetable of region",
"type": "string",
"required": false
},
"wildlife_animal":
{ "label": "wildlife",
"description": "symbolic wild animal of region",
"type": "string",
"required": false
},
"beverage":
{ "label": "beverage",
"description": "symbolic beverage of region",
"type": "string",
"required": false
},
"colour":
{ "label": "colour",
"description": "symbolic colour(s) of region",
"type": "string",
"required": false
},
"color":
{ "label": "color",
"description": "symbolic color(s) of region",
"type": "string",
"required": false
},
"sweet":
{ "label": "sweet",
"description": "symbolic sweet, confectionery, or candy of region",
"type": "string",
"required": false
},
"costume":
{ "label": "costume",
"description": "symbolic costume or dress of region",
"type": "string",
"required": false
},
"dance":
{ "label": "dance",
"description": "symbolic dance of region",
"type": "string",
"required": false
},
"dinosaur":
{ "label": "dinosaur",
"description": "symbolic dinosaur of region",
"type": "string",
"required": false
},
"food":
{ "label": "food",
"description": "symbolic food or dish of region",
"type": "string",
"required": false
},
"drink":
{ "label": "drink",
"description": "symbolic drink of region",
"type": "string",
"required": false
},
"firearm":
{ "label": "firearm",
"description": "symbolic firearm of region",
"type": "string",
"required": false
},
"folk_dance":
{ "label": "folk dance",
"description": "symbolic folk dance of region",
"type": "string",
"required": false
},
"fossil":
{ "label": "fossil",
"description": "symbolic fossil of region",
"type": "string",
"required": false
},
"game":
{ "label": "game",
"description": "symbolic game of region",
"type": "string",
"required": false
},
"gemstone":
{ "label": "gem",
"description": "symbolic gemstone of region",
"type": "string",
"required": false
},
"instrument":
{ "label": "musical instrument",
"description": "symbolic musical instrument of region",
"type": "string",
"required": false
},
"river":
{ "label": "river",
"description": "symbolic river of region (do not use with lake)",
"type": "string",
"required": false
},
"lake":
{ "label": "lake",
"description": "symbolic lake of region (do not use with river)",
"type": "string",
"required": false
},
"mineral":
{ "label": "mineral",
"description": "symbolic mineral of region",
"type": "string",
"required": false
},
"rock":
{ "label": "rock",
"description": "symbolic rock of region",
"type": "string",
"required": false
},
"shell":
{ "label": "shell",
"description": "symbolic seashell of region",
"type": "string",
"required": false
},
"ship":
{ "label": "ship",
"description": "symbolic ship(s) of region",
"type": "string",
"required": false
},
"soil":
{ "label": "soil",
"description": "symbolic soil of region",
"type": "string",
"required": false
},
"sport":
{ "label": "sport",
"description": "symbolic sport of region",
"type": "string",
"required": false
},
"tartan":
{ "label": "tartan",
"description": "tartan of region",
"type": "string",
"required": false
},
"toy":
{ "label": "toy",
"description": "symbolic toy of region",
"type": "string",
"required": false
},
"other":
{ "label": "other symbol",
"description": "other symbol of region (add type to description)",
"type": "string",
"required": false
},
"image_route":
{ "label": "route marker",
"description": "filename of image of route marker for region",
"type": "string",
"required": false
},
"image_quarter":
{ "label": "state quarter",
"description": "filename of image of state quarter (U.S. only)",
"type": "string",
"required": false
},
"image_quarter_size":
{ "label": "quarter image width",
"description": "width of quarter image (e.g., 200px)",
"default": "125px",
"type": "string",
"required": false
},
"quarter_release_date":
{ "label": "quarter year",
"description": "year that quarter was released",
"type": "string",
"required": false
}
}
}
</templatedata>
{{collapse bottom}}

== Tracking categories ==
* {{clc|Pages using infobox region symbols with unknown parameters}}
* {{clc|Pages using Infobox region symbols with overlapping parameters}}

<includeonly>{{sandbox other||

[[Category:Place-related infobox templates|Symbols]]
[[Category:Embeddable templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>

Template:Infobox region symbols/doc - Revision history

>Cedar101: /* Usage */ lang="wikitext"