Template:Area infobox

From Final Fantasy XIV Online Wiki
Jump to navigation Jump to search
Documentation for Template:Area infobox [view] [edit] [history] [purge] (How does this work?)

This infobox should be used for regions, zones, areas, landmarks, etc., i.e. all locations mentioned here. See also parameter type below.

{{Area infobox
| name = 
| type =
| within =
| zone = 
| coordinates =
| aetheryte1 = 
| aetheryte2 = 
| aetheryte3 = 
| aetheryte4 = 
| description = 
| description-source = 
| weather = 
| flag-image = 
| map =
| levels =
| connections =
| loading-screen =
| screenshot =
| sstext =
| release = 
| patch = 
| description =
| description-source =
}}

Parameters

All parameters are optional.

name
Location name. Defaults to {{PAGENAME}}
type
The type of location. Accepts: region, city, area, zone, landmark.
within
The parent location of the location being described. Use plain text with no wiki-links. For zones, this should be a region; for areas, this should be a zone; for everything else, this will usually be an area. If within is an area or zone, the parent of within will be displayed underneath in small text.
zone
The name of the map which is used for coordinates in the game.
coordinates
If specified, indicates position of a location within the world map.
quests
A semicolon-delimtied list of quests required to unlock this location. By default, this pulls a semantic query to find the list.
aetheryte1; aetheryte2; aetheryte3; aetheryte4
Aetherytes available in the current map. Accepts the form <aetheryte name>;<x,y,z coordinates>.
weather
Weather conditions. Accepts comma-separated names: Common — blizzard, clear skies, clouds, dust storms, fair skies, fog, gales, gloom, heat waves, rain, sandstorms, showers, snow, thunder, thunderstorms, umbral static, umbral wind, wind. Special — auroras, core radiation, darkness, eruptions, gales (garuda), gloom (king moggle), heat wave, hot spells, hyperelectricity, irradiance, louring, oppression, rough seas, royal levin, shelf clouds, smoke, storm clouds, tension.
weather-red-alert
Red Alert weather conditions in Cosmic Exploration zones.
flag-image
Flag image for the related city-state. Do not include the "File:" prefix.
map
Map image (do not include the "File:" prefix). Defaults to '{{PAGENAME}} map.jpg'
icon
The icon to display in the top-right corner of the infobox.
levels
Depends on the type used, see as follows
Zone: The level range for the zone. Separate minimum and maximum levels with a single hyphen "-", e.g. 60 - 70
Area: The effective level of the area. For the case of dungeon areas where there are extra modes, separate values with commas.
connections
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.
loading-screen
Loading screen image (do not include the "File:" prefix). Defaults to '{{PAGENAME}} loading screen.jpg'
screenshot
Screenshot (do not include the "File:" prefix). Defaults to '{{PAGENAME}}.jpg'
sstext
Screenshot text
release
The expansion required to access the content. Displays a notice of the release.
patch
The patch in which this location was added to the game.
description
Optional. Description of the location. If blank, the quotation section will not display.
description-source
Optional. The name of the source for the description parameter. Defaults to "In-game description". (This will not display at all if description is blank.)
no-footer-text
Normally the text "Name is a <Type> in <within>" will be added at the end of the template, ie after the infobox. By setting this parameter, this text will not appear.

This infobox is used on all location pages.

Template parameters[Edit template data]

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

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, this should be a zone; for everything else, this will usually be an area. If within is an area or zone, the parent of within will be displayed underneath in small text.

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. Accepts comma-separated names: Common — blizzard, clear skies, clouds, dust storms, fair skies, fog, gales, gloom, heat waves, rain, sandstorms, showers, snow, thunder, thunderstorms, umbral static, umbral wind, wind. Special — auroras, core radiation, darkness, eruptions, gales (garuda), gloom (king moogle), heat wave, hot spells, hyperelectricity, irradiance, louring, oppression, rough seas, royal levin, shelf clouds, smoke, storm clouds, tension.

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

For Cosmic Exploration zones possible Red Alert weather conditions.

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 setting this parameter to y, this text will not appear.

Unknownoptional

Examples

{{Area infobox
| name = South Shroud
| map = South Shroud map.jpg
| type = zone
| within = The Black Shroud
| coordinates =
| description = In days of yore, the city of Amdapor flourished amidst the trees of the South Shroud. Now, the Lumberline cuts through the area from north to south, and the merchants traveling the trading route must be wary of brigands with an eye for their wares.
| aetheryte1 = Quarrymill;25.0, 20.1
| aetheryte2 = Camp Tranquil;16.8, 28.6
| weather = gloom, fog, storm clouds, thunder, thunderstorms, tension
| levels = 20 - 35
| connections = [[Central Shroud]] (NW)<br>[[East Shroud]] (N)<br>[[Eastern Thanalan]] (SW)
}}

South Shroud

     


Map of South Shroud

Levels
20 – 35
Type
Zone
Zone
The Black Shroud
(Hydaelyn)
Connects to
Central Shroud (NW)
East Shroud (N)
Eastern Thanalan (SW)
Aetherytes
Quarrymill (X:25.0, Y:20.1)
Camp Tranquil (X:16.8, Y:28.6)

In days of yore, the city of Amdapor flourished amidst the trees of the South Shroud. Now, the Lumberline cuts through the area from north to south, and the merchants traveling the trading route must be wary of brigands with an eye for their wares.

— In-game description

South Shroud is a zone in The Black Shroud.

{{Area infobox
| name = South Shroud
| icon = Gold saucer icon2.png
| map = South Shroud map.jpg
| type = zone
| within = The Black Shroud
| coordinates =
| description = In days of yore, the city of Amdapor flourished amidst the trees of the South Shroud. Now, the Lumberline cuts through the area from north to south, and the merchants traveling the trading route must be wary of brigands with an eye for their wares.
| aetheryte1 = Quarrymill;25.0, 20.1
| aetheryte2 = Camp Tranquil;16.8, 28.6
| weather = gloom, fog, storm clouds, thunder, thunderstorms, tension
| levels = 20 - 35
| connections = [[Central Shroud]] (NW)<br>[[East Shroud]] (N)<br>[[Eastern Thanalan]] (SW)
| no-footer-text = y
}}

South Shroud

     


Map of South Shroud

Levels
20 – 35
Type
Zone
Zone
The Black Shroud
(Hydaelyn)
Connects to
Central Shroud (NW)
East Shroud (N)
Eastern Thanalan (SW)
Aetherytes
Quarrymill (X:25.0, Y:20.1)
Camp Tranquil (X:16.8, Y:28.6)

In days of yore, the city of Amdapor flourished amidst the trees of the South Shroud. Now, the Lumberline cuts through the area from north to south, and the merchants traveling the trading route must be wary of brigands with an eye for their wares.

— In-game description