Шаблон:Навигационная полоса2/doc

This template allows a navigational template to be set up relatively quickly by supplying it one or more lists of links. It comes equipped with default styles that should work for most navigational templates. Changing the default styles is not recommended, but is possible. Using this template, or one of its "Navbox suite" sister templates, is highly recommended for standardization of navigational templates, and for ease of use.

Usage

Please remove the parameters that are left blank.

{{Навигационная полоса2
|name    = {{subst:PAGENAME}}
|заголовок   = 
|изображение   = 
|вверху   = 

|group1  = 
|listl   = 

|group2  = 
|list2   = 
 ...
|group20 = 
|list20  = 

|внизу   = 
}}

Parameter list

The navbox uses lowercase parameter names, as shown in the box (at right). The mandatory name and заголовок will create a one-line box if other parameters are omitted.

Notice "group1" (etc.) is optional, as are sections named "вверху/внизу".

The basic and most common parameters are as follows (see внизу for the full list):

name - the name of the template.

заголовок - text in the заголовок bar, such as: [[Widget stuff]].

state - autocollapse, uncollapsed, collapsed: the status of box expansion, where "autocollapse" hides stacked navboxes automatically.

стиль_заголовков - a CSS style for the заголовок-bar, such as: background:gray;

стиль_группы - a CSS style for the group-cells, such as: background:#eee;

изображение - an optional right-side изображение (coded as the whole изображение tag: [[Файл:XX.jpg|90px]] ).

изображение_слева - an optional left-side изображение (code the same was as the "изображение" parameter).

вверху - text to appear вверху the group/list section (could be a list of overall wikilinks).

groupn - the left-side text before list-n (if group-n omitted, list-n starts at left of box).

listn - text listing wikilinks, often separated by middot templates, such as: [[A]]{{•}} [[B]]

внизу - optional text to appear внизу the group/list section.

Further details, and complex restrictions, are explained внизу under section Parameter descriptions. See some alternate navbox formats under: Layout of table.

Parameter descriptions

The following is a complete list of parameters for using {{Навигационная полоса2}}. In most cases, the only required parameters are name, заголовок, and listl, though child navboxes do not even require those to be set.

{{Навигационная полоса2}} shares numerous common parameter names as its sister templates {{Навигационная таблица с колонками}} and {{Navbox with collapsible groups}} for consistency and ease of use. Parameters marked with a cross^* are common to all three master templates.

Setup parameters

name^*

The name of the template, which is needed for the "vШаблон:• dШаблон:• e" ("viewШаблон:• discussШаблон:• edit") links to work properly on all pages where the template is used. You can enter {{subst:PAGENAME}} for this value as a shortcut. The name parameter is only mandatory if a заголовок is specified, and the border parameter is not set.

state^* [autocollapse, uncollapsed, collapsed, plain, off]

• Defaults to autocollapse. A navbox with autocollapse will start out collapsed if there are two or more tables on the same page that use other collapsible tables. Otherwise, the navbox will be expanded. For the technically minded, see MediaWiki:Common.js.
• If set to collapsed, the navbox will always start out in a collapsed state.
• If set to plain, the navbox will always be expanded with no [hide] link on the right, and the заголовок will remain centered (by using отступ to offset the v • d • e links).
• If set to off, the navbox will always be expanded with no [hide] link on the right, but no отступ will be used to keep the заголовок centered. This is for advanced use only; the "plain" option should suffice for most applications where the [show]/[hide] button needs to be hidden.
• If set to anything other than autocollapse, collapsed, plain, or off (such as "uncollapsed"), the navbox will always start out in an expanded state, but have the "hide" button.

To show the box when standalone (non-included) but then auto-hide contents when in an article, put "uncollapsed" inside <noinclude> tags:

• state = <noinclude>uncollapsed</noinclude>
• That setting will force the box visible when standalone (even when followed by other boxes), displaying "[hide]" but then auto-collapse the box when stacked inside an article.

Often times, editors will want a default initial state for a navbox, which may be overridden in an article. Here is the trick to do this:

• In your intermediate template, create a parameter also named "state" as a pass-through like this:
• | state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}
• The <includeonly>| will make the template expanded when viewing the template page by itself.

• Example: {{peso}} with autocollapse as the default initial state. Bolivian peso transcludes it and has only one navbox. So the peso navbox shows. Chilean peso has two navboxes. So the peso navbox collapses.

• Example: {{Historical currencies of Hungary}} with expanded as the default initial state. All transcluding articles shows the content by default, unless there were an hypothetical article that specifies state = collapsed when transcluding.

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 отступ will be automatically used to keep the заголовок centered. Use off to remove the v • d • e links, but not apply отступ (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.

border^*

See section внизу on using navboxes within one another for examples and a more complete description. If set to child or subgroup, then the navbox can be used as a borderless child that fits snuggly in another navbox. The border is hidden and there is no отступ on the sides of the table, so it fits into the list area of its parent navbox. If set to none, then the border is hidden and отступ is removed, and the navbox may be used as a child of another container (do not use the none option inside of another navbox; similarly, only use the child/subgroup option inside of another navbox). If set to anything else (default), then a regular navbox is displayed with a 1px border. An alternate way to specify the border to be a subgroup style is like this (i.e. use the first unnamed parameter instead of the named border parameter):

{{Навигационная полоса2|child

...

}}

Cells

заголовок^*

Text that appears centered in the top row of the table. It is usually the template's topic, i.e. a succinct description of the body contents. This should be a single line, but if a second line is needed, use {{-}} to ensure proper centering. This parameter is technically not mandatory, but using {{Навигационная полоса2}} is rather pointless without a заголовок.

group_n^*

(i.e. group1, group2, etc.) If specified, text appears in a header cell displayed to the left of list_n. If omitted, list_n uses the full width of the table.

list_n^*

(i.e. listl, list2, etc.) The body of the template, usually a list of links. Format is inline, although the text can be entered on separate lines if the entire list is enclosed within <div> </div>. At least one list parameter is required; each additional list is displayed in a separate row of the table. Each list_n may be preceded by a corresponding group_n parameter, if provided (see внизу).

изображение^*

An изображение to be displayed in a cell внизу the заголовок and to the right of the body (the groups/lists). For the изображение to display properly, the listl parameter must be specified. The изображение parameter accepts standard wikicode for displaying an изображение, i.e.

изображение = [[Файл:Example.jpg|100px]]

изображение_слева^*

An изображение to be displayed in a cell внизу the заголовок and to the left of the body (lists). For the изображение to display properly, the listl parameter must be specified and no groups can be specified. The изображение_слева parameter accepts standard wikicode for displaying an изображение, i.e.

изображение_слева = [[Файл:Example.jpg|100px]]

вверху^*

A full-width cell displayed between the titlebar and first group/list, i.e. вверху the template's body (groups, lists and изображение). In a template without an изображение, вверху behaves in the same way as the listl parameter without the group1 parameter.

внизу^*

A full-width cell displayed внизу the template's body (groups, lists and изображение). In a template without an изображение, внизу behaves in the same way as the template's final list_n parameter without a group_n parameter. For an example of the внизу parameter in use, see {{Lists of the provinces and territories of Canada}}.

Style parameters

Styles are generally not recommended as to maintain consistency among templates and pages in Wikipedia. However, the option to modify styles is given.

style^*

Specifies CSS styles to apply to the template body. The parameter стиль_тела also does the example same thing and can be used in place of this style parameter. This option should be used sparingly as it can lead to visual inconsistencies. Examples:

style = background:#nnnnnn;

style = width:N [em/%/px or width:auto];

style = float:[left/right/none];

style = clear:[right/left/both/none];

основной_стиль^*

CSS styles to apply to the заголовок, вверху, внизу, and group cells all at once. The style are not applied to list cells. This is convenient for easily changing the basic цвет of the navbox without having to repeat the style specifications for the different parts of the navbox. Examples:

основной_стиль = background:lightskyblue;

стиль_заголовков^*

CSS styles to apply to заголовок, most often the titlebar's background цвет:

стиль_заголовков = background:#nnnnnn;

стиль_заголовков = background:name;

стиль_группы^*

CSS styles to apply to the groupN cells. This option overrides any styles that are applied to the entire table. Examples:

стиль_группы = background:#nnnnnn;

стиль_группы = text-align:[left/center/right];

стиль_группы = vertical-align:[top/middle/bottom];

group_nstyle^*

CSS styles to apply to a specific group, in addition to any styles specified by the стиль_группы parameter. This parameter should only be used when absolutely necessary in order to maintain standardization and simplicity. Examples:

group3style = background:red;color:white;

стиль_списков^*

CSS styles to apply to all lists. Overruled by the стиль_нечетных and стиль_четных parameters (if specified) внизу.

list_nstyle^*

CSS styles to apply to a specific group, in addition to any styles specified by the стиль_группы parameter. This parameter should only be used when absolutely necessary in order to maintain standardization and simplicity. Examples:

list5style = background:#ddddff;

отступ_списка^*

A number and unit specifying the отступ in each list cell. The list cells come equipped with a default отступ of 0.25em on the left and right, and 0em on the top and bottom. Due to complex technical reasons, simply setting "стиль_списков=отступ:0.5em;" (or any other отступ setting) will not work. Examples:

отступ_списка = 0.5em 0em; (sets 0.5em отступ for the left/right, and 0em отступ for the top/bottom.)

отступ_списка = 0em; (removes all list отступ.)

стиль_нечетных

стиль_четных

Applies to odd/even list numbers. Overrules styles defined by стиль_списков. The default behavior is to add striped colors (white and gray) to odd/even rows, respectively, in order to improve readability. These should not be changed except in extraordinary circumstances.

четные_нечетные [swap, even, odd, off]

If set to swap, then the automatic striping of even and odd rows is reversed. Normally, even rows get a light gray background for striping; when this parameter is used, the odd rows receive the gray striping instead of the even rows. Setting to even or odd sets all rows to have that striping цвет. Setting to off disables automatic row striping. This advanced parameter should only be used to fix problems when the navbox is being used as a child of another navbox and the stripes do not match up. Examples and a further description can be found in the section on child navboxes внизу.

стиль_вверху^*

стиль_внизу^*

CSS styles to apply to the top cell (specified via the вверху parameter) and bottom cell (specified via the внизу parameter). Typically used to set background цвет or text alignment:

стиль_вверху = background:#nnnnnn;

стиль_вверху = text-align:[left/center/right];

стиль_изображения^*

стиль_изображения_слева^*

CSS styles to apply to the cells where the изображение/изображение_слева sits. These styles should only be used in exceptional circumstances, usually to fix width problems if the width of groups is set and the width of the изображение cell grows too large. Examples:

стиль_изображения = width:5em;

Default styles

The style settings listed here are those that editors using the navbox change most often. The other more complex style settings were left out of this list to keep it simple. Most styles are set in MediaWiki:Common.css.

стиль_тела = background:#fdfdfd; width:100%; vertical-align:middle;

стиль_заголовков = background:#ccccff; отступ-left:1em; отступ-right:1em; text-align:center;

стиль_вверху = background:#ddddff; отступ-left:1em; отступ-right:1em; text-align:center;

стиль_внизу = background:#ddddff; отступ-left:1em; отступ-right:1em; text-align:center;

стиль_группы = background:#ddddff; отступ-left:1em; отступ-right:1em; text-align:right;

стиль_списков = background:transparent; text-align:left/center;

стиль_нечетных = background:transparent;

стиль_четных = background:#f7f7f7;

Since стиль_списков and стиль_нечетных are transparent odd lists have the цвет of the стиль_тела, which defaults to #fdfdfd (white with a hint of gray). A list has text-align:left; if it has a group, if not it has text-align:center;. Since only стиль_тела has a vertical-align all the others inherit its vertical-align:middle;.

Advanced parameters

titlegroup

This puts a group in the заголовок area, with the same default styles as group_n. It should be used only in exceptional circumstances (usually advanced meta-templates) and its use requires some knowledge of the internal code of {{Навигационная полоса2}}; you should be ready to manually set up CSS styles to get everything to work properly if you wish to use it. If you think you have an application for this parameter, it might be best to change your mind, or consult the talk page first.

titleстиль_группы

The styles for the titlegroup cell.

innerstyle

A very advanced parameter to be used only for advanced meta-templates employing the navbox. Internally, the navbox uses an outer table to draw the border, and then an inner table for everything else (заголовок/вверху/groups/lists/внизу/images, etc.). The style/стиль_тела parameter sets the style for the outer table, which the inner table inherits, but in advanced cases (meta-templates) it may be necessary to directly set the style for the inner table. This parameter provides access to that inner table so styles can be applied. Use at your own risk.

Layout of table

Table generated by {{Навигационная полоса2}} without изображение, вверху and внизу parameters (gray list bacкгround цвет added for illustration only):

Table generated by {{Навигационная полоса2}} with изображение, вверху and внизу parameters (gray list bacкгround цвет added for illustration only):

Table generated by {{Навигационная полоса2}} with изображение, изображение_слева, lists, and without groups, вверху, внизу (gray list bacкгround цвет added for illustration only):

Examples

No изображение

{{Навигационная полоса2
|name  = Навигационная полоса2/Документация
|заголовок = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]{{-}}''without изображение''

|group1 = Centre
|listl  = [[Cyberjaya]]

|group2 = Area
|list2  = [[Klang Valley]]

|group3 = Major landmarks
|list3  = [[Petronas Twin Towers]]{{•}} [[Kuala Lumpur Tower]]{{•}} [[Kuala Lumpur Sentral]]{{•}} [[Technology Park Malaysia]]{{•}} [[Putrajaya]]{{•}} [[Cyberjaya]]{{•}} 
[[Kuala Lumpur International Airport]]

|group4 = Infrastructure
|list4  = [[Express Rail Link]]{{•}} [[KL-KLIA Dedicated Expressway]]

|group5 = Prime applications
|list5  = [[EGovernment]]{{•}} [[MyKad]]  
}}

With изображение, without groups

{{Навигационная полоса2
|name  = Навигационная полоса2/Документация
|заголовок = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|изображение = [[Файл:Flag of Malaysia.svg|80px]]
|listl = [[Petronas Twin Towers]]{{•}} [[Kuala Lumpur Tower]]{{•}} [[Kuala Lumpur Sentral]]{{•}} [[Technology Park Malaysia]]{{•}} [[Putrajaya]]{{•}} [[Cyberjaya]]{{•}} [[Kuala Lumpur International Airport]]
}}

With two images, without groups, multiple lists

{{Навигационная полоса2
|name  = Навигационная полоса2/Документация
|заголовок = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|изображение = [[Файл:Flag of Malaysia.svg|80px]]
|изображение_слева = [[Файл:Flag of Malaysia.svg|80px]]
|listl = [[Petronas Twin Towers]]{{•}} [[Kuala Lumpur Tower]]{{•}} [[Kuala Lumpur Sentral]]
|list2 = [[Express Rail Link]]{{•}} [[KL-KLIA Dedicated Expressway]]
|list3 = [[EGovernment]]{{•}} [[MyKad]]
|list4 = [[Klang Valley]]
}}

With изображение, groups, вверху, внизу

{{Навигационная полоса2
|name  = Навигационная полоса2/Документация
|заголовок = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|изображение = [[Файл:Flag of Malaysia.svg|80px]]

|вверху = вверху text goes here

|group1 = Centre
|listl  = [[Cyberjaya]]

|group2 = Area
|list2  = [[Klang Valley]]

|group3 = Major landmarks
|list3  = [[Petronas Twin Towers]]{{•}} [[Kuala Lumpur Tower]]{{•}} [[Kuala Lumpur Sentral]]{{•}} [[Technology Park Malaysia]]{{•}} [[Putrajaya]]{{•}} [[Cyberjaya]]{{•}} [[Kuala Lumpur International Airport]]

|group4 = Infrastructure
|list4  = [[Express Rail Link]]{{•}} [[KL-KLIA Dedicated Expressway]]

|group5 = Prime applications
|list5  = [[EGovernment]]{{•}} [[MyKad]]

|внизу  = Website: [http://www.msc.com.my/ www.msc.com.my]
}}

Child navboxes

It is possible to place multiple navboxes within a single border with the use of the border parameter, or by specifying the first parameter to be "child". The basic code for doing this is as follows (which adds a subgroup for the first group/list area):

{{Навигационная полоса2
|name = {{subst:PAGENAME}}
|заголовок = заголовок

|group1 = [optional]
|listl = {{Навигационная полоса2|child
   ...child navbox parameters...
 }}

...
}}

Subgroups example

This example shows how subgroups can be used. It is recommended that one uses {{Navbox subgroup}}, but the same result can be reached by using {{Навигационная полоса2}} with border = child or the first unnamed parameter set to child. Note that the четные_нечетные parameter is used to reverse striping in some of the subgroups in order to get all of the stripes to line up properly. If you wish to remove the striping altogether, you can set стиль_списков = background:transparent; in each of the navboxes.

Multiple show/hides in a single container

The example внизу is generated using a regular navbox for the main container, then its listl, list2, and list3 parameters each contain another navbox, with border = child set. Note that each of the child navboxes has its own VDE navbar; these could be hidden using navbar = plain for each of them, or by just leaving out the name parameter (child navboxes do not require the name parameter to be set, unlike regular navboxes).

Additional examples

You may find additional examples of complex subgroups and child navboxes at the advanced navbox examples page and the Navbox code test page.

Relationship with other Navbox templates

This navbox template is specifically designed to work in conjunction two other sister templates: {{Навигационная таблица с колонками}} and {{Navbox with collapsible groups}}. All three of these templates share common parameters for consistency and ease of use (such parameters are marked with a ^* in the complete parameter list вверху). Most importantly, all three of these templates can each be used as children of one another (by using the border = child parameter, or by specifying the first unnamed parameter to be child (i.e. use {{Навигационная полоса2|child, {{Навигационная таблица с колонками|child, or {{Navbox with collapsible groups|child). For examples on how this is done, see the page on advanced navbox examples.

Technical details

• This template uses CSS classes for most of its looks, thus it is fully skinnable.

• Internally this meta template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta templates since wiki markup has several drawbacks. For instance it makes it harder to use parser functions and special characters in parameters.

• For more technical details see the talk page, the CSS classes in MediaWiki:common.css and the collapsible table used to hide the box in MediaWiki:common.js.

Intricacies

• The 2px wide border between groups and lists is drawn using the border-left property of the list cell. Thus, if you wish to change the bacкгround цвет of the template (for example стиль_тела = background:purple;), then you'll need to make the border-left-цвет match the bacкгround цвет (i.e. стиль_списков = border-left-цвет:purple;). If you wish to have a border around each list cell, then the 2px border between the list cells and group cells will disappear; you'll have to come up with your own solution.

• The list cell width is initially set to 100%. Thus, if you wish to manually set the width of group cells, you'll need to also specify the стиль_списков to have width:auto. If you wish to set the group width and use images, it's up to you to figure out the CSS in the стиль_группы, стиль_списков, стиль_изображения, and стиль_изображения_слева parameters to get everything to work correctly. Example of setting group width:

стиль_группы = width:10em;

стиль_списков = width:auto;

• Adjacent navboxes have only a 1 pixel border between them (except in IE6, which doesn't support the necessary CSS). If you set the top or bottom margin of style/стиль_тела, then this will not work.

• The default margin-left and margin-right of the outer navbox table are set to "auto;". If you wish to use navbox as a float, you need to manually set the margin-left and margin-right values, because the auto margins interfere with the float option. For example, add the following code to use the navbox as a float:

style = width:22em;float:right;margin-left:1em;margin-right:0em;

См. также

• {{навигационная полоса}}
• {{навигационная таблица}}
• {{Навигационная таблица с колонками}}
• {{hider}}