Template:Navbox/doc - Revision history

Ostermayer at 21:07, 29 July 2014

2014-07-29T21:07:58Z

@@ Line 88: / Line 88: @@
 :* The {{tag|includeonly|o}}<code>|</code> will make the template expanded when viewing the template page by itself.
 ::* Example: {{tl|peso}} with autocollapse as the default initial state. [[Catalan peseta]] transcludes it and has only one navbox. So the peso navbox shows. [[Chilean peso]] has more than two navboxes. So the peso navbox collapses.
 :* The template {{tl|Collapsible option}} can be added after the template definition to explain how to use the <code>state</code> parameter or to the instructions on the {{tl|documentation subpage}}.
 :; ''navbar''*
@@ Line 563: / Line 562: @@
 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), discuss (d), edit (e) navbar links are hidden using <code>navbar = plain</code> for each of them, or could be suppresed by just leaving out the ''name'' parameter (child navboxes do not require the name parameter to be set, unlike regular navboxes).
-{{Navbox
 == Relationship with other Navbox templates ==

Ostermayer at 01:09, 12 February 2014

2014-02-12T01:09:33Z

← Older revision		Revision as of 01:09, 12 February 2014
Line 51:		Line 51:
	Notice "group1" (etc.) is optional, as are sections named "above/below".		Notice "group1" (etc.) is optional, as are sections named "above/below".
	{{clear}}		{{clear}}
	The basic and most common parameters are as follows ~~(see [[#Parameter descriptions\|below]] for the full list)~~:		The basic and most common parameters are as follows :

	: <code>name – </code>the name of the template.		: <code>name – </code>the name of the template.

Ostermayer: /* Copying to other projects or wikis? */

2014-02-12T00:15:04Z

Copying to other projects or wikis?

← Older revision		Revision as of 00:15, 12 February 2014
Line 669:		Line 669:
	* 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:		* 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:
	::<code>style = width: 22em; float: right; margin-left: 1em; margin-right: 0;</code>		::<code>style = width: 22em; float: right; margin-left: 1em; margin-right: 0;</code>

	~~=== Copying to other projects or wikis? ===~~
	Using this template on other wikis requires [[HTML Tidy]] to be turned on. A version that does not require Tidy can be found at [[Wikipedia:WikiProject Transwiki/Template:Navbox]]. (That version generally shouldn't be used here on the English Wikipedia.) More detailed information on copying {{tlf\|Navbox}} to other wikis can be found on the [[Template talk:Navbox\|talk page]].

	=== Known issues ===		=== Known issues ===

Ostermayer at 23:33, 11 February 2014

2014-02-11T23:33:57Z

← Older revision		Revision as of 23:33, 11 February 2014
Line 54:		Line 54:

	: <code>name – </code>the name of the template.		: <code>name – </code>the name of the template.
	: <code>title – </code>text in the title bar, such as: <nowiki>[[~~Widget stuff~~]]</nowiki>.		: <code>title – </code>text in the title bar, such as: <nowiki>[[Malaria]]</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>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>state – </code>controls when a navbox is expanded or collapsed.
Line 63:		Line 63:
	: <code>imageleft – </code>an optional left-side image (code the same as the "image" parameter).		: <code>imageleft – </code>an optional left-side image (code the same as the "image" parameter).
	: <code>group<sub>n</sub> – </code>the left-side text before list-n (if group-n omitted, list-n starts at left of box).		: <code>group<sub>n</sub> – </code>the left-side text before list-n (if group-n omitted, list-n starts at left of box).
	: <code>list<sub>n</sub> – </code>text listing wikilinks using a ~~[[Help:Lists\|wikilist]]~~ format.		: <code>list<sub>n</sub> – </code>text listing wikilinks using a list format.
	: <code>below – </code>optional text to appear below the group/list section.		: <code>below – </code>optional text to appear below the group/list section.

Line 89:		Line 89:
	::* Example: {{tl\|peso}} with autocollapse as the default initial state. [[Catalan peseta]] transcludes it and has only one navbox. So the peso navbox shows. [[Chilean peso]] has more than two navboxes. So the peso navbox collapses.		::* Example: {{tl\|peso}} with autocollapse as the default initial state. [[Catalan peseta]] transcludes it and has only one navbox. So the peso navbox shows. [[Chilean peso]] has more than two navboxes. So the peso navbox collapses.
	::* Example: {{tl\|Historical currencies of Hungary}} with <code><nowiki>\| state = {{{state<includeonly>\|expanded</includeonly>}}}</nowiki></code> as the default initial state. 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.		::* Example: {{tl\|Historical currencies of Hungary}} with <code><nowiki>\| state = {{{state<includeonly>\|expanded</includeonly>}}}</nowiki></code> as the default initial state. 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.
	:* The template {{tl\|Collapsible option}} can be added ~~to a {{tag\|noinclude\|p}} section~~ after the template definition to explain how to use the <code>state</code> parameter or to the instructions on the {{tl\|documentation subpage}}.		:* The template {{tl\|Collapsible option}} can be added after the template definition to explain how to use the <code>state</code> parameter or to the instructions on the {{tl\|documentation subpage}}.
	:; ''navbar''*		:; ''navbar''*
	:: If set to <code>plain</code>, the <span style="font-size: 88%;">V • T • 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 • T • 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.		:: If set to <code>plain</code>, the <span style="font-size: 88%;">V • T • 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 • T • 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.
Line 110:		Line 110:
	:: 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.'':		:: 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.'':
	::: <code><nowiki>[[File:</nowiki><var>XX</var><nowiki>.jpg\|80px\|link=\|alt=]]</nowiki></code>		::: <code><nowiki>[[File:</nowiki><var>XX</var><nowiki>.jpg\|80px\|link=\|alt=]]</nowiki></code>
	::: nb: including "\|right" will produced the usual left margin to provide separation from the list items ~~and [[zebra striping]]~~.		::: nb: including "\|right" will produced the usual left margin to provide separation from the list items.
	:; ''imageleft''*		:; ''imageleft''*
	:: 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 ''list1'' parameter must be specified and no groups can be specified. It accepts the same sort of parameter that ''image'' accepts.		:: 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 ''list1'' parameter must be specified and no groups can be specified. It accepts the same sort of parameter that ''image'' accepts.
	:; ''below''*		:; ''below''*
	:: A full-width cell displayed ''below'' the template's body (groups, lists and image). In a template without an image, ''below'' behaves in the same way as the template's final ''list<sub>n</sub>'' parameter without a ''group<sub>n</sub>'' parameter~~. For an example of the ''below'' parameter in use, see {{oldid\|Main Page\|352612160\|this}} version of {{tl\|Lists of the provinces and territories of Canada}}~~.		:: A full-width cell displayed ''below'' the template's body (groups, lists and image). In a template without an image, ''below'' behaves in the same way as the template's final ''list<sub>n</sub>'' parameter without a ''group<sub>n</sub>'' parameter.

	=== Style parameters ===		=== Style parameters ===
Line 501:		Line 501:
	}}		}}

	~~== Child navboxes ==~~
	~~{{Selfref\|For additional examples, see the [[Template:Navbox/testcases\|Navbox testcases page]].}}~~

	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):		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):
Line 676:		Line 674:

	=== Known issues ===		=== Known issues ===
	# If the heading of the navbox spans more than one line, the second line will be displayed to the right of center~~. This can be avoided by hard-coding linebreaks with {{tag\|br\|single\|params=clear="all"}}~~.		# If the heading of the navbox spans more than one line, the second line will be displayed to the right of center.

Ostermayer: Created page with "{{Documentation subpage}} This template allows a navigation template to be set up relatively ..."

2014-02-11T23:10:00Z

Created page with "{{Documentation subpage}}  This template allows a navigation template to be set up relatively ..."

Show changes