Difference between revisions of "Template:Ship"

From EVE University Wiki
Jump to: navigation, search
Line 80: Line 80:
 
All the ship informations are stored in this page (wiki template article page) : [[Template:ShipDatabase]]
 
All the ship informations are stored in this page (wiki template article page) : [[Template:ShipDatabase]]
 
You won't see anything by just viewing to page, to actually see the database contents, you'll have to edit the page by clicking the Edit button on the top of the article. There are things you must understand before trying to make any changes to the database, first of all, the article structure itself.
 
You won't see anything by just viewing to page, to actually see the database contents, you'll have to edit the page by clicking the Edit button on the top of the article. There are things you must understand before trying to make any changes to the database, first of all, the article structure itself.
====Header Section====
+
====Database Sections : Where Should I Put The Data?====
This is the header section of the database, it is not modifiable and under no circumstances that you change any of the texts/codes in this section
+
The database article is divided in three sections,
<div style='background-color: #111111;border: 1px dashed #555555;color: #CCCCCC;line-height: 1.1em;padding: 1em;float: left;margin-bottom: 30px;'>
+
*<span style='color:red;'>Header Section</span>
<nowiki>{{Color box|color=darkred|border=white|'''SHIPS DATABASE'''<br><br>If you want to <u>add/edit/remove a ship information</u> so you and other people can use it, this is the place to do them. Just be careful while you do so, since the changes should <u>affect the entire ship information throughout the wiki</u>. Please consult [[Template:Ship|this page]] first if you want to make changes to the database.}}{{#switch:{{{1}}}</nowiki>
+
*<span style='color:green;'>Data Section</span>
 +
*<span style='color:red;'>Footer Section</span>
 +
<u>'''Under no circumstances should you change the Header or Footer Section!'''</u>, if you made a mistake on doing so, click on View History - Click Undo on the last work you've done until that point.
 +
<div style='background-color: #111111;border: 1px dashed #555555;color: #CCCCCC;line-height: 1.1em;padding: 1em;'>
 +
<span style='color:red;'><nowiki><!--HEADER SECTION START-->Header codes<!--HEADER SECTION END--></nowiki></span><br><br>
 +
<span style='color:green;'><nowiki><!--DATA SECTION START--></nowiki><br><br><span style='color:white;'>
 +
This is where we put all the ship datas, it's sorted alphabetically so if you wanted to add a new ship info, try placing them in the appropriate alphabetical section.
 +
</span><br><br><nowiki><!--DATA SECTION END--></nowiki></span><br><br>
 +
<span style='color:red;'><nowiki><!--FOOTER SECTION START-->Footer codes<!--FOOTER SECTION END--></nowiki></span>
 +
</div><br>
 +
====Ship Data : How Is It Written?====
 +
Below is the basic format of an empty ship data, you could copy the codes and paste them on the appropriate data section on the database and change the values of the texts colored in <span style='color:yellow'>yellow</span>. <u>'''Do not change anything else!'''</u>
 +
<div style='background-color: #111111;border: 1px dashed #555555;color: #CCCCCC;line-height: 1.1em;padding: 1em;'>
 +
<nowiki>
 +
|</nowiki><span style='color:yellow'>ship_name</span><nowiki>={{ShipSelector|mode={{{2}}}</nowiki><br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>|shipimg=</nowiki><span style='color:yellow'>ship_image_file</span><nowiki> </nowiki><br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>|caption=</nowiki><span style='color:yellow'>ship_name</span><nowiki> |shipname=</nowiki><span style='color:yellow'>ship_name</span><nowiki> |class=</nowiki><span style='color:yellow'>ship_class</span><nowiki></nowiki><br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>|highs=</nowiki><span style='color:yellow'>0</span><nowiki> |turrets=</nowiki><span style='color:yellow'>0</span><nowiki> |launchers=</nowiki><span style='color:yellow'>0</span><nowiki> |mediums=</nowiki><span style='color:yellow'>0</span><nowiki> |lows=</nowiki><span style='color:yellow'>0</span><nowiki></nowiki><br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>|cargohold=</nowiki><span style='color:yellow'>0 m3</span><nowiki> |dronebay=</nowiki><span style='color:yellow'>0 m3</span><nowiki> |bandwidth= </nowiki><span style='color:yellow'>0 Mbit/sec</span><nowiki></nowiki><br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>|roles=</nowiki><span style='color:yellow'>ship_general_role</span><nowiki></nowiki><br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>|variations=</nowiki><span style='color:yellow'>ship_variations</span><nowiki></nowiki><br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>|bonuses=</nowiki><span style='color:yellow'>ship_bonuses</span><br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>|info=</nowiki><span style='color:yellow'>ship_information_or_description</span><br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>|shieldhp=</nowiki><span style='color:yellow'>0</span><nowiki> |shieldem=</nowiki><span style='color:yellow'>0</span><nowiki> |shieldexp=</nowiki><span style='color:yellow'>0</span><nowiki> |shieldkin=</nowiki><span style='color:yellow'>0</span><nowiki> |shieldtherm=</nowiki><span style='color:yellow'>0</span><nowiki> </nowiki><br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>|armorhp=</nowiki><span style='color:yellow'>0</span><nowiki> |armorem=</nowiki><span style='color:yellow'>0</span><nowiki> |armorexp=</nowiki><span style='color:yellow'>0</span><nowiki> |armorkin=</nowiki><span style='color:yellow'>0</span><nowiki> |armortherm=</nowiki><span style='color:yellow'>0</span><nowiki></nowiki><br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>|targetrange=</nowiki><span style='color:yellow'>0 km</span><nowiki> |sigradius=</nowiki><span style='color:yellow'>0 m</span><nowiki> |maxvelocity=</nowiki><span style='color:yellow'>0 m/sec</span><nowiki></nowiki><br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>|forumlinks=}}</nowiki>
 
</div>
 
</div>
 +
You should replace each of the <span style='color:yellow'>yellow</span> texts to their appropriate values based on the name of texts. Each one correlates to different parts of the info box :
 +
*<span style='color:yellow'>ship_name</span> = the ship's name, example : Drake
 +
*<span style='color:yellow'>ship_image_file</span> = the ship's image file, if you're adding a new ship which has no image present on the wiki, you'll have to upload one yourself. example : Drake.jpg
 +
*<span style='color:yellow'>ship_class</span> = the ship's class or hull class, example : Battlecruiser
 +
*the highs, turrets, mediums and lows <span style='color:yellow'>0 values</span> = the number of the slots available for the ship, example : 7
 +
*cargohold, dronebay and bandwith <span style='color:yellow'>0 values</span> = the values of each parameter, with their appropriate dimension/size, example : 150 m3 (for cargohold), 150 Mbit/sec (for bandwith)
 +
*<span style='color:yellow'>ship_general_role</span> = the role of the ship, this was meant to be a basic guideline on what new players should see what the use for this ship, example : Missions, Tackler
 +
*<span style='color:yellow'>ship_variations</span> = other variants of the ship, you can write them as links, separated by comma, example : <nowiki>[http://wiki.eveonline.com/en/wiki/Crow Crow], [http://wiki.eveonline.com/en/wiki/Raptor Raptor]</nowiki>
 +
*<span style='color:yellow'>ship_bonuses</span> = the bonuses or role bonuses for the ship, please separate each new line with a <nowiki><br></nowiki> tag.
 +
*<span style='color:yellow'>ship_information_or_description</span> = short (or long, if you prefer) description about the ship, you can write a short paragraph for the description.
 +
*shieldhp, shieldem, shieldexp, shieldexp and shieldtherm <span style='color:yellow'>0 values</span> = shieldhp is the base shield hp value of the ship, while the other is the base shield resistance value of the ship, <u>use numerical values only WITHOUT percentage symbol!</u>
 +
*armorhp, armorem, armorexp, armorexp and armortherm <span style='color:yellow'>0 values</span> = armorhp is the base armor hp value of the ship, while the other is the base armor resistance value of the ship, <u>use numerical values only WITHOUT percentage symbol!</u>
 +
*targetrange, sigradius and maxvelocity <span style='color:yellow'>0 values</span> = the values of each parameter, with their appropriate dimension/size, example : 30 km (for targetrange), 500 m/sec (for maxvelocity)
 +
*forumlinks = you can add forum links here or you can just leave them empty but if you decide to add more than one, you don't have to separate them using a <nowiki><br></nowiki> tag, just use comma.
 +
<br>
 +
{{Color box|color=#144f1d|border=#2f8f2f|If you're editing or adding a new ship information, please make sure that no symbols, starting/closing tags, punctuation is left behind. You'll see that if you made a mistake the ship information boxes on this page and others wont render correctly, if you encountered this problem, just undo your work from the View History on the Database page.}}
 +
<br>
 
===Editing a Ship Details===
 
===Editing a Ship Details===
 +
To edit a ship info/details/attributes, simply visit this article : [[Template:ShipDatabase]], and click on the edit button. For safety reasons, please copy the article to a notepad or other editor you prefer (i recommend Notepad++ or EditPlus), but never use word processor such as Ms Word etc. Then, search the ship you'd like to edit by scrolling down through its alphabetical section, for example Ferox should be located in the D-F section.
  
 +
Rewrite/modify/add the things you want to edit, and make sure you did not accidentally erase or add additional tags such as <nowiki>{, }, |, &, [, ], etc.</nowiki>. If you feel something is wrong, undo your work, and start again.
 +
<br>
 
==Notes==
 
==Notes==
 
This template is the main and entry point for the Ship Template & Database. The contents and behaviour of this template directly affected by contents of the following templates :
 
This template is the main and entry point for the Ship Template & Database. The contents and behaviour of this template directly affected by contents of the following templates :

Revision as of 16:45, 8 September 2011

The main purpose of this template is to produce something like this Template:ShipDatabase (you can try hovering the text to see what i mean) or his bigger brother, the box mode (you can see one on the example section below). With just typing something as simple as this

{{Ship|Drake|tooltip}} for the tooltip-look, and

{{Ship|Drake|box}} for the bigger box-styled version

As you can see this template works differently than other templates you'll find in the wiki. By using this template we don't need to write any additional ship information to produce something more informative, as long as the ship information is written on the Template:ShipDatabase. This should cut down the time needed for editors and/or contributors to write articles which includes any particular ship information, not to mention the tooltip mode will enable users to put a hoverable ship information text on their articles. The tooltip mode can be used on any place on any form of wiki stylings or locations, for example inside a table or a list, since the hoverable text would be treated as a normal link by the wiki.

How To Use

Using the template is quite easy. The syntax is written below :

{{Ship|name_of_the_ship|mode_selection}}

  • Ship : this is the name of this template in which you would have to call, there are no other alternatives or options for this, so just write it this way.
  • name_of_the_ship : this is the name of the ship you want displayed, just type a ship's name and the wiki will automatically link them to an existing database entry. Note : Since there's no way to list what ship is already available on the database, you just have to try calling the ship name yourself and see whether it displays anything or not. If nothing comes up or the result shows that the entry cannot be found, then you have to add a new entry to the database.
  • mode_selection : there are two modes available right now..
    • tooltip : this is the tooltip-styled one
    • box : this is the big box-styled one



Examples

There are several way we can use the template, below are some examples :

Embedding Inside a Paragraph

If you have a paragraph text like this :

The Ferox is the most commonly flown ship in all of EVE, effective in both PvE and PvP combat. PvE load-outs sport an insane passive regeneration shield tank while in PvP the Ferox is fitted with a huge buffer tank (sometimes achieving a number of effective hit points equal to Battleships). While its DPS is not as effective as those of other races Battlecruisers its awesome tank means that it will often be the last ship standing on a battlefield.

and you want to change the Ferox text to a hoverable ship information box, just write them like these.

The Code

The {{Ship|Ferox|tooltip}} is the most commonly flown ship in all of EVE, effective in both PvE and PvP combat. PvE load-outs sport an insane passive regeneration shield tank while in PvP the Ferox is fitted with a huge buffer tank (sometimes achieving a number of effective hit points equal to Battleships). While its DPS is not as effective as those of other races Battlecruisers its awesome tank means that it will often be the last ship standing on a battlefield.

This is the result :

The Template:ShipDatabase is the most commonly flown ship in all of EVE, effective in both PvE and PvP combat. PvE load-outs sport an insane passive regeneration shield tank while in PvP the Ferox is fitted with a huge buffer tank (sometimes achieving a number of effective hit points equal to Battleships). While its DPS is not as effective as those of other races Battlecruisers its awesome tank means that it will often be the last ship standing on a battlefield.

Embedding Inside a Table

The Code

{| border="1" align="center" style="text-align:center;"
|{{Ship|Ferox|tooltip}}
|PvE/PvP ship
|312,333.00
|-
|This is a {{Ship|Drake|tooltip}}
|Pie
|5111100.00
|}


This is the result :

Template:ShipDatabase

PvE/PvP ship 312,333.00
This is a

Template:ShipDatabase

Pie 5111100.00

Box Style for More Complete Information

The Code

Battlecruisers are sometimes considered as a more powerful version of Destroyer class ships, they fit the same sized weapons as Cruisers and more widely used as a damage dealing ship than Destroyers. One of the most notable Battlecruiser class ship is probably the Caldari Drake, which is well known for it's tanking capabilities.
{{Ship|Drake|box}}

This is the result :

Battlecruisers are sometimes considered as a more powerful version of Destroyer class ships, they fit the same sized weapons as Cruisers and more widely used as a damage dealing ship than Destroyers. One of the most notable Battlecruiser class ship is probably the Caldari Drake, which is well known for it's tanking capabilities.

Template:ShipDatabase



Editing the Database

If the ship information you requested does not exist in the database, you could add them yourself, or if you want to update a certain information on a specific ship or just removing a ship information entirely (please contact the ship curator or wiki manager if you want to delete any ship data entry). Since all the ship data are stored in a wiki article format, it should be easy for anyone to add/edit the entries. Please read the remaining sections below if you're planning on adding/editing the database entries.

The Database

All the ship informations are stored in this page (wiki template article page) : Template:ShipDatabase You won't see anything by just viewing to page, to actually see the database contents, you'll have to edit the page by clicking the Edit button on the top of the article. There are things you must understand before trying to make any changes to the database, first of all, the article structure itself.

Database Sections : Where Should I Put The Data?

The database article is divided in three sections,

  • Header Section
  • Data Section
  • Footer Section

Under no circumstances should you change the Header or Footer Section!, if you made a mistake on doing so, click on View History - Click Undo on the last work you've done until that point.

<!--HEADER SECTION START-->Header codes<!--HEADER SECTION END-->

<!--DATA SECTION START-->

This is where we put all the ship datas, it's sorted alphabetically so if you wanted to add a new ship info, try placing them in the appropriate alphabetical section.

<!--DATA SECTION END-->


<!--FOOTER SECTION START-->Footer codes<!--FOOTER SECTION END-->


Ship Data : How Is It Written?

Below is the basic format of an empty ship data, you could copy the codes and paste them on the appropriate data section on the database and change the values of the texts colored in yellow. Do not change anything else!

|ship_name={{ShipSelector|mode={{{2}}}
    |shipimg=ship_image_file
    |caption=ship_name |shipname=ship_name |class=ship_class
    |highs=0 |turrets=0 |launchers=0 |mediums=0 |lows=0
    |cargohold=0 m3 |dronebay=0 m3 |bandwidth= 0 Mbit/sec
    |roles=ship_general_role
    |variations=ship_variations
    |bonuses=ship_bonuses
    |info=ship_information_or_description
    |shieldhp=0 |shieldem=0 |shieldexp=0 |shieldkin=0 |shieldtherm=0
    |armorhp=0 |armorem=0 |armorexp=0 |armorkin=0 |armortherm=0
    |targetrange=0 km |sigradius=0 m |maxvelocity=0 m/sec
    |forumlinks=}}

You should replace each of the yellow texts to their appropriate values based on the name of texts. Each one correlates to different parts of the info box :

  • ship_name = the ship's name, example : Drake
  • ship_image_file = the ship's image file, if you're adding a new ship which has no image present on the wiki, you'll have to upload one yourself. example : Drake.jpg
  • ship_class = the ship's class or hull class, example : Battlecruiser
  • the highs, turrets, mediums and lows 0 values = the number of the slots available for the ship, example : 7
  • cargohold, dronebay and bandwith 0 values = the values of each parameter, with their appropriate dimension/size, example : 150 m3 (for cargohold), 150 Mbit/sec (for bandwith)
  • ship_general_role = the role of the ship, this was meant to be a basic guideline on what new players should see what the use for this ship, example : Missions, Tackler
  • ship_variations = other variants of the ship, you can write them as links, separated by comma, example : [http://wiki.eveonline.com/en/wiki/Crow Crow], [http://wiki.eveonline.com/en/wiki/Raptor Raptor]
  • ship_bonuses = the bonuses or role bonuses for the ship, please separate each new line with a <br> tag.
  • ship_information_or_description = short (or long, if you prefer) description about the ship, you can write a short paragraph for the description.
  • shieldhp, shieldem, shieldexp, shieldexp and shieldtherm 0 values = shieldhp is the base shield hp value of the ship, while the other is the base shield resistance value of the ship, use numerical values only WITHOUT percentage symbol!
  • armorhp, armorem, armorexp, armorexp and armortherm 0 values = armorhp is the base armor hp value of the ship, while the other is the base armor resistance value of the ship, use numerical values only WITHOUT percentage symbol!
  • targetrange, sigradius and maxvelocity 0 values = the values of each parameter, with their appropriate dimension/size, example : 30 km (for targetrange), 500 m/sec (for maxvelocity)
  • forumlinks = you can add forum links here or you can just leave them empty but if you decide to add more than one, you don't have to separate them using a <br> tag, just use comma.


If you're editing or adding a new ship information, please make sure that no symbols, starting/closing tags, punctuation is left behind. You'll see that if you made a mistake the ship information boxes on this page and others wont render correctly, if you encountered this problem, just undo your work from the View History on the Database page.


Editing a Ship Details

To edit a ship info/details/attributes, simply visit this article : Template:ShipDatabase, and click on the edit button. For safety reasons, please copy the article to a notepad or other editor you prefer (i recommend Notepad++ or EditPlus), but never use word processor such as Ms Word etc. Then, search the ship you'd like to edit by scrolling down through its alphabetical section, for example Ferox should be located in the D-F section.

Rewrite/modify/add the things you want to edit, and make sure you did not accidentally erase or add additional tags such as {, }, |, &, [, ], etc.. If you feel something is wrong, undo your work, and start again.

Notes

This template is the main and entry point for the Ship Template & Database. The contents and behaviour of this template directly affected by contents of the following templates :

  • Template:ShipDatabase : this is where the ship database is stored
  • Template:ShipSelector ¹
  • Template:ShipBoxLarge ¹
  • Template:ShipBoxTooltip ¹
¹ these three templates are not meant to be edited, unless absolutely necessary.

All these five templates were designed to be work in conjunction to each other, meaning if one of them is missing, all five and especially this ship template won't work! The reason why this template exi

Template:ShipDatabase