Editing Template:Place Summary/Doc

Jump to: navigation, search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
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.
  
−
{| class="wikitable"
+
{{Parameters
−
!colspan="3"| {{{template|{{BASEPAGENAME}}}}}
+
|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.
−
! Parameter !! Scope !! Description
+
|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 <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".
−
|type||required||Any sensible term, for example, "Cave", "Fort", "House", "Store", "Inn", "Guild Hall", "Landmark", "Lake". Used in infobox title and trail.
+
|imgdesc|optional|Description of image. Optional, but should usually be provided with <code>image</code>.
−
|-
+
|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.
−
|description||required||A description of the location.
+
|is/are|optional|Define as anything to change from <code>Place is &lt;description></code> to <code>Place are &lt;description></code>.
−
|-
+
|titlename|optional|Name of place, used in infobox title and description sentence. Defaults to SUBPAGENAME.
−
|mod||optional||Name of mod that adds the location (if not in baseline version of game).
+
|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 [[Dragonborn:Last Vigil|Last Vigil]] and [[Shivering:A Strange Door|A Strange Door]].
−
|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".
+
|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.
−
|imgdesc||optional||Description of image. Optional, but should usually be provided with <code>image</code>.
+
|lorepage|optional|Name (or full link) to a Lore page with more information on the location.
−
|-
+
|zones|optional|Number of zones at 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.
+
|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.
−
|is/are||optional||Define as anything to change from <code>Place is &lt;description></code> to <code>Place are &lt;description></code>.
+
|prop|deprecated|Identical to <code>job1</code>.
−
|-
+
|propname|deprecated|Identical to <code>jobtitle1</code> parameters. <code>jobtitle</code> is preferred over <code>propname</code>.
−
|titlename||optional||Name of place, used in infobox title and description sentence. Defaults to SUBPAGENAME.
+
|occupants|optional|Type of occupants.
−
|-
+
|treasure|optional|Listing of important treasures.
−
|mapname||optional||Name of location on the Oblivion/SI/Morrowind Map. Defaults to SUBPAGENAME - set to "none" to omit this field.
+
|transtype|optional|Transportation type for destinations header.
−
|-
+
|dest1<br>dest2<br>dest3<br>dest4|optional|Fast-travel destinations from this location.
−
|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]].
+
|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.
−
|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.
+
|region<br>region2<br>region3|optional|Name of the region(s) in which the place can be found. Autolinked.
−
|-
+
−
|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.
−
|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.
−
|district||optional||District within the city (should only be used if city{{=}}Vivec, Imperial City, or New Sheoth). Autolinked.
+
|location|optional|Where this place is located.
−
|-
+
|coords|optional|Coordinates of place (only if city or region is provided).
−
|town||optional||Name of town in which the place can be found. Unlike city, is not categorized. Autolinked.
+
|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.
−
|location||optional||Where this place is located.
+
|!|Morrowind-Specific|
−
|-
+
|almsivi|optional|Location that will be reached via Almsivi Intervention.
−
|coords||optional||Coordinates of place (only if city or region is provided).
+
|divine|optional|Location that will be reached via Divine Intervention.
−
|-
+
|interventionns|optional|Namespace to be used for header text link of <code>almsivi</code> and <code>divine</code>.
−
|notrail||optional||Specify any value to omit trail at top-left of screen. Defaults to omitted on User and Template pages.
+
|daedra|required for<br>Daedric&nbsp;Ruin&nbsp;or<br>Daedric&nbsp;Shrine|Daedra Lord association. Use "None" for those without any Daedra Lord.
−
|-
+
|kollops|required for<br>Grotto|Number of pearl-containing Kollops.
−
|marker_icon||optional||Name of icon used for this place on the map.  Icon will be added to the title of the infobox.
+
|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.
−
|-
+
|samples|required for<br>Mine|Number of ore samples or eggs in mine.
−
|roomcost||optional||Cost to rent a room (only if type{{=}}Inn).
+
|propylon1<br>propylon2|optional for<br>Stronghold|Propylon chambers. Normally used with <code>type{{=}}Stronghold</code> but can be used regardless of type.
−
|-
+
|shrine<br>shrine2|optional for<br>Tomb|Names of shrines.
−
|clearable||optional||Is this place clearable?  If missing/empty, nothing is displayed; otherwise "Yes" is displayed (and it's added to the clearable category).
+
|!|Oblivion-Specific|
−
|-
+
|roomcost|optional|Cost to rent a room (only if type{{=}}Inn).
−
|dungeon||optional||Is this place classified as a dungeon?  If missing/empty, nothing is displayed; otherwise "Yes" is displayed.
+
|welkynd|optional for<br>Ayleid Ruins|Number of welkynd stones.
−
|-
+
|varla|optional for<br>Ayleid Ruins|Number of varla stones.
−
|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.
+
|!|Skyrim-Specific|
−
|-
+
|roomcost|optional|Cost to rent a room (only if type{{=}}Inn).
−
|oretype<br>oretype2<br>…<br>oretype7||optional||Types of ore vein (e.g., iron, ebony, etc).
+
|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.
−
|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.
+
|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.
−
|-
+
|oretype<br>oretype2<br>…<br>oretype7|optional|Types of ore vein (e.g., iron, ebony, etc).
−
|alchemy||optional||# of alchemy labs.
+
|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.
−
|enchanting||optional||# of arcane enchanters.
+
|enchanting|optional|# of arcane enchanters.
−
|-
+
|tanning|optional|# of tanning racks.
−
|tanning||optional||# of tanning racks.
+
|smelter|optional|# of smelters.
−
|-
+
|forge|optional|# of forges and/or anvils.
−
|smelter||optional||# of smelters.
+
|grindstone|optional|# of grindstones.
−
|-
+
|workbench|optional|# of workbenches.
−
|forge||optional||# of forges and/or anvils.
+
|cooking|optional|# of cooking pots or cooking spits.
−
|-
+
|lumber|optional|# of wood chopping blocks.
−
|grindstone||optional||# of grindstones.
+
|clay|optional|# of clay deposits.
−
|-
+
|stone|optional|# of stone quarries.
−
|workbench||optional||# of workbenches.
+
|amethyst|optional|# of amethyst geodes.
−
|-
+
|emerald|optional|# of emerald geodes.
−
|cooking||optional||# of cooking pots or cooking spits.
+
|ruby|optional|# of ruby geodes.
−
|-
+
|sapphire|optional|# of sapphire geodes.
−
|lumber||optional||# of wood chopping blocks.
+
|heartstone|optional|# of heart stone deposits.
−
|-
+
|stalhrim|optional|# of stalhrim deposits.
−
|clay||optional||# of clay 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>).
−
|stone||optional||# of stone quarries.
+
|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]][[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>
+

Please note that all contributions to Beyond Skyrim are considered to be released under the Creative Commons Attribution-ShareAlike (see Beyond Skyrim Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)

Template used on this page:

Retrieved from "https://wiki.beyondskyrim.org/wiki/Template:Place_Summary/Doc"