Template:RealmBox/doc

Page Information

This is a documentation subpage for the RealmBox 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 RealmBox Project. It is enabled for semantic coding of the included data. This template uses all available semantic coding at the realm level, with the exception of the realm founding date and realm founder.

• There are a few parameters that are required to be included. These are identified in the parameter list below.
• Several pieces of information will be automatically determined and added to the page. This includes the number of duchies, number of regions, region names, region lords, etc. You cannot manually specify this information. If it is not correct here, then go fix the appropriate region pages.

NOTE: The template includes Category:Realms. If you use this template, you do not need to manually add this category to your page.

Using the Template

There are three ways to use this template.

1. The first, and easiest, way is to just copy the "Minimal RealmBox" template shown below. This will give you a basic RealmBox with a minimum of information.
2. The second way, requiring only a little more effort, is to copy the "Suggested RealmBox" template provided below. This allows you to specify additional information, such as food and gold values, and provide background and text colors for your RealmBox.
3. If you really want to get fancy, the go ahead and mix and match individual pieces of information you want to see on your RealmBox. Check the list below for a description of available pieces. If you specify it, RealmBox will show it.

Parameters

This section lists all the available parameters for use with the template. It is split into two sections; "Required/Suggested" and "Optional".

Required/Suggested

This is a listing of all the required, and highly suggested parameters. You don't need' to specify a RulerTitle, for example, but you probably should.

• Island - (Required) The name of the island on which the realm is located.
• Government - (Required) The government type: Monarchy, Theocracy, etc.
• RulerTitle - Ruler's custom title. Defaults to "Ruler".
• RulerName - (Required) Ruler's name.
• GeneralTitle - General's custom title. Defaults to "General".
• GeneralName - (Required) General's name.
• JudgeTitle - Judge's custom title. Defaults to "Judge".
• JudgeName - (Required) Judge's name.
• BankerTitle - Banker's custom title. Defaults to "Banker".
• BankerName - (Required) Banker's name.

Optional

• TitleBackColor - The color code for the title bar backgrounds. Defaults to a light blue/gray color. (#aabbcc)
• TitleTextColor - The color code of the title bar text. Defaults to black. (#000000)
• Flag - The name of the image file to use at the top of the RealmBox. Must be an image uploaded to the wiki. Do not include the "Image:" part of the name. Leave blank if you don't want a flag displayed.
• FlagCaption - An optional caption to go under the flag image. Ignored if Flag is is not specified.
• Realm - If you want a map in your RealmBox, then enter the realm name here. You must replace all spaces with "%20", This is because of the way the wiki handles off-site image links. For example, to include a map for "Pian en Luries", you would enter "Pian%20en%20Luries". If your realm is very wide, this will make your RealmBox very wide, too.
• StateReligion - The official state religion of the realm.
• Nobles - The number of nobles in the realm.
• Food - The approximate food production of the realm.
• Gold - Gold production of the realm.

Template

You can copy/paste the following guide into your page, then add the values.

Minimal RealmBox

This provides the minimum parameters needed to add a RealmBox to your realm page.

{{RealmBox
|Island = 
|Government = 
|RulerTitle = 
|RulerName = 
|GeneralTitle = 
|GeneralName = 
|JudgeTitle = 
|JudgeName = 
|BankerTitle = 
|BankerName = 
}}

Suggested RealmBox

This provides the suggested parameters you can use with RealmBox to show more information, and to customize it with your realm's colors.

{{RealmBox
|TitleBackColor = 
|TitleTextColor = 
|Island = 
|Realm = 
|Government = 
|RulerTitle = 
|RulerName = 
|GeneralTitle = 
|GeneralName = 
|JudgeTitle = 
|JudgeName = 
|BankerTitle = 
|BankerName = 
|Nobles = 
|Food = 
|Gold = 
}}

Known Issues

• The SUM output format for semantic queries inserts a line break before the value. This seems the be a "feature" of the semantic output formats extension. The means the Population figure is about a half-line below where it should be. I don't know how to force it back to where it should be. Maybe some HTML/CSS guru can fix it.