Template:Kerala topic/doc
Appearance
This is a documentation subpage for Template:Kerala topic. 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 this template's sandbox, the general template sandbox, or your user space before changing anything here. |
This template allows for the quick creation of a navigational template for any group of articles which contains the names of the Districts of Kerala and Municipal corporations of Kerala. It uses {{Navbox}}
to create the navigation box.
Blank syntax
[edit]{{Kerala topic
<!--passed through to Template:Navbox-->
|name =
|state =
|title =
|titlestyle =
|bodystyle =
|groupstyle =
<!--specific to Template:Kerala topic-->
|prefix =
|suffix =
|exclude-dis =
|exclude-cor =
}}
Parameters
[edit]Mandatory
[edit]- name
- Mandatory when creating a new template. 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 district or city name.
- suffix
- Places text after the district or city name.
- prefix and suffix
- Places text before and after the district or city name.
- Note: The title in this example should be replaced by using the title parameter described below.
Optional
[edit]- state
- A navbox with
autocollapse
will start out collapsed if there are two or more tables on the same page that usecollapsible
. If set tocollapsed
, the navbox will always start out in a collapsed state. If set to blank or anything other thanautocollapse
orcollapsed
, 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.
- navbar*
- Defaults to
Tnavbar
. If set toplain
, 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. Useoff
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 group
[edit]- exclude-dis
- Set to any value this excludes display of the group named Districts.
- exclude-cor
- Set to any value this excludes display of the group named Municipal Corporations.
Adding groups and lists
[edit]Some templates may require a list of links not already included in the template. These can be specified as follows:
- list3
- Text or a list of links that is displayed below the state and territory links.
- group3
- Header text displayed in cell to left of text specified in list5.
- above
- A full-width cell (no group header) displayed above the template's body (between the title and Kerala links).
- below
- A full-width cell (no group header) displayed below the template's body.