Template:Navbox/doc - Revision history

76561198021843184: 6 revisions imported

2025-10-21T23:46:25Z

6 revisions imported

← Older revision		Revision as of 23:46, 21 October 2025
(No difference)

wgg>Cadaei: 1 revision imported: updating to current dlw version

2025-04-19T19:47:19Z

1 revision imported: updating to current dlw version

← Older revision		Revision as of 19:47, 19 April 2025
(No difference)

wgg>RheingoldRiver: Pushing 1.43-related updates to all wikis - please let us know at https://discord.gg/rTnST57tuW if you have questions or want to opt out

2025-03-27T04:41:24Z

Pushing 1.43-related updates to all wikis - please let us know at https://discord.gg/rTnST57tuW if you have questions or want to opt out

← Older revision		Revision as of 04:41, 27 March 2025
(No difference)

dlw>HaiFire3344: /* Parameters */ Via support:Special:Diff/7794/7879

2025-02-13T06:35:50Z

Parameters: Via support:Special:Diff/7794/7879

← Older revision		Revision as of 06:35, 13 February 2025
Line 1:		Line 1:
	{{no direct use}}		{{no direct use}}
	{{~~Uses Lua~~\|Navbox}}		{{UsesLua\|Navbox}}
	This template is designed to set up navigational templates relatively quickly with one or more lists of links. We highly recommend using this template for standardizing navigational templates and ease of use, especially for mobile devices.		This template is designed to set up navigational templates relatively quickly with one or more lists of links. We highly recommend using this template for standardizing navigational templates and ease of use, especially for mobile devices.

Line 9:		Line 9:

	{{Navbox		{{Navbox

	\| title = Items		\| title = Items
	\| striped = even		\| striped = even
Line 33:		Line 34:
	<syntaxhighlight lang="wikitext" style="overflow: auto;">		<syntaxhighlight lang="wikitext" style="overflow: auto;">
	{{Navbox		{{Navbox
			\| template = <template_title> <!-- Required. e.g. `\|template=Items` for template:Items -->

	\| title = Items		\| title = Items
	\| striped = even		\| striped = even
Line 64:		Line 67:
	! Parameter		! Parameter
	! Description		! Description
			\|-
			! <code>template</code><br><code>name</code>
			\| ('''Required''') Title of the template that the edit icon links to. e.g. <code>Items</code> for template:Items.
	\|-		\|-
	! <code>title</code>		! <code>title</code>
Line 73:		Line 79:
	* <code>collapsed</code> - the navbox will start closed and readers can expand it.		* <code>collapsed</code> - the navbox will start closed and readers can expand it.
	* <code>off</code>, <code>no</code>, or <code>plain</code> - the navbox will start open and cannot be collapsed.		* <code>off</code>, <code>no</code>, or <code>plain</code> - the navbox will start open and cannot be collapsed.
	Advanced users can modify this on a page-by-page basis; see [[#~~Snippets~~\|~~§ Snippets~~]].		Advanced users can modify this on a page-by-page basis; see [[support:RANGER navboxes#Controlling the collapsible\|the support wiki]] for more information.
	\|-		\|-
	! <code>editlinks</code>		! <code>editlinks</code>
Line 112:		Line 118:
	* <code>collapsed</code> - the section will start closed and readers can expand it.		* <code>collapsed</code> - the section will start closed and readers can expand it.
	* <code>off</code> or <code>plain</code> - the section will start open and cannot be collapsed.		* <code>off</code> or <code>plain</code> - the section will start open and cannot be collapsed.
	Advanced users can modify these on a page-by-page basis; see [[#~~Snippets~~\|~~§ Snippets~~]].		Advanced users can modify these on a page-by-page basis; see [[support:RANGER navboxes#Controlling the collapsible\|the support wiki]] for more information.

	Both parameters have no effect on sections with headers set to two or more <code>-</code>, which are always expanded and cannot be collapsed.		Both parameters have no effect on sections with headers set to two or more <code>-</code>, which are always expanded and cannot be collapsed.
Line 143:		Line 149:

	To assist with text alignment, three default classes are available: <code>align-left</code>, <code>align-center</code>, and <code>align-right</code>.		To assist with text alignment, three default classes are available: <code>align-left</code>, <code>align-center</code>, and <code>align-right</code>.

	~~In addition, two more default classes~~

	{\| class="wikitable"		{\| class="wikitable"

wgg>Cadaei: template name

2024-12-12T18:47:40Z

template name

← Older revision		Revision as of 18:47, 12 December 2024
Line 1:		Line 1:
	{{no direct use}}		{{no direct use}}
	{{~~UsesLua~~\|Navbox}}		{{Uses Lua\|Navbox}}
	This template is designed to set up navigational templates relatively quickly with one or more lists of links. We highly recommend using this template for standardizing navigational templates and ease of use, especially for mobile devices.		This template is designed to set up navigational templates relatively quickly with one or more lists of links. We highly recommend using this template for standardizing navigational templates and ease of use, especially for mobile devices.

wgg>Cadaei: from https://support.wiki.gg/wiki/Template:Navbox/doc

2024-12-12T18:37:09Z

from https://support.wiki.gg/wiki/Template:Navbox/doc

Show changes

wgg>Cadaei: taken from https://ark.wiki.gg/wiki/Template:Navbox/doc

2023-06-22T18:58:46Z

taken from https://ark.wiki.gg/wiki/Template:Navbox/doc

New page

{{doc/start}}
== Usage ==
Please remove the parameters that are left blank.

<pre style="overflow: auto;">{{Navbox
| name = {{subst:PAGENAME}}{{subst:void|Don't change anything on this line. It will change itself when you save.}}
| title =
| listclass = hlist
| state = {{{state|}}}

| above =
| image =

| group1 =
| list1 =

| group2 =
| list2 =

| group20 =
| list20 =

| below =
}}
</pre>

== Parameter list ==
{{Navbox
| name = Navbox/doc
| state = uncollapsed
| title = {{{title}}}
| above = {{{above}}}
| image = {{{image}}}
| group1 = {{{group1}}}
| list1 = {{{list1}}}
| group2 = {{{group2}}}
| list2 = {{{list2}}}
| list3 = {{{list3}}} ''without {{{group3}}}''
| group4 = {{{group4}}}
| list4 = {{{list4}}}
| below = {{{below}}}
}}

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

Notice "group1" (etc.) is optional, as are sections named "above/below".
{{clear}}
The basic and most common parameters are as follows (see [[#Parameter descriptions|below]] for the full list):

: <code>name</code> – the name of the template.
: <code>title</code> – text in the title bar, such as: <nowiki>[[Widget stuff]]</nowiki>.
: <code>listclass</code> – a CSS class for the list cells, usually <code>hlist</code> for horizontal lists. Alternatively, use bodyclass for the whole box.
: <code>state</code> – controls when a navbox is expanded or collapsed.
: <code>titlestyle</code> – a CSS style for the title-bar, such as: <code>background: gray;</code>
: <code>groupstyle</code> – a CSS style for the group-cells, such as: <code>background: #eee;</code>
: <code>above</code> – text to appear above the group/list section (could be a list of overall wikilinks).
: <code>image</code> – an optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be coded as <code><nowiki>[[File:</nowiki><var>XX</var><nowiki>.jpg|80px|link=|alt=]]</nowiki></code>.
: <code>imageleft</code> – an optional left-side image (code the same as the "image" parameter).
: <code>groupn</code> – the left-side text before list-n (if group-n omitted, list-n starts at left of box).
: <code>listn</code> – text listing wikilinks using a [[wikipedia:Help:Lists|wikilist]] format.
: <code>below</code> – optional text to appear below the group/list section.

== Parameter descriptions ==
The following is a complete list of parameters for using {{tlx|Navbox}}. In most cases, the only required parameters are <code>name</code>, <code>title</code>, and <code>list1</code>.

=== Setup parameters ===
:; ''name''
:: The name of the template, which is needed for the "V • T • E" ("View • Talk • 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'' [<code>autocollapse, collapsed, expanded, plain, off</code>]
:* Defaults to <code>autocollapse</code>. A navbox with <code>autocollapse</code> 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.
:* If set to <code>collapsed</code>, the navbox will always start out in a collapsed state.
:* If set to <code>expanded</code>, the navbox will always start out in an expanded state.
:* If set to <code>plain</code>, 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 • T • E links).
:* 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 <code><noinclude|></code>...<code></noinclude|></code> tags. This setting will force the box visible when standalone (even when followed by other boxes), displaying "[hide]", but then it will auto-collapse the box when stacked inside an article:
:: <code><nowiki>| state = </nowiki></code><code><noinclude|></code>expanded<code></noinclude|></code>
: 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:
:: <code><nowiki>| state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}</nowiki></code>
:* The <code><includeonly></code><code>|</code> will make the template expanded when viewing the template page by itself.
:; ''navbar''
:: If set to <code>plain</code>, the V • T • 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 <code>off</code> to remove the V • T • 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). 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''
{{doc/end}}