Difference between revisions of "Template:RealmBox/doc"

From BattleMaster Wiki
Jump to navigation Jump to search
m
m
 
(12 intermediate revisions by 2 users not shown)
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 importing of the game's external data feed, and for semantic coding of the included data. This template uses all available [[Semantic Wiki|semantic coding]] at the realm level, with the exception of the realm founding date and realm founder.
  
−
This template is part of the [[RealmBox Project]]. It is enabled for semantic coding of the included data.
+
* There are a few parameters that are required to be included. These are identified in the parameter list below.
 +
* Nearly all data in this infobox is pulled directly from the game. You ''cannot'' manually specify this information.
  
−
* Certain parameters in this template are automatically tagged for the [[Semantic Wiki]]. These properties are noted in their descriptions below.
+
'''NOTE:''' The template includes the realm category, [[:Category:Realms]], and the appropriate island category. If you use this template, you do not need to manually add these categories to your page.
−
* 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.:
 
−
:<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.
+
== Using the Template ==
 +
Copy one of the blank templates provided at the bottom of this page.
  
−
==Parameters==
+
=== Special Considerations ===
−
All parameters, vertical format:
+
* If you want a map in your RealmBox, then you will need to specify a "MapName = " parameter. Due to the way the wiki handles off-site image links, the spaces in the realm map names will cause problems. If your realm name has spaces in it you need to encode them as "%20". This will allow the wiki to show the map. For example, if you are putting a map in the RealmBox for "Pian en Luries", you need to include the parameter "MapName = Pian%20en%20Luries".
−
* Island - The name of the island on which the realm is located. {{C|red|Required}}
+
 
 +
== Parameters ==
 +
This section lists all the available parameters for use with the template. It is split into two sections; "Required" and "Optional".
 +
 
 +
=== Required ===
 +
This is a listing of the required parameters.
 +
*World = {{c|Red|Required}}. The world number the realm is on. EC=1, AT=2, BT=4, Col=6, FEI=7, DW=8.
 +
*RealmID = {{c|Red|Required}}. The ID number of the realm. You can get this from the island realm list. The URL of the "Details" link provides this number. ''Examples: "<nowiki>https://battlemaster.org/testing/RealmDetails.php?ID=12</nowiki>" shows 12 as the RealmID for Astrum on Dwilight.''
 +
 
 +
=== Optional ===
 +
* TitleTextColor - The color code of the title bar text. Defaults to black. ''(#000000)''
 +
* TitleColor - The color code of the background of the title bars. Defaults to the realm color set by the realm's ruler. This is the color used for the realm of the diplomacy chart and stats graphs.
 
* 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.
+
* FlagSize - An image format or size parameter.
−
* RulerTitle - Ruler's custom title.
+
* FlagCaption - A caption to go under the flag image. Ignored if '''Flag''' is is not specified.
−
* RulerName - Ruler's name.
+
* MapName - 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.
−
* GeneralTitle - General's custom title.
+
* MapHeight - Height of map. Numbers only.
−
* GeneralName - General's name.
+
* MapWidth - Width of map. Numbers only.
−
* JudgeTitle - Judge's custom title.
+
* StateReligion - The official state religion of the realm.
−
* JudgeName - Judge's name.
+
* Nobles - The number of nobles in the realm.
−
* BankerTitle - Banker's custom title.
+
* Food - The approximate food production of the realm.
−
* BankerName - Banker's name.
+
* Gold - Gold production of the realm.
−
* 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.
 
−
 
 
  
 
==Template==
 
==Template==
 
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.
−
|TitleBackColor =  
+
<pre>{{RealmBox
 +
|World =
 +
|RealmID =
 +
}}</pre>
 +
 
 +
=== Full RealmBox ===
 +
This provides the complete list of parameters that can be used with RealmBox. You can pick and choose which one you want, so long as you provide the two required parameters.
 +
 
 +
<pre>{{RealmBox
 +
|World =
 +
|RealmID =
 +
|TitleColor =  
 
|TitleTextColor =  
 
|TitleTextColor =  
 +
|MapName =
 
|Flag =  
 
|Flag =  
 
|FlagCaption =  
 
|FlagCaption =  
−
|RulerTitle =
 
−
|RulerName =
 
−
|GeneralTitle =
 
−
|GeneralName =
 
−
|JudgeTitle =
 
−
|JudgeName =
 
−
|BankerTitle =
 
−
|BankerName =
 
−
|Island =
 
−
|Nobles =
 
−
|Population =
 
−
|Government =
 
 
|Nobles =  
 
|Nobles =  
−
|Population =
 
 
|Food =  
 
|Food =  
−
}}
+
|Gold =
−
</pre>
+
}}</pre>
 +
 
 +
===Alternate Method===
 +
RealmBox supports inline parameters for basic usage, like this:
 +
<pre>{{RealmBox|(World)|(RealmID)|(TitleColor)|(TitleTextColor)}}</pre>
 +
Just replace the items in parentheses with the actual values. For example, the RealmBox for [[Astrum]] could be specified as:
 +
<pre>{{RealmBox|8|12|Blue|White}}</pre>
 +
Note that with this method, you can only provide the Four listed parameters.
 +
 
 +
== Known Issues ==
 +
* The SUM output format for semantic queries inserts a line break before the value. This seems the be a ''{{T|bug|"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.

Latest revision as of 09:14, 7 February 2021

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 importing of the game's external data feed, and 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.
  • Nearly all data in this infobox is pulled directly from the game. You cannot manually specify this information.

NOTE: The template includes the realm category, Category:Realms, and the appropriate island category. If you use this template, you do not need to manually add these categories to your page.

Using the Template

Copy one of the blank templates provided at the bottom of this page.

Special Considerations

  • If you want a map in your RealmBox, then you will need to specify a "MapName = " parameter. Due to the way the wiki handles off-site image links, the spaces in the realm map names will cause problems. If your realm name has spaces in it you need to encode them as "%20". This will allow the wiki to show the map. For example, if you are putting a map in the RealmBox for "Pian en Luries", you need to include the parameter "MapName = Pian%20en%20Luries".

Parameters

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

Required

This is a listing of the required parameters.

  • World = Required. The world number the realm is on. EC=1, AT=2, BT=4, Col=6, FEI=7, DW=8.
  • RealmID = Required. The ID number of the realm. You can get this from the island realm list. The URL of the "Details" link provides this number. Examples: "https://battlemaster.org/testing/RealmDetails.php?ID=12" shows 12 as the RealmID for Astrum on Dwilight.

Optional

  • TitleTextColor - The color code of the title bar text. Defaults to black. (#000000)
  • TitleColor - The color code of the background of the title bars. Defaults to the realm color set by the realm's ruler. This is the color used for the realm of the diplomacy chart and stats graphs.
  • 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.
  • FlagSize - An image format or size parameter.
  • FlagCaption - A caption to go under the flag image. Ignored if Flag is is not specified.
  • MapName - 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.
  • MapHeight - Height of map. Numbers only.
  • MapWidth - Width of map. Numbers only.
  • 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
|World = 
|RealmID = 
}}

Full RealmBox

This provides the complete list of parameters that can be used with RealmBox. You can pick and choose which one you want, so long as you provide the two required parameters. 

{{RealmBox
|World = 
|RealmID = 
|TitleColor = 
|TitleTextColor = 
|MapName = 
|Flag = 
|FlagCaption = 
|Nobles = 
|Food = 
|Gold = 
}}

Alternate Method

RealmBox supports inline parameters for basic usage, like this: 

{{RealmBox|(World)|(RealmID)|(TitleColor)|(TitleTextColor)}}

Just replace the items in parentheses with the actual values. For example, the RealmBox for Astrum could be specified as: 

{{RealmBox|8|12|Blue|White}}

Note that with this method, you can only provide the Four listed parameters.

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.
Retrieved from "https://wiki.battlemaster.org/index.php?title=Template:RealmBox/doc&oldid=206723"