Template:Location Infobox/doc: Difference between revisions

Raven.Familiar (talk | contribs)
No edit summary
No edit summary
Line 1: Line 1:
{{Documentation/Header}}
{{Documentation/Header}}
To use this template, add the {{T|{{BASEPAGENAME}}}} template and fill in the appropriate fields. Fields left blank will not appear in articles. This infobox template uses [[w:Help:Infoboxes|Fandom's infobox syntax]].
==Syntax==
==Syntax==
<pre>
<pre>
{{Location Infobox
{{Location Infobox
|title      =  
|title      = <!-- use only if different than actual page name -->
|image      =  
|image      =  
|type        =  
|type        =  
|aspect      = <!-- use only for plane pages -->
|plane      = <!-- actual name of plane -->
|planeAspect = <!-- use only if actual plane name doesn't specify aspect -->
|continent  =
|town        =
}}
</pre>
==Example==
===Iia===
{{Location Infobox
|title      = Iia
|image      = Town Iia.png
|type        = Town
|aspect      =  
|aspect      =  
|plane      =  
|plane      = Plane of Reality
|planeAspect =  
|planeAspect =  
|continent  =  
|continent  = Lusciell
|town        =
}}
<pre>
{{Location Infobox
|title      = Iia
|image      = Town Iia.png
|type        = Town
|aspect      =
|plane      = Plane of Reality
|planeAspect =
|continent  = Lusciell
|town        =  
|town        =  
}}
}}
</pre>
</pre>
==Parameters==
* type
** The type of location.
** Acceptable types for auto-categorization: Plane, Continent, Town, Place 


==Template Data==
==Template Data==
<templatedata>
<templatedata>
{
{
"format": "{{_\n|______________ = _\n}}\n",
"params": {
"params": {
"title": {
"label": "Title",
"description": "Name of location",
"type": "string",
"default": "{{PAGENAME}}"
},
"image": {
"label": "Image",
"description": "Location's image(s)",
"type": "content",
"required": true
},
"type": {
"type": {
"label": "Type",
"label": "Type",
"description": "The location's type"
"description": "Location's type",
"type": "string",
"required": true,
            "example": "Plane, Continent, Town, Place"
},
"aspect": {
"label": "Aspect",
"description": "Plane's Aspect, used only for Plane pages",
"type": "string",
            "example": "Beauty, Love, Peace"
},
},
"plane": {
"plane": {
"description": "Plane which the location is located. Use Planes name if known, use \"Plane of X\" if only Aspect is known"
"label": "Plane",
"description": "Location's associated Plane",
"type": "string",
            "example": "Circular Station, Court of Dragons, Plane of Reality"
},
},
"planeAspect": {
"planeAspect": {
"description": "If Plane name is known, use \"Plane of X\" in this parameter"
"label": "Plane with Aspect",
"description": "Plane with Aspect, used only if actual Plane name doesn't specify Aspect",
"type": "string",
            "example": "Plane of Infinity, Plane of Order, Plane of Reality"
},
"continent": {
"label": "Continent",
"description": "Location's continent",
"type": "string",
            "example": "Lusciell"
},
},
"continent": {},
"town": {
"town": {},
"label": "Town",
"title": {},
"description": "Location's town",
"aspect": {}
"type": "string",
            "example": "Iia"
}
},
},
"paramOrder": [
"paramOrder": [
"title",
"title",
        "image",
"type",
"type",
"aspect",
"aspect",
Line 48: Line 103:
"continent",
"continent",
"town"
"town"
]
],
"description": "Infobox used to display information about a location."
}
}
</templatedata>
</templatedata>