Template:Area infobox/doc

From Final Fantasy XIV Online Wiki
Jump to navigation Jump to search
This is the documentation subpage of Template:Area infobox. It contains usage information that is not part of the underlying template.

This infobox is used on all location pages.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

Location name. Defaults to {{PAGENAME}}

Example
South Shroud
Stringoptional
Typetype

The type of location. Accepts: region, city, area, zone, landmark.

Suggested values
region city area zone landmark
Example
zone
Stringoptional
Withinwithin

This sets the category the location is "in" (i.e. Locations in The Black Shroud) This should be the in-game parent location of the location being described. Use plain text with no wiki-links. For zones, this should be a region. For areas and landmarks, this should be a zone. Areas and landmarks should list the zone. If a zone is accessed via another zone (such as an inn) that zone can be considered what it is "in".

Example
The Black Shroud
Stringoptional
Zonezone

The name of the map which is used for coordinates in the game.

Stringoptional
Descriptiondescription

Description of the location put in quotes.

Stringoptional
Description sourcedescription-source

The source for the description parameter. If a description is given, this is necessary.

Stringsuggested
Releaserelease

The expansion required to access the content. Displays a notice of the release.

Suggested values
Heavensward Stormblood Shadowbringers Endwalker Dawntrail
Example
Dawntrail
Stringoptional
Patchpatch

The patch in which this location was added to the game.

Example
7.4
Numberoptional
Weatherweather

If zone, weather conditions possible. Separate multiple conditions with comma (,). See [[Weather]] for all possible weathers conditions.

Example
gloom, fog, storm clouds, thunder, thunderstorms, tension
Stringoptional
Red Alert Weatherweather-red-alert

For Cosmic Exploration zones, possible Red Alert weather conditions. See the Red Alert section of [[Weather]] for possible options.

Example
thunderstorms, annealing winds, glass storms
Stringoptional
Levelslevels

If zone: The level range for the zone. Separate minimum and maximum levels with a single hyphen "-", e.g. 60 - 70. <br> If area: The effective level of the area. For the case of dungeon areas where there are extra modes, separate values with commas.

Example
20 - 35
Stringoptional
Iconicon

The icon to display in the top-right corner of the infobox.

Example
Gold saucer icon2.png
Fileoptional
Flagflag-image

Flag image for if the location is a city-state or nation. Do not include the "File:" prefix.

Fileoptional
Mapmap

Map image (do not include the "File:" prefix). Defaults to '{{PAGENAME}} map.jpg'

Example
South Shroud map.jpg
Fileoptional
Screenshotscreenshot

Screenshot (do not include the "File:" prefix). Defaults to '{{PAGENAME}}.jpg'

Fileoptional
Screenshot textsstext

Text displayed beneath screenshot.

Stringoptional
Loading Screen imageloading-screen

Loading screen image (do not include the "File:" prefix). Defaults to '{{PAGENAME}} loading screen.jpg'

Fileoptional
Coordinatescoordinates

If specified, indicates position of a location within the world map.

Stringoptional
Connectionsconnections

Other locations that this one has connections to. Only specified on zones. Separate multiple connections with <br> and add your own wiki-links. The cardinal direction is usually specified in brackets after the zone name; (N), (S), (E), (W), (NE), etc. In the case of a portal, add (portal) instead of direction.

Example
[[Central Shroud]] (NW)<br>[[East Shroud]] (N)<br>[[Eastern Thanalan]] (SW)
Stringoptional
Aetheryte #1aetheryte1

Aetherytes available in the current map. Accepts the form <aetheryte name>;<x,y,z coordinates>.

Example
Quarrymill;25.0, 20.1
Stringoptional
Aetheryte #2aetheryte2

Aetherytes available in the current map. Accepts the form <aetheryte name>;<x,y,z coordinates>.

Example
Camp Tranquil;16.8, 28.6
Stringoptional
Aetheryte #3aetheryte3

Aetherytes available in the current map. Accepts the form <aetheryte name>;<x,y,z coordinates>.

Example
Quarrymill;25.0, 20.1
Stringoptional
Aetheryte #4aetheryte4

Aetherytes available in the current map. Accepts the form <aetheryte name>;<x,y,z coordinates>.

Example
Camp Tranquil;16.8, 28.6
Stringoptional
No footer textno-footer-text

Normally the text "Name is a <Type> in <within>" will be added at the end of the template (after the infobox). By checking this box, this text will not appear.

Auto value
0
Booleanoptional