Template:Infobox port/doc

From WWII Archives

Revision as of 20:07, 19 March 2023 by Paul Sidle (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Usage

{{{name}}}
[[File:{{{image}}}|{{{image_size}}}|alt={{{image_alt}}}]]
{{{image_caption}}}
[[File:{{{logo}}}|{{{logo_size}}}|alt={{{logo_alt}}}]]
{{{logo_caption}}}
Native name
{{{native_name}}}
Location
Country{{{country}}}
Location{{{location}}}
Coordinates{{{coordinates}}} {{{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}}}
No. of platforms{{{platforms}}}
Rail lines{{{lines}}}
Rail gauge{{{gauge}}}
Street access{{{streets}}}
Truck types{{{trucks}}}
Employees{{{employees}}}
{{{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             = 
|opened             = 
|closed             = 
|operated           = 
|owner              = 
|type               = 
|sizewater          = 
|sizeland           = 
|size               = 
|berths             = 
|ships              = 
|wharfs             = 
|piers              = 
|draft_depth        = 
|air_draft          = 
|platforms          = 
|lines              = 
|gauge              = 
|streets            = 
|trucks             = 
|employees          = 
|leadershiptitle    = 
|leader             = 
|blankdetailstitle1 = 
|blankdetails1      = 
|blankdetailstitle2 = 
|blankdetails2      = 
|blankdetailstitle3 = 
|blankdetails3      = 
|blankdetailstitle4 = 
|blankdetails4      = 
|arrivals           = 
|cargotonnage       = 
|containervolume    = 
|cargovalue         = 
|teu                = 
|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. -->
  }}
}}

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= any value in this field will cause a map to appear
  • |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 websiter of the port (please us {{official}})
  • |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.

ParameterDescriptionTypeStatus
embedembed

no description

Unknownoptional
namename

name of port

Unknownoptional
imageimage

filename of image of the port

Fileoptional
image_altimage_alt

text for accessible caption

Unknownoptional
image_sizeimage_size

width of image in px (use only for images smaller than 250px)

Unknownoptional
image_captionimage_caption

text for caption beneath image

Unknownoptional
logologo

filename of official logo image for the port

Unknownoptional
logo_altlogo_alt

alt text for the logo image

Unknownoptional
logo_sizelogo_size

width of logo image in px (use only for images smaller than 250px)

Unknownoptional
logo_captionlogo_caption

caption for logo image

Unknownoptional
pushpin_mappushpin_map

any value in this field will cause a map to appear

Unknownoptional
pushpin_map_geomaskpushpin_map_geomask

if set to "Yes", the map with highlight the country and grey the rest

Unknownoptional
pushpin_map_zoompushpin_map_zoom

set zoom level for the map

Unknownoptional
pushpin_map_captionpushpin_map_caption

caption for pushpin map

Unknownoptional
countrycountry

UN recognised country within which the port is located

Unknownoptional
locationlocation

nearest city (also state/province/locale where relevant)

Unknownoptional
coordinatescoordinates

latitude and longitude - Use {{coord}} with |display=inline,title

Unknownoptional
coordinates_footnotescoordinates_footnotes

footnotes for coordinates

Unknownoptional
grid_namegrid_name

no description

Unknownoptional
grid_positiongrid_position

no description

Unknownoptional
locodelocode

UN/Locode for the port

Unknownoptional
openedopened

year port was opened

Unknownoptional
closedclosed

year port was closed (if it is no longer operating)

Unknownoptional
operatedoperated

operator name

Unknownoptional
ownerowner

owner name

Unknownoptional
typetype

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
Unknownoptional
sizewatersizewater

size/area of the water surface of the port

Unknownoptional
sizelandsizeland

size/area of the land of the port

Unknownoptional
sizesize

no description

Unknownoptional
berthsberths

number of berths within the port

Unknownoptional
wharfswharfs

number of wharves within the port

Unknownoptional
pierspiers

number of piers within the port

Unknownoptional
draft_depthdraft_depth

maximum draft or depth (please specify which) available within the port

Unknownoptional
air_draftair_draft

any above-water height restrictions for vessels using the port. Please also specify location of restriction, e.g. Hamilton Bridge.

Unknownoptional
employeesemployees

number of employees at the port

Unknownoptional
leadershiptitleleadershiptitle

job title of the port CEO

Unknownoptional
leaderleader

name of the port CEO

Unknownoptional
blankdetailstitle1blankdetailstitle1

no description

Unknownoptional
blankdetails1blankdetails1

no description

Unknownoptional
blankdetailstitle2blankdetailstitle2

no description

Unknownoptional
blankdetails2blankdetails2

no description

Unknownoptional
blankdetailstitle3blankdetailstitle3

no description

Unknownoptional
blankdetails3blankdetails3

no description

Unknownoptional
blankdetailstitle4blankdetailstitle4

no description

Unknownoptional
blankdetails4blankdetails4

no description

Unknownoptional
arrivalsarrivals

number of vessel arrivals at the port in an average or recent year

Unknownoptional
cargotonnagecargotonnage

annual tonnage of cargo handled at the port

Unknownoptional
containervolumecontainervolume

annual number of TEUs moved onto or off vessels

Unknownoptional
cargovaluecargovalue

annual value of cargo handled at the port

Unknownoptional
passengertrafficpassengertraffic

annual number of passengers handled at the port

Unknownoptional
revenuerevenue

annual revenue of the port

Unknownoptional
profitprofit

annual profit of the port

Unknownoptional
blankstatstitle1blankstatstitle1

no description

Unknownoptional
blankstats1blankstats1

no description

Unknownoptional
blankstatstitle2blankstatstitle2

no description

Unknownoptional
blankstats2blankstats2

no description

Unknownoptional
blankstatstitle3blankstatstitle3

no description

Unknownoptional
blankstats3blankstats3

no description

Unknownoptional
websitewebsite

official websiter of the port (please us {{official}})

Unknownoptional
embeddedembedded

no description

Unknownoptional

Tracking category