Difference between revisions of "Template:RegionBox/doc"

From BattleMaster Wiki
Jump to navigation Jump to search
m (Template:RegionBox/Doc moved to Template:RegionBox/doc: I am case-challenged today)
m (new documentation)
Line 1: Line 1:
 
<noinclude>{{DocSubpage}}</noinclude>
 
<noinclude>{{DocSubpage}}</noinclude>
 
== Intro ==
 
== Intro ==
−
This template is part of the [[RegionBox Project]]. (Which itself is part of the [[RealmBox Project]].)
+
This template is part of the [[RegionBox Project]], dedicated to providing customized, stylish
  
 
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 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.
Line 10: Line 10:
 
These parameters are used by the template. Some information is required to be included, and is noted in the description.
 
These parameters are used by the template. Some information is required to be included, and is noted in the description.
  
 +
=== Required ===
 +
* World - {{C|Red|(required)}} The world number of the region: EC = 1, AT = 2, Colonies = 3, BT = 4, FEI = 7, Dwilight = 8.
 +
* Region - {{C|Red|(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.
 +
 +
=== Optional ===
 
* TitleBackColor - The color code for the title bar backgrounds. Defaults to #000000 (black).
 
* 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).
 
* 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).
 
* 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.
+
* BorderStyle - The style of the box borders. Defaults to "hidden". Change to "single" to display the borders. ''(May not work quite right. Probably best to leave it as "hidden" until I figure it out.)''
 
* BorderColor - The color of the borders. Defaults to #000000 (black)
 
* 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 - {{C|Red|(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 - {{C|Red|(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 - {{C|Red|(required)}} The region type. i.e.: City, Townsland, Badlands, etc.
 
−
* Population - {{C|Red|(required)}} The approximate population of the region.
 
 
* Gold  - The approximate gold production of the region.
 
* Gold  - The approximate gold production of the region.
 
* Food - The approximate food 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.
+
Note that the food and gold values may be obsolete with the implementation of the [[New Economy]]. If this happens, they will be removed from the template. For now I will leave them here, and they will be displayed if provided.
  
 
== Usage ==
 
== Usage ==
−
===Minimal===
+
For a super-basic, no frills region box, use the super-basic syntax. If you want to color=customize your region box, see the second sample.
−
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.
+
 
−
<pre>{{RegionBox
+
== Super-Basic Syntax ==
−
| RegionID =  
+
This is all you have to provide to make a regionbox:
−
| Island =  
+
<pre><nowiki>{{RegionBox|world|regionid}}</nowiki></pre>
−
| Realm =  
+
 
−
| Duchy =  
+
For example, for [[Libidizedd]] on [[Dwilight]]:
−
| Lord =
+
<pre><nowiki>{{RegionBox|8|200}}</nowiki></pre>
−
| RegionType =
 
−
| Population =
 
−
| Gold  =
 
−
| Food =
 
−
| Economy =
 
−
| Weather =
 
−
}}</pre>
 
  
−
===Full===
 
−
This template will allow you to customize the colors of the region infobox.
 
  
−
<pre>{{RegionBox
+
== Syntax for color customized region boxes ==
−
| RegionName =  
+
If you want the region box to have a specific color scheme, you can add some extra parameters, like this. See the parameter descriptions for details. Leave out anything you want, and the defaults will be used.
 +
<pre><nowiki>{{RegionBox
 +
| World =
 +
| RegionId =  
 
| BorderStyle =  
 
| BorderStyle =  
−
| BorderColor =
 
 
| BackColor =  
 
| BackColor =  
 
| TitleBackColor =  
 
| TitleBackColor =  
−
| TitleColor =
+
| TitleTextColor =  
−
| RegionID =
+
| Gold =  
−
| Island =
 
−
| Realm =
 
−
| Duchy =
 
−
| Lord =
 
−
| RegionType =
 
−
| Population =  
 
−
| Gold =  
 
 
| Food =  
 
| Food =  
−
| Economy =  
+
}}</nowiki></pre>
−
| Weather =  
+
 
−
}}</pre>
+
For example, for [[Libidizedd]], a region of [[Astrum]] on [[Dwilight]]:
 +
<pre><nowiki>{{RegionBox
 +
| World = 8
 +
| RegionId = 200
 +
| TitleBackColor = #17375E
 +
}}</nowiki></pre>
  
 
[[Category:RealmBox]]
 
[[Category:RealmBox]]

Revision as of 17:56, 25 March 2009

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, dedicated to providing customized, stylish

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.

Required

  • World - (required) The world number of the region: EC = 1, AT = 2, Colonies = 3, BT = 4, FEI = 7, Dwilight = 8.
  • Region - (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.

Optional

  • 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. (May not work quite right. Probably best to leave it as "hidden" until I figure it out.)
  • BorderColor - The color of the borders. Defaults to #000000 (black)
  • Gold - The approximate gold production of the region.
  • Food - The approximate food production of the region.

Note that the food and gold values may be obsolete with the implementation of the New Economy. If this happens, they will be removed from the template. For now I will leave them here, and they will be displayed if provided.

Usage

For a super-basic, no frills region box, use the super-basic syntax. If you want to color=customize your region box, see the second sample.

Super-Basic Syntax

This is all you have to provide to make a regionbox: 

{{RegionBox|world|regionid}}

For example, for Libidizedd on Dwilight: 

{{RegionBox|8|200}}


Syntax for color customized region boxes

If you want the region box to have a specific color scheme, you can add some extra parameters, like this. See the parameter descriptions for details. Leave out anything you want, and the defaults will be used. 

{{RegionBox
| World = 
| RegionId = 
| BorderStyle = 
| BackColor = 
| TitleBackColor = 
| TitleTextColor = 
| Gold = 
| Food = 
}}

For example, for Libidizedd, a region of Astrum on Dwilight: 

{{RegionBox
| World = 8
| RegionId = 200
| TitleBackColor = #17375E
}}
Retrieved from "https://wiki.battlemaster.org/index.php?title=Template:RegionBox/doc&oldid=120653"