Template:AUshield/doc

From Wikivoyage
Jump to navigation Jump to search

Template:Intricate template This is the basic syntax you need to get an Australian shield for use in a junction listing. Just place this prior to a road name and fill in the variables.

Some helpful usage hints can also be found here.

Usage[edit]

{{AUshield|1|2|3|4|5|6|7|8}}

Here's what you should fill in[edit]

  • 1, 3, 5, 7: The code for the type of route. See the table below for the codes to use.
  • 2, 4, 6, 8: The route number.
    • For state routes that are alphanumeric, this is just the number, not the prefix letter.
    • For national highways that are alphanumeric, this includes the prefix letter.
  • Parameters 3 to 8 are optional, and should only be used when two ore more routes are multiplexed on the same road.
  • Always use an even number of parameters, as using an odd number of parameters will generate an error.
  • The parameters replace the numbers, i.e. it should not be 1=S, just simply S.

Route Types[edit]

Route Type Code Example Example image
National Highway (numeric) N {{AUshield|N|1}} Template:AUshield/default size
National Highway (alpha-numeric) {{AUshield|N|M1}} Template:AUshield/default size
National Highway (ACT standard) ACTN {{AUshield|ACTN|23}} Template:AUshield/default size
National Route R {{AUshield|R|1}} Template:AUshield/default size
Alternate National Route {{AUshield|R|ALT23}} Template:AUshield/default size
State Route (numeric) S {{AUshield|S|2}} Template:AUshield/default size
Alternate State Route (numeric) {{AUshield|S|ALT30}} Template:AUshield/default size
State Route (numeric) – tollway {{AUshield|S|TOLL43}} Template:AUshield/default size
Alpha-numeric Route
Use state where highway is located.
For interstate routes without a shield and name change use AN.
For alpha-numeric National Highways, use N.
AN {{AUshield|AN|A1}}
NSW {{AUshield|NSW|M1}}
NT {{AUshield|NT|C80}} Template:AUshield/default size
QLD {{AUshield|QLD|M2}} Template:AUshield/default size
{{AUshield|QLD|ALTA2}} Template:AUshield/default size
SA {{AUshield|SA|B90}} Template:AUshield/default size
TAS {{AUshield|TAS|B34}} Template:AUshield/default size
VIC {{AUshield|VIC|B400}} Template:AUshield/default size
Alphanumeric (ACT standard) ACT {{AUshield|ACT|B23}} Template:AUshield/default size
Metroad Met {{AUshield|Met|1}}
Tourist Drive T {{AUshield|T|2}} Template:AUshield/default size
ACT Tourist Drive ACTT {{AUshield|ACTT|3}} Template:AUshield/default size
Old Brisbane freeway route Bris {{AUshield|Bris|F3}} Template:AUshield/default size
Old Melbourne freeway route Mel {{AUshield|Mel|F80}} Template:AUshield/default size
NSW detour route D {{AUshield|D|D1}} Template:AUshield/default size
Additional icons:
Airport + {{AUshield|+|airport}}
Hospital {{AUshield|+|hospital}}
Special:
No Route Marker (Blank)
Used to align text on articles that would look messy otherwise. Use common sense.
None {{AUshield|None|<shield>}}
See below for accepted inputs.
Template:AUshield/default size Foo Highway
Foo Street
Template:AUshield/default size Foo Highway
Foo Highway
Template:AUshield/default size Foo Motorway
Foo Avenue

Other settings[edit]

  • Alt text: By default, alt text and image linking is turned off. Use |alt=on to include alt text (e.g. State Route 2) and the default image link.
  • Size: The default size is x20px (height of 20 pixels). To change this, use |size= parameter, which accepts the same values as the [[File ]] syntax.
  • ALT/BUS shield sizes: The default size for alternative or business National Routes is 17px, while the default size for alternative State Routes is 21px, this will ensure the "main" part of the shield is equivalent to the default size of the standard shields.
Examples
What you type What you get
{{AUshield|S|2|alt=on}} Template:AUshield/default size
{{AUshield|S|2|size=35px}} 35px

Blank Markers[edit]

Currently available blanks exist for the following marker types:

  • N
  • N Alpha
  • R
  • S
  • Met
  • NSW Small
  • NSW Mid
  • NSW Large
  • AN4
  • AN3
  • AN2

Note: AN# refers to generic Non-NSW alphanumerics, with # denoting the number of characters on the shield (including lead letter).

Template:Collapse top The following notes describe the inner workings of the {{AUshield}} group of templates. They are intended to assist template maintainers – for standard usage of the template in articles, see the documentation above.

Template:AUshield
  • This is a wrapper template, that calls the core sub-template in order to display each shield. Each set of unnamed parameters (1 and 2, 3 and 4, 5 and 6, 7 and 8) is passed through to the core sub-template as unnamed parameters. Also passed through is the optional |alt= parameter, which defines whether alt text and the image link are displayed; and the |size= parameter - if not defined, the default size for each shield is used, by passing through each pair of unnamed parameters to the default size sub-template.
Template:AUshield/default size
  • This sub-template determines the default size based on route type. Most routes have a default size of x20px.
  • Alternate and Business National Routes are identified by seeing if there is an error encountered when the sum "1 + route number", as only e alternate and business routes will generate an error
  • Alternate State Route work on the same principle
  • Alphanumeric route ALT2 is identified using a #switch statement, as it is the only alternate alphanumeric route.
Template:AUshield/core
  • This sub template implements the file syntax, with the naming pattern based on route type. This is typically in the format [[File:<Route type> <route number>.svg]]. Size is determined by the size parameter passed through to this sub template. Alt text and image link are intentionally undefined, unless the alt parameter has been passed through with a non-null value.

Template:Collapse bottom

TemplateData[edit]

Template:Collapse top

A template to generate Australian route markers (shields). Up to four can be listed using this template.

Template parameters

ParameterDescriptionTypeStatus
1st route type1

The code for the route type (see doucmentation at https://en.wikipedia.org/wiki/Template:AUshield for a description of the codes). Allowable values are: N, ACTN, R, S, AN, NT, QLD, SA, TAS, VIC, NSW, ACT, T, ACTT, Met, MelRR, Syd, SydRR, +, None

Stringrequired
1st route number2

The route number, or additional icon type

Stringrequired
2nd route type3

The code for the route type (see doucmentation at https://en.wikipedia.org/wiki/Template:AUshield for a description of the codes). Allowable values are: N, ACTN, R, S, AN, NT, QLD, SA, TAS, VIC, NSW, ACT, T, ACTT, Met, MelRR, Syd, SydRR, +, None

Stringoptional
2nd route number4

The route number, or additional icon type

Stringoptional
3rd route type5

The code for the route type (see doucmentation at https://en.wikipedia.org/wiki/Template:AUshield for a description of the codes). Allowable values are: N, ACTN, R, S, AN, NT, QLD, SA, TAS, VIC, NSW, ACT, T, ACTT, Met, MelRR, Syd, SydRR, +, None

Stringoptional
3rd route number6

The route number, or additional icon type

Stringoptional
4th route type7

The code for the route type (see doucmentation at https://en.wikipedia.org/wiki/Template:AUshield for a description of the codes). Allowable values are: N, ACTN, R, S, AN, NT, QLD, SA, TAS, VIC, NSW, ACT, T, ACTT, Met, MelRR, Syd, SydRR, +, None

Stringoptional
4th route number8

The route number, or additional icon type

Stringoptional
Show alternate text and image linkalt

Normally this parameter should be left empty (Set this parameter to 'on' to include alt text, e.g. State Route 2, and the default image link)

Stringoptional
image sizesize

Normally this parameter should be left empty (Use this parameter to change image size. Allowing values are '<number>px', to set the width in pixels, or 'x<number>px', to set the height in pixels)

Stringoptional

Template:Collapse bottom