Template:RegionBox/doc

From BattleMaster Wiki
Revision as of 15:21, 25 March 2009 by Indirik (talk | contribs) (New page: <noinclude>{{DocSubpage}}</noinclude> == Intro == This template is part of the RegionBox Project. (Which itself is part of the RealmBox Project.) This is a template designed to pl...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Gtk-dialog-info.svg Page Information
This is a documentation subpage for the RegionBox template.
It contains usage information, categories and other content that is not part of the original template page.

Intro

This template is part of the RegionBox Project. (Which itself is part of the RealmBox Project.)

This is a template designed to place a regional infobox on a region page. It is coded for automatic tagging of properties for the Semantic Wiki. You can use this template by simply copying and pasting the sample given below.

This template will place your region in the appropriate island/region category. Do not add a "Regions" category to your page.

Parameters

These parameters are used by the template. Some information is required to be included, and is noted in the description.

  • TitleBackColor - The color code for the title bar backgrounds. Defaults to #000000 (black).
  • TitleTextColor - The color code of the title bar text. Defaults to #FFFFFF (white).
  • BackColor - The background color for the regionbox. Defaults to #DDDDDD (light gray).
  • BorderStyle - The style of the box borders. Defaults to "hidden". Change to "single" to display the borders.
  • BorderColor - The color of the borders. Defaults to #000000 (black)
  • RegionName - The name of the region. You only need this if your region is a city that has "(Region)" in the page title.
  • RegionID - (required) The region ID of the region you want to show. You can get this from the URL of the region map in the game, or from the link to the region in the region listing.
  • Island - (required) The full name of the island on which the region is located. (East Continent, Atamara, Far East, etc.) Use "East Continent" and not "East Island" to place your region in the proper category.
  • Realm - The realm to which the region is aligned.
  • Duchy - The duchy to which the region is aligned.
  • Lord - The name of the regional lord.
  • RegionType - (required) The region type. i.e.: City, Townsland, Badlands, etc.
  • Population - (required) The approximate population of the region.
  • Gold - The approximate gold production of the region.
  • Food - The approximate food production of the region.
  • Weather - The weather area of the region.
  • Economy - The major resources produced in the region.

Usage

Minimal

This will give you a simple region infobox, with default colors. If you want to be able to customize the colors to match your realm, then see the Full template below.

{{RegionBox
| RegionID = 
| Island = 
| Realm = 
| Duchy = 
| Lord = 
| RegionType = 
| Population = 
| Gold  = 
| Food = 
| Economy = 
| Weather = 
}}

Full

This template will allow you to customize the colors of the region infobox.

{{RegionBox
| RegionName = 
| BorderStyle = 
| BorderColor = 
| BackColor = 
| TitleBackColor = 
| TitleColor = 
| RegionID = 
| Island = 
| Realm = 
| Duchy = 
| Lord = 
| RegionType = 
| Population = 
| Gold  = 
| Food = 
| Economy = 
| Weather = 
}}