Template:Simple navbox/doc

From Uncyclopedia, the content-free encyclopedia
Jump to navigation Jump to search

A simple navbox template used to construct other navigational templates. Use {{Navbox}} for anything more complicated.

Usage

Simple box with links

{{Simple navbox
|name = {{subst:PAGENAME}}
|title = 
|image =
|list =
}}

Simple box with ordered links

{{Simple navbox
|name = {{subst:PAGENAME}}
|title = 
|image = 
|group1 =
|list1 =
|group2 =
|list2 =
<!-- ... -->
}}

Simple box with nested navboxes

{{Simple navbox
|name = {{subst:PAGENAME}}
|title = 
|image = 
|list =
{{Simple navbox
|title =
|list =
}}
{{Simple navbox
|title =
|group1 =
|list1 =
}}
<!-- ... -->
}}

Parameter list

{{{title}}}

{{{above}}}

{{{imageleft}}}
{{{group1}}}

{{{list1}}}

{{{group2}}}

{{{list2}}}

{{{group3}}}

{{{list3}}}

{{{image}}}

{{{below}}}

All Parameters

name – the page name for the template, needed for the "v·t·e" section to work, omitting this will remove the "v·t·e" navbar
title – text in the title bar
collapsible or collapse – defaults to yes, set to no if you want a non-collapsible navigation template
image – optional image, uses wiki syntax, as in: [[File:Example.png|50px]], will not show if |collapsible=no
imageleft or image2 – optional image, like image except it's on the left. You can use both image and imageleft, unless image-outer is used.
image-align – defaults to right[1]
image-valign – defaults to "center" (like middle in "valign"), set to "auto" to vertically align the image to top, accepts values for "align-self" CSS property
image-outer – like image, except it sits next to the header and content, does NOT accept image-align or image-valign parameters, MUST have |collapsible=no, overrides image as well.
bodystyle – inline styling for the whole navbox container, such as: background:red; color:white
titlestyle or headerstyle – inline styling for the navbox header, such as: font-size:200%; color:green[2]
navcontentstyle – inline styling for all navbox content.
containerstyle – inline styling for navbox content, except {{{above}}} and {{{below}}}.
contentstyle – inline styling for div containing all grouped list content, such as: color:gray; font-variant:small-caps
list – text listing the links you want, NOT compatible with group1,list1

You can also use group1, list1 parameters to make an ordered list.

group1 – name of group, goes up to 20
list1 – list of links for group, goes up to 20
groupstyle – inline styling for each of the group rows, such as background: pink, border:1px solid blue[3]
liststyle – inline styling for each of the list rows, such as background: pink, border:1px solid blue
oddgroupstyle and evengroupstyle – inline styling for every odd or even group, overrides groupstyle[4]
oddliststyle and evenliststyle – inline styling for every odd or even list, overrides liststyle
groupnstyle – inline styling for the nth group row, with n being the number, like group4style, overrides oddgroupstyle and evengroupstyle
listnstyle – inline styling for the nth list row, with n being the number, like list4style, overrides oddliststyle and evenliststyle
above or below – adds a group row above, or below, the group list
abovestyle or belowstyle – inline styling for the "above" or "below" row
tablestyle – inline styling for table holding grouped lists

CSS trickery

WARNING: WILL BREAK STUFF IF YOU DO SOMETHING WRONG

You can specify a unique class for the template navbox by using bodyclass

bodyclass – add your own CSS classes, either existing ones (i.e. "hlist", "hlist toccolours") or a custom one, which can be used with either {{#CSS:}} or TemplateStyles to further customize the navbox template
templatestyles – loads a CSS stylesheet: setting parameter to Example/styles.css would load the stylesheet at Template:Example/styles.css

Footnotes

  1. ↑ You can either use image and move it to the left, or just use imageleft. The way the code works, using imageleft and setting this parameter to left will move it to the right.
  2. ↑ Using this paramter adds the .simple-header-modified class to the header, which makes the VTE and navtoggle links inherit the color of the header, which saves time and effort for 99% of usecases. If that's not something you want, you'll have to use the templatestyles method in the CSS trickery section.
  3. ↑ Using this parameter adds the .simple-group-modified class to the group-row table, which slightly modifies the styling of the groups and rows to make navboxes with colored backgrounds in group names look more organized. It shouldn't affect the look too much if that is not your intent, but that is still something to keep note of.
  4. ↑ Unlike {{Navbox}}, no "oddstyle" or "evenstyle" exists
Retrieved from "https://en.uncyclopedia.co/w/index.php?title=Template:Simple_navbox/doc&oldid=6419931"