Template:Adjacent communities/sandbox

Example infobox
Example infobox
Label	Data
Label	Data
Label	Data

This is the template sandbox page for Template:Adjacent communities (diff).
See also the companion subpage for test cases.

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

This template is used on approximately 27,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes at Wikipedia talk:High-risk templates before implementing them.

This template uses Lua:

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 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 after 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.

Expansion state

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

Tracking category

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