Template:ParseHiscoreData/doc

From Darkan
Revision as of 09:08, 25 June 2012 by imported>Dictature
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Documentation This is a documentation subpage for Template:ParseHiscoreData.
It contains usage information, categories, and other content that is not part of the original template page.

The ParseHiscoreData template can be used to extract chosen skill levels, rank or experience from raw highscore data in the same format as returned from http://hiscore.runescape.com/index_lite.ws?player=<playername>.

Usage

{{ParseHiscoreData|hiscore data|skill name|value type}}

The hiscore data should be a string of number separated with commas and spaces in the format returned by the index_lite.ws. For example, for Zezima, this can be seen here.

Rather than copying the data into each use of ParseHiscoreData, this returned text from the index_lite.ws can be saved in a user's subpage that then can be included. See examples below.

The skill name is the name of the skill to extract the information for. The skill name can be one of the following:

The value type is the type of value to extract.

  • 0 - for the skill or minigame rank.
  • 1 - for the skill level or minigame score (this is the default).
  • 2 - for the skill experience (does not apply to minigames).

Examples

The following template call returns the overall level of a user called Example, using the user's hiscore data saved in the page [[User:Example/Hiscore Data]]:

{{ParseHiscoreData| {{User:Example/Hiscore Data}} | overall}}

The following example shows the number of experience points for the user Example for the Fletching skill:

{{ParseHiscoreData| {{User:Example/Hiscore Data}} | fletching | 2}}

The following example shows the Duel Tournament score for the user Example:

{{ParseHiscoreData| {{User:Example/Hiscore Data}} | duel | 1}}

The following example shows the Fist of Guthix rank for the user Example:

{{ParseHiscoreData| {{User:Example/Hiscore Data}} | fog | 0}}

Updating a user's Hiscore Data pages

Users can periodically update their Hiscore Data pages by doing the following:

  1. Go to the web page http://services.runescape.com/m=hiscore/index_lite.ws?player=<playername> (where the <playername> is replaced with the player's RuneScape username).
  2. Copy the contents of the page (e.g. using Ctrl-C).
  3. Go to user's own Hiscore Data sub-page.
  4. Edit the Hiscore Data page.
  5. Select any existing text in the edit box.
  6. Paste in the new data.
  7. Save the changes.

All pages making use of the user's hiscore data should then be automatically updated.