Difference between revisions of "Template:Area (AL)"

Line 2: Line 2:
  
 
<!-- Area Page -->|Page =
 
<!-- Area Page -->|Page =
 +
{{QuestNavbar (AL)}}
 
{{Infobox (AL)
 
{{Infobox (AL)
 
|Title = {{#if:{{{Name|}}}|{{{Name}}}|{{Missing (AL)|Name}}}}
 
|Title = {{#if:{{{Name|}}}|{{{Name}}}|{{Missing (AL)|Name}}}}
Line 19: Line 20:
 
|Header4 = {{#if:{{{Attributes|}}}|Area attributes}}
 
|Header4 = {{#if:{{{Attributes|}}}|Area attributes}}
 
|Content4 = {{ListFormat (AL)|{{AreaAttributes (AL)|{{{Attributes|}}}}}|Bullets}}
 
|Content4 = {{ListFormat (AL)|{{AreaAttributes (AL)|{{{Attributes|}}}}}|Bullets}}
}}__NOTOC__
+
}}
 
{{#if:{{{Description|}}}|{{{Description}}}|{{Missing (AL)|Description}}}}
 
{{#if:{{{Description|}}}|{{{Description}}}|{{Missing (AL)|Description}}}}
 +
 
== Important sites =={{#if:{{{Towns|}}}|:
 
== Important sites =={{#if:{{{Towns|}}}|:
 
=== Towns ===
 
=== Towns ===

Revision as of 12:21, 3 March 2020

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 (AL)
|Mode = {{{1|Page}}}
|Select = {{{2|}}}

<!-- Quick Facts -->
|Name = 
|Pagename = 
|Type = 
|Attributes = 
|Factions = 
|Characters = 
|Shops = 
|Quests = 
|Secrets = 
|Level = 

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

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

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

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

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

Parameters

NameRequiredDescriptionValues
ModeYesDetermines the mode of execution of the template (see below). Changing the predefined value may lead to unexpected behavior.{{{1|Page}}} (should not be changed)
SelectYesUsed 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)
Quick Facts
NameYesThe name of the area. Usually identical to the page title. Will be displayed in the infobox of the page.arbitrary text
PagenameYesThe 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
TypeYesThe 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 (AL) (if new types are introduced, they should also be added there).one of the values defined in Template:AreaType (AL) (other values are ignored): Outdoor • Town • Dungeon • Building
AttributesNoOne 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 (AL) (if new attributes are introduced, they should also be added there).a semicolon-separated list of the values defined in Template:AreaAttributes (AL) (other values are ignored): Townhall • Resting • Sealed • New
FactionsNoIf the area is under control of one or more factions, they can be listed here.a semicolon-separated list of [[Faction]]s
CharactersNoThe named characters (including merchants) 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
ShopsNoIf there are merchants in the area, they can be listed here (even if they have already been listed under <Characters>). Their inventory will automatically be transcluded from the respective shop page.a semicolon-separated list of [[Merchant]]s
QuestsNoIf the area is of importance for certain quests, they can be listed here.a semicolon-separated list of [[Quests]]s
SecretsNoThe number of secrets to be discovered in the area.non-negative number
LevelYesThe character level recommended for visiting this area. Will be displayed in the infobox of the page.positive number
Media
ImageYesThe image (PNG or JPG) to be displayed in the infobox of the page.image name (including file extension)
IconNoThe image (PNG or JPG) to be displayed as an icon in area tables, lists, etc. If nothing is specified, a small version of <Image> is used instead.image name (including file extension)
MapYesThe local map of the area. For information on how to include an annoted map, see below.image name (including file extension)
SiteYesThe site map of the area, showing its location on the world map.image name (including file extension)
Info
DescriptionYesA short 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
NotesNoAny 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
GridYesThe grid coordinates of the area on the world map. Will be displayed in the infobox of the page.A1, A2, B1, etc.
RegionYesThe geographical region or kingdom to which the area belongs. Will be displayed in the infobox of the page.arbitrary text
TownsNoThe towns located in the area.a semicolon-separated list of [[Town]]s
BuildingsNoThe buildings located in the area.a semicolon-separated list of [[Building]]s
DungeonsNoThe dungeons located in the area.a semicolon-separated list of [[Dungeon]]s
AdjacentNoOther areas directly connected to or surrounding this area. Will be displayed in the infobox of the page.a semicolon-separated list of [[Area]]s
POINoIf there are special points of interest in the area, they can be described here.a semicolon-separated list of POIs
TransportNoIf there are means for fast transportation in the area, they can be described here.a semicolon-separated list of transportation means
Threats
LevelLNoThe lowest level of creatures in the area.positive number
LevelHNoThe highest level of creatures in the area.positive number
ThreatNonrecNoIf 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
ThreatRecurNoIf 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
ThreatEnvNoIf 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
ElemDangerNoThe types of elemental damage that may be encountered in the area.a vector of 6 comma-separated numbers (representing the 6 elements), where each number may take one of the following values: 0 (no threat) • 1 (medium threat) • 2 (high threat)
ElemVulnNoThe types of elements to which the creatures in the area are particularly vulnerable.a vector of 6 comma-separated numbers (representing the 6 elements), where each number may take one of the following values: 0 (low to normal vulnerability) • 1 (increased vulnerability) • 2 (high vulnerability)
Loot
LootFixedNoIf there is non-recurring (one-time) loot to be found in the area, it can be listed here.a semicolon-separated list of [[Item]]s
LootRandomNoIf there is recurring (randomly respawning) loot to be found in the area, it can be listed here (ideally with information about drop rates).a semicolon-separated list of [[Item]]s

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 (AL) (see the corresponding documentation there). If such a subpage exists, it will automatically be displayed on the area page.

Extracting specific area information for use in other pages

{{:PAGENAME|<Mode>|<Select>}}

View/Edit documentation page