Template:Primary Destination

From All About Ayrshire
Jump to: navigation, search

Documentation: Primary Destination

The Infobox is the big template down the right hand side of every single page on the Wiki, other than those that relate to a road. This template calls the main {{Infobox}}, and passes parameters to it that are relevant to Primary Destinations (in the UK) or Terminal and Intermediate Destinations (in the Republic of Ireland). It also places the page within the correct regional categories. If a place is not in one of those official categories, then do not use this template - use {{Place}} instead.

Do not edit this template unnecessarily as it is included in every Primary Destination or Terminal Destination page. This causes issues regarding the Job Queue, after an update it takes hundreds of page views to clear the job queue. If edited twice, that number doubles (etc..) Smaller updates to other templates then need to wait for the job queue to clear before they take full effect, which can cause problems for other editors.

Test all edits on Template:Primary Destination sandbox first.

To use this template, copy the code below, replacing anything within <tags> as appropriate. Note that these are only the most common tags, others are also available.

{{Primary Destination
| name = <name>
| type = <type>
| welsh = <welsh>
| irish = <irish>
| gaelic = <gaelic>
| country = <country>
| region = <region>
| county = <county>
| authority = <authority>
| image = <image>
| caption = <caption>
| primary_roads = <primary_roads>
| next = <next>
| next_td = <next_td>
| near = <near>
| near_td = <near_td>
| near_npd = <near_npd>
| HA_roads = <HA_roads>
| TS_roads = <TS_roads>
| TW_roads = <TW_roads>
| NRA_roads = <NRA_roads>
| RS_roads = <RS_roads>
| TfL_roads = <TfL_roads>
| lat = <lat>
| lon = <lon>
| zoom = <zoom>
| layer = <layer>
| static = <static>
| rel1 = <rel1>
| rel2 = <rel2>
| rel3 = <rel3>
| rel4 = <rel4>
| rel5 = <rel5>
}}

NOTE: Unless expressly noted within this documentation, the phrase "Terminal Destination" also should be taken to include Intermediate Destinations

<name> - The primary English name of the place. For places in Wales where the Welsh name is primarily used, put it here.
<type> - Use primary (United Kingdom), terminal or intermediate (Republic of Ireland) depending on whether the place is a Primary Destination, a Terminal Destination or an Intermediate Destination.
<welsh> - The Welsh name of the place, if used on signage.
<irish> - The Irish name of the place, if used on signage.
<gaelic> - The Gaelic name of the place, if used on signage.
<country> - The country that that place is located within.
<region> - The region that that place is located within. Only valid for places in England and needs to be correctly formatted.
<county> - The Historic (or Traditional) County that that place is located within.
<authority> - The body that looks after non-Trunk roads in the place.
<image> - A suitable picture for diplaying to illustrate the place, often "welcome to" signage.
<caption> - The caption for the above image, if needed.
<primary_roads> - Primary Routes or National Primary Routes that run through the place. Include motorways where relevant.
<next> - The next Primary Destination found on signage on Primary Routes that run through the place. Only use for items within the United Kingdom.
<next_td> - The next Terminal or Intermediate Destination found on signage on National Routes that run to the place. Only use for items within the Republic of Ireland.
<near> - Nearby Primary Destinations that are not directly connected on the Primary Route network, but are signed from the place. Only use for items within the United Kingdom.
<near_td> - Nearby Terminal Destinations that are not directly connected on the National Route network, but are signed from the place. Only use for items within the Republic of Ireland.
<near_npd> - Nearby other destinations that are on the SABRE Wiki and are signed from the place.
<HA_roads> - Roads managed by the Highways Agency within the place. Only valid for places in England.
<TS_roads> - Roads managed by Transport Scotland within the place. Only valid for places in Scotland.
<TW_roads> - Roads managed by the Welsh Assembly Government within the place. Only valid for places in Wales.
<NRA_roads> - Roads managed by the National Roads Authority within the place. Only valid for places in the Republic of Ireland.
<RS_roads> - Roads managed by the NI Roads Service within the place. Only valid for places in Northern Ireland.
<TfL_roads> - Roads managed by Transport for London within the place. Only valid for places within the Greater London Authority.
<lat> - The latitude of the place. Needed to display a map.
<lon> - The longitude of the place. Needed to display a map.
<zoom> - The zoom level of a displayed map.
<static> - Forces a map to display in static mode, so removes the ability to scroll or zoom. Must be equal to true if desired.
<layer> - The SABRE Maps layer displayed in this Infobox. Defaults to OpenStreetMap if not used.
<relx> - Related item, often a road number.