Difference between revisions of "Template:Place Summary/Doc"

The Beyond Skyrim Wiki — Hosted by UESP
Jump to: navigation, search
m (1 revision imported: templates from UESPWiki)
m (clean out MetaTemplate)
 
Line 5: Line 5:
 
Note that several parameters are case-insensitive for backwards compatibility. Lower-case parameters are customary for templates.  Parameters marked as being "autolinked" can be provided either as links or plain text and will convert plain text to links.
 
Note that several parameters are case-insensitive for backwards compatibility. Lower-case parameters are customary for templates.  Parameters marked as being "autolinked" can be provided either as links or plain text and will convert plain text to links.
  
−
{{Parameters
+
{| class="wikitable"
−
|type|required|Any sensible term, for example, "Cave", "Fort", "House", "Store", "Inn", "Guild Hall", "Landmark", "Lake". Used in infobox title and trail.
+
!colspan="3"| {{{template|{{BASEPAGENAME}}}}}
−
|description|required|A description of the location.
+
|-
−
|mod|optional|Name of mod that adds the location (if not in baseline version of game).
+
! Parameter !! Scope !! Description
−
|image|required|The name of an image file for this place (without "File:" or <nowiki>[[brackets]]</nowiki>). If this parameter is missing, a [[Template:NeedsImage|NeedsImage]] banner will automatically be added to the quest article. In cases where an image is truly never needed, set image to "none".
+
|-
−
|imgdesc|optional|Description of image. Optional, but should usually be provided with <code>image</code>.
+
|type||required||Any sensible term, for example, "Cave", "Fort", "House", "Store", "Inn", "Guild Hall", "Landmark", "Lake". Used in infobox title and trail.
−
|addabove<br>addbelow|optional|Any text to be added above or below the description. A space is automatically added after <code>addabove</code> and before <code>addbelow</code>. This should generally only be used for descriptive text and should not contain tables or images that would be better placed outside the template call.
+
|-
−
|is/are|optional|Define as anything to change from <code>Place is &lt;description></code> to <code>Place are &lt;description></code>.
+
|description||required||A description of the location.
−
|titlename|optional|Name of place, used in infobox title and description sentence. Defaults to SUBPAGENAME.
+
|-
−
|mapname|optional|Name of location on the Oblivion/SI/Morrowind Map. Defaults to SUBPAGENAME - set to "none" to omit this field.
+
|mod||optional||Name of mod that adds the location (if not in baseline version of game).
−
|mapbase|optional|Namespace of game map to use if not the current namespace. Used for cases like [[Dragonborn:Last Vigil|Last Vigil]] and [[Shivering:A Strange Door|A Strange Door]].
+
|-
−
|mapx|optional|If mapname cannot be used for some reason, the location of a place can be specified using mapx and mapy. These are coordinates taken directly from the relevant map.
+
|image||required||The name of an image file for this place (without "File:" or <nowiki>[[brackets]]</nowiki>). If this parameter is missing, a [[Template:NeedsImage|NeedsImage]] banner will automatically be added to the quest article. In cases where an image is truly never needed, set image to "none".
−
|mapy|optional|See mapx.
+
|-
−
|lorepage|optional|Name (or full link) to a Lore page with more information on the location.
+
|imgdesc||optional||Description of image. Optional, but should usually be provided with <code>image</code>.
−
|zones|optional|Number of zones at location.
+
|-
−
|job1<br>…<br>job5|optional|List of people with functions at the location.
+
|addabove<br>addbelow||optional||Any text to be added above or below the description. A space is automatically added after <code>addabove</code> and before <code>addbelow</code>. This should generally only be used for descriptive text and should not contain tables or images that would be better placed outside the template call.
−
|jobtitle1<br>…<br>jobtitle5|optional|Corresponding headings to use for <code>job</code> parameters. Defaults to "Publican" for Inns, "Guildmaster" for Guild Halls, "Master" for Telvanni Towers, and "Proprietor" for anything else.
+
|-
−
|prop|deprecated|Identical to <code>job1</code>.
+
|is/are||optional||Define as anything to change from <code>Place is &lt;description></code> to <code>Place are &lt;description></code>.
−
|propname|deprecated|Identical to <code>jobtitle1</code> parameters. <code>jobtitle</code> is preferred over <code>propname</code>.
+
|-
−
|occupants|optional|Type of occupants.
+
|titlename||optional||Name of place, used in infobox title and description sentence. Defaults to SUBPAGENAME.
−
|treasure|optional|Listing of important treasures.
+
|-
−
|transtype|optional|Transportation type for destinations header.
+
|mapname||optional||Name of location on the Oblivion/SI/Morrowind Map. Defaults to SUBPAGENAME - set to "none" to omit this field.
−
|dest1<br>dest2<br>dest3<br>dest4|optional|Fast-travel destinations from this location.
+
|-
−
|locationcode|optional|Console location code. Defaults to "Unknown" - set to "none" to omit this field.
+
|mapbase||optional||Namespace of game map to use if not the current namespace. Used for cases like [[Dragonborn:Last Vigil|Last Vigil]] and [[Shivering:A Strange Door|A Strange Door]].
−
|regionheader|optional|Header to use with <code>region</code>. Defaults to "Region", or "Regions" if <code>region2</code> is provided.
+
|-
−
|region<br>region2<br>region3|optional|Name of the region(s) in which the place can be found. Autolinked.
+
|mapx||optional||If mapname cannot be used for some reason, the location of a place can be specified using mapx and mapy. These are coordinates taken directly from the relevant map.
 +
|-
 +
|mapy||optional||See mapx.
 +
|-
 +
|lorepage||optional||Name (or full link) to a Lore page with more information on the location.
 +
|-
 +
|zones||optional||Number of zones at location.
 +
|-
 +
|job1<br>…<br>job5||optional||List of people with functions at the location.
 +
|-
 +
|jobtitle1<br>…<br>jobtitle5||optional||Corresponding headings to use for <code>job</code> parameters. Defaults to "Publican" for Inns, "Guildmaster" for Guild Halls, "Master" for Telvanni Towers, and "Proprietor" for anything else.
 +
|-
 +
|prop||deprecated||Identical to <code>job1</code>.
 +
|-
 +
|propname||deprecated||Identical to <code>jobtitle1</code> parameters. <code>jobtitle</code> is preferred over <code>propname</code>.
 +
|-
 +
|occupants||optional||Type of occupants.
 +
|-
 +
|treasure||optional||Listing of important treasures.
 +
|-
 +
|transtype||optional||Transportation type for destinations header.
 +
|-
 +
|dest1<br>dest2<br>dest3<br>dest4||optional||Fast-travel destinations from this location.
 +
|-
 +
|locationcode||optional||Console location code. Defaults to "Unknown" - set to "none" to omit this field.
 +
|-
 +
|regionheader||optional||Header to use with <code>region</code>. Defaults to "Region", or "Regions" if <code>region2</code> is provided.
 +
|-
 +
|region<br>region2<br>region3||optional||Name of the region(s) in which the place can be found. Autolinked.
 +
|-
 
|-|<center>Use only one of <code>location</code>, <code>city</code>, or <code>town</code>. (Prioritized in that order if more than one is specified.)|
 
|-|<center>Use only one of <code>location</code>, <code>city</code>, or <code>town</code>. (Prioritized in that order if more than one is specified.)|
−
|city|optional|Name of the city in which the place can be found. Autolinked.
+
|-
−
|district|optional|District within the city (should only be used if city{{=}}Vivec, Imperial City, or New Sheoth). Autolinked.
+
|city||optional||Name of the city in which the place can be found. Autolinked.
−
|town|optional|Name of town in which the place can be found. Unlike city, is not categorized. Autolinked.
+
|-
−
|location|optional|Where this place is located.
+
|district||optional||District within the city (should only be used if city{{=}}Vivec, Imperial City, or New Sheoth). Autolinked.
−
|coords|optional|Coordinates of place (only if city or region is provided).
+
|-
−
|notrail|optional|Specify any value to omit trail at top-left of screen. Defaults to omitted on User and Template pages.
+
|town||optional||Name of town in which the place can be found. Unlike city, is not categorized. Autolinked.
−
|marker_icon|optional|Name of icon used for this place on the map.  Icon will be added to the title of the infobox.
+
|-
−
|!|Morrowind-Specific|
+
|location||optional||Where this place is located.
−
|almsivi|optional|Location that will be reached via Almsivi Intervention.
+
|-
−
|divine|optional|Location that will be reached via Divine Intervention.
+
|coords||optional||Coordinates of place (only if city or region is provided).
−
|interventionns|optional|Namespace to be used for header text link of <code>almsivi</code> and <code>divine</code>.
+
|-
−
|daedra|required for<br>Daedric&nbsp;Ruin&nbsp;or<br>Daedric&nbsp;Shrine|Daedra Lord association. Use "None" for those without any Daedra Lord.
+
|notrail||optional||Specify any value to omit trail at top-left of screen. Defaults to omitted on User and Template pages.
−
|kollops|required for<br>Grotto|Number of pearl-containing Kollops.
+
|-
−
|minetype|required for<br>Mine|Normally one of: Diamond, Ebony, Egg, Glass or Iron Ore. Other values may be used and will automatically link to a page of the same name if possible.
+
|marker_icon||optional||Name of icon used for this place on the map.  Icon will be added to the title of the infobox.
−
|samples|required for<br>Mine|Number of ore samples or eggs in mine.
+
|-
−
|propylon1<br>propylon2|optional for<br>Stronghold|Propylon chambers. Normally used with <code>type{{=}}Stronghold</code> but can be used regardless of type.
+
|roomcost||optional||Cost to rent a room (only if type{{=}}Inn).
−
|shrine<br>shrine2|optional for<br>Tomb|Names of shrines.
+
|-
−
|!|Oblivion-Specific|
+
|clearable||optional||Is this place clearable?  If missing/empty, nothing is displayed; otherwise "Yes" is displayed (and it's added to the clearable category).
−
|roomcost|optional|Cost to rent a room (only if type{{=}}Inn).
+
|-
−
|welkynd|optional for<br>Ayleid Ruins|Number of welkynd stones.
+
|dungeon||optional||Is this place classified as a dungeon?  If missing/empty, nothing is displayed; otherwise "Yes" is displayed.
−
|varla|optional for<br>Ayleid Ruins|Number of varla stones.
+
|-
−
|!|Skyrim-Specific|
+
|respawn||optional||Respawn time for location.  Most commonly used to set value to <code>never</code>.  If entire respawn section should be skipped, set it to <code>skip</code>. Otherwise, default text is displayed, dependent upon whether or not location is clearable.
−
|roomcost|optional|Cost to rent a room (only if type{{=}}Inn).
+
|-
−
|clearable|optional|Is this place clearable?  If missing/empty, nothing is displayed; otherwise "Yes" is displayed (and it's added to the clearable category).
+
|oretype<br>oretype2<br>…<br>oretype7||optional||Types of ore vein (e.g., iron, ebony, etc).
−
|dungeon|optional|Is this place classified as a dungeon?  If missing/empty, nothing is displayed; otherwise "Yes" is displayed.
+
|-
−
|respawn|optional|Respawn time for location.  Most commonly used to set value to <code>never</code>.  If entire respawn section should be skipped, set it to <code>skip</code>. Otherwise, default text is displayed, dependent upon whether or not location is clearable.
+
|orenum<br>orenum2<br>…<br>orenum7||optional||# of veins of the corresponding <code>oretype</code>. Only used if the corresponding <code>oretype</code> is set.
−
|oretype<br>oretype2<br>…<br>oretype7|optional|Types of ore vein (e.g., iron, ebony, etc).
+
|-
−
|orenum<br>orenum2<br>…<br>orenum7|optional|# of veins of the corresponding <code>oretype</code>. Only used if the corresponding <code>oretype</code> is set.
+
|alchemy||optional||# of alchemy labs.
−
|alchemy|optional|# of alchemy labs.
+
|-
−
|enchanting|optional|# of arcane enchanters.
+
|enchanting||optional||# of arcane enchanters.
−
|tanning|optional|# of tanning racks.
+
|-
−
|smelter|optional|# of smelters.
+
|tanning||optional||# of tanning racks.
−
|forge|optional|# of forges and/or anvils.
+
|-
−
|grindstone|optional|# of grindstones.
+
|smelter||optional||# of smelters.
−
|workbench|optional|# of workbenches.
+
|-
−
|cooking|optional|# of cooking pots or cooking spits.
+
|forge||optional||# of forges and/or anvils.
−
|lumber|optional|# of wood chopping blocks.
+
|-
−
|clay|optional|# of clay deposits.
+
|grindstone||optional||# of grindstones.
−
|stone|optional|# of stone quarries.
+
|-
−
|amethyst|optional|# of amethyst geodes.
+
|workbench||optional||# of workbenches.
−
|emerald|optional|# of emerald geodes.
+
|-
−
|ruby|optional|# of ruby geodes.
+
|cooking||optional||# of cooking pots or cooking spits.
−
|sapphire|optional|# of sapphire geodes.
+
|-
−
|heartstone|optional|# of heart stone deposits.
+
|lumber||optional||# of wood chopping blocks.
−
|stalhrim|optional|# of stalhrim deposits.
+
|-
−
|wordwall|optional|Type of shout provided by the Word Wall (as a link).
+
|clay||optional||# of clay deposits.
−
|shadowmark<br>shadowmark2<br>…<br>shadowmark4|optional|Name(s) of any shadowmark(s) displayed at this location (possible values: <code>cache</code>, <code>danger</code>, <code>empty</code>, <code>escape</code>, <code>fence</code>, <code>guild</code>, <code>loot</code>, <code>protected</code>, or <code>safe</code>).
+
|-
−
|marker_id|optional|Name of marker used on the world map (e.g., 'Farm').  Auto-converted into the correct value of marker_icon.
+
|stone||optional||# of stone quarries.
−
}}<includeonly>[[Category:Infobox Templates]][[Category:MetaTemplate-Templates Using Save]]</includeonly><noinclude>[[Category:Template Documentation]]</noinclude>
+
|-
 +
|amethyst||optional||# of amethyst geodes.
 +
|-
 +
|emerald||optional||# of emerald geodes.
 +
|-
 +
|ruby||optional||# of ruby geodes.
 +
|-
 +
|sapphire||optional||# of sapphire geodes.
 +
|-
 +
|heartstone||optional||# of heart stone deposits.
 +
|-
 +
|stalhrim||optional||# of stalhrim deposits.
 +
|-
 +
|wordwall||optional||Type of shout provided by the Word Wall (as a link).
 +
|-
 +
|shadowmark<br>shadowmark2<br>…<br>shadowmark4||optional||Name(s) of any shadowmark(s) displayed at this location (possible values: <code>cache</code>, <code>danger</code>, <code>empty</code>, <code>escape</code>, <code>fence</code>, <code>guild</code>, <code>loot</code>, <code>protected</code>, or <code>safe</code>).
 +
|-
 +
|marker_id||optional||Name of marker used on the world map (e.g., 'Farm').  Auto-converted into the correct value of marker_icon.
 +
|}<includeonly>[[Category:Infobox Templates]]</includeonly><noinclude>[[Category:Template Documentation]]</noinclude>

Latest revision as of 19:01, 1 July 2017

Summary[edit]

This template provides a uniform look for all in-game location pages, and should be used at the top of the pages for any dungeons, settlements, campsites, houses, or other locations. It automatically fills in the breadcrumb trails, primary image, and primary description. The description is also made available for other templates, such as Place Link.

Parameters[edit]

Note that several parameters are case-insensitive for backwards compatibility. Lower-case parameters are customary for templates. Parameters marked as being "autolinked" can be provided either as links or plain text and will convert plain text to links.

Place Summary
Parameter Scope Description
type required Any sensible term, for example, "Cave", "Fort", "House", "Store", "Inn", "Guild Hall", "Landmark", "Lake". Used in infobox title and trail.
description required A description of the location.
mod optional Name of mod that adds the location (if not in baseline version of game).
image required The name of an image file for this place (without "File:" or [[brackets]]). If this parameter is missing, a NeedsImage banner will automatically be added to the quest article. In cases where an image is truly never needed, set image to "none".
imgdesc optional Description of image. Optional, but should usually be provided with image.
addabove
addbelow		 optional Any text to be added above or below the description. A space is automatically added after addabove and before addbelow. This should generally only be used for descriptive text and should not contain tables or images that would be better placed outside the template call.
is/are optional Define as anything to change from Place is <description> to Place are <description>.
titlename optional Name of place, used in infobox title and description sentence. Defaults to SUBPAGENAME.
mapname optional Name of location on the Oblivion/SI/Morrowind Map. Defaults to SUBPAGENAME - set to "none" to omit this field.
mapbase optional Namespace of game map to use if not the current namespace. Used for cases like Last Vigil and A Strange Door.
mapx optional If mapname cannot be used for some reason, the location of a place can be specified using mapx and mapy. These are coordinates taken directly from the relevant map.
mapy optional See mapx.
lorepage optional Name (or full link) to a Lore page with more information on the location.
zones optional Number of zones at location.
job1
…
job5		 optional List of people with functions at the location.
jobtitle1
…
jobtitle5		 optional Corresponding headings to use for job parameters. Defaults to "Publican" for Inns, "Guildmaster" for Guild Halls, "Master" for Telvanni Towers, and "Proprietor" for anything else.
prop deprecated Identical to job1.
propname deprecated Identical to jobtitle1 parameters. jobtitle is preferred over propname.
occupants optional Type of occupants.
treasure optional Listing of important treasures.
transtype optional Transportation type for destinations header.
dest1
dest2
dest3
dest4		 optional Fast-travel destinations from this location.
locationcode optional Console location code. Defaults to "Unknown" - set to "none" to omit this field.
regionheader optional Header to use with region. Defaults to "Region", or "Regions" if region2 is provided.
region
region2
region3		 optional Name of the region(s) in which the place can be found. Autolinked.
city optional Name of the city in which the place can be found. Autolinked.
district optional District within the city (should only be used if city=Vivec, Imperial City, or New Sheoth). Autolinked.
town optional Name of town in which the place can be found. Unlike city, is not categorized. Autolinked.
location optional Where this place is located.
coords optional Coordinates of place (only if city or region is provided).
notrail optional Specify any value to omit trail at top-left of screen. Defaults to omitted on User and Template pages.
marker_icon optional Name of icon used for this place on the map. Icon will be added to the title of the infobox.
roomcost optional Cost to rent a room (only if type=Inn).
clearable optional Is this place clearable? If missing/empty, nothing is displayed; otherwise "Yes" is displayed (and it's added to the clearable category).
dungeon optional Is this place classified as a dungeon? If missing/empty, nothing is displayed; otherwise "Yes" is displayed.
respawn optional Respawn time for location. Most commonly used to set value to never. If entire respawn section should be skipped, set it to skip. Otherwise, default text is displayed, dependent upon whether or not location is clearable.
oretype
oretype2
…
oretype7		 optional Types of ore vein (e.g., iron, ebony, etc).
orenum
orenum2
…
orenum7		 optional # of veins of the corresponding oretype. Only used if the corresponding oretype is set.
alchemy optional # of alchemy labs.
enchanting optional # of arcane enchanters.
tanning optional # of tanning racks.
smelter optional # of smelters.
forge optional # of forges and/or anvils.
grindstone optional # of grindstones.
workbench optional # of workbenches.
cooking optional # of cooking pots or cooking spits.
lumber optional # of wood chopping blocks.
clay optional # of clay deposits.
stone optional # of stone quarries.
amethyst optional # of amethyst geodes.
emerald optional # of emerald geodes.
ruby optional # of ruby geodes.
sapphire optional # of sapphire geodes.
heartstone optional # of heart stone deposits.
stalhrim optional # of stalhrim deposits.
wordwall optional Type of shout provided by the Word Wall (as a link).
shadowmark
shadowmark2
…
shadowmark4		 optional Name(s) of any shadowmark(s) displayed at this location (possible values: cache, danger, empty, escape, fence, guild, loot, protected, or safe).
marker_id optional Name of marker used on the world map (e.g., 'Farm'). Auto-converted into the correct value of marker_icon.
Retrieved from "https://wiki.beyondskyrim.org/w/index.php?title=Template:Place_Summary/Doc&oldid=231"