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 page.

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.
description-source
Optional. The name of the source for the description parameter. Defaults to "In-game description".
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.