Templat:Navbox/doc: Perbedaan antara revisi

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

<presyntaxhighlight lang="wikitext" style="overflow: auto;">{{Navbox

| list3 group3 = {{{list3}}} ''without {{{group3}}}''

: <code>name</code> – the name (Wikipedia location) of the template.

: <code>image</code> – an optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be codedsuch as: <code><nowiki>[[File:</nowiki><var>XX</var><nowiki>.jpg|80px|link=|alt=]]</nowiki></code>.

: <code>group_n</code> – the left-side text before list-n (if group-n omitted, list-n startsextends atto the left edge of the box, and defaults to <code>text-align:center</code> styling).

: <code>list_n</code> – text listing wikilinks using a [[Help:ListsList|wikilist]] format.

The following is a complete list of parameters for using {{tl|Navbox}}. In most cases, the only required parameters are <code>name</code>, <code>title</code>, and <code>list1</code>, though [[Template:Navbox/doc#Child navboxes|child navboxes]] do not even require those to be set.

{{tl|Navbox}} shares numerous common parameter names with its sister templates, {{tl|Navbox with columns}} and {{tl|Navbox with collapsible groups}}, for consistency and ease of use. Parameters marked with an asterisk (*) are common to all three master templates.

:; ''name''*

:: The name of the template, which is needed for the "V&nbsp;• T&nbsp;• E" ("View&nbsp;• Talk&nbsp;• Edit") links to work properly on all pages where the template is used. You can enter <code><nowiki>{{subst:PAGENAME}}</nowiki></code> for this value as a shortcut. The name parameter is only mandatory if a <code>title</code> is specified, and the <code>border</code> parameter is not set, and the <code>navbar</code> parameter is not used to disable the navbar.

:; ''state''* <span style="font-weight:normal;">[<code>autocollapse, collapsed, expanded, plain, off</code>]</span>{{anchor|Autocollapse}}

:* Defaults to <code>autocollapse</code>. A navbox with <code>autocollapse</code> will start out collapsed if there are two or more tablescollapsible elements on the same page that use other collapsible tables. Otherwise, the navbox will be expanded. For the technically minded, see [[MediaWiki:Common.js]] (search for "autocollapse").

:* If set to <code>off</code>, 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.

: To show the box when standalone (non-included) but then auto-hide contents when in an article, put "expanded" inside {{tag|noinclude|p}} tags. This setting will force the box to be visible when standalone (even when followed by other boxes), displaying "[hide]", but then it will 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: <pre><nowiki>| state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}</nowiki></pre>

::** Example 1: {{tl|Peso}} with ''autocollapse'' as the default initial state. [[Catalan peseta]] transcludes it and has only one navbox; thus, the peso navbox shows. [[Chilean peso]] has more than two navboxes; thus, the peso navbox collapses.

::** Example 2: {{tl|Historical currencies of Hungary}} with ''expanded'' as the default initial state, as such: <pre>| state = {{{state<includeonly>|expanded</includeonly>}}}</pre> All transcluding articles show the content by default, unless there is a hypothetical article that specifies <code><nowiki>{{templatename|state=collapsed}}</nowiki></code> when transcluding.

:; ''navbar''*

:: If set to <code>plain</code>, the <span style="font-size: 88%;">V&nbsp;• T&nbsp;• E</span> links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the title centered. Use <code>off</code> to remove the <span style="font-size: 88%;">V&nbsp;• T&nbsp;• E</span> 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). It is highly recommended that one 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 later section on [[#Child navboxes|using navboxes within one another]] for examples and a more complete description.'' If set to <code>child</code> or <code>subgroup</code>, then the navbox can be used as a borderless child that fits snugly 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 <code>none</code>, 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 <code>none</code> option inside of another navbox; similarly, only use the <code>child</code>/<code>subgroup</code> 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):

::: <code><nowikipre>{{Navbox|child|...}}</nowiki></codepre>

:; ''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 <code><nowiki>{{-}}</nowiki></code> to ensure proper centering. This parameter is technically not mandatory, but using {{tl|Navbox}} is rather pointless without a title.

:; ''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 ''list1'' parameter without the ''group1'' parameter.

:; ''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. ''list1'', ''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 <code><nowiki><div> </div></nowiki></code>. 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 below).

::Entries should be separated using a [[newline]] and an [[asterisk]] (*). If instead two asterisks are used, it provides [[Nesting (computing)|nesting]] within the previous entry by enclosing the entry with brackets. Increasing the number of asterisks used increases the number of brackets around entries.

:; ''image''*

:: 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 ''list1'' parameter must be specified. The ''image'' parameter accepts standard wikicode for displaying an image, ''e.g.'': <pre>[[File:</nowiki><var>XX</var><nowiki>.jpg|80px|link=|alt=]]</pre> nb: including "|right" will produce the usual left margin to provide separation from the list items and [[Zebra striping (computer graphics)|zebra striping]].

:; ''bodystyle''*

:: Specifies [[Cascading Style Sheets|CSS]] styles to apply to the template body. This option should be used sparingly as it can lead to visual inconsistencies. Examples:

:::* <code>bodystyle = background: #''nnnnnn'';</code>

:::* <code>bodystyle = width: ''N''&nbsp;[em/%/px or width: auto];</code>

:::* <code>bodystyle = float: [''left/right/none''];</code>

:::* <code>bodystyle = clear: [''right/left/both/none''];</code>

:; ''basestyle''*

:: CSS styles to apply to the ''title'', ''above'', ''below'', and ''group'' cells all at once. The styles 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. Example: Examples<code>basestyle = background: lightskyblue;</code>

:::* <code>titlestyle = background: ''#nnnnnnname'';</code>

:::* <code>titlestyle = background: ''name''none;</code> — for no background color

:::* <code>groupstyle = backgroundtext-align: #[''nnnnnnleft/center/right''];</code>

:::* <code>groupstyle = textvertical-align: [''lefttop/centermiddle/rightbottom''];</code>

:; ''groupwidthliststyle''*

:::* <code>list5stylelistpadding = background: #ddddff0;</code> (removes all list padding.)

:; ''listpaddingoddstyle''*

:; ''evenstyleabovestyle''*

<sourcesyntaxhighlight lang="css">

:; ''bodyclass''

:; ''aboveclass''

:; ''groupclass''

:; ''listclass''

:; ''belowclass''

:: This enables attaching a CSS class to group or list cells. The most common use for ''listclass'' is to give it the <code>hlist</code> class that will cause lists to render horizontally. All these parameters accept the <code>hlist</code> class, but if more than one parameter is used for <code>hlist</code>, use {{para|bodyclass|hlist}} instead.

:; ''bodyclass''

:: This parameter is inserted into the "class" attribute for the navbox as a whole.

:; ''titleclass''

:: This parameter is inserted into the "class" attribute for the navbox's title caption.

<sourcesyntaxhighlight lang="moinwikitext" style="overflow: auto;">

{{Navbox

| name = Navbox/doc

| title = [[MSC Malaysia]]

| listclass = hlist

| name = Navbox/doc

The example below is generated using a regular navbox for the main container, then its list1, list2, and list3 parameters each contain another navbox, with <code>1 = child</code> set. The view (v), discusstalk (dt), edit (e) navbar links are hidden using <code>navbar = plain</code> for each of them, or could be suppressed by just leaving out the ''name'' parameter (child navboxes do not require the name parameter to be set, unlike regular navboxes).

| title = [[File:Blason France moderne.svg|x17px|link=|alt=]] [[File:Flag of France.svg|x17px|link=|alt=]] [[French colonial empire|Former French overseas empire]]

This navbox template is specifically designed to workworks in conjunction with two other sister templates: {{tl|Navbox with columns}} and {{tl|Navbox with collapsible groups}}. All three of these templates share common parameters for consistency and ease of use (such parameters are marked with an asterisk (*) in the [[#Parameter descriptions|parameter descriptions]] list hereinbefore). Most importantly, each template can be used as a child of one another (by using the {{para|border|child}} parameter, or by specifying the first unnamed parameter to be <code>child</code>. For example: <code><nowiki>{{Navbox|child ...}}</nowiki></code>, <code><nowiki>{{Navbox with columns|child ...}}</nowiki></code> or <code><nowiki>{{Navbox with collapsible groups|child ...}}</nowiki></code>.)

::** <code>bodystyle = width: 22em; float: right; margin-left: 1em; margin-right: 0;</code>

=== Copying to other projects or wikis? ===

MoreIf detailedyou informationare ontrying copyingto copy {{tlf|Navbox}} to your local wiki, there are several other wikisthings canthat must be foundinstalled onor thecopied [[Templateover talk:Navbox|talkas page]].well:

=== KnownTemplateData issues ===

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox other||

<!-- CategoriesAdd gocategories below this line, please;and interwikis go toat Wikidata, thank you! -->

[[Category:TemplatNavbox navigasimeta-templates| ]]

[[Category:TemplatTemplates yanggenerating menghasilkan mikroformatmicroformats]]

[[Category:MetatemplatTemplates Wikipediathat are not mobile friendly]]

[[Category:TidakCollapse layak cetaktemplates]]