Template:ShipArticle/doc

From EVE University Wiki
< Template:ShipArticle
Revision as of 11:01, 15 January 2023 by Evon R'al (talk | contribs) (Add note to deprecated label.)
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: 13:11, 14 January 2023 (UTC)

Description
This template is used to create a ship page for the Ship Database.
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 faction is empty or unknown.
Build-in UniWiki links to
Ships
Build-in external links to
zKillboard
EVE Workbench
evepraisal
EVE Ref
Indirectly used
{{RequiredSkill}} to fill the parameter reqskill
{{Ship}} which in-turn calls {{ShipBoxTooltip}} to fill the parameter variations
Used by
{{Ship}} Wrapper for:
{{ShipBoxLarge}} Uses part of the parameter set. Used parameters are marked with bl
{{ShipBoxTooltip}} Uses part of the parameter set. Used parameters are marked with tt
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 [Preferred]
EVE Online database ID for the ship. See How to get ID for how to find it. Used for:
* External links to zKillboard, EVE workbench, evepraisal and EVE Ref:
* Ship image from CCP image server when no local image available.
shipimg [Preferred] [bl, tt]
Name of the local image file with extension. Used to show the image. Overrules the use of the CCP image server (see shipid)
shipname [Required] [bl, tt]
The name of the ship. Exactly as written in-game. Must be identical to the article name. Used for:
* Show ship name;
* Show ship name when hovering over the image;
* Breadcrumbs;
* Naming of external links, (see shipid).
caption [Deprecated] [Note 1]
Not used in {{ShipArticle}} (Need to check for {{ShipBoxLarge}} and {{ShipBoxTooltip}}
class [Required] [bl]
Class the ship belongs to. This info can be found in-game on the ship info. It is in the header, after the ship name, in parentheses (see table Ship classes). 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;
* Part of the header text, [bl] only

2022-12-28 - Be aware: the tables give the "old" values. this part of the template is being worked on.

Bold: Used in the template
Italic: Used in the template not found in-game
grouping [Required] [tt]
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);
* Part of the header, [tt]
hulltype [Required] [tt]
Ships basic hulltype. The Tech1 shipname when there are variations i.e. The Vexor, Guardian-Vexor, Ishtar and Vexor Navy Issue all have Vexor for their hulltype. Otherwise use the shipname.
Used for: <Hull type> Class under ship image. The word Class must be included.
faction [Required] [bl]
Name of the faction the ship belongs to. Used for:
* Faction name under ship image;
* Faction logo under ship image;
* Show faction name when hovering over the logo.
race [Deprecated] [Note 1]
Not used in {{ShipArticle}} (Need to check for {{ShipBoxLarge}} and {{ShipBoxTooltip}}
roles [bl]
List of ship role(s). Defaults to: unspecified
When more than one, separate by ",<space>".
variations [bl]
List of ship variations. Defaults to: none
Use the template {{Ship}}. If more than one, separate by ",<space>".
tech [bl, tt]
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). Defaults to: unknown.
"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 [tt]
Amount of Powergrid the ship has. Including the unit i.e. 700 MW. Defaults to: 0 MW
cpu [tt]
Amount of CPU the ship has. Including the unit i.e. 300 tf. Defaults to: 0 tf
capacitor
Capacitor capacity. Including the unit i.e. 1,450 GJ. Defaults to: 0 GJ


highs [bl, tt]
Number of high power slots. Defaults to: 0
turrets [bl, tt]
Number of turret hard-points. Defaults to: 0
launchers [bl, tt]
Number of launcher hard-points. Defaults to: 0
mediums [bl, tt]
Number of medium power slots. Defaults to: 0
lows [bl, tt]
Number of low power slots. Defaults to: 0


mass
The ship's mass. Including the unit i.e. 1,100,000 kg. Defaults to: 0 kg
volume
The ship's volume (unpackaged). Including the unit i.e. 115,000 {{m3}}. Defaults to: 0  m3


cargohold [bl, tt]
Capacity of the standard cargo hold. Including the unit i.e. 480 {{m3}}. Defaults to: 0  m3
extraholdtype Optional
Type of an additional hold/bay (Mining, Gas, Ice, Minerals, Planetary Commodities, Command Center, Ammo, Fleet Hangar, Fuel Bay, Ship Maintenance Bay).
extrahold Optional
Capacity of an additional hold/bay.
extrahold<x>type Optional
<x> is 2 till 4. See extraholdtype
extrahold<x> Optional
<x> is 2 till 4. See extrahold


Drones. Overruled when fighterbay is used. Defaults to: "No drone bay." when neither dronebay nor fighterbay are used.
dronebay [bl]
Dronebay capacity. Including the unit i.e. 125 {{m3}}.
bandwidth [bl]
Drone bandwidth. Including the unit i.e. 75 Mbit/sec. [Required] when dronebay is used.


Fighters. Overrules dronebay.
fighterbay
Fighter bay capacity. Including the unit i.e. 125 {{m3}}.
fightertubes
Number of fighter tubes. [Required] when fighterbay is used.
lightfightersquadlimit
Max number of light fighters. (Optional not visible when not used)
heavyfightersquadlimit
Max number of heavy fighters. (Optional not visible when not used)
supportfightersquadlimit
Max number of support fighters. (Optional not visible when not used)


info [bl]
The text found on the Description tab of the in-game ship info.
bonuses [bl]
List of bonuses applied to the ship (Source; Trait tab in-game ship info). Optional not visible when not used.
Preferably in the same order as on the Traits tab. Group headers like <skill> or role are bolded, header and actual bonuses are separated by <br> and may each be put on their own line to make it easier to read the source. Use &bull;&nbsp; for things like "Can fit module"
example:
bonuses= '''Gallente Cruiser bonuses (per skill level):'''<br>
5% bonus to Medium Hybrid Turret damage<br>
10% bonus to Drone hitpoints, damage and mining yield<br>
&bull;&nbsp;Can fit module


structurehp
Hitpoint value of the hull. Including the unit i.e. 2,000 HP. Defaults to: 0 HP


armorhp [bl]
Hitpoint value of the armor. Including the unit i.e. 2,000 HP. Defaults to: 0 HP
armorem [bl]
Armor resistance percentage for electromagnetic damage. Defaults to: 0
armorherm [bl]
Armor resistance percentage for thermal damage. Defaults to: 0
armorkin [bl]
Armor resistance percentage for kinetic damage. Defaults to: 0
armorexp [bl]
Armor resistance percentage for explosive damage. Defaults to: 0


shieldhp [bl]
Hitpoint value of the shield. Including the unit i.e. 2,000 HP. Defaults to: 0 HP
shieldem [bl]
Shield resistance percentage for electromagnetic damage. Defaults to: 0
shieldtherm [bl]
Shield resistance percentage for thermal damage. Defaults to: 0
shieldkin [bl]
Shield resistance percentage for kinetic damage. Defaults to: 0
shieldexp [bl]
Shield resistance percentage for explosive damage. Defaults to: 0


maxvelocity [bl, tt]
Maximum velocity. Including the unit i.e. 195 m/s. Defaults to: 0 m/s
inertia
Inertia modifier. Defaults to: 0.0
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 Accelerating to warp for the calculation.)


targetrange [bl]
Maximum range to lock targets. Including the unit i.e. 52.5 km. Defaults to: 0 km
maxlockedtargets
Maximum number of simultaneously lockable targets. Defaults to: 0
sigradius [bl]
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:
* 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. Defaults to: 0 points


reqskills
List of skills required to fly the hull. Use the template {{RequiredSkill}}. Defaults to: none
Use wiki mark-up for an unordered list (*). For skills that are prerequisites for other skills use nested lists. (Note: make sure the * starts at the first position of the line, except for the first if behind reqskills=, otherwise the wiki mark-up will not recognize it as an unordered list.)
Example
reqskills= * {{RequiredSkill|Gallente Cruiser|I}} ** {{RequiredSkill|Spaceship Command|II}} ** {{RequiredSkill|Gallente Destroyer|III}} *** {{RequiredSkill|Gallente Frigate|III}} **** {{RequiredSkill|Spaceship Command|I}}
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 Optional
List of relevant forum links. When more than one separate by ",<br>". (not visible when not used)
wikireferences
List of relevant UniWiki article links (Has some build-in). When more than one separate by ",<br>".
externallinks
List of relevant external links (zKillboard, EVE Workbench, evepraisal and EVE Ref are build in). When more than one separate by ",<br>".
highlights<x> Optional [tt]
<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.
Notes
  1. ^ a b There is no need to go edit an article because of the use of a deprecated parameter. But if you are editing one anyway, feel free to remove deprecated parameters.

    2. 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
 | class= Battleship
 | grouping= Standard Battleships
 | hulltype= Rokh Class
 | faction= Caldari State
 | roles= 
 | variations= 
 | 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= 470,000 m³

 | cargohold= 820 m³
 | extraholdtype=
 | extrahold=

 | dronebay= 50 m³
 | bandwidth= 50 Mbit/sec

 | info= <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>
'''Role bonus:'''<br>
100% bonus to Shield Extender hitpoints<br>
50% bonus to Armor Plate hitpoints<br>
5% additional bonus to Reinforced Bulkhead hitpoints

 | structurehp= 8,250 HP

 | armorhp= 7,700 HP
 | armorem= 50
 | armortherm= 45
 | armorkin= 25
 | armorexp= 10

 | shieldhp= 9,350 HP
 | shieldem= 0
 | shieldtherm= 20
 | shieldkin= 40
 | shieldexp= 50

 | maxvelocity= 89 m/sec
 | inertia= 0.136
 | warpspeed= 3 AU/s
 | warptime= 19.85 s

 | targetrange= 108 km
 | maxlockedtargets= 7
 | sigradius= 500 m
 | scanres= 98 mm
 | sensortype= Gravimetric
 | sensorvalue= 24 points

 | 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= 
}}
    Retrieved from "https://wiki.eveuniversity.org/index.php?title=Template:ShipArticle/doc&oldid=199512"