Template:Infobox Location/doc

From RuneScape Classic Wiki
Jump to: navigation, search
Information icon-grey.svg
This is a documentation subpage for Template:Infobox Location.
It contains usage information, categories, and other content that is not part of the original template page.
Template:Infobox Location invokes function main in Module:Infobox Location using Lua.


Standard infobox parameters

This infobox uses Module:Infobox, which provides a number of standard parameters.

Versioning

This infobox supports switching between multiple versions. Each version needs to have a name defined in a parameter called version#, numbered sequentially starting from 1. For all parameters that have different values, a number can be appended to the end of each parameter name to define the value for each version. Parameters without a version number will be shared between all versions.

For example, if the name of version 2 is called "Bob", you should define |name2 = Bob.

Linking

You can link to a page and have an alternative infobox appear by using a hash value, as if you were linking to a section. The hash value is the version name, as defined by the relevant version# parameter. For example, to link to the variant of a switch infobox with |version3 = Quest, you can use [[Example#Quest]].

Alternative versions are not visible or accessible when Javascript is disabled.

smwname

This overrides the name of the Semantic MediaWiki subobject that the infobox will set the parameters into. By default, an infobox with multiple versions will save properties into subobjects with the same name as the version name. This parameter only needs to be set if the version name is different from the desired subobject name, or if an unversioned infobox needs to set properties of a specific subobject (for example, when versioned and unversioned infoboxes of different types, like Item and Bonuses, are used on the same page).

This is necessary when a version name would otherwise be an invalid SMW subobject name. The value of smwname is also not permitted to be an invalid subobject name. A subobject name must not violate the following rules:

  • The first 5 characters of the name must not contain a period (.).
  • The name must not be the number zero (0).
  • The name must not be the empty string.


If the infobox does not have multiple versions, SMW properties would normally be set on the page itself. Setting smwname overrides this default behaviour and the properties will be only be set to the specified subobjects and not the page itself.

Multiple subobjects can be specified by separating the subobject names with the broken bar character (¦). The properties will be set in all of the subobjects specified.

For example, if the infobox has |version2 = H.A.M. member, this would cause an invalid subobject name due to having a period within the first 5 characters. The infobox should therefore override the smwname using |smwname2 = HAM member or something similar.

__dump__

This parameter is used only for debugging an infobox. If __dump__ is present with any value then a string version of the infobox object is dumped to the page, rather than displaying the infobox as normal. This should only be used when previewing the page and must never be saved in a mainspace page. Setting this adds Category:Dumping infoboxes to the page.

Specifically, this shows the result at the time the infobox is converted to a string. This will always occur when the module finally returns, but may instead occur earlier in the code. The object is dumped using mw.dumpObject(box). Dumping will not prevent a script error occurring.


Parameters

name

The name of the location.

image

An image of the location.

release

The release date of the location.

update

The update post associated with the release date.

aka

(Optional) Other names the location is called.

members

Whether the location is only accessible to members. Must be "Yes" or "No".

floors

(Optional) The number of floors of the location. Omit if 1 or not applicable.

location

(Optional) Name of the surrounding area. Omit for large regions that don't have a proper surrounding area. Examples:

  • For cities, this would be the region the city is located in.
  • For buildings, this would be the name of the city that contains the building.
  • For islands, this would be the name of the sea containing the island.

capital

(Optional) The capital city within the location. Generally only used for regions.

requirement

(Optional) Requirements for entering the location. This will primarily be used for Guilds that have some skill or quest requirement before entry.

race

(Optional) Race of NPCs residing within the location.

wilderness

(Optional) Range of wilderness levels that the location spans.

teleport

(Optional) Possible teleports to the location.

map

A map of the locatioin. Should either be a map image or an interactive mapframe.

type

(Optional) The location type. Used for adding specific categories to pages. Multiple types can be provided, separated by commas. Allowed values are:

  • agility course
  • building
  • settlement
  • dungeon
  • guild
  • mine
  • river
  • mountain
  • volcano
  • realm
  • island
  • windmill
  • woods
  • region

Quick copy

{{Infobox Location
|name = 
|image = 
|release = 
|update = 
|aka = (Optional)
|members = 
|floors = (Optional)
|location = (Optional)
|capital = (Optional)
|requirement = (Optional)
|race = (Optional)
|wilderness = (Optional)
|teleport = (Optional)
|map = 
|type = (Optional)
}}