Template:Location page/doc: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(3 intermediate revisions by the same user not shown)
Line 25: Line 25:
== Examples ==
== Examples ==


=== Ebonlake Grotto ===
=== Usage: ===
<pre>{{Location page
| prefix = The
| name = Ebonlake Grotto
| alt name prefix = the
| alt name = Myconid Colony
| image = Ebonlake Grotto Overview.jpg
| image description = Overview of the area.
| act = one
| summary = It is the home of the [[Myconid]] Circle, a group of mushroom-like telepaths led by Sovereign {{CharLink|Spaw}}.
| region prefix = the
| region = Underdark
| north =
| west = Dread Hollow
| east = Storehouse
| south = Decrepit Village
}}</pre>
 
=== Result ===
{{Location page
{{Location page
| prefix = The
| prefix = The
| name = Ebonlake Grotto
| name = Ebonlake Grotto
| prefix alt name = the
| alt name prefix = the
| alt name = Myconid Colony
| alt name = Myconid Colony
| image = Ebonlake Grotto Overview.jpg
| image = Ebonlake Grotto Overview.jpg
Line 58: Line 76:
             "required": true
             "required": true
},
},
"prefix alt name": {
"alt name prefix": {
"description": "What to prefix the alt name with",
"description": "What to prefix the alt name with",
"type": "string"
"type": "string"
Line 113: Line 131:
"description": "The location to the west of this location.",
"description": "The location to the west of this location.",
"type": "wiki-page-name"
"type": "wiki-page-name"
},
"no output": {
"description": "If yes, don't output anything and just insert into the table.",
"type": "string"
}
}
},
},

Latest revision as of 09:02, 27 August 2024

This template displays part of a Location page. It is responsible for the summary, main image and relative location template.

It will also insert a row into the locations Cargo table.

Copy-ready:

{{Location page
| prefix = 
| name =
| alt name prefix = 
| alt name =
| image = 
| image description = 
| act =
| summary =
| region prefix = 
| region = 
| north =
| west =
| east = 
| south =
}}

Examples

Usage:

{{Location page
| prefix = The
| name = Ebonlake Grotto
| alt name prefix = the
| alt name = Myconid Colony
| image = Ebonlake Grotto Overview.jpg
| image description = Overview of the area.
| act = one
| summary = It is the home of the [[Myconid]] Circle, a group of mushroom-like telepaths led by Sovereign {{CharLink|Spaw}}.
| region prefix = the
| region = Underdark
| north = 
| west = Dread Hollow
| east = Storehouse
| south = Decrepit Village
}}

Result

Underdark
Dread Hollow Ebonlake Grotto Storehouse
Decrepit Village
The Ebonlake Grotto (also known as the Myconid Colony) is a Location within the Underdark in Act One of Baldur's Gate 3. It is the home of the Myconid Circle, a group of mushroom-like telepaths led by Sovereign Spaw Spaw.

Template data

No description.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
prefixprefix

What to prefix the name with

Stringoptional
namename

If specified, overrides the name. Otherwise, it will take the name of the article

Stringrequired
alt name prefixalt name prefix

What to prefix the alt name with

Stringoptional
alt namealt name

Alternative name for the location

Stringoptional
imageimage

Image to use as the main page image at the top right

Fileoptional
image descriptionimage description

Description of the main page image, displayed underneath.

Stringoptional
actact

Which act of the game this location appears in

Suggested values
prologue one two three
Stringrequired
summarysummary

Summary of the location. Also used for SEO purposes.

Contentoptional
region prefixregion prefix

What to prefix the region name with

Stringoptional
regionregion

The region where this location is located within. Slightly changes the summary.

Example
Underdark
Page nameoptional
northnorth

The location to the north of this location.

Page nameoptional
easteast

The location to the east of this location.

Page nameoptional
southsouth

The location to the south of this location.

Page nameoptional
westwest

The location to the west of this location.

Page nameoptional
no outputno output

If yes, don't output anything and just insert into the table.

Stringoptional