Template:Infobox port/doc

Usage

{{{name}}}
[[File:{{{image}}}|280px|alt={{{image_alt}}}]] {{{image_caption}}}
[[File:{{{logo}}}|{{{logo_size}}}|alt={{{logo_alt}}}]] {{{logo_caption}}}
Native name	{{{native_name}}}
Location
Country	{{{country}}}
Location	{{{location}}}
Coordinates	0°N 0°E / 0; 0 {{{coordinates_footnotes}}}
{{{grid_name}}}	{{{grid_position}}}
UN/LOCODE	{{{locode}}}
Details
Built	{{{built}}}
Opened	{{{opened}}}
Closed	{{{closed}}}
Operated by	{{{operated}}}
Owned by	{{{owner}}}
Type of harbour	{{{type}}}
Size of harbour	{{{sizewater}}}
Land area	{{{sizeland}}}
Size	{{{size}}}
No. of berths	{{{berths}}}
Ship types	{{{ships}}}
No. of wharfs	{{{wharfs}}}
No. of piers	{{{piers}}}
Draft depth	{{{draft_depth}}}
Air draft	{{{air_draft}}}
Length of approach channel	{{{length_of_approach_channel}}}
No. of platforms	{{{platforms}}}
Rail lines	{{{lines}}}
Rail gauge	{{{gauge}}}
Street access	{{{streets}}}
Truck types	{{{trucks}}}
Employees	{{{employees}}}
{{{leadershiptitle}}}	{{{leader}}}
{{{blankdetailstitle1}}}	{{{blankdetails1}}}
{{{blankdetailstitle2}}}	{{{blankdetails2}}}
{{{blankdetailstitle3}}}	{{{blankdetails3}}}
{{{blankdetailstitle4}}}	{{{blankdetails4}}}
Statistics
Vessel arrivals	{{{arrivals}}}
Annual cargo tonnage	{{{cargotonnage}}}
Annual container volume	{{{containervolume}}}
Annual TEU	{{{teu}}}
Value of cargo	{{{cargovalue}}}
Passenger traffic	{{{passengertraffic}}}
Annual revenue	{{{revenue}}}
Net income	{{{profit}}}
{{{blankstatstitle1}}}	{{{blankstats1}}}
{{{blankstatstitle2}}}	{{{blankstats2}}}
{{{blankstatstitle3}}}	{{{blankstats3}}}
Website {{{website}}}

All fields are optional, if left blank they will not appear. The 'Details' have four additional blank spots, and 'Statistics' have three blank spots, to facilitate additional field entries and allow for maximum flexibility.

full version

short version

{{Infobox port |embed = |name = |image = |image_alt = |image_size = |image_caption = |logo = |logo_alt = |logo_size = |logo_caption = |pushpin_map = |pushpin_map_geomask= |pushpin_map_zoom = |pushpin_map_caption= |native_name = |native_name_lang = |country = |location = |coordinates = |coordinates_footnotes= |grid_name = |grid_position = |locode = |built = |opened = |closed = |operated = |owner = |type = |sizewater = |sizeland = |size = |berths = |ships = |wharfs = |piers = |draft_depth = |air_draft = |length_of_approach_channel = |platforms = |lines = |gauge = |streets = |trucks = |employees = |leadershiptitle = |leader = |blankdetailstitle1 = |blankdetails1 = |blankdetailstitle2 = |blankdetails2 = |blankdetailstitle3 = |blankdetails3 = |blankdetailstitle4 = |blankdetails4 = |arrivals = |cargotonnage = |containervolume = |teu = |cargovalue = |passengertraffic = |revenue = |profit = |blankstatstitle1 = |blankstats1 = |blankstatstitle2 = |blankstats2 = |blankstatstitle3 = |blankstats3 = |website = |embedded = }}

{{Infobox port |name = |image = |image_size = |image_caption = |pushpin_map = |country = |native_name = |native_name_lang= |location = |coordinates = |locode = |opened = |operated = |owner = |type = |sizewater = |sizeland = |size = |berths = |wharfs = |piers = |draft_depth = |employees = |arrivals = |cargotonnage = |containervolume = |cargovalue = |passengertraffic= |website = }}

Usage as a child template

The embed parameter is used when embedding this infobox into another (see the Template:Infobox documentation which explains embedding and subboxes).

{{Infobox ABC
|name= 
|<!-- etc. -->
|embedded=<!-- or module= -->
  {{Infobox port
  |embed= yes
  |<!-- etc. -->
  }}
}}

Embedding other templates

The embedded parameter is used for embedding other templates into this infobox (see Wikipedia:Infobox modules).

{{Infobox port
|name= 
|<!-- etc. -->
|embedded=
  {{Infobox ABC
  |embed= yes
  |<!-- etc. -->
  }}
}}

Mapframe maps

• Basic parameters:
  • mapframe – Specify yes or no to show or hide the map, overriding the default. Default: no
    • The default value of the mapframe parameter is also modified by the internal onByDefault parameter. Default: yes
  • mapframe-caption – Caption for the map. Default: |pushpin_map_caption= or "Click on the map for a fullscreen view"
  • mapframe-custom – Use a custom map instead of the automatic mapframe. Specify either a {{maplink}} template, or another template that generates a mapframe map, or an image name. If used, the subsequent mapframe parameters will be ignored. Default: not specified
  • mapframe-id or id or qid – Id (Q-number) of Wikidata item to use. Default: item for current page
  • mapframe-coordinates or mapframe-coord or coordinates or coord – Coordinates to use, instead of any on Wikidata. Use the {{Coord}} template, e.g. |coord={{Coord|12.34|N|56.78|E}}. Default: |coordinates=
  • mapframe-wikidata – Set to yes to show shape/line features from the wikidata item, if any, when |coord= is set. Default: not specified
• Customise which features are displayed:
  • mapframe-shape – Turn off display of shape feature by setting to none. Use an inverse shape (geomask) instead of a regular shape by setting to inverse. Default: not specified
  • mapframe-point – Turn off display of point feature by setting to none. Force point marker to be displayed by setting to on. Default: not specified
  • mapframe-line – Turn off display of line feature by setting to none. Default: not specified
  • mapframe-geomask – Wikidata item to use as a geomask (everything outside the boundary is shaded darker). Can either be a specific Wikidata item (Q-number), or a property that specifies the item to use (e.g. P17 for country (P17), P131 for located in the administrative territorial entity (P131)). Default: if |pushpin_map_geomask=, P17
  • mapframe-switcher – set to auto or geomasks or zooms to enable Template:Switcher-style switching between multiple mapframes. Default: not specified
    • auto – switch geomasks found in location (P276) and located in the administrative territorial entity (P131) statements on the page's Wikidata item, searching recursively. E.g. an item's city, that city's state, and that state's country.
    • geomasks – switch between the geomasks specified as a comma-separated list of Wikidata items (Q-numbers) in the mapframe-geomask parameter
    • zooms – switch between "zoomed in"/"zoomed midway"/"zoomed out", where "zoomed in" is the default zoom (with a minimum of 3), "zoomed out" is 1, and "zoomed midway" is the average
• Other optional parameters:
  • mapframe-frame-width or mapframe-width – Frame width. Default: {{Digits}} over |image_size= or 280px
  • mapframe-frame-height or mapframe-height – Frame height. Default: 200
  • mapframe-shape-fill – Color used to fill shape features. Default: #606060
  • mapframe-shape-fill-opacity – Opacity level of shape fill, a number between 0 and 1. Default: 0.5
  • mapframe-stroke-color or mapframe-stroke-colour – Color of line features, and outlines of shape features. Default: #ff0000
  • mapframe-stroke-width – Width of line features, and outlines of shape features; default is "5". Default: 5
  • mapframe-marker – Marker symbol to use for coordinates; see mw:Help:Extension:Kartographer/Icons for options. Default: |marker= or |harbor=
    • Can also be set to blank to override any default marker symbol
  • mapframe-marker-color or mapframe-marker-colour – Background color for the marker. Default: #005E80
  • mapframe-geomask-stroke-color or mapframe-geomask-stroke-colour – Color of outline of geomask shape. Default: if |pushpin_map_geomask=, #000000
  • mapframe-geomask-stroke-width – Width of outline of geomask shape. Default: if |pushpin_map_geomask=, 0.5
  • mapframe-geomask-fill – Color used to fill outside geomask features. Default: if |pushpin_map_geomask=, #BABABA
  • mapframe-geomask-fill-opacity – Opacity level of fill outside geomask features, a number between 0 and 1. Default: 0.5
  • mapframe-zoom – Set the zoom level, from "1" (map of earth) to "18" (maximum zoom in), to be used if the zoom level cannot be determined automatically from object length or area. Default: |pushpin_map_zoom= or |mapframe_zoom= or 11
  • mapframe-length_km or mapframe-length_mi or mapframe-area_km2 or mapframe-area_mi2 – Determine zoom level by passing in object's length (in kilometres or miles) or area (in square kilometres or square miles). Default: not specified
  • mapframe-frame-coordinates or mapframe-frame-coord – Alternate latitude and longitude coordinates for initial placement of map, using {{coord}}. Default: derived from item coordinates
  • mapframe-type – Set the type of the object, with the same usage as {{coord}}. Default: not specified
  • mapframe-population – Set the population, useful with type="city", for {{Infobox dim}}. Default: not specified

Parameter descriptions

• |embed=
• |name= full name of port (in English)
• |image= filename of image of the port
• |image_alt= text for accessible caption
• |image_size= width of image in px (use only for images smaller than 250px)
• |image_caption= text for caption beneath image
• |logo= filename of official logo image for the port
• |logo_alt= alt text for the logo image
• |logo_size= width of logo image in px (use only for images smaller than 250px)
• |logo_caption= caption for logo image
• |pushpin_map= the name of a {{location map}} to display
• |pushpin_map_geomask= if set to 'Yes', the map with highlight the country and grey the rest
• |pushpin_map_zoom= set zoom level for the map
• |pushpin_map_caption= caption for pushpin map
• |country= United Nations recognised country within which the port is located
• |location= nearest city (also state/province/locale where relevant)
• |coordinates= latitude and longitude - use {{coord}} with |display=inline,title
• |coordinates_footnotes= footnotes for coordinates
• |grid_name=
• |grid_position=
• |locode= UN/Locode for the port
• |opened= year port was opened - use {{Start date and age}} with |df=y
• |closed= year port was closed (if it is no longer operating)
• |operated= operator name
• |owner= owner name
• |type= type of port - open roadstead, coastal natural, coastal breakwater, coastal tide gate, river natural, river basin, river tide gate, lake, canal, offshore terminal, dry port - do not classify by cargo type (oil, container, etc) as this inevitably changes over time
• |sizewater= size/area of the water surface of the port
• |sizeland= size/area of the land of the port
• |size= total combined area of land and water
• |berths= number of berths within the port
• |wharfs= number of wharves within the port
• |piers= number of piers within the port
• |draft_depth= maximum draft or depth (please specify which) available within the port
• |air_draft= any above-water height restrictions for vessels using the port; please also specify location of restriction, e.g. Hamilton Bridge.
• |employees= number of employees at the port
• |leadershiptitle= job title of the port CEO
• |leader= name of the port CEO
• |blankdetailstitle1=
• |blankdetails1=
• |blankdetailstitle2=
• |blankdetails2=
• |blankdetailstitle3=
• |blankdetails3=
• |blankdetailstitle4=
• |blankdetails4=
• |arrivals= number of vessel arrivals at the port in an average or recent year
• |cargotonnage= annual tonnage of cargo handled at the port
• |containervolume= annual number of twenty foot equivalent unit (TEU) moved onto or off vessels
• |cargovalue= annual value of cargo handled at the port
• |passengertraffic= annual number of passengers handled at the port
• |revenue= annual revenue of the port
• |profit= annual profit of the port
• |blankstatstitle1=
• |blankstats1=
• |blankstatstitle2=
• |blankstats2=
• |blankstatstitle3=
• |blankstats3=
• |website= official website of the port (please use {{official URL}})
• |embedded=

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Infobox port in articles based on its TemplateData.

TemplateData for Infobox port

Infobox for use on articles about ports

Template parameters

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
embed	embed	no description	Unknown	optional
name	name	name of port	Unknown	optional
image	image	filename of image of the port	File	optional
image_alt	image_alt	text for accessible caption	Unknown	optional
image_size	image_size	width of image in px (use only for images smaller than 250px)	Unknown	optional
image_caption	image_caption	text for caption beneath image	Unknown	optional
logo	logo	filename of official logo image for the port	Unknown	optional
logo_alt	logo_alt	alt text for the logo image	Unknown	optional
logo_size	logo_size	width of logo image in px (use only for images smaller than 250px)	Unknown	optional
logo_caption	logo_caption	caption for logo image	Unknown	optional
pushpin_map	pushpin_map	any value in this field will cause a map to appear	Unknown	optional
pushpin_map_geomask	pushpin_map_geomask	if set to "Yes", the map with highlight the country and grey the rest	Unknown	optional
pushpin_map_zoom	pushpin_map_zoom	set zoom level for the map	Unknown	optional
pushpin_map_caption	pushpin_map_caption	caption for pushpin map	Unknown	optional
country	country	UN recognised country within which the port is located	Unknown	optional
location	location	nearest city (also state/province/locale where relevant)	Unknown	optional
coordinates	coordinates	latitude and longitude - Use {{coord}} with |display=inline,title	Unknown	optional
coordinates_footnotes	coordinates_footnotes	footnotes for coordinates	Unknown	optional
grid_name	grid_name	no description	Unknown	optional
grid_position	grid_position	no description	Unknown	optional
locode	locode	UN/Locode for the port	Unknown	optional
opened	opened	year port was opened	Unknown	optional
closed	closed	year port was closed (if it is no longer operating)	Unknown	optional
operated	operated	operator name	Unknown	optional
owner	owner	owner name	Unknown	optional
type	type	Type of port - do not classify by cargo type (oil, container, etc) as this inevitably changes over time Suggested values open roadstead coastal natural coastal breakwater coastal tide gate river natural river basin river tide gate lake canal offshore terminal dry port	Unknown	optional
sizewater	sizewater	size/area of the water surface of the port	Unknown	optional
sizeland	sizeland	size/area of the land of the port	Unknown	optional
size	size	no description	Unknown	optional
berths	berths	number of berths within the port	Unknown	optional
wharfs	wharfs	number of wharves within the port	Unknown	optional
piers	piers	number of piers within the port	Unknown	optional
draft_depth	draft_depth	maximum draft or depth (please specify which) available within the port	Unknown	optional
air_draft	air_draft	any above-water height restrictions for vessels using the port. Please also specify location of restriction, e.g. Hamilton Bridge.	Unknown	optional
employees	employees	number of employees at the port	Unknown	optional
leadershiptitle	leadershiptitle	job title of the port CEO	Unknown	optional
leader	leader	name of the port CEO	Unknown	optional
blankdetailstitle1	blankdetailstitle1	no description	Unknown	optional
blankdetails1	blankdetails1	no description	Unknown	optional
blankdetailstitle2	blankdetailstitle2	no description	Unknown	optional
blankdetails2	blankdetails2	no description	Unknown	optional
blankdetailstitle3	blankdetailstitle3	no description	Unknown	optional
blankdetails3	blankdetails3	no description	Unknown	optional
blankdetailstitle4	blankdetailstitle4	no description	Unknown	optional
blankdetails4	blankdetails4	no description	Unknown	optional
arrivals	arrivals	number of vessel arrivals at the port in an average or recent year	Unknown	optional
cargotonnage	cargotonnage	annual tonnage of cargo handled at the port	Unknown	optional
containervolume	containervolume	annual number of TEUs moved onto or off vessels	Unknown	optional
cargovalue	cargovalue	annual value of cargo handled at the port	Unknown	optional
passengertraffic	passengertraffic	annual number of passengers handled at the port	Unknown	optional
revenue	revenue	annual revenue of the port	Unknown	optional
profit	profit	annual profit of the port	Unknown	optional
blankstatstitle1	blankstatstitle1	no description	Unknown	optional
blankstats1	blankstats1	no description	Unknown	optional
blankstatstitle2	blankstatstitle2	no description	Unknown	optional
blankstats2	blankstats2	no description	Unknown	optional
blankstatstitle3	blankstatstitle3	no description	Unknown	optional
blankstats3	blankstats3	no description	Unknown	optional
website	website	official website of the port (please use {{official}})	Unknown	optional
embedded	embedded	no description	Unknown	optional
caption	caption	no description	Unknown	optional
Wikidata ID	qid	ID in WIkidata Example Q1129891	String	optional
marker	marker	no description	Unknown	optional
native_name	native_name	no description	Unknown	optional
native_name_lang	native_name_lang	no description	Unknown	optional
built	built	no description	Unknown	optional
ships	ships	no description	Unknown	optional
length_of_approach_channel	length_of_approach_channel	no description	Unknown	optional
platforms	platforms	no description	Unknown	optional
lines	lines	no description	Unknown	optional
gauge	gauge	no description	Unknown	optional
streets	streets	no description	Unknown	optional
trucks	trucks	no description	Unknown	optional
teu	teu	for seaports or harbors that primarily handle cargo containers, a number measured in Twenty-Foot Equivalent Units (TEUs)	Unknown	optional

Tracking category

• Category:Pages using infobox port with unknown parameters (0)