User:Shinerunner/shipwreck list/doc

This is a documentation subpage for User:Shinerunner/shipwreck list.
It may contain usage information, categories and other content that is not part of the original user template page.

This user page employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
You can conduct experiments, and should test all major changes, in either , the general template sandbox, or your user space before changing anything here.

Parameters

Shipwreck list parameters (and basic guidelines)
Ship Name	The name of the ship involved. The ship name may be linked if article page exists for the entry.
Country (optional)	This box should be used for the country the ship was registered in at the time of disaster.
Ship Type (optional)	The type of ship involved. Examples include ocean liners, battleships, aircraft carriers, etc.
Date of Loss (optional)	Year of the disaster
Type of Loss (optional)	The cause of the loss: collision, fire, battle, etc.
Location of Loss (optional)	Where the loss occurred: ocean, river, lake, etc.
Number of Survivors (optional)	How many people survived the disaster.
Number Lost (optional)	How many people lost their lives in the disaster.
ShortSummary (optional)	A short summary of the disaster. Linking to other information or referencing may be included.
LineColor (optional)	Hex codes for the separator line between the shipwreck entries. Use a color code without the # symbol. For example, the color code #00ff00 would be entered as 00ff00. When no color preference is defined the color used defaults to color "#CCCCFF".

This is where information from the template is placed when rendered ({{{LineColor}}} not shown, since there's no text to display, just a color):

{{{Ship Name}}}	{{{Country}}}	{{{Ship Type}}}	{{{Date of Loss}}}	{{{Type of Loss}}}	{{{Location of Loss}}}	{{{Number of Survivors}}}	{{{Number Lost}}}
{{{ShortSummary}}}

Using the template

To apply an entry to a shipwreck listing add the following where the entry would go in the List of shipwrecks.

{{User:Shinerunner/shipwreck list
 |Ship Name=
 |Country=
 |Ship Type=
 |Date of Loss=
 |Type of Loss=
 |Location of Loss=
 |Number of Survivors=
 |Number Lost=
 |ShortSummary=
 |LineColor=
}}

Note: This template is only part of a WikiTable, you will need to open the WikiTable first

{| class="wikitable" 
! width="180" style="background:#B0C4DE;"| Ship Name
! width="120" style="background:#B0C4DE;" | Country
! width="120" style="background:#B0C4DE;"| Ship Type
! width="80" style="background:#B0C4DE;"| Date of Loss
! width="80" style="background:#B0C4DE;"| Type of Loss
! width="140" style="background:#B0C4DE;"| Location of Loss
! width="80" style="background:#B0C4DE;"|Number of Survivors
! width="80" style="background:#B0C4DE;"|Number Lost
|-

The Shipwreck list template(s) would then follow.

{{User:Shinerunner/shipwreck list
 |Ship Name= RMS Titanic
 |Country= Great Britain
 |Ship Type= Ocean liner
 |Date of Loss= April 1912
 |Type of Loss= Collision
 |Location of Loss= Atlantic Ocean
 |Number of Survivors=706
 |Number Lost=1,517
 |ShortSummary= The Titanic sank after hitting an iceberg.
 |LineColor=696969
}}

After the final entry/template you will need to close the WikiTable with:

|}

Example

This entry:

{{User:Shinerunner/shipwreck list
 |Ship Name= RMS Titanic
 |Country= Great Britain
 |Ship Type= Ocean liner
 |Date of Loss= April 1912
 |Type of Loss= Collision
 |Location of Loss= Atlantic Ocean
 |Number of Survivors=706
 |Number Lost=1,517
 |ShortSummary= The Titanic sank after hitting an iceberg.
 |LineColor=696969
}}

Would appear as follows (shown without table headers):

Ship Name	Country	Ship Type	Date of Loss	Type of Loss	Location of Loss	Number of Survivors	Number Lost
RMS Titanic	Great Britain	Ocean liner	April 1912	Collision	Atlantic Ocean	706	1,517
The Titanic sank after hitting an iceberg.