თარგი:ნავდაფა

(გინოწურაფილი რე თარგი:Navbox-შე)
დოკუმენტაცია დოკუმენტაცია
თე თანგი ირინუანს თანგიშ სინტაქსიშ უძგალაშო რთულ დო ეზოთერულ მუშებეფს.

რთხიინთ ვეცადათ თიშ თირუას დორწუმაფილი ვარეთჷ-და, ნამდა გარჩქილენა თიში ნწყილობა დო ხაზირი რეთ დუდშა გეჭოფათ თეშ გეშა მერინაფილი გავალინ. ნამდგარდია ექსპერიმენტიქ ოკო მუკორთას თანგიშ ოქარინჯეს ვარდა თქვანი მახვარებუშ ოფირჩას.

თარგი:ნავდაფა suite 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.

{{ნავდაფა
|ჯოხო    = {{subst:PAGENAME}}
|დუდჯოხო   = 
|სურათი   = 
|ჟილენი   = 

|ბუნა1  = 
|ერკებული1   = 

|ბუნა2  = 
|ერკებული2   = 
 ...
|ბუნა20 = 
|ერკებული20  = 

|გიმენი   = 
}}

Parameter list

The navbox uses lowercase parameter names, as shown in the box (at right). The mandatory name and title will create a one-line box if other parameters are omitted.

Notice "ბუნა1" (etc.) is optional, as are sections named "above/გიმენი".
The basic and most common parameters are as follows (see below for the full list):

name - the name of the template.
title - text in the title 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 title-bar, such as: background:gray;
ბუნასტილი - a CSS style for the group-cells, such as: background:#eee;
სურათი - an optional right-side image (coded as the whole image tag: [[სურათი:XX.jpg|90px]] ).
სურკვარჩხანშე - an optional left-side image (code the same was as the "სურათი" parameter).
above - text to appear above 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 below the group/list section.

Further details, and complex restrictions, are explained below 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 {{ნავდაფა}}. In most cases, the only required parameters are name, title, and ერკებული1, though child navboxes do not even require those to be set.

{{ნავდაფა}} shares numerous common parameter names as its sister templates {{Navbox with columns}} 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 title is specified, and the კონტური 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 title will remain centered (by using padding 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 padding will be used to keep the title 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.
ნავბარი
Defaults to Tნავბარი. 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 ნავბარი is not desired). Note that it is highly recommended that one does not hide the ნავბარი, in order to make it easier for users to edit the template, and to keep a standard style across pages.
კონტური
See section below 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 padding 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 padding 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 კონტური parameter):
{{ნავდაფა|child
...
}}

Cells

title
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 {{ნავდაფა}} is rather pointless without a title.
groupn
(i.e. ბუნა1, ბუნა2 დო ა.უ..) If specified, text appears in a header cell displayed to the left of listn. If omitted, listn uses the full width of the table.
listn
(i.e. ერკებული1, ერკებული2 დო ა.უ..) 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 listn may be preceded by a corresponding groupn parameter, if provided (see below).
სურათი
An image to be displayed in a cell below the title and to the right of the body (the groups/lists). For the image to display properly, the ერკებული1 parameter must be specified. The სურათი parameter accepts standard wikicode for displaying an image, i.e.
სურათი = [[სურათი:Example.jpg|100px]]
სურკვარჩხანშე
An image to be displayed in a cell below the title and to the left of the body (lists). For the image to display properly, the ერკებული1 parameter must be specified and no groups can be specified. The სურკვარჩხანშე parameter accepts standard wikicode for displaying an image, i.e.
სურკვარჩხანშე = [[სურათი:Example.jpg|100px]]
above
A full-width cell displayed between the titlebar and first group/list, i.e. above the template's body (groups, lists and image). In a template without an image, above behaves in the same way as the ერკებული1 parameter without the ბუნა1 parameter.
გიმენი
A full-width cell displayed გიმენი the template's body (groups, lists and image). In a template without an image, გიმენი behaves in the same way as the template's final listn parameter without a groupn 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 title, above, გიმენი, and group cells all at once. The style are not applied to list cells. This is convenient for easily changing the basic color 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 title, most often the titlebar's background color:
დუდსტილი = 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];
groupnstyle
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:
ბუნა3სტილი = background:red;color:white;
ერკებულსტილი
CSS styles to apply to all lists. Overruled by the ცალსტილი and ჭკულსტილი parameters (if specified) below.
listnstyle
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:
ერკებული5სტილი = background:#ddddff;
listpadding
A number and unit specifying the padding in each list cell. The list cells come equipped with a default padding of 0.25em on the left and right, and 0em on the top and bottom. Due to complex technical reasons, simply setting "ერკებულსტილი=padding:0.5em;" (or any other padding setting) will not work. Examples:
listpadding = 0.5em 0em; (sets 0.5em padding for the left/right, and 0em padding for the top/bottom.)
listpadding = 0em; (removes all list padding.)
ცალსტილი
ჭკულსტილი
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.
evenodd [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 color. 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 below.
ჟილენსტილი
გიმენსტილი
CSS styles to apply to the top cell (specified via the above parameter) and bottom cell (specified via the below parameter). Typically used to set background color or text alignment:
ჟილენსტილი = background:#nnnnnn;
ჟილენსტილი = text-align:[left/center/right];
სურათსტილი
სურკვარჩხანშეstyle
CSS styles to apply to the cells where the image/სურკვარჩხანშე 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 image 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; padding-left:1em; padding-right:1em; text-align:center;
ჟიჟილენსტილი = background:#ddddff; padding-left:1em; padding-right:1em; text-align:center;
გიმენსტილი = background:#ddddff; padding-left:1em; padding-right:1em; text-align:center;
ბუნასტილი = background:#ddddff; padding-left:1em; padding-right:1em; text-align:right;
ერკებულსტილი = background:transparent; text-align:left/center;
ცალსტილი = background:transparent;
ჭკულსტილი = background:#f7f7f7;

Since ერკებულსტილი and ცალსტილი are transparent odd lists have the color 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

დუდბუნა
This puts a group in the title area, with the same default styles as groupn. It should be used only in exceptional circumstances (usually advanced meta-templates) and its use requires some knowledge of the internal code of {{ნავდაფა}}; 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.
დუდბუნასტილი
The styles for the დუდბუნა cell.
დინოხსტილი
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 (title/above/groups/lists/below/images დო ა.უ..). 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 {{ნავდაფა}} without image, above and below parameters (gray list background color added for illustration only):


Table generated by {{ნავდაფა}} with image, above and below parameters (gray list background color added for illustration only):


Table generated by {{ნავდაფა}} with image, სურკვარჩხანშე, lists, and without groups, above, below (gray list background color added for illustration only):

Examples

No image

{{ნავდაფა
|ჯოხო  = Navbox/doc
|დუდჯოხო = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]{{-}}''without image''

|ბუნა1 = Centre
|ერკებული1  = [[Cyberjaya]]

|ბუნა2 = Area
|ერკებული2  = [[Klang Valley]]

|ბუნა3 = Major landmarks
|ერკებული3  = [[Petronas Twin Towers]]{{•}} [[Kuala Lumpur Tower]]{{•}} [[Kuala Lumpur Sentral]]{{•}} [[Technology Park Malaysia]]{{•}} [[Putrajaya]]{{•}} [[Cyberjaya]]{{•}} 
[[Kuala Lumpur International Airport]]

|ბუნა4 = Infrastructure
|ერკებული4  = [[Express Rail Link]]{{•}} [[KL-KLIA Dedicated Expressway]]

|ბუნა5 = Prime applications
|ერკებული5  = [[EGovernment]]{{•}} [[MyKad]]  
}}


With image, without groups

{{ნავდაფა
|ჯოხო  = Navbox/doc
|დუდჯოხო = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|სურათი = [[სურათი:Flag of Malaysia.svg|80px]]
|ერკებული1 = [[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

{{ნავდაფა
|ჯოხო  = Navbox/doc
|დუდჯოხო = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|სურათი = [[სურათი:Flag of Malaysia.svg|80px]]
|სურკვარჩხანშე = [[სურათი:Flag of Malaysia.svg|80px]]
|ერკებული1 = [[Petronas Twin Towers]]{{•}} [[Kuala Lumpur Tower]]{{•}} [[Kuala Lumpur Sentral]]
|ერკებული2 = [[Express Rail Link]]{{•}} [[KL-KLIA Dedicated Expressway]]
|ერკებული3 = [[EGovernment]]{{•}} [[MyKad]]
|ერკებული4 = [[Klang Valley]]
}}


With image, groups, above, below

{{ნავდაფა
|ჯოხო  = Navbox/doc
|დუდჯოხო = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|სურათი = [[სურათი:Flag of Malaysia.svg|80px]]

|ჟილენი = Above text goes here

|ბუნა1 = Centre
|ერკებული1  = [[Cyberjaya]]

|ბუნა2 = Area
|ერკებული2  = [[Klang Valley]]

|ბუნა3 = Major landmarks
|ერკებული3  = [[Petronas Twin Towers]]{{•}} [[Kuala Lumpur Tower]]{{•}} [[Kuala Lumpur Sentral]]{{•}} [[Technology Park Malaysia]]{{•}} [[Putrajaya]]{{•}} [[Cyberjaya]]{{•}} [[Kuala Lumpur International Airport]]

|ბუნა4 = Infrastructure
|ერკებული4  = [[Express Rail Link]]{{•}} [[KL-KLIA Dedicated Expressway]]

|ბუნა5 = Prime applications
|ერკებული5  = [[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 კონტური 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):

{{ნავდაფა
|ჯოხო = {{subst:PAGENAME}}
|დუდჯოხო = Title

|ბუნა1 = [optional]
|ერკებული1 = {{ნავდაფა|child
   ...child navbox parameters...
 }}

...
}}

Subgroups example

This example shows how subgroups can be used. It is recommended that one uses {{ნავდაფა გიმენბუნა}}, but the same result can be reached by using {{ნავდაფა}} with კონტური = child or the first unnamed parameter set to child. Note that the evenodd 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 below is generated using a regular navbox for the main container, then its ერკებული1, ერკებული2, and ერკებული3 parameters each contain another navbox, with კონტური = child set. Note that each of the child navboxes has its own VDE ნავბარი; these could be hidden using ნავბარი = 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: {{Navbox with columns}} 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 above). Most importantly, all three of these templates can each be used as children of one another (by using the კონტური = child parameter, or by specifying the first unnamed parameter to be child (i.e. use {{ნავდაფა|child, {{ნავდაფა with columns|child, or {{ნავდაფა 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.

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 background color of the template (for example შქასტილი = background:purple;), then you'll need to make the border-left-color match the background color (i.e. ერკებულსტილი = border-left-color: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 სურკვარჩხანშეstyle 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;

See also

  • {{Navbox with columns}} – Allows columns instead of groups/lists
  • {{Navbox with collapsible groups}} – Another variation.
  • Wikipedia:Line break handling – The how-to guide about how to handle word wraps (line breaks) on Wikipedia, such as the wrapping of the link lists used in navboxes.
  • {{Nowrap begin}} – The recommended format for adding bullets, pipes, or dashes between list items. The page describes how to go about using them with proper wrapping.
  • {{Nobold}} – To display text at normal font-weight within a context where the default font-weight is bold, e.g. header cells in tables.
  • {{•}} and {{•}} – The dot and bullet commonly used to separate items in Navbox lists.


ონავიგაციე თანგიშ ალაზიმაფა
გჷმაფაჩუ დუდჯოხოშ ფერი სურათი ბუნეფი სტილი (ჯინჯ.)
პარამეტრეფი
მინუშეფი
{{ნავდაფა}} გჷმაფაჩუ ნავდაფა შქაგურიშ კვარჩხ/მარძგვანშე ქო ქო {{USCongress}}, {{ბჟაშ სისტემა}}
{{ნავიგაცია სჷმეტეფით}} გჷმაფაჩუ ნავდაფა სჷმეტეფიშ კვარჩხ/მარძგვანშე ვარი ქო {{Current U.S. Senators}}, {{Czech lands}}
{{ნავდაფა გჷმაფაჩუ ბუნეფით}} გჷმაფაჩუ ნავდაფა შქაგურიშ ვარა ირი ერკებულიშ კვარჩხ/მარძგვანშე ქო ქო {{University of Michigan}}, {{Scouting}}
გოფაჩუაშ ატრიბუტეფი
ტიპი CSS კლასეფი ჯავასკრიპტი იფაჩუ მუჟამცჷთ ომანგუ
ოჭყაფუ დგომარ.
მეგაფა
გჷმაფაჩუ ცხირეფი გჷმაფაჩუ გოხურგილი რე Common.js-ით 2 ვარა უმოსი გოფაჩუა ხასჷლას ქო ქო