Gah - a solution with more questions. – EntropicLqd

Difference between revisions of "Template:Navbox/doc"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(New page: <noinclude>{{Documentation subpage}}</noinclude> <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> This template provides a basic framework for a navigation box. =...)
 
(Usage)
Line 4: Line 4:
  
 
==Usage==
 
==Usage==
A navigation box with a simply body:
+
A simple navigation box:
 
<pre>
 
<pre>
 
{{navbox
 
{{navbox
Line 17: Line 17:
 
| body  = (some links here)
 
| body  = (some links here)
 
}}
 
}}
 +
The parameter '''title''' is mandatory and defines the navigation box title. The '''name''' is optional and specifies the name of the template that implements the navigation box for the view/discuss/edit links in the top right corner. The parameter '''body''' is an alias for '''list1''' (see next example) and specifies the content of the (first list of the) navigation box.
 +
The optional parameters '''headerstyle''' and '''bodystyle''' can be used to modify the appearance of the navigation box.
  
 
A navigation box with two named list groups:
 
A navigation box with two named list groups:
Line 37: Line 39:
 
| list2  = (some more links)
 
| list2  = (some more links)
 
}}
 
}}
Up to six list groups are supported.
+
Up to six list groups are supported. Group labels are optional and will not be rendered if empty. Labeled and unlabeled lists can be used in the same navigation box.
 +
 
 +
Group labels can be customized with the '''groupstyle''' parameter. Additionally odd and even list bodies can be customized with the '''oddstyle''' and '''evenstyle''' properties respectively.
  
 
<includeonly><!--
 
<includeonly><!--

Revision as of 09:07, 5 March 2008

This subpage contains documentation, categories and other content that is not part of the template.
To view the template page itself, see Template:Navbox.

This template provides a basic framework for a navigation box.

Usage

A simple navigation box:

{{navbox
| name  = Navbox/doc
| title = Navigation
| body  = (some links here)
}}

The parameter title is mandatory and defines the navigation box title. The name is optional and specifies the name of the template that implements the navigation box for the view/discuss/edit links in the top right corner. The parameter body is an alias for list1 (see next example) and specifies the content of the (first list of the) navigation box. The optional parameters headerstyle and bodystyle can be used to modify the appearance of the navigation box.

A navigation box with two named list groups:

{{navbox
| name   = Navbox/doc
| title  = Navigation
| group1 = Group 1
| list1  = (some links here)
| group2 = Group 2
| list2  = (some more links)
}}

Up to six list groups are supported. Group labels are optional and will not be rendered if empty. Labeled and unlabeled lists can be used in the same navigation box.

Group labels can be customized with the groupstyle parameter. Additionally odd and even list bodies can be customized with the oddstyle and evenstyle properties respectively.