Difference between revisions of "Template:StellarData.layout/doc"

From Traveller Wiki - Science-Fiction Adventure in the Far future
Jump to navigation Jump to search
 
(14 intermediate revisions by the same user not shown)
Line 5: Line 5:
  
 
== Description ([[Specifications]]) ==
 
== Description ([[Specifications]]) ==
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.  
+
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.  
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.  
+
* 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.  
+
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 ===
 
=== Layout ===
Line 62: Line 68:
  
 
==== Eras ====
 
==== Eras ====
 +
[[Timeline]]:
 
* 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.  
 
* 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]].
 
* Interstellar Wars : The planetary UWP for the world during the [[Interstellar Wars]] and the [[Second Imperium]].
Line 77: Line 84:
  
 
==== Universal World Profile ====
 
==== Universal World Profile ====
UWP: the UWP code in standard format.  
+
[[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 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.
 
* 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.
Line 83: Line 90:
 
==== Trade codes ====
 
==== Trade codes ====
 
pcode: One of the planetary [[Trade classification]]s, the code determining the background color of the title bar for the world name.  
 
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: #8e9397;">'''as''' ''([[Asteroid Belt]])''</span>
::<span style="color: #000;background: #EDC9AF;">'''de''' ''(Desert World)''</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: #FFB0B0;">'''fl''' ''([[Fluid Ocean]])''</span>
::<span style="color: #000;background: #C0FFC0;">'''ga''' ''(Garden world)'' - Default</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: #FF8D3F;">'''he''' ''([[Hell world]])''</span>
::<span style="color: #000;background: #A5F2F3;">'''ic''' ''(Ice-Capped)''</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: #0094ED;">'''oc''' ''([[Ocean world]])''</span>
::<span style="color: #000;background: #C4D6C4;">'''po''' ''(Poor 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: #F0F0F0;">'''va''' ''([[Vacuum World]]))''</span>
::<span style="color: #000;background: #7ACFF7;">'''wa''' ''(Water 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.
+
* [[Trade Code|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.  
+
* [[sophont]]s: All of the trade information data regarding sophonts, including [[home world]]s and population divisions.  
* details: All of the details codes including climate, secondary, political, and special codes. This will include the owner and colony codes.
+
* [[Trade Code|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 ====
 
==== T5 Second Survey data ====
Line 101: Line 108:
 
* [[ex]]: Economic extension data
 
* [[ex]]: Economic extension data
 
* [[cx]]: Cultural extension data
 
* [[cx]]: Cultural extension data
* nobility: Nobility presence codes
+
* [[Imperial Nobility|nobility]]: Nobility presence codes
  
 
==== Travel information ====
 
==== Travel information ====
; bases : Any military or special bases located on this world or in the system
+
* [[base]]s : 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
+
* zone  : [[Travel zone]], one of [[Red Zone]], [[Amber Zone]] or (default) green
; Aleg  : Allegiance Code for the world in the given era
+
* Aleg  : [[Allegiance Code]] for the world in the given era
; basesDescription: Description of the bases located on this world
+
* basesDescription: Description of the bases located on this world
; basesCategories: Categories for the included bases
+
* basesCategories: Categories for the included bases
  
 
==== PBGW & Stellar data ====
 
==== PBGW & Stellar data ====
; popmul : population multiplier for the UWP population number
+
* popmul : [[population]] multiplier for the UWP population number
; belts  : number of planetoid belts in the system
+
* belts  : number of [[planetoid belt]]s in the system
; giants : number of gas giants in the system
+
** There is an in-game distinction between asteroid belt and planetoid belt.
; worlds : total number of worlds in the system
+
* giants : number of [[gas giant]]s in the system
; stars  : comma list of the stars in the system.  
+
** GG's exist as SGG and LGG at this time.
 +
* worlds : total number of [[world]]s in the system. Including the [[mainworld]].
 +
** No clear method for including of not including [[moon]]s or [[satellite]]s.
 +
* stars  : comma list of the [[star]]s in the system.
 +
** Six stars is the most that exists within Charted Space at this time.
  
 
==== Economic extension data ====
 
==== Economic extension data ====
; wtn : world trade number, a calculation of approximate trade for the world.
+
* wtn: [[World Trade Number]], a calculation of approximate trade for the world.
; ru : Resource Units, a calculation of relative economic strength
+
* ru: [[Resource Unit]]s, a calculation of relative economic strength
; gwp : Gross World Product, another economic calculation (MCr)
+
* gwp: [[Gross World Product]], another economic calculation ([[MCr]])
; trade : external trade for the world (MCr/Year)
+
* trade: External trade for the world ([[MCr]]/Year)
; pass : passenger volume through the star port (people/year)
+
* pass: [[passenger]] volume through the star port (people/year)
; build : estimation of maximum shipyard capacity
+
* build: Estimation of maximum [[shipyard]] capacity
; army : army size in BEs
+
* army: Army size in [[BE]]s
; portSize : Port size, a relative calculation of size of the port based upon trade and passenger traffic
+
* 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.  
+
* spa: [[Starport Authority]] personnel. The number of people working at the port to support the trade and passenger traffic.
  
 
==== Extra Name ====
 
==== Extra Name ====
;worldName : The full [[Template:World]] name for this world.
+
* worldName : The full [[Template:World]] name for this world.
;Non-canon trade code: Comma separated list of non-canon trade codes
+
* Non-canon trade code: Comma separated list of non-canon trade codes
;First Survey name: name of the world from the First Survey, print the alternative name in the list.
+
** This includes Mongoose codes and others that have been absorbed into [[TravMap]] and other sources.
 +
* First Survey name: name of the world from the [[First Survey]], print the alternative name in the list.
  
 
== History & Background ([[Dossier]]) ==
 
== History & Background ([[Dossier]]) ==

Latest revision as of 19:38, 31 January 2019


Imperial Sunburst-Sun-IISS-Traveller.gif

This page is the documentation for the Template:StellarData.layout

Description (Specifications)[edit]

This template is used by Template:StellarDataQuery to format the 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[edit]

Parameter layout

 {{{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}}}
 {{{basesDescription|}}} == {{{34}}}
 {{{basesCategories|}}} == {{{35}}}
 {{{Non-canon trade codes|}}} == {{{36}}}
 {{{First Survey name|}}} == {{{37}}}

Parameter Descriptions[edit]

Names[edit]

  • 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[edit]

Timeline:

Universal World Profile[edit]

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 div.UWPInfo statements. To make this work you need to include the following in your page: <div class=UWPInfo>Text to be visible<span>Text to be in the popup</span></div>. The two sets of text can include any HTML code.

Trade codes[edit]

pcode: One of the planetary Trade classifications, the code determining the background color of the title bar for the world name.

as (Asteroid Belt)
de (Desert World)
fl (Fluid Ocean)
ga (Garden world) - Default
he (Hell world)
ic (Ice-Capped)
oc (Ocean world)
po (Poor world)
va (Vacuum World))
wa (Water World)
  • 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[edit]

  • ix: Importance
  • ex: Economic extension data
  • cx: Cultural extension data
  • nobility: Nobility presence codes

Travel information[edit]

  • 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
  • basesDescription: Description of the bases located on this world
  • basesCategories: Categories for the included bases

PBGW & Stellar data[edit]

  • popmul : population multiplier for the UWP population number
  • belts : number of planetoid belts in the system
    • There is an in-game distinction between asteroid belt and planetoid belt.
  • giants : number of gas giants in the system
    • GG's exist as SGG and LGG at this time.
  • worlds : total number of worlds in the system. Including the mainworld.
  • stars : comma list of the stars in the system.
    • Six stars is the most that exists within Charted Space at this time.

Economic extension data[edit]

  • 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[edit]

  • worldName : The full Template:World name for this world.
  • Non-canon trade code: Comma separated list of non-canon trade codes
    • This includes Mongoose codes and others that have been absorbed into TravMap and other sources.
  • First Survey name: name of the world from the First Survey, print the alternative name in the list.

History & Background (Dossier)[edit]

Thomas Jones-Low did all of the initial coding.

  • Thomas has updated the code several times to take advantages of new capabilities as the wiki code was updated.
  • Maksim has followed up so that someone else would understand it.
  • Maksim has made minor edits to the template over the yeara.

Interacting Templates[edit]

  1. Template:EXexpand
  2. Template:GovCode
  3. Template:HexConvert
  4. Template:JumpMap
  5. Template:LawCode
  6. Template:Primary
  7. Template:Sources
  8. Template:StellarData.layout-world
  9. Template:StellarData.layout/doc
  10. Template:UWPexpand
  11. Template:World summary allegiance
  12. Template:World summary allegiance.layout
  13. Template:WorldSummaryComment

References & Contributors (Sources)[edit]

This list of sources was used by the Traveller Wiki Editorial Team and individual contributors to compose this article. Copyrighted material is used under license from Far Future Enterprises or by permission of the author. The page history lists all of the contributions.