View source for Template:Infobox port-of-entry/doc

{{Documentation subpage}}
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Check for unknown parameters}}

== Usage ==
{{Infobox port-of-entry
| embed                  = 
| name                   = {{{name}}}
| image                  = Porto de Valparaiso - Chile - by Sérgio Schmiegelow.jpg
| image_alt              = {{{image_alt}}}
| image_size             = 
| image_caption          = {{{image_caption}}}
| logo                   = File:Indic TechCom Sample Logo 07.svg
| logo_alt               = {{{logo_alt}}}
| logo_size              = 100px
| logo_caption           = {{{logo_caption}}}
| pushpin_map            = Yes
| pushpin_map_geomask    = 
| pushpin_map_zoom       = 
| country                = {{{country}}}
| location               = {{{location}}}
| coordinates            = {{Coordinates|51.8850|4.2867}}
| coordinates_footnotes  = {{{coordinates_footnotes}}}
| grid_name              = {{{grid_name}}}
| grid_position          = {{{grid_position}}}
| locode                 = {{{locode}}}
| opened                 = {{{opened}}}
| operated               = {{{operated}}}
| owner                  = {{{owner}}}
| type                   = {{{type}}}
| sizewater              = {{{sizewater}}}
| sizeland               = {{{sizeland}}}
| size                   = {{{size}}}
| berths                 = {{{berths}}}
| wharfs                 = {{{wharfs}}}
| piers                  = {{{piers}}}
| draft_depth            = {{{draft_depth}}}
| air_draft              = {{{air_draft}}}
| employees              = {{{employees}}}
| leadershiptitle        = {{{leadershiptitle}}}
| leader                 = {{{leader}}}
| blankdetailstitle1     = {{{blankdetailstitle1}}}
| blankdetails1          = {{{blankdetails1}}}
| blankdetailstitle2     = {{{blankdetailstitle2}}}
| blankdetails2          = {{{blankdetails2}}}
| blankdetailstitle3     = {{{blankdetailstitle3}}}
| blankdetails3          = {{{blankdetails3}}}
| arrivals               = {{{arrivals}}}
| cargotonnage           = {{{cargotonnage}}}
| containervolume        = {{{containervolume}}}
| cargovalue             = {{{cargovalue}}}
| passengertraffic       = {{{passengertraffic}}}
| revenue                = {{{revenue}}}
| profit                 = {{{profit}}}
| blankstatstitle1       = {{{blankstatstitle1}}}
| blankstats1            = {{{blankstats1}}}
| blankstatstitle2       = {{{blankstatstitle2}}}
| blankstats2            = {{{blankstats2}}}
| blankstatstitle3       = {{{blankstatstitle3}}}
| blankstats3            = {{{blankstats3}}}
| website                = {{{website}}}
| embedded               = 
}}

All fields are optional, if left blank they will not appear. Both the "Details" and "Statistics" have three blank spots to cover additional entries and allow for maximum flexibility.

{|
! Full version
! Short version
|- style="vertical-align:top;"
|<pre>
{{Infobox port-of-entry
| embed                  = 
| name                   = 
| image                  = 
| image_alt              = 
| image_size             = 
| image_caption          = 
| logo                   = 
| logo_alt               = 
| logo_size              = 
| logo_caption           = 
| pushpin_map            = 
| pushpin_map_geomask    = 
| pushpin_map_zoom       = 
| country                = 
| location               = 
| coordinates            = 
| coordinates_footnotes  = 
| grid_name              = 
| grid_position          = 
| locode                 = 
| opened                 = 
| operated               = 
| owner                  = 
| type                   = 
| sizewater              = 
| sizeland               = 
| size                   = 
| berths                 = 
| wharfs                 = 
| piers                  = 
| draft_depth            = 
| air_draft              = 
| employees              = 
| leadershiptitle        = 
| leader                 = 
| blankdetailstitle1     = 
| blankdetails1          = 
| blankdetailstitle2     = 
| blankdetails2          = 
| blankdetailstitle3     = 
| blankdetails3          = 
| arrivals               = 
| cargotonnage           = 
| containervolume        = 
| cargovalue             = 
| passengertraffic       = 
| revenue                = 
| profit                 = 
| blankstatstitle1       = 
| blankstats1            = 
| blankstatstitle2       = 
| blankstats2            = 
| blankstatstitle3       = 
| blankstats3            = 
| website                = 
| embedded               = 
}}</pre>
|<pre>
{{Infobox port
| name             = 
| image            = 
| image_size       = 
| image_caption    = 
| pushpin_map      = 
| country          = 
| location         = 
| coordinates      = 
| locode           =
| opened           = 
| operated         = 
| owner            = 
| type             = 
| sizewater        = 
| sizeland         = 
| size             = 
| berths           = 
| wharfs           = 
| piers            = 
| employees        = 
| arrivals         = 
| cargotonnage     = 
| containervolume  = 
| cargovalue       = 
| passengertraffic = 
| website          = 
}}</pre>
|}

=== Use as a child template ===
The '''embed''' parameter is used when embedding this infobox into another (see the [[Template:Infobox]] documentation which explains [[Template:Infobox/doc#Embedding|embedding]] and [[Template:Infobox/doc#Subboxes|subboxes]]).

<pre style="overflow: auto;">
{{Infobox ABC
| name        =
| <!-- etc. -->
| embedded    = <!-- or module= -->
  {{Infobox port-of-entry
  | embed = yes
  | <!-- etc. -->
  }}
}}
</pre>

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

<pre style="overflow: auto;">
{{Infobox port-of-entry
| name =
| <!-- etc. -->
| embedded =
  {{Infobox ABC
  | embed = yes
  | <!-- etc. -->
  }}
}}
</pre>

==Parameter descriptions ==
* {{para|embed}}
* {{para|name}} name of port-of-entry
* {{para|image}} filename of image of the port=of-entry
* {{para|image_size}} width of image in px (use only for images smaller than 250px)
* {{para|image_caption}} text for caption beneath image
* {{para|logo}} filename of official logo image for the port
* {{para|logo_alt}} alt text for the logo image
* {{para|logo_size}} width of logo image in px (use only for images smaller than 250px) 
* {{para|logo_caption}} caption for logo image
* {{para|pushpin_map}} any value in this field will cause a map to appear
* {{para|pushpin_map_geomask}} if set to "Yes", the map with highlight the country and grey the rest
* {{para|pushpin_map_zoom}} set zoom level for the map
* {{para|country}} UN recognised country within which the port is located
* {{para|location}}  nearest city (also state/province/locale where relevant)
* {{para|coordinates}} latitude and longitude
** Use {{tlx|coord}} with {{para|display|inline,title}}
* {{para|coordinates_footnotes}} footnotes for coordinates
* {{para|grid_name}}
* {{para|grid_position}}
* {{para|locode}} [[UN/Locode]] for the port 
* {{para|opened}} year port was opened 
* {{para|operated}} Operated by
* {{para|owner}} Owner
* {{para|type}} Type of port - open roadstead, coastal natural, coastal breakwater, coastal breakwater, coastal tide gate, river natural, river basin, river tide gate, lake, canal, offshore terminal - do not classify by cargo type (oil, container, etc) as this inevitably changes over time
* {{para|sizewater}} size/area of the water surface of the port
* {{para|sizeland}} size/area of the land of the port 
* {{para|size}}
* {{para|berths}} number of berths within the port
* {{para|wharfs}} number of wharves within the port
* {{para|piers}} number of piers within the port
* {{para|draft_depth}} maximum draft or depth (please specify which) available within the port
* {{para|air_draft}} any above-water height restrictions for vessels using the port. Please also specify location of restriction, e.g. Hamilton Bridge.  
* {{para|employees}} number of employees at the port
* {{para|leadershiptitle}} job title of the port CEO
* {{para|leader}} name of the port ceo
* {{para|blankdetailstitle1}}
* {{para|blankdetails1}}
* {{para|blankdetailstitle2}}
* {{para|blankdetails2}}
* {{para|blankdetailstitle3}}
* {{para|blankdetails3}}
* {{para|arrivals}} number of vessel arrivals at the port in an average or recent year
* {{para|cargotonnage}} annual tonnage of cargo handled at the port
* {{para|containervolume}} annual number of [[Twenty foot equivalent unit|TEU]]s moved onto or off vessels  
* {{para|cargovalue}} annual value of cargo handled at the port
* {{para|passengertraffic}} annual number of passengers handled at the port
* {{para|revenue}} annual revenue of the port
* {{para|profit}} annual profit of the port
* {{para|blankstatstitle1}}
* {{para|blankstats1}}
* {{para|blankstatstitle2}}
* {{para|blankstats2}}
* {{para|blankstatstitle3}}
* {{para|blankstats3}}
* {{para|website}} official websiter of the port (please us {{tl|official}})
* {{para|embedded}}

== Tracking category ==
* {{Category link with count|Pages using infobox port with unknown parameters}}
* {{Category link with count|Pages using infobox port with deprecated parameters}}

<includeonly>
{{Sandbox other||
[[Category:Transport infobox templates|Port]]
[[Category:Place infobox templates|Port]]
[[Category:Embeddable templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>