Template:InfoboxShip2/doc

From Traveller Wiki - Science-Fiction Adventure in the Far future
Jump to navigation Jump to search

This is a infobox template for starships, space ships, and other space capable vehicle designs.

This template also stored data in the Cargo tables. This means the format of the elements is more specific and or picky. The parameters to the template are parsed and inserted into tables in the database for query through Cargo.


InfoboxShip2 Parameters
Parameter
name
Remarks Formatting Default Value
name Name of the ship or class of ships. For ship classes, include the word "class" (lower case) in the name. For individual ships Named Ships, enter only the name. Text, no formatting Required
alsosee Link to an additional important reference or page. Page name with brackets Empty
architect The architect fee for the ship in MegaCredits. raw number 0
barracks Number of barrack spaces allocated in the ship. May be used for either ship crew or steerage passengers. raw number 0
blueprint Does this ship design have a blueprint or Deck Plans available in the wiki? Yes or No No
bunks Number of bunk rooms allocated in the ship design for either crew, carried troops, or steerage passengers raw number 0
canon Is this ship from a canon source? Yes or No No
caption A short description of the image displayed under image. Text Empty
cargo Size of the cargo hold in Tons. raw number 0
cost Cost of the ship in MegaCredit. raw number Required
costQuantity Cost of the ship in MegaCredit when purchased in quantity. raw number 0
crew Number of expected crew: officers and enlisted. raw number Required
designation Ship Mission Code - the two to four letter code for the ship mission and designation. Text - no formatting or brackets Required
designer Author and designer for this ship Author page - no formatting or brackets None
designSystem Ship design system used to create this ship: Book 2, High Guard, MegTraveller, FF&S1, FF&S2, GT:Starships, T20, MGT1, MGT2, T5, or Other Text None
endservice End of Service - year when the last of this design were retired from active service raw number 0
enlisted Number of enlisted crew on the ship raw number 0
era See Timeline or Milieu for categories. Text with link Milieu 1116
footnote extra note for the infobox, if needed. Displays at bottom of infobox. text None
frozenwatch Number of ship crew allocated to be in Frozen Watch. raw number 0
hardpoints Number of weapon hardpoints designated on the ships. raw number 0
hullshape Hull overall shape and design text - no formatting or brackets None
image Image of the ship for the infobox. For best results format the image to be between 200 and 300 pixels both wide and high. File name - no formatting or brackets None
illustration Does this ship have additional illustrations in the wiki? Yes or No No
jump Jump drive rating of the ship. 0 if none installed raw number 0
lowberths Number of low berths installed for either the frozen watch or low passage passengers. raw number 0
lowpassage Number of low passage passengers that could be carried raw number 0
maneuver Maneuver drive or NAFAL drive rating. raw number 0
manufacturer Company or polity building this ship. Page - no formatting or brackets None
marines Number of Marines included in the ships complement raw number 0
model Ship's Computer model and description text None
officers Number of officers in the ships crew. raw number 0
origin World or empire where this ship class originated. Page - no formatting or brackets None
passengers Number of passengers (High Passage or Middle Passage) expected to be carried raw number 0
QSP Quick Ship Profile - The short encoded string of the ships capability text None
ref Book reference of the source of this ship design. Use Template:Ludography ref text - Template:Ludography ref None
seats Number of seats allocated for passengers. Seats are for short term passengers raw number 0
size Size of the ship in Tons raw number Required
sizeCategory Category of the ship size and capabilities - ACS, BCS, FCS, or WCS text with brackets ACS
staterooms Number of full size staterooms allocated in the ship design. Can be used for crew or passengers raw number 0
startservice Initial Operational Capability - year the ship design entered service raw number 0
steerage Number of passengers carried in bunk rooms or other similar conditions raw number 0
streamlining Streamlining hull shape or aerodynamics. text None
TL Technology Level of the ship design. text - no formatting or brackets Required
type Ship type listed in either Military Starship Types or Civilian Starship Types based upon the Ship Mission Code text - no formatting or brackets Required
weapons Comma separated list of weapons install in the ships hardpoint text None
USP Universal Ship Profile - The High Guard encoded description for the ship. text None

Parameter Formatting

Each parameter has an expected format of the entry as shown in the "Formatting" column. The values there have the following meanings:

  • Text - any text. Since this is for the Infobox, try to be really brief (6 words or less)
    • Text - No formatting. Avoid using any wiki formatting in the field as the infobox applies formatting
    • Page - No Formatting or brackets. Use the full name of the page as the field, but the template will apply the brackets to create links.
    • Page - Include brackets. This is expected to be a link to a page. Or two.
  • raw number - A simple number like 11 or 42.7. Do not include any other text for the parameter.
  • Yes or No - A Boolean field. Enter only "Yes" or "No".

Default Value

Some parameters have a default value. If you omit the parameter or leave it blank the paramter is automatically set to the default value.

  • Required - The parameter is a required value, you must supply a value.
  • Empty - The default value is nothing.
  • 0 - The default value is 0, only for the numeric fields.
  • "No" - the default Boolean value.

Template (Copy & Paste)

Use:


{{InfoboxShip2
 |name         = TBD class Type <REQUIRED>
 |alsosee      = 
 |architect    = 0
 |barracks     = 0
 |blueprint    = No
 |bunks        = 0
 |canon        = No
 |caption      = 
 |cargo        = 0
 |cost         = 0 <REQUIRED>
 |costQuantity = 0
 |crew         = 0 <REQUIRED>
 |designation  = <REQUIRED>
 |designer     = 
 |designSystem = 
 |endservice   = 0
 |enlisted     = 0
 |era          = [[Milieu 1116]]
 |footnote     = 
 |frozenwatch  = 0
 |hardpoints   = 0
 |hullshape    =
 |image        = 
 |illustration = No
 |jump         = 0
 |lowberths    = 0
 |lowpassage   = 0
 |maneuver     = 0
 |manufacturer = 
 |marines      = 0
 |model        = 
 |officers     = 0
 |origin       = 
 |passengers   = 0
 |QSP          = 
 |ref          = 
 |seats        = 0
 |size         = 0 <REQUIRED>
 |sizeCategory = [[ACS]]
 |staterooms   = 0
 |startservice = 0
 |steerage     = 0
 |streamlining = 
 |TL           = <REQUIRED>
 |type         = <REQUIRED>
 |weapons      = 
 |USP          = 
}}