Difference between revisions of "Template:RealmBox/doc"

From BattleMaster Wiki
Jump to navigation Jump to search
m
m (updating documentation)
Line 1: Line 1:
 
<noinclude>{{DocSubpage}}</noinclude>
 
<noinclude>{{DocSubpage}}</noinclude>
−
==Intro==
+
== Intro ==
−
'''This is an experimental template for exploring the [[Semantic Wiki]] project.''' You should not use this for your realm. ''(Yet...)''
+
This template is part of the [[RealmBox Project]]. It is enabled for semantic coding of the included data. As of Feb 26, 2009, this template uses all available [[Semantic Wiki|semantic coding]] at the realm level.
−
 
 
−
This template is part of the [[RealmBox Project]]. It is enabled for semantic coding of the included data.
 
  
 
* Certain parameters in this template are automatically tagged for the [[Semantic Wiki]]. These properties are noted in their descriptions below.
 
* Certain parameters in this template are automatically tagged for the [[Semantic Wiki]]. These properties are noted in their descriptions below.
 
* The Island parameter '''must''' have a value. If you fail to supply the required information, then you will get a nasty-gram on your page telling you about it.
 
* The Island parameter '''must''' have a value. If you fail to supply the required information, then you will get a nasty-gram on your page telling you about it.
−
* '''All parameter names must be listed on your page.''' If you do not wish a particular piece of information to appear, then leave that parameter blank and it will not be shown at all. i.e.:
+
* Several pieces of information will be automatically determined and added to the page. This includes the realm name (taken from the page name), number of duchies, number of regions, region names, region lords, etc. You ''cannot'' manually specify this information.
−
:<pre>|StateReligion = </pre>
 
−
:If you leave the parameter out, the template will not function properly, and you'll see something like <nowiki>{{{Government}}}</nowiki> on your page.
 
−
* Several pieces of information will be automatically determined and added to the page. This includes the realm name, number of duchies, number of regions, region names, region lords, etc. You cannot manually specify this information. We are working on autogenerating population, food, and gold, but we're not there yet.
 
  
 
'''NOTE:''' The template includes the Realms and applicable Island categories. If you use this template, you do not need to manually add them to your page.
 
'''NOTE:''' The template includes the Realms and applicable Island categories. If you use this template, you do not need to manually add them to your page.
  
−
==Parameters==
+
== Using the Template ==
−
All parameters, vertical format:
+
There are three ways to sue this template.
−
* Island - The name of the island on which the realm is located. {{C|red|Required}}
+
# 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.
 +
# 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.
 +
# 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 - ''{{C|red|(Required)}}'' The name of the island on which the realm is located.  
 +
* Government - ''{{C|red|(Required)}}'' The government type: Monarchy, Theocracy, etc.
 +
* RulerTitle - Ruler's custom title. Defaults to "Ruler".
 +
* RulerName - ''{{C|red|(Required)}}'' Ruler's name.
 +
* GeneralTitle - General's custom title. Defaults to "General".
 +
* GeneralName - ''{{C|red|(Required)}}'' General's name.
 +
* JudgeTitle - Judge's custom title. Defaults to "Judge".
 +
* JudgeName - ''{{C|red|(Required)}}'' Judge's name.
 +
* BankerTitle - Banker's custom title. Defaults to "Banker".
 +
* BankerName - ''{{C|red|(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. ''(#0000)''
 
* 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.
 
* 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 - A caption to go under the image. Ignored if "Flag" is blank.
+
* FlagCaption - An optional caption to go under the flag image. Ignored if '''Flag''' is is not specified.
−
* RulerTitle - Ruler's custom title.
+
* StateReligion - The official state religion of the realm.
−
* RulerName - Ruler's name.
+
* Nobles - The number of nobles in the realm.
−
* GeneralTitle - General's custom title.
+
* Food - The approximate food production of the realm.
−
* GeneralName - General's name.
+
* Gold - Gold production of the realm.
−
* JudgeTitle - Judge's custom title.
 
−
* JudgeName - Judge's name.
 
−
* BankerTitle - Banker's custom title.
 
−
* BankerName - Banker's name.
 
−
* Government - The government type: Monarchy, Theocracy, etc.
 
−
* StateReligion - The official state religion of the realm. Leave blank if there is none. ''(Do '''not''' enter "None" or anything lie that.)''
 
−
* Nobles - The number of nobles in the realm. If you leave this blank the template will attempt to calculate it based on the semantic coding found in family pages. If this happens, it will almost certainly be very low, if not zero.
 
−
* Population - The approximate population of the realm. If you leave this blank the template will attempt to calculate it based on the semantic coding found in the region pages. '''This will cause errors if the region population values uses the thousands separator.'''
 
−
* Food - The approximate food production of the realm. If you leave this blank, the template will attempt to calculate it based on the semantic coding found in the region pages. It should work fine.
 
−
* Gold - Gold production of the realm. If you leave this blank, the template will attempt to calculate it based on the semantic coding found in the region pages. '''This will cause errors if the gold production values use the thousands separator.'''
 
−
* TitleBackColor - The color code for the title bar backgrounds. Optional. Defaults to a light blue/gray color. ''(#aabbcc)''
 
−
* TitleTextColor - The color code of the title bar text. Defaults to black.
 
  
  
Line 40: Line 45:
 
You can copy/paste the following guide into your page, then add the values.
 
You can copy/paste the following guide into your page, then add the values.
  
−
<pre>
+
=== Minimal RealmBox ===
−
{{RBRealmOne
+
This provides the minimum parameters needed to add a RealmBox to your realm page.
 +
<pre>{{RealmBox
 +
|Island =
 +
|Government =
 +
|RulerTitle =
 +
|RulerName =
 +
|GeneralTitle =
 +
|GeneralName =
 +
|JudgeTitle =
 +
|JudgeName =
 +
|BankerTitle =
 +
|BankerName =
 +
}}</pre>
 +
 
 +
=== 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.
 +
<pre>{{RealmBox
 
|TitleBackColor =  
 
|TitleBackColor =  
 
|TitleTextColor =  
 
|TitleTextColor =  
−
|Flag =
+
|Government =  
−
|FlagCaption =  
 
 
|RulerTitle =  
 
|RulerTitle =  
 
|RulerName =  
 
|RulerName =  
Line 54: Line 74:
 
|BankerTitle =  
 
|BankerTitle =  
 
|BankerName =  
 
|BankerName =  
−
|Island =
 
−
|Nobles =
 
−
|Population =
 
−
|Government =
 
 
|Nobles =  
 
|Nobles =  
−
|Population =
 
 
|Food =  
 
|Food =  
−
}}
+
|Gold =
−
</pre>
+
}}</pre>

Revision as of 19:40, 26 February 2009

Gtk-dialog-info.svg 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. As of Feb 26, 2009, this template uses all available semantic coding at the realm level.

  • Certain parameters in this template are automatically tagged for the Semantic Wiki. These properties are noted in their descriptions below.
  • The Island parameter must have a value. If you fail to supply the required information, then you will get a nasty-gram on your page telling you about it.
  • Several pieces of information will be automatically determined and added to the page. This includes the realm name (taken from the page name), number of duchies, number of regions, region names, region lords, etc. You cannot manually specify this information.

NOTE: The template includes the Realms and applicable Island categories. If you use this template, you do not need to manually add them to your page.

Using the Template

There are three ways to sue 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. (#0000)
  • 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.
  • 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 = 
|Government = 
|RulerTitle = 
|RulerName = 
|GeneralTitle = 
|GeneralName = 
|JudgeTitle = 
|JudgeName = 
|BankerTitle = 
|BankerName = 
|Nobles = 
|Food = 
|Gold = 
}}
Retrieved from "https://wiki.battlemaster.org/index.php?title=Template:RealmBox/doc&oldid=117998"