Template:CanalInfobox/doc

This is a documentation subpage for Template:CanalInfobox. It may contain usage information, categories and other content that is not part of the original template page.

The {{CanalInfobox}} template provides a right-hand infobox with information specific to a canal.

Usage

To use the template, copy the following code to the page on which you wish it to appear.

{{CanalInfobox
| canal_name =
| canal_image =
| length =
| length_imp =
| boat_length =
| boat_length_imp =
| boat_beam =
| boat_beam_imp =
| boat_draft =
| boat_draft_imp =
| locks =
| authority =
| original_owner =
| began =
| completed =
| start_point =
| end_point =
| connects =
}}

Parameters

All of the parameters are optional.

Parameter	Description	Type	Notes
canal name	Name of the canal	String
canal image	Filename of an image of the canal	String
length	Length of the canal	String	In kilometers
length imp	Length of the canal, imperial units	String	In miles
boat lenght	Maximum boat length	String	In meters
boat length imperial	Maximum boat length, imperial units	In feet
boat beam	Maximum boat beam (width)	String	In meters
boat beam imp	Maximum boat beam, imperial units	String	In feet
boat draft	Maximum boat draft	String	In meters
boat draft imp	Maximum boat draft, imperial units	String	In feet
locks	Number of locks	String	Total locks or number up and number down
authority	Authority overseeing the canal	String
original owner	Original owner of the canal	String
began	Date construction began	String
completed	Date construction ended	String
start point	Entrance to the canal	String
end point	Exit from the canal	String
connects	Bodies of water the canal connects to	String

Example

Panama Canal

Canal
File:Filename.png
Length	82 km (51 mi)
Maximum boat length	366 m (1,200 ft)
Maximum boat beam	49 m (160 ft)
Maximum boat draft	15.2 m (60 ft)
Locks	3 up, 3 down
Navigation authority	Panama Canal Authority
History
Original owner	Société internationale du Canal
Construction began	May 4, 1904
Date completed	August 15, 1914
Geography
Start point	Atlantic Ocean
End point	Pacific Ocean
Connects to	Pacific Ocean from Atlantic Ocean and vice versa

{{CanalInfobox
| canal_name = Panama Canal
| canal_image = filename.png
| length = 82
| length_imp = 51
| boat_length = 366
| boat_length_imp = 1,200
| boat_beam = 49
| boat_beam_imp = 160
| boat_draft = 15.2
| boat_draft_imp = 60
| locks = 3 up, 3 down
| authority = Panama Canal Authority
| original_owner = Société internationale du Canal
| began = May 4, 1904
| completed = August 15, 1914
| start_point = Atlantic Ocean
| end_point = Pacific Ocean
| connects = Pacific Ocean from Atlantic Ocean and vice versa
}}