Difference between revisions of "Template:Ship"
(writing the template's help section) |
(help section edit) |
||
Line 1: | Line 1: | ||
<noinclude> | <noinclude> | ||
− | + | The main purpose of this template is to produce something like this {{Ship|Drake|tooltip}} (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 | With just typing something as simple as this | ||
<div style='background-color: #111111;border: 1px dashed #555555;color: #CCCCCC;line-height: 1.1em;padding: 1em;'> | <div style='background-color: #111111;border: 1px dashed #555555;color: #CCCCCC;line-height: 1.1em;padding: 1em;'> | ||
Line 7: | Line 6: | ||
<span style='color:white'><nowiki>{{Ship|Drake|box}}</nowiki></span> for the bigger box-styled version | <span style='color:white'><nowiki>{{Ship|Drake|box}}</nowiki></span> for the bigger box-styled version | ||
</div> | </div> | ||
− | As you | + | 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|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. |
+ | <br><br> | ||
+ | ==How To Use== | ||
+ | Using the template is quite easy. The syntax is written below : | ||
+ | <div style='background-color: #111111;border: 1px dashed #555555;color: #CCCCCC;line-height: 1.1em;padding: 1em;text-align:center'> | ||
+ | <nowiki>{{</nowiki><span style='color:white;'>Ship</span><nowiki>|</nowiki><span style='color:green;'>name_of_the_ship</span><nowiki>|</nowiki><span style='color:yellow;'>mode_selection</span><nowiki>}}</nowiki> | ||
+ | </div> | ||
+ | *<span style='color:white;'>Ship</span> : 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. | ||
+ | *<span style='color:green;'>name_of_the_ship</span> : 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 [[Template:ShipDatabase|database]]''. | ||
+ | *<span style='color:yellow;'>mode_selection</span> : there are two modes available right now.. | ||
+ | **<span style='color:yellow;'>'''tooltip'''</span> : this is the tooltip-styled one | ||
+ | **<span style='color:yellow;'>'''box'''</span> : this is the big box-styled one | ||
+ | <br><br> | ||
+ | ==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 : | ||
+ | <div style='background-color: #111111;border: 1px dashed #555555;color: #CCCCCC;line-height: 1.1em;padding: 1em;'> | ||
+ | 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. | ||
+ | </div> | ||
+ | and you want to change the Ferox text to a hoverable ship information box, just write them like these. | ||
+ | |||
+ | '''The Code''' | ||
+ | <div style='background-color: #111111;border: 1px dashed #555555;color: #CCCCCC;line-height: 1.1em;padding: 1em;'> | ||
+ | The <nowiki>{{Ship|Ferox|tooltip}}</nowiki> 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. | ||
+ | </div> | ||
+ | '''This is the result :'''<br> | ||
+ | <div style='background-color: #111111;border: 1px dashed #555555;color: #CCCCCC;line-height: 1.1em;padding: 1em;'> | ||
+ | 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. | ||
+ | </div> | ||
+ | |||
+ | ===Embedding Inside a Table=== | ||
+ | '''The Code''' | ||
+ | <div style='background-color: #111111;border: 1px dashed #555555;color: #CCCCCC;line-height: 1.1em;padding: 1em;'> | ||
+ | <nowiki>{| border="1" align="center" style="text-align:center;"</nowiki><br><nowiki> | ||
+ | |{{Ship|Ferox|tooltip}}</nowiki><br><nowiki> | ||
+ | |PvE/PvP ship</nowiki><br><nowiki> | ||
+ | |312,333.00</nowiki><br><nowiki> | ||
+ | |-</nowiki><br><nowiki> | ||
+ | |This is a {{Ship|Drake|tooltip}}</nowiki><br><nowiki> | ||
+ | |Pie</nowiki><br><nowiki> | ||
+ | |5111100.00</nowiki><br><nowiki> | ||
+ | |}</nowiki> | ||
+ | </div><br> | ||
+ | '''This is the result :'''<br> | ||
+ | <div style='background-color: #111111;border: 1px dashed #555555;color: #CCCCCC;line-height: 1.1em;padding: 1em;'> | ||
+ | {| 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 | ||
+ | |} | ||
+ | </div> | ||
+ | |||
+ | ===Box Style for More Complete Information=== | ||
+ | '''The Code''' | ||
+ | <div style='background-color: #111111;border: 1px dashed #555555;color: #CCCCCC;line-height: 1.1em;padding: 1em;'> | ||
+ | <nowiki>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.</nowiki><br> | ||
+ | <nowiki>{{Ship|Drake|box}}</nowiki> | ||
+ | </div> | ||
+ | '''This is the result :'''<br> | ||
+ | <div style='background-color: #111111;border: 1px dashed #555555;color: #CCCCCC;line-height: 1.1em;padding: 1em;float: left;margin-bottom: 30px;'> | ||
+ | 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}} | ||
+ | </div> | ||
+ | <br><br> | ||
+ | ==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 : | ||
+ | <div style='background-color: #111111;border: 1px dashed #555555;color: #CCCCCC;line-height: 1.1em;padding: 1em;float: left;margin-bottom: 30px;'> | ||
+ | <nowiki><noinclude>{{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.}}</noinclude>{{#switch:{{{1}}}</nowiki> | ||
+ | </div> | ||
+ | ===Editing a Ship Details=== | ||
− | |||
==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 15:17, 8 September 2011
The main purpose of this template is to produce something like this {{#switch:Drake</nowiki>
Editing a Ship Details
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 </noinclude> 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 {{#switch:Ferox</nowiki>
Editing a Ship Details
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 </noinclude> 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 :
{{#switch:Ferox</nowiki>
Editing a Ship DetailsNotesThis 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 :
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 </noinclude> Template:ShipDatabase |
PvE/PvP ship | 312,333.00 |
This is a {{#switch:Drake</nowiki>
Editing a Ship DetailsNotesThis 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 :
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 </noinclude> 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. {{#switch:Drake</nowiki>
Editing a Ship Details
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 </noinclude> 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 :
<noinclude>{{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.}}</noinclude>{{#switch:{{{1}}}
Editing a Ship Details
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