Template:Adjacent communities

Template documentation[view] [edit] [history] [purge]

Usage

{{Adjacent communities
 | Centre    = 
 | North     = 
 | Northeast = 
 | East      = 
 | Southeast = 
 | South     = 
 | Southwest = 
 | West      = 
 | Northwest = 
}}

Or:

{{Adjacent communities
 | Centre = 
 | N  = 
 | NE = 
 | E  = 
 | SE = 
 | S  = 
 | SW = 
 | W  = 
 | NW = 
}}

This template provides for a convenient compass-based navigational aid for articles about communities. It allows you to display the communities surrounding the subject of your article.

While this template may be useful for cities, it certainly is redundant for continents, countries and other large geographical areas like states, provinces and islands. In the lead paragraphs of those types of articles, all surrounding countries and features are invariably stated and linked and there's usually a map in the infobox too.

The only required field is |Centre=; the template defaults to an "(enter location)" in the centre of the box message if nothing is entered here (see note below). The fields |Northwest= (|NW=), |North= (|N=), |Northeast= (|NE=), |West= (|W=), |East= (|E=), |Southwest= (|SW=), |South= (|S=), and |Southeast= (|SE=) are optional. They will be hidden when not used; when values are entered for the relevant parameters, the fields will automatically appear. (Normal Wiki markup can be used in the fields, such as links, colours, and bold/italics.)

The template is coded to handle the American spelling "center". It first looks for a value in |Centre=, then in |Center=; it defaults to the "(enter location)" message if both are left blank.

How to use and not use this template

In order to ensure consistent usage, the following guidelines apply:

• This template is for immediately adjacent places only.
• Use same-level jurisdictions or equivalent in the directional fields as in the centre. For instance, when using this template for a municipality, show adjacent municipalities; when using it for unincorporated places, show adjacent unincorporated communities; etc.
• When a municipality borders an international, provincial, or state boundary, try to use a municipality in that adjacent jurisdiction rather than the jurisdiction itself.
• Geographical features such as oceans, rivers, lakes, and mountains should be in italics to differentiate them. But this should only be used sparingly for major defining features, in particular if there is no adjacent jurisdiction (e.g. sea, lake, etc.).
• Avoid cluttering the template with too much detail; it is a navigational guide to provide links to adjacent locations, not a map.
• Don't use flag icons for every link, see MOS:INFOBOXFLAG. They don't add value and are unnecessarily distracting.

Placement in article

• WP:LAYOUTNAV specifies that navboxes, including geography boxes such as this one, are placed after the "External links" section (i.e., immediately before categories; they should also be placed before stub templates).

Examples

Here is an example for Ottawa (capital of Canada) demonstrating the guidelines above:

{{Adjacent communities
 | Centre    = Ottawa
 | North     = [[Pontiac, Quebec|Pontiac]], [[Gatineau]] ([[Quebec]])<br/>''[[Ottawa River]]''
 | Northeast = [[Lochaber-Partie-Ouest, Quebec|Lochaber-Partie-Ouest]] ([[Quebec]])<br/>''[[Ottawa River]]''
 | East      = [[Clarence-Rockland, Ontario|Clarence-Rockland]]
 | Southeast = [[Russell, Ontario|Russell]], [[The Nation, Ontario|The Nation]]
 | South     = [[North Grenville, Ontario|North Grenville]], [[North Dundas, Ontario|North Dundas]]
 | Southwest = [[Merrickville-Wolford, Ontario|Merrickville-Wolford]]
 | West      = [[Mississippi Mills, Ontario|Mississippi Mills]]<br/>[[Beckwith, Ontario|Beckwith]]<br/>[[Montague, Ontario|Montague]]
 | Northwest = [[Arnprior, Ontario|Arnprior]]
}}

produces:

Not all directions necessarily need to be filled.

{{Adjacent communities
 | Centre = Knokke-Heist
 | N = ''[[North Sea]]''
 | E = [[Sluis]] ([[Netherlands|NL]]-[[Zeeland|ZE]])
 | S = [[Damme]]
 | W = [[Bruges]]
}}

produces:

Optional parameters

Title

The default title is "Places adjacent to {{PAGENAME}}". To override this, an optional title can be added; use |title=. This is particularly useful where 2 boxes are needed. For example, |title=Eastern part (includes the poblacion) produces:

Width (nesting/floating box)

By default, the width of the geographic location box is 100%, and is forced to clear below any left or right floating elements. To allow the box to position next to an infobox, image, or other floating element, enter |width=auto on the first line.

Example infobox
Label	Data
Label	Data
Label	Data

Expansion state

Use |state=expanded to force the box to the expanded state, or |state=collapsed to hide it.

Template Data

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

TemplateData for Adjacent communities

Template Data

<templatedata> { "params": { "width": { "description": "Optional width for the navbox", "type": "string", "suggestedvalues": [ "auto" ], "default": "Omit for full page width. Set to \"auto\" for a minimum width." }, "margin": {}, "border": {}, "state": { "description": "Force the navbox to be expanded or collapsed", "type": "string", "suggestedvalues": [ "expanded", "collapsed" ] }, "title": { "label": "Title for the navbox", "description": "Replaces the default title", "default": "\"Places adjacent to place\", where place is set by Centre" }, "North-west": { "aliases": [ "NW" ], "description": "Name of the community to the north-west", "type": "content" }, "North": { "aliases": [ "N" ], "description": "Name of the community to the north", "type": "content" }, "North-east": { "aliases": [ "NE" ], "description": "Name of the community to the north-east", "type": "content" }, "WNW": {}, "ENE": {}, "Centre": { "aliases": [ "Center" ], "description": "Name of the place at the centre", "type": "string", "required": true }, "WSW": {}, "ESE": {}, "South-west": { "aliases": [ "SW" ], "description": "Name of the community to the south-west", "type": "content" }, "South": { "aliases": [ "S" ], "description": "Name of the community to the south", "type": "content" }, "South-east": { "aliases": [ "SE" ], "description": "Name of the community to the south-east", "type": "content" }, "East": { "aliases": [ "E" ], "description": "Name of the community to the east", "type": "content" }, "West": { "aliases": [ "W" ], "description": "Name of the community to the west", "type": "content" } }, "format": "block", "description": "Display the communities surrounding the subject of the article.", "paramOrder": [ "title", "Centre", "North", "South", "East", "West", "North-west", "North-east", "South-west", "South-east", "width", "margin", "border", "state", "WNW", "ENE", "WSW", "ESE" ] } </templatedata>

Tracking category

• Category:Pages using adjacent communities with unknown parameters (0)
• Category:Pages using adjacent communities with added directions (0)

The above documentation is transcluded from Template:Adjacent communities/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.