Template:Area/doc

Description

This is the main template for all area pages. It determines the layout of the individual page and provides functionality for extracting specific area information for use in other pages.

Usage

{{Area
|Mode = {{{1|Page}}}
|Param1 = {{{2|}}}
|Param2 = {{{3|}}}

<!-- Quick Facts -->
|Name = 
|Pagename = 
|Translation = 
|Status = 
|Type = 
|Version = 
|VersionUpdate = 
|Attributes = 
|Quests = 
|Secrets = 
|Level = 

<!-- Media -->
|Image = 
|Map = 
|Site = 

<!-- Info -->
|Description = 
|Notes = 

<!-- Geography -->
|Grid = 
|Region = 
|Section = 
|Buildings = 
|Dungeons = 
|POI = 
|Adjacent = 

<!-- Inhabitants -->
|Factions = 
|Characters = 

<!-- Services -->
|Shops = 
|Training = 
|Healing = 
|Transport = 

<!-- Threats -->
|LevelL = 
|LevelH = 
|ThreatNonrec = 
|ThreatRecur = 
|ThreatEnv = 
|ElemDanger = 
|ElemVuln = 

<!-- Loot -->
|LootFixed = 
|LootRandom = 
}}

Parameters

Name	Required	Description	Values
Mode	Yes	Determines the mode of execution of the template (see below). Changing the predefined value may lead to unexpected behavior.	{{{1|Page}}} (should not be changed)
Param1	Yes	Used for routing a selection parameter to the template in certain modes (see below). Changing the predefined value may lead to unexpected behavior.	{{{2|}}} (should not be changed)
Param2	Yes	Used for routing a selection parameter to the template in certain modes (see below). Changing the predefined value may lead to unexpected behavior.	{{{3|}}} (should not be changed)
Quick Facts
Name	Yes	The name of the area. Usually, but not necessarily identical to the page title. Will be displayed in the infobox of the page.	arbitrary text
Pagename	Yes	The title of the area page, needed for linking purposes. Note: Do not use magic words such as {{PAGENAME}} here, as this prevents proper linking when transcluding information from this page on other pages.	arbitrary text
Translation	No	If the area is named differently in other languages, those names can be listed here.	internationalization string according to the format described in Template:Translation
Status	No	If the page has a special status, it can be set here. A corresponding box will be displayed at the top of the page.	one of the values defined in Template:PageStatus
Type	Yes	The specific type of the area. Will be displayed in the infobox of the page. A list of predefined types can be found in Template:AreaType (if new types are introduced, they should also be added there).	one of the values defined in Template:AreaType (other values are ignored): Outdoor • Town • Dungeon • Building
Version	Yes	The game version in which the area was first introduced. Will be displayed in the infobox of the page.	version number in the form X.Y.Z
VersionUpdate	No	The game version in which the area was last updated. Will be displayed in the infobox of the page.	version number in the form X.Y.Z
Attributes	No	One or more attributes which describe certain aspects of the area. Will be displayed in the infobox of the page. A list of predefined attributes can be found in Template:AreaAttributes (if new attributes are introduced, they should also be added there).	a semicolon-separated list of the values defined in Template:AreaAttributes (other values are ignored): Camping • Inn • Trading • Healing • Teleport
Quests	No	If the area is of importance for certain quests, they can be listed here.	a semicolon-separated list of [[Quests]]s
Secrets	No	The number of secrets to be discovered in the area.	non-negative number
Level	Yes	The character level recommended for visiting this area. Will be displayed in the infobox of the page.	positive number
Media
Image	Yes	The image (PNG or JPG) to be displayed in the infobox of the page.	image name (including file extension)
Map	Yes	The local map of the area. For information on how to include an annoted map, see below.	image name (including file extension)
Site	Yes	The site map of the area, showing its location on the world map.	image name (including file extension)
Info
Description	Yes	A concise description of the area itself. Is used as an introductory paragraph and should not be too excessive (2−3 sentences are usually enough).	arbitrary text
Notes	No	Any kind of ancillary information (which does not seem appropriate anywhere else) can be provided here.	arbitrary text, ideally formatted as a bullet list (using *)
Geography
Grid	Yes	The grid coordinates of the area on the world map. Will be displayed in the infobox of the page.	A1, A2, B1, etc.
Region	Yes	The geographical region or kingdom to which the area belongs. Will be displayed in the infobox of the page.	arbitrary text
Section	No	The name of the subsection in case the area is split into multiple area pages. Will be displayed in the infobox of the page.	arbitrary text
Buildings	No	The buildings located in the area.	a semicolon-separated list of [[Building]]s
Dungeons	No	The dungeons located in the area.	a semicolon-separated list of [[Dungeon]]s
POI	No	If there are special points of interest in the area, they can be described here.	a list of POIs, ideally formatted as a bullet list (using *)
Adjacent	No	Other areas directly connected to or surrounding this area. Will be displayed in the infobox of the page.	a semicolon-separated list of [[Area]]s
Inhabitants
Factions	No	If the area is under control of one or more factions, they can be listed here.	a semicolon-separated list of [[Faction]]s
Characters	No	The named characters present in the area. Note that inhabitants of a town should only be listed on the town's page and not on the page of the outdoor area containing the town.	a semicolon-separated list of [[Character]]s
Services
Shops	No	If there are merchants in the area, they can be listed here (even if they have already been listed under Characters).	a semicolon-separated list of [[Merchant]]s
Training	No	If there are trainers in the area, they can be listed here (even if they have already been listed under Characters).	a semicolon-separated list of [[Trainer]]s
Healing	No	If there are healers in the area, they can be listed here (even if they have already been listed under Characters).	a semicolon-separated list of [[Healer]]s
Transport	No	If there are means for fast transportation in the area, they can be described here.	a semicolon-separated list of transportation means
Threats
LevelL	No	The lowest level of creatures in the area.	positive number
LevelH	No	The highest level of creatures in the area.	positive number
ThreatNonrec	No	If there are non-recurring (one-time) enemies in the area, they can be listed here (ideally with information about their number).	a semicolon-separated list of [[Creature]]s
ThreatRecur	No	If there are recurring (respawning) enemies in the area, they can be listed here (ideally with information about their number).	a semicolon-separated list of [[Creature]]s
ThreatEnv	No	If there are environmental dangers (e.g. traps) in the area, they can be listed here (ideally with information about their number).	a semicolon-separated list of [[Danger]]s
ElemDanger	No	The types of resistances that are important in this area.	a vector of 6 comma-separated numbers, representing the 6 resistances (see Template:Resistances). Each number may take one of the following values: 0 (no threat) • 1 (medium threat) • 2 (high threat)
ElemVuln	No	The types of resistances to which the creatures in the area are particularly vulnerable.	a vector of 6 comma-separated numbers, representing the 6 resistances (see Template:Resistances). Each number may take one of the following values: 0 (low to normal vulnerability) • 1 (increased vulnerability) • 2 (high vulnerability)
Loot
LootFixed	No	If there is fixed one-time loot to be found in the area, it can be listed here.	a list of [[Item]]s, ideally formatted as a bullet list (using *)
LootRandom	No	If there is randomly spawning loot to be found in the area, it can be listed here (ideally with information on drop rates).	a list of [[Item]]s, ideally formatted as a bullet list (using *)

Including an annoted map

By default, the image specified as Map will be displayed on the area page. If you want to include a special annoted map instead, create a subpage <PAGENAME>/map in which the content of the annoted map is defined, e.g. via Template:Overlay (see the corresponding documentation there). If such a subpage exists, it will automatically be transcluded into the area page.

Extracting specific area information for use in other pages

Syntax

You can transclude information from an area page in any other page by using the following syntax:

{{:<pagename>|<mode>|<param1>|<param2>}}

Here, <pagename> is the area's full page name (in main namespace), <mode> determines the type of information to be transcluded, and <param1> & <param2> represent selection parameters required by certain modes.

Modes and parameters

Mode	Description	Parameter 1	Parameter 2
Page	Outputs the full area page. This is the default mode.	none	none
TableHead	Outputs the header of an area table (intended for constructing overview tables).	none	none
TableEntry	Outputs a table row containing specific area information (intended for constructing overview tables). If a selector is specified in <param1>, output is only generated if the selector of a specific area matches the value of <param2>. If no selector is specified, output is always generated.	one of the following selectors: Type • Region • Attribute	one of the possible values of the specified selector