Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:ShipArticle/doc: Difference between revisions

Template page
m Start adding "Required" and "Preferred" labels to parameters.
m Add default value to parameters that have one. Add 'Required" and "Optional" labels.
Line 1: Line 1:
{{cleanup|Standardize [[Template:Documentation/preload|documentation]]. Explain auto image fetching from [https://images.evetech.net/ CCP Servers]. [[User:Arin Mara|Arin Mara]] ([[User talk:Arin Mara|talk]]) 11:33, 27 July 2022 (UTC)}}
{{cleanup|Standardize [[Template:Documentation/preload|documentation]]. Explain auto image fetching from [https://images.evetech.net/ CCP Servers]. [[User:Arin Mara|Arin Mara]] ([[User talk:Arin Mara|talk]]) 11:33, 27 July 2022 (UTC)}}
{{Work in progress|Both the actual template and the doc page are being overhauled. The doc in situ and the template in [[User:Evon R'al/Sandbox template]]|date= 16:09, 28 December 2022 (UTC)}
{{Work in progress|Both the actual template and the doc page are being overhauled. The doc in situ and the template in [[User:Evon R'al/Sandbox template]]|date= 17:36, 1 January 2023 (UTC) }}


; Description
; Description
Line 93: Line 93:
| info=  
| info=  
| bonuses=  
| bonuses=  
| structurehp=  
| structurehp=  


Line 141: Line 142:
:;; shipname {{Co|palegreen|[Required]}} : The name of the ship. Exactly as written in-game. Must be identical to the article name. Used for: <br>* Breadcrumbs; <br>* Show ship name when hovering over the image; <br>* Naming of external links, (see '''shipid''').
:;; shipname {{Co|palegreen|[Required]}} : The name of the ship. Exactly as written in-game. Must be identical to the article name. Used for: <br>* Breadcrumbs; <br>* Show ship name when hovering over the image; <br>* Naming of external links, (see '''shipid''').
:;; caption : {{Co|red|Not used}} in {{Tl|ShipArticle}} (Need to check for <s>{{Tl|ShipBoxLarge}}</s> and <s>{{Tl|ShipBoxTooltip}}</s>
:;; caption : {{Co|red|Not used}} in {{Tl|ShipArticle}} (Need to check for <s>{{Tl|ShipBoxLarge}}</s> and <s>{{Tl|ShipBoxTooltip}}</s>
::; class : Class the ship belongs to. This info is not directly available in-game (see ''table'') Used for: <br>* Excluding (special edition) shuttles from the external EVE Workbench link; <br>* Determine the (default) number of rigs (in combination with '''tech'''); <br>* Determine the (default) rig size; <br>* Determine (default) number of calibration points (in combination with '''grouping'''); <br>* Determine presence of Frigate Escape Bay
::; class {{Co|palegreen|[Required]}} : Class the ship belongs to. This info is not directly available in-game (see ''table'') Used for: <br>* Excluding (special edition) shuttles from the external EVE Workbench link; <br>* Determine the (default) number of rigs (in combination with '''tech'''); <br>* Determine the (default) rig size; <br>* Determine (default) number of calibration points (in combination with '''grouping'''); <br>* Determine presence of Frigate Escape Bay
{{Note box|
{{Note box|
2022-12-28 - Be aware: the tables give the "old" values. this part of the template is being worked on.
2022-12-28 - Be aware: the tables give the "old" values. this part of the template is being worked on.
Line 149: Line 150:
|+ Ship classes
|+ Ship classes
|-
|-
! style="min-width: 10em;" | Class !!Grouping
! style="min-width: 10em;" | Class !! style="min-width: 8em;" | Grouping
|-
|-
| Corvette || Corvettes<br> Special Edition Corvettes
| Corvette || Corvettes<br> Special Edition Corvettes
Line 160: Line 161:
|+ Default number of rigs
|+ Default number of rigs
|-
|-
! style="min-width: 10em;" | Class !! Tech !! # Rigs
! style="min-width: 10em;" | Class !! style="min-width: 8em;" | Tech !! # Rigs
|-
|-
| Corvette<br> Shuttle<br> Freighter<br> Jump Freighter
| Corvette<br> Shuttle<br> Freighter<br> Jump Freighter
Line 174: Line 175:
|}
|}
:::: {| class="wikitable collapsible collapsed"
:::: {| class="wikitable collapsible collapsed"
|+ Rigs size
|+ Default rig size
! style="min-width: 10em;" | Class !! Size
! style="min-width: 10em;" | Class !! style="min-width: 8em;" | Size
|-
|-
| Corvette<br>
| Corvette<br>
Line 233: Line 234:
|+ Default number of calibration points
|+ Default number of calibration points
|-
|-
! style="min-width: 10em;" | Class !! Grouping !! Points
! style="min-width: 10em;" | Class !! style="min-width: 8em;" | Grouping !! Points
|-
|-
| Corvette<br> Shuttle<br> Freighter<br> Jump Freighter
| Corvette<br> Shuttle<br> Freighter<br> Jump Freighter
Line 247: Line 248:
|}
|}
::; grouping {{Co|palegreen|[Required]}} : Name of the market group the ship belongs to. Used for: <br>* Ship category in breadcrumbs; <br>* Ship category under ship image; <br>* Determine (default) number of calibration points (in combination with '''class''')
::; grouping {{Co|palegreen|[Required]}} : Name of the market group the ship belongs to. Used for: <br>* Ship category in breadcrumbs; <br>* Ship category under ship image; <br>* Determine (default) number of calibration points (in combination with '''class''')
::; hulltype : Ships basic hulltype. The Tech1 shipname i.e. The [[Vexor]], [[Guardian-Vexor]], [[Ishtar]] and [[Vexor Navy Issue]] all have Vexor for their hulltype. <br>Used for: <''Hull type''> Class under ship image. The word class must be included.
::; hulltype : Ships basic hulltype. The Tech1 shipname when there ar variations i.e. The [[Vexor]], [[Guardian-Vexor]], [[Ishtar]] and [[Vexor Navy Issue]] all have Vexor for their hulltype. Otherwise use the shipname. <br>Used for: <''Hull type''> Class under ship image. The word Class must be included.
::; faction {{Co|palegreen|[Required]}} : Name of the faction the ship belongs to. Used for: <br>* Faction name under ship image; <br>* Faction logo under ship image; <br>* Show faction name when hovering over the logo.
::; faction {{Co|palegreen|[Required]}} : Name of the faction the ship belongs to. Used for: <br>* Faction name under ship image; <br>* Faction logo under ship image; <br>* Show faction name when hovering over the logo.
::; race : {{Co|red|Not used}} in {{Tl|ShipArticle}} (Need to check for <s>{{Tl|ShipBoxLarge}}</s> and <s>{{Tl|ShipBoxTooltip}}</s>
::; race : {{Co|red|Not used}} in {{Tl|ShipArticle}} (Need to check for <s>{{Tl|ShipBoxLarge}}</s> and <s>{{Tl|ShipBoxTooltip}}</s>
::; roles : List of ship role(s).
::; roles : List of ship role(s). Defaults to: ''unspecified''<br> ''Needs more info''
::; variations : List of ship variations. Use the template {{Tl|Ship}}
::; variations : List of ship variations. Defaults to: ''none''<br>Use the template {{Tl|Ship}}. If more then one separate by ",<space>".
::; tech : The ships tech "level". Unused for Tech1 ships (2 for Tech2, 3 for Tech3 and F for faction) Used for: <br>* Techcorner on ship image; <br>* Determine the (default) number of rigs (in combination with '''class''')
::; tech : The ships tech "level". Unused for Tech1 ships (2 for Tech2, 3 for Tech3 and F for faction) Used for: <br>* Techcorner on ship image; <br>* Determine the (default) number of rigs (in combination with '''class''')
::; ecmprio : Priority in which the ship should be an ECM target (0 = none, 1 = low, 2 = normal, 3 = high, 4 = highest). "Somebody's" interpretation. Used for: <br>* ECM priority block under ship image; <br>* ECM priority info on the ECM priority block "what's this?" pop-up
::; ecmprio : Priority in which the ship should be an ECM target (0 = none, 1 = low, 2 = normal, 3 = high, 4 = highest). Defaults to: unknown.<br> "''Somebody's''" interpretation. Used for: <br>* ECM priority block under ship image; <br>* ECM priority info on the ECM priority block "what's this?" pop-up
::; powergrid : Amount of Powergrid the ship has. Including the unit i.e. 700 MW
 
::; cpu : Amount of CPU the ship has. Including the unit i.e. 300 tf
 
::; capacitor : Capacitor capacity. Including the unit i.e. 1,450 GJ
::; powergrid : Amount of Powergrid the ship has. Including the unit i.e. 700 MW. Defaults to: 0 MW
::; highs : Number of high power slots.
::; cpu : Amount of CPU the ship has. Including the unit i.e. 300 tf. Defaults to: 0 tf
::; turrets : Number of turret hard-points.
::; capacitor : Capacitor capacity. Including the unit i.e. 1,450 GJ. Defaults to: 0 GJ
::; launchers : Number of launcher hard-points.
 
::; mediums : Number of medium power slots..
::; lows : Number of low power slots..
::; mass : The ships mass. Including the unit i.e. 1,100,000 kg
::; volume : The ships volume (unpackaged). Including the unit i.e. 115,000 <nowiki>{{m3}}</nowiki>
::; cargohold : Capacity of the standard cargo hold. Including the unit i.e. 480 <nowiki>{{m3}}</nowiki>
::; extraholdtype : Type of an additional hold/bay (Mining, Gas, Ice, Minerals, Planetary Commodities, Command Center, Ammo, Fleet Hangar, Fuel Bay, Ship Maintenance Bay).
::; extrahold : Capacity of an additional hold/bay.
::; extrahold<''x''>type : <''x''> is 2 till 4. See '''extraholdtype'''
::; extrahold<''x''> : <''x''> is 2 till 4. See '''extrahold'''


:: Drones. Overruled when '''fighterbay''' is used. Defaults to "No drone bay." when not used.
::; highs : Number of high power slots. Defaults to: 0
::; dronebay : Dronebay capacity. Including the unit i.e. 125 <nowiki>{{m3}}</nowiki>. Defaults to  
::; turrets : Number of turret hard-points. Defaults to: 0
::; bandwidth : Drone bandwidth. Including the unit i.e. 75 Mbit/sec
::; launchers : Number of launcher hard-points. Defaults to: 0
::; mediums : Number of medium power slots. Defaults to: 0
::; lows : Number of low power slots. Defaults to: 0


:: Fighters. Overrules '''dronebay'''
 
::; mass : The ships mass. Including the unit i.e. 1,100,000 kg. Defaults to: 0 kg
::; volume : The ships volume (unpackaged). Including the unit i.e. 115,000 <nowiki>{{m3}}</nowiki>. Defaults to: 0 {{m3}}
 
 
::; cargohold : Capacity of the standard cargo hold. Including the unit i.e. 480 <nowiki>{{m3}}</nowiki>. Defaults to: 0 {{m3}}
::; extraholdtype {{Co|wheat|Optional}} : Type of an additional hold/bay (Mining, Gas, Ice, Minerals, Planetary Commodities, Command Center, Ammo, Fleet Hangar, Fuel Bay, Ship Maintenance Bay).
::; extrahold {{Co|wheat|Optional}} : Capacity of an additional hold/bay.
::; extrahold<''x''>type {{Co|wheat|Optional}} : <''x''> is 2 till 4. See '''extraholdtype'''
::; extrahold<''x''>  {{Co|wheat|Optional}}: <''x''> is 2 till 4. See '''extrahold'''
 
 
:: Drones. Overruled when '''fighterbay''' is used. Defaults to: "No drone bay." when neither <kbd>dronebay</kbd> nor <kbd>fighterbay</kbd> are used.
::; dronebay : Dronebay capacity. Including the unit i.e. 125 <nowiki>{{m3}}</nowiki>.
::; bandwidth : Drone bandwidth. Including the unit i.e. 75 Mbit/sec. {{Co|palegreen|[Required]}} when '''dronebay'''is used.
 
 
:: Fighters. Overrules '''dronebay'''.
::; fighterbay : Fighter bay capacity. Including the unit i.e. 125 <nowiki>{{m3}}</nowiki>
::; fighterbay : Fighter bay capacity. Including the unit i.e. 125 <nowiki>{{m3}}</nowiki>
::; fightertubes : Number of fighter tubes.
::; fightertubes : Number of fighter tubes. {{Co|palegreen|[Required]}} when '''fighterbay'''is used.
::; lightfightersquadlimit : Max number of light fighters. (not visible when not used)
::; lightfightersquadlimit : Max number of light fighters. ({{Co|wheat|Optional}} not visible when not used)
::; heavyfightersquadlimit : Max number of heavy fighters. (not visible when not used)
::; heavyfightersquadlimit : Max number of heavy fighters. ({{Co|wheat|Optional}} not visible when not used)
::; supportfightersquadlimit : Max number of support fighters. (not visible when not used)
::; supportfightersquadlimit : Max number of support fighters. ({{Co|wheat|Optional}} not visible when not used)
 


::; info : The text found on the Description tab of the in-game ship info.
::; info : The text found on the Description tab of the in-game ship info.
::; bonuses : List of bonuses applied to the ship (Source; Trait tab in-game ship info). ''needs more info about how to use''
::; bonuses : List of bonuses applied to the ship (Source; Trait tab in-game ship info). {{Co|wheat|Optional}} not visible when not used.<br> ''Needs more info about how to use''
::; structurehp : Hitpoint value of the hull. Including the unit i.e. 2,000 HP
 
 
::; structurehp : Hitpoint value of the hull. Including the unit i.e. 2,000 HP. Defaults to: 0 HP
 
 
::; armordhp : Hitpoint value of the armor. Including the unit i.e. 2,000 HP. Defaults to: 0 HP
::; armorem : Armor resistance percentage for electromagnetic damage. Defaults to: 0
::; armorherm : Armor resistance percentage for thermal damage. Defaults to: 0
::; armorkin : Armor resistance percentage for kinetic damage. Defaults to: 0
::; armorexp : Armor resistance percentage for explosive damage. Defaults to: 0
 


::; armordhp : Hitpoint value of the armor. Including the unit i.e. 2,000 HP
::; shieldhp : Hitpoint value of the shield. Including the unit i.e. 2,000 HP. Defaults to: 0 HP
::; armorem : Armor resistance percentage for electromagnetic damage.
::; shieldem : Shield resistance percentage for electromagnetic damage. Defaults to: 0
::; armorherm : Armor resistance percentage for thermal damage.
::; shieldtherm : Shield resistance percentage for thermal damage. Defaults to: 0
::; armorkin : Armor resistance percentage for kinetic damage.
::; shieldkin : Shield resistance percentage for kinetic damage. Defaults to: 0
::; armorexp : Armor resistance percentage for explosive damage.
::; shieldexp : Shield resistance percentage for explosive damage. Defaults to: 0


::; shieldhp : Hitpoint value of the shield. Including the unit i.e. 2,000 HP
::; shieldem : Shield resistance percentage for electromagnetic damage. Including the unit i.e. 1,100 HP
::; shieldtherm : Shield resistance percentage for thermal damage.
::; shieldkin : Shield resistance percentage for kinetic damage.
::; shieldexp : Shield resistance percentage for explosive damage.


::; maxvelocity : Maximum velocity. Including the unit i.e. 195 m/sec
::; maxvelocity : Maximum velocity. Including the unit i.e. 195 m/s. Defaults to: 0 m/s
::; inertia : Inertia modifier.
::; inertia : Inertia modifier. Defaults to: 0.0
::; warpspeed : Warp speed. Including the unit i.e. 4 AU/s
::; warpspeed : Warp speed. Including the unit i.e. 4 AU/s. Defaults to: 0 AU/s
::; warptime : Base time to warp (manually calculated). Including the unit i.e. 8.62 s. (see [[Acceleration#Accelerating_to_warp|Accelerating to warp]])
::; warptime : Base time to warp (manually calculated). Including the unit i.e. 8.62 s. (see [[Acceleration#Accelerating_to_warp|Accelerating to warp]])


::; targetrange : Maximum range to lock targets. Including the unit i.e. 52.5 km
::; maxlockedtargets : Maximum number of simultaneously lockable targets.
::; sigradius : Signature radius. Including the unit i.e. 145 m
::; scanres : Scan Resolution. Including the unit i.e. 280 mm
::; sensortype : Type of sensor used. Used for: <br>* Ship attributes; <br>* Sensor type info on the ECM priority block "what's this?" pop-up
::; sensorvalue : Sensor strength value. Including the unit i.e. 16 points


::; reqskills : List of required skills. use the template {{Tl|RequiredSkill}} ''needs more info about how to use''
::; targetrange : Maximum range to lock targets. Including the unit i.e. 52.5 km. Defaults to: 0 km
::; totaltraintime : Training time for the skills in Required Skill (manually calculated). Including the unit i.e. 19h 15m 30s
::; maxlockedtargets : Maximum number of simultaneously lockable targets. Defaults to: 0
::; forumlinks : (Optional) List of relevant forum links. (not visible when not used)
::; sigradius : Signature radius. Including the unit i.e. 145 m. Defaults to: 0 m
::; scanres : Scan Resolution. Including the unit i.e. 280 mm. Defaults to 0 mm
::; sensortype : Type of sensor used. Defaults to: Multi. Otherwise use one of Gravimetric, LADAR, Magnetrometric or RADAR. Used for: <br>* Ship attributes; <br>* Sensor type info on the ECM priority block "what's this?" pop-up.
::; sensorvalue : Sensor strength value. Including the unit i.e. 16 points. Defaults to: 0 points
 
 
::; reqskills : List of required skills. use the template {{Tl|RequiredSkill}}. Defaults to: ''none''<br> ''needs more info about how to use''
::; totaltraintime : Training time for the skills in Required Skill (manually calculated). Including the unit i.e. 19h 15m 30s. Not visible when no required skills.
 
::; forumlinks {{Co|wheat|Optional}} : List of relevant forum links. (not visible when not used)
::; wikireferences : List of relevant UniWiki articles (Has some build-in).
::; wikireferences : List of relevant UniWiki articles (Has some build-in).
::; externallinks : List of relevant external links (zKillboard, EVE Workbench, evepraisal and EVE ref are build in).
::; externallinks : List of relevant external links (zKillboard, EVE Workbench, evepraisal and EVE ref are build in).
::; highlights<''x''> : (Optional) <''x''> is 1 till 4. highlights. (not visible when not used)
::; highlights<''x''> {{Co|wheat|Optional}} : <''x''> is 1 till 4. highlights. (not visible when not used)
 


:: Overrides, use only when the build in results are incorrect.
:: Overrides, use only when the build in results are incorrect.