Template:Brazil topic/doc

This template allows for the quick creation of a navigation template for any group of articles which contains the names of the States of Brazil. It uses {{Navbox}} to create the navigation box.

Blank syntax

{{Brazil topic
<!--passed through to Template:Navbox-->
|name       =
|state      = 
|title      = 
|titlestyle =
|bodystyle  = 
|groupstyle = 
<!--specific to Template:Brazil topic-->
|prefix =
|suffix =
|exclude-wdc =
|exclude-ter =
|exclude-isl =
}}

Parameters

Mandatory

name

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

One of the following combinations is needed to create the links:

prefix

Places text before the Brazil state name. For example: |prefix = List of airports in would create a title List of airports in Brazil and a body containing state names linked to List of airports in Alagoas, List of airports in Amapá, etc.

suffix

Places text after the Brazil state name. For example: |suffix = National Guard would create a title Brazil National Guard and a body containing state names linked to Alagoas National Guard, Amapá National Guard, etc.

prefix and suffix

Places text before and after the Brazil state name. For example: |prefix = List of and |suffix = rivers would create a title List of Brazil rivers and a body containing state names linked to List of Alagoas rivers, List of Amapá rivers, etc.

Note: The title in this example should be replaced by using the title parameter described below.

Optional

state

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

Default is: autocollapse.

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. For example: title = [[List of rivers in Brazil|Rivers in Brazil]] generates the title Rivers in Brazil.

navbar*

Defaults to Tnavbar. If set to plain, 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 off 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.

Adding groups and lists

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

above

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

below

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

Change state name used in link

Links for state use the primary page for that state. The following parameters allow for substitution where the article name does not use the default.

AM

Replace "Amazonas (Brazilian state)" in links with specified text, i.e. "Amazonas".

| AM = Amazonas

RJ

Replace "Rio de Janeiro (state)" in links with specified text, i.e. "Rio de Janeiro".

| RJ = Rio de Janeiro

SP

Replace "São Paulo (state)" in links with specified text, i.e. "São Paulo".

| SP = São Paulo

Styles

titlestyle

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

titlestyle = background: #0000FF;

titlestyle = background: blue;

Default is: background: #ccccff;

bodystyle

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

abovestyle = background:#ddddff;

belowstyle = background:#ddddff;

groupstyle = background:#ddddff; text-align:right; white-space:nowrap;

liststyle = width:100%; font-size:95%;

abovestyle

belowstyle

Specifies CSS values to apply to the cell specified via the above and below parameters. For instance:

belowstyle = border-top: #ccccff 1px solid;

Default is: background: #ddddff;

groupstyle

Specifies CSS values to apply to the cells specified via the group_n cells. This option overrides any styles that are applied to the entire table. Example:

groupstyle = background:#6AFB92; vertical-align:top;

Default is: background: #ddddff; text-align:right; white-space:nowrap;

liststyle

Specifies CSS values to apply to the cells specified via the list_n cells. This option overrides any styles that are applied to the entire table. Examples:

liststyle = padding: 5px 10px 5px 10px;

Default is: width:100%; font-size:95%;

Examples

Changing the navbox title

{{Brazil topic
|title  = [[History of Brazil]] by political division
|prefix = History of
}}

Excluding display of federal district and minor outlying islands

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.

{{Brazil topic
|title  = [[List of airports in Brazil|Airports in Brazil]]
|titlestyle = background: #64E986;
|groupstyle = background: #6AFB92; vertical-align: top;
|prefix = List of airports in
|exclude-wdc = y
|exclude-isl = y
}}

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 "States" heading, and the AC parameter to change link from "Acre (state)" to "Acre".

{{Brazil topic
|liststyle = padding: 5px 10px 5px 10px;
|group1 =
|prefix = List of
|suffix = -related topics
|AC = Acre
|exclude-wdc = y
|exclude-ter = y
|exclude-isl = y
}}

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.

{{Brazil topic
|title  = [[Rivers in Brazil]]
|prefix = List of
|suffix = _rivers
}}

Creating a new template

Code used to create Template:Hospitals in Brazil:

{{Brazil topic
<!--passed through to Template:Navbox-->
| name  = {{subst:PAGENAME}}
|title=[[List of hospitals in Brazil|Hospitals in Brazil]]
<!--specific to Template:Brazil topic-->
| prefix = List of hospitals in
}}<noinclude>
[[Category:Brazil topic navigational boxes|{{PAGENAME}}]]
</noinclude>

Note: {{subst:PAGENAME}} in the above example would be replaced by Hospitals in Brazil when this code is saved in Template:Hospitals in Brazil.

Result:

Templates implemented with Brazil topic

1. Template: Rivers in Brazil