Template:Australia topic/doc

This template allows for the quick creation of a navigational template for any group of articles which contains the names of Australian states. It uses to create the navigation box.

Mandatory

 * name
 * Mandatory when creating a new template (i.e. Template:Hospitals in Australia), otherwise the "view· talk· edit" links will connect to Template:Australia topic. You can enter  for this value as a shortcut.

One of the following combinations is needed to create the links:
 * prefix
 * Places text before the state or territory name.


 * suffix
 * Places text after the state or territory name.


 * prefix and suffix
 * Places text before and after the state or territory name.

Optional

 * state
 * A navbox with  will start out collapsed if there are two or more tables on the same page that use collapsible . If set to , the navbox will always start out in a collapsed state. If set to blank or anything other than   or  , the navbox will always start out in an expanded state.
 * Default is:.


 * title
 * Text that appears centered in the titlebar (the top bar). This is optional because the use of either prefix, suffix or both will automatically generate a title if the title parameter is not supplied. This parameter is not automatically wiki-linked.


 * navbar *
 * Defaults to . If set to , the v • d • e links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the title centered.  Use   to remove the v • d • e links, but not apply padding (this is for advanced use only; the "plain" option should suffice for most applications where a navbar is not desired).  Note that it is highly recommended that one does not hide the navbar, in order to make it easier for users to edit the template, and to keep a standard style across pages.

Excluding groups
In some instances, the territories may not have their own articles on particular topics. To disable their inclusion in the template and avoid unnecessary red links, add any or all of the following parameters:


 * exclude-int
 * Set to any value this excludes display of the group named Territories which links to the Australian Capital Territory and the other internal territories.


 * exclude-ext
 * Set to any value this excludes display of the group named External territories which links to Christmas Island, Coral Sea Islands and the other external territories.

Adding groups and lists
Some templates may require a list of links not already included in the template. These can be specified as follows:


 * group1
 * Header text displayed in cell to left of text specified in list1.


 * list1
 * Text or a list of links that is displayed above the state and territory links.


 * group5
 * Header text displayed in cell to left of text specified in list3.


 * list5
 * Text or a list of links that is displayed below the state and territory links.


 * above
 * A full-width cell (no group header) displayed above the template's body (between the title and state/territory links).


 * below
 * A full-width cell (no group header) displayed below the template's body.

Change state name used in link
Links for Victoria may use "Victoria (Australia)". The following parameter allows for substitution where the article name does not use the default.


 * VI
 * Replace "Victoria (Australia)" in links with specified text, i.e. "Victoria".

Styles

 * titlestyle
 * Specifies CSS values to apply to the title. One use of this is to set the background color of the title:
 * Default is:
 * Default is:
 * Default is:


 * bodystyle
 * Specifies CSS values to apply to the entire template. This will not override the following Navbox default styles:


 * abovestyle
 * belowstyle
 * Specifies CSS values to apply to the cell specified via the above and below parameters. For instance:
 * Default is:
 * Default is:


 * groupstyle
 * Specifies CSS values to apply to the cells specified via the groupn cells. This option overrides any styles that are applied to the entire table. Example:
 * Default is:
 * Default is:


 * liststyle
 * Specifies CSS values to apply to the cells specified via the listn cells. This option overrides any styles that are applied to the entire table. Examples:
 * Default is:
 * Default is:

Excluding display of external territories
This example also shows the use of the titlestyle to change the background color and the groupstyle parameters to change the background color and vertical alignment of text.

Adding suffix without leading space
This example also shows the use of the liststyle parameter to add some extra padding around the list, the group1 parameter to remove the "Mainland" heading, and the VI parameter to change link from "Victoria (Australia)" to "Victoria".

Adding suffix with leading space
Note the use of an underscore in place of the leading space in the suffix. This is done to accommodate the use of suffixes without a leading space, as in the previous example. A title should be specified to avoid the underscore appearing in the title.

Adding extra rows
This example shows the use of the group1/ list1 & group5/ list5 parameters to add a group and list above and below the default rows.



Using a suffix without a prefix


Creating a new template
Code used to create Template:Universities in Australia:

Note:   in the above example would be replaced by Universities in Australia when this code is saved in Template:Universities in Australia.

Result: