__EXPECTED_UNCONNECTED_PAGE__

Template:High-use


This infobox is part of WikiProject Historic sites. The infobox is meant for use on articles about sites which have been deemed worthy of protection by local, state, provincial, national, or other governmental bodies. Supported designations are listed at the WikiProject's home page. If you would like to add a new designation, contact members of the WikiProject by leaving a comment at the WikiProject talk page and/or see Template:Designation/doc. An explanation of how to use this infobox and what each parameter does is listed below, including examples.

Usage

Unknown
[[File:[[File:{{{image}}}|300px|alt={{{alt}}}|upright=1.35]]|210px|]]
Some attributes
First Unknown
Second Unknown
Third Unknown
Other attributes

To get started, copy and paste the following blank template into the top of the article.

{{Infobox historic site
| embed             = 
| name              = 
| native_name       = 
| native_name_lang  = 
| native_name2      = 
| native_name_lang2 = 
| native_name3      = 
| native_name_lang4 = 
| other_name        = 
| image             = 
| image_size        = 
| image_upright     = 
| alt               = 
| caption           = 
| image_map         = 
| image_map_size    = 
| image_map_upright = 
| image_map_alt     = 
| image_map_caption = 
| coordinates       = <!-- {{coord|LAT|LON|format=dms|display=inline,title}} -->
| coord_ref         = 
| mapframe          = <!-- Set to yes to always show a mapframe map -->
| pushpin_map       = 
| pushpin_caption   = 
| pushpin_alt       = 
| pushpin_relief    = 
| pushpin_map_size  = 
| pushpin_mark      = 
| pushpin_label     = 
| type              = 
| location          = 
| etymology         = 
| epochs            = 
| cultures          = 
| dependency_of     = 
| occupants         = 
| region            = 
| nearest_city      = 
| part_of           = 
| gbgridref         = 
| gbgridref_note    = 
| grid_name         = 
| grid_position     = 
| beginning_label   = 
| beginning_date    = 
| formed            = 
| founded           = 
| founder           = 
| built             = 
| builder           = 
| built_for         = 
| original_use      = 
| demolished        = 
| abandoned         = 
| rebuilt           = 
| restored          = 
| restored_by       = 
| condition         = 
| current_use       = 
| end_label         = 
| end_date          = 
| archaeologists    = 
| discovered        = 
| excavations       = 
| material          = 
| elevation         = 
| height            = <!-- use [[Template:Convert]]  -->
| length            = <!-- use [[Template:Convert]]  -->
| width             = <!-- use [[Template:Convert]]  -->
| area              = <!-- use [[Template:Convert]]  -->
| volume            = <!-- use [[Template:Convert]]  -->
| diameter          = <!-- use [[Template:Convert]]  -->
| circumference     = <!-- use [[Template:Convert]]  -->
| architect         = 
| sculptor          = 
| architecture      = 
| year_of_event     = 
| events            = 
| governing_body    = 
| owner             = 
| management        = 
| visitors_num      = 
| visitors_year     = 
| visitors_ref      = 
| public_access     = 
| website           = <!-- {{URL|example.com}} -->
| nhle              = 
| hillfort          = 
| megaj             = 
| hes               = 
| embedded          = 
| notes             = 

| other_designation       = 
| designation1            = 
| designation1_offname    = 
| designation1_type       = 
| designation1_criteria   = 
| designation1_date       = 
| delisted1_date          = 
| designation1_partof     = 
| designation1_number     = 
| designation1_free1name  = 
| designation1_free1value = 
| designation1_free2name  = 
| designation1_free2value = 
| designation1_free3name  = 
| designation1_free3value = 
<!-- Can be repeated up to 6 times -->
| designation6            = 
| designation6_offname    = 
| designation6_type       = 
| designation6_criteria   = 
| designation6_date       = 
| delisted6_date          = 
| designation6_partof     = 
| designation6_number     = 
| designation6_free1name  = 
| designation6_free1value = 
| designation6_free2name  = 
| designation6_free2value = 
| designation6_free3name  = 
| designation6_free3value = 
}}

Parameters

All fields are optional. The infobox is segmented into several basic parts, including the name of the site, an image, a map of the site's location, basic information about the site, and information pertaining to the registers on which the site is listed. Wikilinks and other formatting are acceptable in any of the Infobox fields except map/image and coordinate parameters.

Please spend some time at the Historic sites WikiProject and its talk page for standards on presenting names, designations, and other data.

Parameter Description
embed Set to true to embed in another tempalte
name Most recognizable name of the site. This may or may not be the official name given by any designation registers. See WP:TITLE for more information.
native_name The name of the site in its native language. For sites in countries that have more than one common language, choose the language most closely associated with the specific region of the country in which the site is located, and use the native_name2 and native_name3 parameters for other languages. Only three languages are supported at this time.
native_name2
native_name3
native_name_lang The language of the native name or its corresponding ISO 639-1, ISO 639-2 or ISO 639-3 language code. This uses the {{lang}} templates to display a link to the article about the language. If a language name (e.g. "French", "Russian", etc.) is specified, {{Lang2iso}} converts it into its ISO abbreviation.
native_name_lang2
native_name_lang3
other_name Other name(s) by which the site is known. Most often this entry is used best for alternative names of the site in English. The transliteration of a foreign-language name into English often produces multiple English names with slightly different spellings.
image Name of main image displayed. Only the title of the image (i.e. Don't include "File:" or "Image:").
image_size Width of main image in pixels.
caption Caption for main image. Links can be included in this text.
alt Alt text for image. For more information see WP:ALT.
image_map Name of site map image displayed. Only the title of the image (i.e. Don't include "File:" or "Image:").
image_map_size Width of site map image in pixels.
image_map_caption Caption for site map image. Links can be included in this text.
image_map_alt Alt text for image. For more information see WP:ALT.
coordinates The location using {{Coords}}
coord_ref A reference for the coordinates if avaliable
pushpin_map If you want a map to be displayed, set this parameter to the region in which the site is located. See {{Location map}} for valid regions. If the parameter is left blank, no location map will be displayed. A mapframe map may still be displayed; see below.
pushpin_caption Caption for the map.
pushpin_relief Any non-blank value (yes, 1, etc.) will cause the template to display a relief map image, where available. For additional information, see Template:Location map#Relief parameter.
pushpin_mark If the template is set to display a location map, this parameter will set the symbol used as the "pin" to mark the site's location. If not specified, defaults to File:Red pog.svg (File:Red pog.svg).
type Type of object (e.g. Church, Burial Mound)
location City, country, state, province, etc. in which site is located. If known, the postal address of the site can be included here as well. It is suggested that links are provided to the cities and countries.
etymology
epochs Period(s) during which the site was in use (e.g., Bronze Age II–Iron Age I)
cultures Cultures which evidence has shown to have occupied the site. This can be an archaeological culture but also a culture in the sense of a people. Mention the archaeological culture in the form of a noun minus the word "culture" and mention a people in the form of an adjective. For example, a wikilink to [[Vinča culture]] becomes [[Vinča culture|Vinča]].
dependency_of If a satellite dependency (e.g., outlying village, quarry, etc.), specify the controlling nearby city or site
occupants Significant historical figures occupying or associated with the site
region
nearest_city
part_of Name of main site, if part of larger site or complex
gbgridref For sites in Great Britain an Ordnance Survey grid reference may be given. Spaces are allowed - see details of format.
gbgridref_note
grid_name ?
grid_position ?
formed If the site is a natural land formation or habitat, this parameter describes when it was formed.
founded If the site is a city or locality which was founded by a group of people, this parameter describes when it was founded.
founder If the site is a city or locality which was founded by a group of people, this parameter describes who did the founding
built If the site is a building or manmade structure, this parameter describes when it was built.
beginning_label If none of the above labels quite apply to the article's subject (i.e. if the place was "settled" or "discovered"), these parameters can be used to show a customized date. Example: |beginning_label=Settled and |beginning_date=15th century
beginning_date
builder If known, name of person or people who built the site
built_for If a building or structure was built for a specific person (such as a king or queen) or organization, this parameter identifies them.
original_use
demolished If the site is no longer standing because it has been demolished, this is the date of demolition.
abandoned If the site was abandoned, this is the date it was abandoned.
rebuilt If the site was rebuilt, this is the date it was rebuilt.
restored If the site was restored, this is the date it was restored.
restored_by The person who restored or remodelled the building.
condition Present condition of the remains (no extant remains, restored, ruined, etc.)
current_use
end_label
end_date
archaeologists Superintending archeologist(s)
discovered Year of discovery.
excavations Years of major excavation work.
material Significant construction materials (stone, plaster, concrete, brick, wood)
elevation Elevation above sea level. Must use {{Convert}} to display English alongside metric measurements.
height Height of designated object, if applicable. Mostly used with statues, obelisks, and some buildings. Must use {{Convert}} to display English alongside metric measurements.
length Length of the site. Must use {{Convert}} to display English alongside metric measurements.
width Width of the site. Must use {{Convert}} to display English alongside metric measurements.
area Land area of the site. Mostly used with districts, parks, and other extended areas. Must use {{Convert}} to display English alongside metric measurements.
volume Volume of the site. Must use {{Convert}} to display English alongside metric measurements.
diameter Diameter of the site. Must use {{Convert}} to display English alongside metric measurements.
circumference Circumference of the site. Must use {{Convert}} to display English alongside metric measurements.
architect If the site is a building or manmade structure, this parameter names the architect. If Wikipedia contains an article about the architect, link to that article.
sculptor
architecture If the site is a building or manmade structure, this parameter describes the architectural style. Links are encouraged.
year_of_event
events Significant historical event(s) associated with the site
governing_body Body that owns/operates the historic site. If there is a Wikipedia article about the governing body, link to it. If the site is owned by a local or national government, be sure to provide adequate regional information.
owner Who owns the property or is it public?
management Pertinent info about the management of the site (private manager, admission fee, etc.)
visitors_num Most recent figure describing the number of visitors to the site in a given year along with a reference. If a specific year is not known, an estimated annual number of visitors can be included.
visitors_year
visitors_ref
public_access Is the site open to public visits (Yes, No, Limited)
website Use only if the site has an official web presence. Use {{Url}}
nhle Number of the site in the National Heritage List for England (NHLE Code), e.g. 1018385
hillfort number of the site in the Atlas of Hillforts of Britain and Ireland, e.g. 0425, do not include the country code (EN, WA, SC, NI, IR).
megaj Middle Eastern Geodatabase for Antiquities (MEGA) Jordan Number
hes number of the site in the Historic Environment Scotland database, e.g. SM90209
embedded Any other Infoboxes to embed within this one.
notes Any notes to appear at the bottom of the Infobox
other_designation
These can all be repeated up to 6 times by incrementing the number
designation1 Input the callname of the designation here. For a list of supported callnames, see Template:Designation/doc#Supported designations.
designation1_offname The official name of the historic site, as listed in the register. If the official name is the same as the common name at the top of the infobox, this field is not necessary. If more than one name is included on the register, include all of them.
designation1_type Some registers have certain types of designations (i.e. "Natural" and "Cultural", "Grade I" and "Grade II", etc.). If the type is closely associated with the designation, input that type here.
designation1_criteria Some registers require sites to meet specific criteria (normally one or more items in a list) for inclusion. If the criteria is known, input it here.
designation1_date Date when the site received this designation. Normally this parameter needs a reference (make sure it is properly formatted).
delisted1_date If a site has been removed from a designation's list, this is the date of delisting. Setting a value to this parameter causes the designation's color bar to turn grey and adds the word "Former" to the beginning. This parameter also needs a reference.
designation1_partof Some designations are part of larger designations (i.e. an individually designated building inside a designated district or an individually designated district in a designated city). For example, Ellis Island is a part of the Statue of Liberty National Monument; both are listed as New York City Landmarks. If the larger designation is listed on the same register, include the name of the larger designation here. If a Wikipedia article exists about that designation, link to it.
designation1_number Most registers include unique reference numbers for each site so that they can be searched for more easily than by name (There may be two Jones Houses on the register, but they have unique reference numbers). Include this reference number here.

Pushpin map

Below are the parameters used by Module:Location map to produce the pushpin map in this Infobox. These parameters are available for editors to set in articles that use this infobox. For the maps available, please consult available maps.

Parameter Description Default
|pushpin_map= The map(s) to display. For example, specifying England will use the values for England in Module:Location map/data/England.Multiple maps can be shown by providing a list of map names separated by #. For multiple maps, the first is shown by default. A reader can select the others with radio buttons. N/A
|pushpin_caption= The text of a caption to be displayed below the map. If not provided a default caption will be generated. Multiple captions can be shown when separated by ## (that's two). Location within MAPNAME
|pushpin_relief= 0/false/off will cause the template to display the map defined as image (generally not a relief map). 1/true/on will cause the template to display the map defined as image1 (generally a relief map). Any non-zero numeric value such as 2 or 3 will display image2 or image3, if those images are defined. Any other non-empty value will cause display of image1. See the example at Location map+/relief. 0
|pushpin_label= The text of the label to display next to the identifying mark; a wikilink can be used. You can enclose the label inside of {{nowrap}} if you want to make sure that it stays on a single line. N/A
|pushpin_label_size= The font size to use for the label, given as a percentage of the normal font size (<100=smaller, >100=larger); the default size is 90. Do not include %. For example, use |pushpin_label_size=80, not |pushpin_label_size=80%. If set to 0, the label is only displayed when the user hovers over the mark. 90
|pushpin_label_position= The position of the label relative to the identifying mark; valid values are left, right, top, bottom and none. This defaults to either left or right, depending on the coordinates of the marker and its position relative to the right border of the map image. When |pushpin_label_position=none, any defined label will not be displayed with the mark, but it will be used to create the default caption. N/A
|pushpin_mark= The name of an image file to display as the identifying mark; the default is Red pog.svg File:Red pog.svg. See examples at Commons:Location markers and Commons:Category:Map icons. Red pog.svg File:Red pog.svg
|pushpin_mark_size= The size of the identifying mark in pixels. Do not include px 8
|pushpin_alt= Alt text for map; used by screen readers. See WP:ALT. N/A
|pushpin_background= The background color to use for the label; see Web colors. The default is no background color, which shows the map image behind the label. N/A
|pushpin_map_size= Determines the width of the map in pixels, overriding any default values; do not include px. N/A

Mapframe parameters

  • Basic {{Infobox mapframe}} parameters:
    • mapframe – Specify yes or no to show or hide the map, overriding the default. Default: no, but also modified by onByDefault
      • Internal onByDefault parameter: yes, unless any of these are set: |pushpin_map=, |image_map=, |embed=
    • 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 from Wikidata d:Property:P625
    • mapframe-caption – Caption for the map. Default: blank (or if |mapframe-geomask= is set, "Location in geomask's label")
    • 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, most 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-wikidata – Set to yes to show all shape/line features from OpenStreetMap. Default: not specified
  • Customise which features are displayed:
  • Other optional parameters:
    • mapframe-frame-width or mapframe-width – Frame width. Default: 250
    • 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.1
    • mapframe-stroke-color or mapframe-stroke-colour – Color of line features, and outlines of shape features. Default: #ff0000
      • mapframe-line-stroke-color or mapframe-line-stroke-colour – Color of line features. Default: #ff0000
      • mapframe-shape-stroke-color or mapframe-shape-stroke-colour – Color of outlines of shape features. Default: #ff0000
    • mapframe-stroke-width – Width of line features, and outlines of shape features. Default: 2
      • mapframe-shape-stroke-width – Width of outlines of shape features. Default: 2
      • mapframe-line-stroke-width – Width of line features. Default: 5
    • mapframe-marker – Marker symbol to use for coordinates; see mw:Help:Extension:Kartographer/Icons for options. Default: historic
      • 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: #5E74F3
    • mapframe-geomask-stroke-color or mapframe-geomask-stroke-colour – Color of outline of geomask shape. Default: #555555
    • mapframe-geomask-stroke-width – Width of outline of geomask shape. Default: 1
    • mapframe-geomask-fill – Color used to fill outside geomask features. Default: #606060
    • mapframe-geomask-fill-opacity – Opacity level of fill outside geomask features, a number between 0 and 1. Default: 0.25
    • 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: 10
    • 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 / not specified / not specified / 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: landmark
    • mapframe-population – Set the population, useful with type="city", for {{Infobox dim}}. Default: not specified


Use 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 historic site
  | embed = yes
  | <!-- etc. -->
}}
}}

Embedding other templates

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

{{Infobox historic site
| name =
| <!-- etc. -->
| embedded =
{{Infobox ABC
  | embed = yes <!-- or child=yes or subbox=yes-->
  | <!-- etc. -->
}}
}}

Example

Unknown
[[File:The Statue of Liberty as seen on a partly sunny day in June 2024.|210px|]]
Some attributes
First Unknown
Second Unknown
Third Unknown
Other attributes
{{Infobox historic site
| name = {{unbulleted list|Statue of Liberty|''Liberty Enlightening the World''}}
| image = Front view of Statue of Liberty (cropped).jpg
| image_size = 100px
| caption = Statue of Liberty in June 2024
| alt = The Statue of Liberty as seen on a partly sunny day in June 2024.
| location = [[Liberty Island]]<br />[[New York City]], U.S.
| coordinates = {{coord|40|41|21|N|74|2|40|W|region:US-NY_type:landmark_scale:5000|display=inline,title}}
| height = {{plainlist|
* Height of copper statue (to torch): {{convert|151|ft|1|in|0|abbr=off|sp=us}}
* From ground level to torch: {{convert|305|ft|1|in|0|abbr=off|sp=us}}
}}
| beginning_label = Dedicated
| beginning_date = {{Start date and age|October 28, 1886}}
| restored = 1938, 1984–1986, 2011–2012
| sculptor = [[Frédéric Auguste Bartholdi]]
| visitors_num = 4.5 million
| visitors_year = 2019
| visitors_ref =
| governing_body = [[National Park Service]]
| designation1 = WHS
| designation1_date = [[List of World Heritage Sites by year of inscription#1984 (8th session)|1984]] <small>(8th [[World Heritage Committee|session]])</small>
| designation1_type = Cultural
| designation1_criteria = i, vi
| designation1_number = [https://whc.unesco.org/en/list/307 307]
| designation1_free1name = Region
| designation1_free1value = [[List of World Heritage Sites in North America|Europe and North America]]
| designation2 = NMON
| designation2_date = October 15, 1924
| designation2_free1name = Designated by
| designation2_free1value = President [[Calvin Coolidge]]
| designation3 = NRHP
| designation3_offname = The Statue of Liberty Enlightening the World
| designation3_date = September 14, 2017
| designation3_number = 100000829
| designation4 = New Jersey Register of Historic Places
| designation4_offname = Statue of Liberty National Monument, Ellis Island and Liberty Island
| designation4_date = May 27, 1971
| designation4_number = 1535
| designation5 = New York State Register of Historic Places
| designation5_number = 06101.003324
| designation5_date = June 23, 1980
| designation6 = New York City Landmark
| designation6_date = September 14, 1976
| designation6_type = Individual
| designation6_number = 0931
| website = {{URL|www.nps.gov/stli/index.htm|nps.gov/stli}}
}}

Tracking categories

TemplateData

See also

Template:Infobox historic site invokes Module:Navbox using Lua.

Usage

This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.

Syntax

{{navbox
|state      = uncollapsed, collapsed, plain, autocollapse (default)
|name       = mandatory - name of the template
|style      = optional - style for the whole table
|title      = mandatory - navbox header
|gtitleN    = optional - title of N-th group of items
|styleN     = optional - style for groupN; i.e. text-align
|groupN     = mandatory - list of groups of items
|fstyle     = optional - style for footer ; i.e. text-align
|footer     = optional - navbox footer
}}
  • Groups: Currently there is no technical limit to the maximum number of groups.
    • Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
  • Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
  • Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
    • Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
  • Line breaks: Line-breaks (<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN.
  • Bullets: Create unordered lists with lines beginning with *.
  • Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! ({{!}}).

States

  • Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
    • Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
  • Uncollapsed: Forces the navbox to be displayed.
    • All of the navboxes in this documentation are in the uncollapsed state.
  • Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
    • Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
  • Plain: Removes the "show/hide" link.

Sub-groups

  • For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
  • To create sub-groups within {{navbox}}, certain parameters are to be included:
    • The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
    • The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.
{{navbox
|name    =
|title   =
|gtitle1 =
|group1  =
|gtitle2 =  
|gtype2  = Subgroup (mandatory)
|group2  = 
  {{navbox
  |subgroup = yes (mandatory)
  |gtitle1  = 
  |group1   =
  |gtitle2  = 
  |group2   = 
  }}
}}

Collapsible sub-groups

  • For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
  • To create collapsible sub-groups within {{navbox}}, these parameters need to be included:
    • The parent navbox is almost always uncollapsed (state=uncollapsed).
    • The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
    • The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
    • The nested collapsible navbox is forcefully collapsed (state=collapsed).
{{navbox
|state  = uncollapsed
|name   = 
|gtype1 = Subgroup
|group1 = 
  {{navbox
  |collapsible = yes
  |state   = collapsed
  |title   = 
  |gtitle1 = 
  |group1  = 
  |gtitle2 = 
  |group2  = 
  }}
}}

Use of images

  • The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
  • Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.

Link and file share the same name

{{plink|Item}}

File name differs from the link

{{plink|Item|File}}

Link and file share the same name, but different text is desired to display

{{plink|Item|alt=Text}}

File name differs from the link and different text is desired to display

{{plink|Item|File|alt=Text}}

Categorising

Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.

There are 2 methods of categorising pages with navboxes:

The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.

Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.

Examples

To see the following navboxes in action, see Template:Navbox.

Single line navbox with centered list

{{navbox
|name    = 
|title   = 
|style1  = text-align:center
|group1  =
}}
{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|footer  = Centered footer
}}
{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|fstyle  = text-align:right
|footer  = Right-aligned footer
}}

Multiple line navbox

{{navbox
|name    = 
|title   = 
|gtitle1 = Group title 1
|group1  = 
|gtitle2 = Group title 2
|group2  = 
|gtitle3 = Group title 3
|group3  = 
}}

Collapsed navbox

{{navbox
|state   = collapsed
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox with Tnavbar

{{navbox
|state   = plain
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox without Tnavbar

{{navbox
|state   = plain
|title   = 
|style1  = text-align:center
|group1  = 
}}

Complicated navbox

{{navbox
|state   = uncollapsed
|name    = 
|title   = 
|gtitle1 = Level 1 Title 1
|group1  = 
|gtitle2 = Level 1 Title 2
|group2  = 
|gtitle3 = Level 1 Title 3
|group3  = 
|gtitle4 = Level 1 Title 4
|group4  = 
|gtitle5 = Level 1 Title 5
|gtype5  = Subgroup
|group5  = 
  {{navbox
  |subgroup = Yes
  |gtitle1  = Level 2 Title 1
  |group1   =
  |gtitle2  = Level 2 Title 2
  |group2   =
  |gtitle3  = Level 2 Title 3
  |gtype3   = Subgroup
  |group3   = 
    {{navbox
    |subgroup = Yes
    |gtitle1  = Level 3 Title 1
    |group1   =
    |gtitle2  = Level 3 Title 2
    |group2   =
    }}
  |gtitle4  = Level 2 Title 4
  |group4   = 
  }}
|gtitle6 = Level 1 Title 6
|group6  = 
|gtitle7 = Level 1 Title 7
|group7  = 
|fstyle  = 
|footer  = 
}}

Preventing unwanted documentation

The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).

Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.