Template:Coastal settlements/doc

This is a documentation subpage for Template:Coastal settlements.
It may contain usage information, categories and other content that is not part of the original template page.

Purpose[edit]

This template allows navigation from a page for a settlement that is usually identified as a coastal settlement to adjacent coastal settlements around a sea coast, or the coast of a lake or inland sea. At some point the linked pages might be in the next county or country, but that would not be a problem. When complete these template entries will link their pages into a two way circular linked list.

Structure:[edit]

{{Coastal_settlements navbox
|place = 
|settlement = 
|anticlockwise = 
|clockwise = 
}}

Required parameters[edit]

place: County or suitably large administrative body containing the settlement, and that matches 'structure' above. DO NOT WIKILINK.
settlement: Name of the settlement. Defaults to the pagename.
anticlockwise: The wikilinked name of the next settlement anticlockwise around the coast
clockwise: The wikilinked name of the next settlement clockwise around the coast

example:

{{Coastal_settlements navbox
|place         = North Yorkshire
|settlement    = Saltburn-by-the-Sea
|anticlockwise = [[Marske-by-the-Sea]]
|clockwise     = [[Skinningrove]]
}}

This template makes use of the list page 'List of coastal settlements in North Yorkshire' or alternatively the category 'Coastal settlements in North Yorkshire' and will link to them although their presence is not essential.