Template:AUshield/doc

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

This template employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
You can conduct experiments, and should test all major changes, in either , the general template sandbox, or your user space before changing anything here.

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

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

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.

Route Types

Route Type	Code	Example	Example image
National Highway (numeric)	N	{{AUshield\|N\|1}}
National Highway (alpha-numeric)	N	{{AUshield\|N\|M1}}
National Highway (ACT standard)	ACTN	{{AUshield\|ACTN\|23}}
National Route	R	{{AUshield\|R\|1}}
Alternate National Route	R	{{AUshield\|R\|ALT23}}
State Route (numeric)	S	{{AUshield\|S\|2}}
Alternate State Route (numeric)		{{AUshield\|S\|ALT30}}
State Route (numeric) – tollway		{{AUshield\|S\|TOLL43}}
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}}
	QLD	{{AUshield\|QLD\|M2}}
	QLD	{{AUshield\|QLD\|ALTA2}}
	SA	{{AUshield\|SA\|B90}}
	TAS	{{AUshield\|TAS\|B34}}
	VIC	{{AUshield\|VIC\|B400}}
Alphanumeric (ACT standard)	ACT	{{AUshield\|ACT\|B23}}
VIC / new QLD Toll Alpha-numeric Route	Toll	{{AUshield\|Toll\|M6}}
Metroad	Met	{{AUshield\|Met\|1}}
Tourist Drive	T	{{AUshield\|T\|2}}
Old ACT Tourist Drive	ACTT	{{AUshield\|ACTT\|3}}
Old Brisbane freeway route	Bris	{{AUshield\|Bris\|F3}}
Old Melbourne freeway route	Mel	{{AUshield\|Mel\|F80}}
Old New South Wales freeway route	NSWF	{{AUshield\|NSWF\|F4}}
NSW detour route	D	{{AUshield\|D\|D1}}
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.	Foo Highway Foo Street Foo Highway Foo Highway Foo Motorway Foo Avenue

Other settings

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}}
{{AUshield\|S\|2\|size=35px}}

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

Technical documentation

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.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:AUshield in articles based on its TemplateData.

TemplateData for AUshield

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

Template parameters
Parameter		Description	Type	Status
1st route type	`1`	The code for the route type (see documentation at https://wiki.riteme.site/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	String	required
1st route number	`2`	The route number, or additional icon type	String	required
2nd route type	`3`	The code for the route type (see documentation at https://wiki.riteme.site/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	String	optional
2nd route number	`4`	The route number, or additional icon type	String	optional
3rd route type	`5`	The code for the route type (see documentation at https://wiki.riteme.site/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	String	optional
3rd route number	`6`	The route number, or additional icon type	String	optional
4th route type	`7`	The code for the route type (see documentation at https://wiki.riteme.site/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	String	optional
4th route number	`8`	The route number, or additional icon type	String	optional
Show alternate text and image link	`alt`	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)	String	optional
image size	`size`	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)	String	optional