Template:ShipArticle/doc

From EVE University Wiki
< Template:ShipArticle
Revision as of 14:17, 24 December 2022 by Evon R'al (talk | contribs) (Start creation of default value tables.)
Jump to: navigation, search
This article should be cleaned up or improved.
The reason is: Standardize documentation. Explain auto image fetching from CCP Servers. Arin Mara (talk) 11:33, 27 July 2022 (UTC)
This page is a work in progress.
Notes: 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

This article or section is in the process of an expansion or major restructuring. You are welcome to assist in its construction by editing it as well.
If this article or section has not been edited in several days, please remove this template.

Last edited: 14:17, 24 December 2022 (UTC)

Description
This template is being used to create a "graphical" of the ships information on the Ship Database pages.
Dependencies
Uses
MediaWiki:Common.css Elements identified by #ship-article.
no-image.png Default ship image when neither shipid nor shipimg are given. Default faction logo when either no or an unknown faction is given.
Build-in UniWiki links to
Ships
Build-in external links to
zKillboard
EVE Workbench
evepraisal
EVE Ref
Used by
{{Ship}} Wrapper for:
{{ShipBoxLarge}} Uses part of the parameter set
{{ShipBoxTooltip}} Uses part of the parameter set
Syntax
<onlyinclude>{{{{#if:{{{mode|}}}|{{#switch:{{{mode}}}|box=ShipBoxLarge|#default=ShipBoxTooltip}}|ShipArticle}} <!--  Template marker : DON'T EDIT LINE -->
<!-----------------------------------------------------------
* SHIP ATTRIBUTES SECTION (last update : 2022-12-10)
-------------------------------------------------------------
* on editing the attributes, please make sure that you don't
* leave/mistype any tags required. please follow the same
* format below and edit only the values (after the = sign).
------------------------------------------------------------->
| shipid= 
| shipimg= 
| shipname= 
... parameter list
}}</onlyinclude> <!-- Template marker : DON'T EDIT LINE -->
Note: While {{ShipArticle}} on its own will work, leaving out the other parts given in the syntax will break the functioning of {{SchipBoxTooltip}} and {{ShipboxLarge}}.
Parameters
shipid
EVE Online database ID for the ship. See How to get ID for how to find it. Used for:
* Ship image from CCP image server when no local image available;
* External links to zKillboard, EVE workbench, evepraisal and EVEref.
shipimg
Name of the local image file with extension. Used to show the image. Overrules the use of the CCP image server (see shipid)
shipname
The name of the ship. Exactly as written in-game. Must be identical to the article name. Used for:
* Breadcrumbs;
* Show ship name when hovering over the image;
* Naming of external links, (see shipid).
caption
Not used in {{ShipArticle}} (Need to check for {{ShipBoxLarge}} and {{ShipBoxTooltip}}
class
Class the ship belongs to. This info is not directly available in-game (see table) Used for:
* Excluding (special edition) shuttles from the external EVE Workbench link;
* Determine the (default) number of rigs (in combination with tech);
* Determine the (default) rig size;
* Determine (default) number of calibration points (in combination with grouping);
* Determine presence of Frigate Escape Bay
grouping
Name of the market group the ship belongs to. Used for:
* Ship category in breadcrumbs;
* Ship category under ship image;
* 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.
Used for: Hull type (Class) under ship image
faction
Name of the faction the ship belongs to. Used for:
* Faction logo under ship image;
* Show faction name when hovering over the logo;
* Faction name under ship image
race
Not used in {{ShipArticle}} (Need to check for {{ShipBoxLarge}} and {{ShipBoxTooltip}}
roles
List of ship role(s).
variations
List of ship variations. Use the template {{Ship}}
tech
The ships tech "level". Unused for Tech1 ships (2 for Tech2, 3 for Tech3 and F for faction) Used for:
* Techcorner on ship image;
* 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:
* ECM priority block under ship image;
* 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
highs
Number of high power slots.
turrets
Number of turret hard-points.
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 {{m3}}
cargohold
Capacity of the standard cargo hold. Including the unit i.e. 480 {{m3}}
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.
dronebay
Dronebay capacity. Including the unit i.e. 125 {{m3}}. Defaults to
bandwidth
Drone bandwidth. Including the unit i.e. 75 Mbit/sec
Fighters. Overrules dronebay
fighterbay
Fighter bay capacity. Including the unit i.e. 125 {{m3}}
fightertubes
Number of fighter tubes.
lightfightersquadlimit
Max number of light fighters. (not visible when not used)
heavyfightersquadlimit
Max number of heavy fighters. (not visible when not used)
supportfightersquadlimit
Max number of support fighters. (not visible when not used)
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
structurehp
Hitpoint value of the hull. Including the unit i.e. 2,000 HP
armordhp
Hitpoint value of the armor. Including the unit i.e. 2,000 HP
armorem
Armor resistance percentage for electromagnetic damage.
armorherm
Armor resistance percentage for thermal damage.
armorkin
Armor resistance percentage for kinetic damage.
armorexp
Armor resistance percentage for explosive damage.
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
inertia
Inertia modifier.
warpspeed
Warp speed. Including the unit i.e. 4 AU/s
warptime
Base time to warp (manually calculated). Including the unit i.e. 8.62 s. (see 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:
* Ship attributes;
* 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 {{RequiredSkill}} 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
forumlinks
(Optional) List of relevant forum links. (not visible when not used)
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).
highlights<x>
(Optional) <x> is 1 till 4. highlights. (not visible when not used)
Overrides, use only when the build in results are incorrect.
rigs_count
Override for (default) number of rigs.
rigs_size
Override for (default) size of rigs.
rigs_calibration
Override for (default) number of calibration points.


Example

Top

An example of a proper template would be: 

{{ShipArticle
 <!--  Template marker : DON'T EDIT LINE -->
 <!-----------------------------------------------------------
 * SHIP ATTRIBUTES SECTION (last update : 2022-12-10)
 -------------------------------------------------------------
 * on editing the attributes, please make sure that you don't
 * leave/mistype any tags required. please follow the same
 * format below and edit only the values (after the = sign).
 ------------------------------------------------------------->
 | shipid=24688
 | shipimg=Rokh.jpg
 | shipname=Rokh
 | caption=Rokh
 | class=Battleship
 | grouping=Standard Battleships
 | hulltype=Rokh Class
 | faction=Caldari State
 | race=Caldari
 | roles=unspecified
 | variations=<i>none</i>
 | tech=
 | ecmprio=0 <!-- 0 = none, 1 = low, 2 = normal, 3 = high, 4 = highest -->
 | powergrid=15,000 MW
 | cpu=780 tf
 | capacitor=6,000 GJ
 | highs=8
 | turrets=8
 | launchers=4
 | mediums=6
 | lows=5
 | mass=105,300,000 kg
 | volume=486,000 m³
 | cargohold=625 m³
 | extrahold=
 | extraholdtype=
 | extrahold2=
 | extrahold2type=
 | extrahold3=
 | extrahold3type=
 | extrahold4=
 | extrahold4type=
 | dronebay=50 m³
 | bandwidth=50 Mbit/sec
 | fighterbay=
 | fightertubes=
 | lightfightersquadlimit=
 | heavyfightersquadlimit=
 | supportfightersquadlimit=
 | info=<br><b>Development</b><br>Having long suffered the lack of an adequate hybrid platform, the Caldari State's capsule pilots found themselves rejoicing as the Rokh's design specs were released. A fleet vessel if ever there was one, this far-reaching and durable beast is expected to see a great deal of service on battlefields near and far.
 | bonuses=<b>Caldari Battleship bonuses (per skill level):</b><br>10% bonus to Large Hybrid Turret optimal range<br>4% bonus to all shield resistances<br>
 | structurehp=7,500 HP
 | shieldhp=8,500 HP
 | shieldem=0
 | shieldexp=50
 | shieldkin=40
 | shieldtherm=20
 | armorhp=7,000 HP
 | armorem=50
 | armorexp=10
 | armorkin=25
 | armortherm=44.99999999999999
 | maxvelocity=89 m/sec
 | inertia=0.136
 | warpspeed=2 AU/s
 | warptime=19.85 s
 | targetrange=90.00 km
 | sigradius=500 m
 | maxlockedtargets=7
 | sensortype=Gravimetric
 | sensorvalue=24 points
 | scanres=75 mm
 | reqskills=*{{RequiredSkill|Caldari Battleship|I}}
**{{RequiredSkill|Spaceship Command|IV}}
**{{RequiredSkill|Caldari Battlecruiser|III}}
***{{RequiredSkill|Spaceship Command|III}}
***{{RequiredSkill|Caldari Cruiser|III}}
****{{RequiredSkill|Spaceship Command|II}}
****{{RequiredSkill|Caldari Destroyer|III}}
*****{{RequiredSkill|Caldari Frigate|III}}
******{{RequiredSkill|Spaceship Command|I}}

 | totaltraintime=3d 20h 55m 10s
 | forumlinks=
 | wikireferences=
 | externallinks=
 | highlights1=
 | highlights2=
 | highlights3=
 | highlights4=
 | rigs_count=
 | rigs_size=
 | rigs_calibration=
}}
Retrieved from "https://wiki.eveuniversity.org/index.php?title=Template:ShipArticle/doc&oldid=198924"