Template:AUshield/doc

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


Here's what you should fill in

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

Other settings

 * Alt text: By default, alt text and image linking is turned off. Use 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 &#91;&#91;File &#93;&#93; 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.

Blank Markers
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).

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 ( and ,   and  ,   and  ,   and  ) 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: .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.

TemplateData
{	"description": "A template to generate Australian route markers (shields). Up to four can be listed using this template.", "params": { "1": {			"label": "1st route type", "description": "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", "type": "string", "required": true },		"2": {			"label": "1st route number", "description": "The route number, or additional icon type", "type": "string", "required": true },		"3": {			"label": "2nd route type", "description": "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", "type": "string" },		"4": {			"label": "2nd route number", "description": "The route number, or additional icon type", "type": "string" },		"5": {			"label": "3rd route type", "description": "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", "type": "string" },		"6": {			"label": "3rd route number", "description": "The route number, or additional icon type", "type": "string" },		"7": {			"label": "4th route type", "description": "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", "type": "string" },		"8": {			"label": "4th route number", "description": "The route number, or additional icon type", "type": "string" },		"alt": { "label": "Show alternate text and image link", "description": "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)", "type": "string" },		"size": { "label": "image size", "description": "Normally this parameter should be left empty (Use this parameter to change image size. Allowing values are ' px', to set the width in pixels, or 'x px', to set the height in pixels)", "type": "string" }	} }