Editing Template:StellarData.layout/doc

<noinclude>This page is the documentation for the [[Template:StellarData.layout]]<br/></noinclude>
This template is used by [[Template:StellarDataQuery]] to format the [[Special:CargoTables/StellarData|StellarData]] raw results into a layout for a world page. This layout includes a infobox side bar on the left size with the summary information about the world, and separated for each era. It also include a header section on the page with a summary of the world based upon the trade, sophont, and details and allegiance of the world. 

Different eras, particularly the changes from classic era through the hard times and into the new era, have changes to the starport, population, government, law level, and tech level. Along with these changes include changes to economic fortunes including starport size, trade, cultural changes, and so on. 

Features of this template include: World Habitability is color coded in the planet title. Each era included can have its own travel zone. If details are know about the system (stellar types, Belts, gas giant counts) these are included. If there is a full article on the system, a link to that article can be included. And a popup box containing the expanded UWP descriptions will be shown when you put the mouse cursor over the UWP in the infobox table. 

== Layout ==

Parameter layout
<pre>
 {{{world}}} == {{{1}}}
 {{{sector}}} == {{{2}}}
 {{{subsector}}} == {{{3}}}
 {{{era}}} == {{{4}}}
 {{{hex}}} == {{{5}}}
 {{{name}}} == {{{6}}}
 {{{UWP}}} == {{{7}}}
 {{{pcode}}} == {{{8}}}
 {{{codes}}} == {{{9}}}
 {{{sophonts}}} == {{{10}}}
 {{{details|}}} == {{{11}}}
 {{{ix}}} == {{{12}}}
 {{{ex|}}} == {{{13}}}
 {{{cx|}}} == {{{14}}}
 {{{nobility|}}} == {{{15}}}
 {{{bases|}}} == {{{16}}}
 {{{zone|}}} == {{{17}}}
 {{{popmul|}}} == {{{18}}}
 {{{belts|}}} == {{{19}}}
 {{{giants|}}} == {{{20}}}
 {{{worlds|}}} == {{{21}}}
 {{{aleg|}}}   == {{{22}}}
 {{{stars|}}}  == {{{23}}}
 {{{wtn|}}}    == {{{24}}}
 {{{ru|}}}    == {{{25}}}
 {{{gwp|}}}  == {{{26}}}
 {{{trade|}}} == {{{27}}}
 {{{pass|}}}  == {{{28}}}
 {{{build|}}} == {{{29}}}
 {{{army|}}}  == {{{30}}}
 {{{portSize|}}} == {{{31}}}
 {{{spa|}}}  == {{{32}}}
 {{{worldName|}}} == {{{33}}}
</pre>
==Parameter Descriptions==
=== Names ===
;world : Name of the world as given for the era. This may change over time. 
;sector : Sector name for the location of the world
;subsector : Subsector name for the location of the world
;hex : Hex number location in the sector for the world
;name : The page name in the wiki for the world article. Will not change between era's. 

=== Eras ===
;First Imperium : The planetary UWP for the world during the [[First Imperium]]. The exact time is a little vague because records from that time are not always complete. 
;Interstellar Wars : The planetary UWP for the world during the [[Interstellar Wars]] and the [[Second Imperium]].
;Milieu 0 : The UWP for the world at or around the founding of the [[Third Imperium]]
;First Survey : The UWP published for the world during the [[First Survey]].
;Milieu 990 : The UWP established during the [[Solomani Rim War]] and the end of the first millennium. 
;Second Survey : The UWP published for the world during the [[Second Survey]].
;Milieu 1116 : The UWP established just after the [[Fifth Frontier War]] and just before the [[Rebellion]].
;Hard Times : The UWP of the world for the [[Hard Times]] era during the Rebellion.
;New Era : The UWP of the world as surveyed during the [[The New Era]].
;Milieu 1248 : The UWP of the world during the [[Fourth Imperium]], [[TNE]] & [[:Category: Era: Milieu 1248|Milieu 1248]].
;ua : The UWP of the world during the [[Collapse and Interregnum]].
;ue : The UWP of the world during the [[False Spring]].
;Galaxiad : The UWP of the world during the [[Galaxiad]] .

=== Universal World Profile ===
; UWP : the UWP code in standard format. 
The UWP format '''must''' be in the standard 7-1 format ("A000000-T"). The UWP template uses [[Template: UWPexpand]] (and a css trick) to enable a formated box which pops up when move your mouse cursor over the UWP. This box contains the expanded text for the UWP, for those of us who haven't yet memorized the UWP codes. 

The css trick to create a formatted pop-up box in contained [[MediaWiki:Common.css]], and the four <nowiki>div.UWPInfo</nowiki> statements. To make this work you need to include the following in your page: <nowiki><div class=UWPInfo>Text to be visible<span>Text to be in the popup</span></div></nowiki>. The two sets of text can include any HTML code.

=== Trade codes ===
;pcode: One of the planetary [[Trade classification]]s, the code determining the background color of the title bar for the world name. 
::<span style="color: #000;background: #8e9397;">'''as''' ''(Asteroid Belt)''</span>
::<span style="color: #000;background: #EDC9AF;">'''de''' ''(Desert World)''</span>
::<span style="color: #000;background: #FFB0B0;">'''fl''' ''(Fluid Ocean)''</span>
::<span style="color: #000;background: #C0FFC0;">'''ga''' ''(Garden world)'' - Default</span>
::<span style="color: #000;background: #FF8D3F;">'''he''' ''(Hell world)''</span>
::<span style="color: #000;background: #A5F2F3;">'''ic''' ''(Ice-Capped)''</span>
::<span style="color: #000;background: #0094ED;">'''oc''' ''(Ocean world)''</span>
::<span style="color: #000;background: #C4D6C4;">'''po''' ''(Poor world)''</span>
::<span style="color: #000;background: #F0F0F0;">'''va''' ''(Vacuum World))''</span>
::<span style="color: #000;background: #7ACFF7;">'''wa''' ''(Water World)'' </span>
; codes: The complete set of planetary, populations, and economic codes. These create the starting list of description to the world for the era.
; sophonts: All of the trade information data regarding sophonts, including home worlds and population divisions. 
; details: All of the details codes including climate, secondary, political, and special codes. This will include the owner and colony codes.

=== T5 Second Survey data ===
; ix : Importance 
; ex : Economic extension data
; cx : Cultural extension data
; nobility: Nobility presence codes


=== Travel information ===
; bases : Any military or special bases located on this world or in the system
; zone  : Travel zone, one of [[Red Zone]], [[Amber Zone]] or (default) green
; Aleg  : Allegiance Code for the world in the given era

=== PBGW & Stellar data ===
; popmul : population multiplier for the UWP population number
; belts  : number of planetoid belts in the system
; giants : number of gas giants in the system
; worlds : total number of worlds in the system
; stars  : comma list of the stars in the system. 

=== Economic extension data ===
; wtn : world trade number, a calculation of approximate trade for the world.
; ru  : Resource Units, a calculation of relative economic strength
; gwp : Gross World Product, another economic calculation (MCr)
; trade : external trade for the world (MCr/Year)
; pass : passenger volume through the star port (people/year)
; build : estimation of maximum shipyard capacity
; army  : army size in BEs
; portSize : Port size, a relative calculation of size of the port based upon trade and passenger traffic
; spa : Starport Authority personnel. The number of people working at the port to support the trade and passenger traffic. 

=== Extra Name ===
;worldName : The full [[Template:World]] name for this world.

<noinclude>[[Category: Help]]</noinclude>