Template:Navbox/doc

From Nookipedia, the Animal Crossing wiki
Jump to navigation Jump to search
Emotion Surprise NH Icon cropped.png
This template is complex or is transcluded on a large number of pages.
Due to the sensitive nature of this template, caution is advised before editing. Any changes should first be tested in a sandbox. Please consider discussing planned changes on the talk page or with staff members before implementing them.
Emotion Surprise NH Icon cropped.png
This template is complex or is transcluded on a large number of pages.
Due to the sensitive nature of this template, caution is advised before editing. Any changes should first be tested in a sandbox. Please consider discussing planned changes on the talk page or with staff members before implementing them.

Usage

{{Navbox
 | Title          = 
 | Link           = 
 | Icon           = 
 | IconSize       = 
 | Image          = 
 | PrimaryColor   = 
 | SecondaryColor = 
 | Width          =

 | Above          =
 | Group          = 
 | GroupLink      = 
 | List           = 

 | Below          =
 | BelowLink      =
}}

This template is intended to be used for all navboxes, as it allows them to be easily created and maintained and gives them a consistent visual style and functionality. It is very complex, and has been designed to adapt to the many different needs of various navboxes across the wiki. This template is mobile-friendly and will appear with repositioned elements on mobile devices.

The following parameters primarily set the visual style of the template:

  • Title sets the displayed heading of the navbox.
  • Link sets a linked page for the navbox title.
  • Icon is an optional parameter that allows an image or text to appear in the upper-left corner of the navbox.
  • IconSize is an optional parameter that allows a custom size for the icon to be specified.
  • Image sets the image file to be displayed on the right side of the navbox.
  • PrimaryColor sets the display colors of the infobox. Requires hue and saturation values in in HSL format, as other colors on the template are adjusted dynamically based on these values.
  • SecondaryColor allows a complimentary color to be specified. Requires hue and saturation values in in HSL format, as other colors on the template are adjusted dynamically based on these values.
  • Width allows a custom width to be specified for the navbox (for style reasons this parameter should normally not be used)

The following parameters primarily set the content of the template:

  • Above sets a text heading to be displayed above the group and list.
  • Group sets a text heading for the group, which appears to the left of the list.
  • GroupLink sets sets a linked page for the group heading text.
  • List sets the content that appears in the list. This should always be wikilinks to articles, and each link should be separated with a bullet (•) symbol.

The following parameters set the content of the navbox footer. This should be used to link to the topic's category, project page or relevant image category. It can also be used for broad topic links that don't fit into any of the groups in the navbox.

  • Below sets the text of a link that will appear in the footer.
  • BelowLink sets the linked page for the specified text.

The infobox template supports up to 10 groups with lists and 5 footer links. When adding more than one, you must append the sequential number to the names of the parameters like so. Failing to this will result in display errors.

 | Above2         =
 | Group2         =
 | Group2Link     =
 | List2          =

 | Below2         = 
 | Below2Link     =

Example

{{Navbox
 | Title          = Fashion
 | Icon           = Tops NH Icon cropped.png
 | Image          = [[File:Gracie NLa.png|40px|link=]]
 | PrimaryColor   = 322 49

 | Group          = Clothing
 | List           = [[Clothes]] • [[Accessories]] • [[Bottoms]] • [[Dress|Dresses]] • [[Headgear]] • [[Shoes]] • [[Socks]] • [[Tops]] • [[Umbrellas]] • [[Wigs]]

 | Group2         = Concepts
 | List2          = [[Design]]s • [[Look]] • [[Hairstyle]] • [[Mii Mask]]

 | Group3         = Merchants
 | List3          = [[Able Sisters]] • [[GracieGrace]] • [[Kicks (shop)|Kicks]] • [[Shampoodle]]

 | Group4         = Designers
 | List4          = [[Gracie]] • [[Harriet]] • [[Kicks]] • [[Label]] • [[Mabel]] • [[Sable]]

 | Below          = Category
 | BelowLink      = :Category:Furniture
 | Below2         = Project
 | Below2Link     = Nookipedia:Project Fashion
}}