View source for Information:Navigation template

{{hatnote|For the navigation template guideline, see [[BattleTechWiki:Categories, lists, and navigation templates#Navigation templates|BattleTechWiki:Categories, lists, and navigation templates §&nbsp;Navigation templates]].}}
{{hatnote|For the Navbox template page, see [[Template:Navbox]]}}
{{Supplement|interprets=[[Guideline:Categories, lists, and navigation templates]]|BTW:NAV}}
{{nutshell|A navigation template links between existing articles belonging to the same topic on BattleTechWiki. There are two types: "navigation boxes" (or navboxes) and "sidebars".}}
A '''navigation template''' is a grouping of links used in multiple related articles to facilitate navigation between those articles. Editing of a navigation template is done in a central place, the template page.

'''Do not rely solely on navboxes for links to articles highly relevant to a particular article.''' Navboxes are not displayed very well on the mobile version for BattleTechWiki, which accounts for around half of readers.
Navboxes are categorized under [[:Category:Navigational boxes]]. Some [[BattleTechWiki:WikiProject|WikiProjects]] maintain a list of their navigation templates.

== Types ==
There are two main varieties of navigation template: ''navigation boxes'' (or ''navboxes''), designed to sit at the very bottom of articles, and ''sidebars'', designed to sit at the side of the article text. The two are complementary and either or both may be appropriate in different situations.

* ''Navboxes'' are footer templates that sit below the [[BattleTechWiki:Manual of Style/Layout#Standard appendices and footers|standard article appendices]] and are laid out horizontally. They are created using the {{tl|navbox}} template. 
* ''Sidebars'' sit alongside content, in the same manner as [[BattleTechWiki:WikiProject Infoboxes|infoboxes]], and are predominantly laid out vertically. They are created using the {{tl|sidebar}} template. An example sidebar is shown to the right:

The two types are used interchangeably, and either or both may be appropriate in different circumstances. The primary differences between the two are:

* Navboxes are laid out horizontally, and so work best for longer lists of links in a small number of sub-categories. As they are placed at the very bottom of articles, they are better for broader lists of links than would be appropriate in a sidebar. Articles often have more than one navbox and content may overlap to a degree: nevertheless, not everything needs a navbox, so navbox templates should only be created when they would be genuinely useful as navigational tools.
* Sidebars are laid out predominantly vertically, and are placed relatively prominently in the body of articles alongside the text. This makes them useful for smaller amounts of directly relevant links. Tangential information should be kept out of sidebars. Few articles have more than one sidebar.

== Properties ==
The usual way to create navigation templates is to use the {{tl|navbox}} or {{tl|sidebar}} master templates. This simplifies the process of creating a functional and consistent template.
The style of any navigation template depends on its articles, how they are most intuitively presented, and previously established convention.

=== Navigation templates provide navigation ''within'' BattleTechWiki ===
* They are intended to link articles to each other.  That is, every article listed on a particular navigation template generally has the template placed on its page.
* The goal is not to cram as many related articles as possible into one space. Ask yourself, does this help the reader in reading up on related topics? Take any two articles in the template. Would a reader really want to go from A to&nbsp;B?
* They should be kept small in size as a large template has limited navigation value. For large navigation templates, consider the following:
** Splitting them into multiple, smaller templates on each sub-topic, and especially if individual [[Template:Navbox#Parameter list|groups]] within the template are [[BattleTechWiki:Manual of Style#Scrolling lists and collapsible content|collapsible]] [[Template:Navbox#Child navboxes|child navboxes]] that have BattleTechWiki articles about their subjects and the smaller navigation templates would still satisfy [[BattleTechWiki:Categories, lists, and navigation templates#Navigation templates|most or all of the guidelines for good navboxes]].
** Doing the above with only one template using [[mw:Help:Extension:ParserFunctions|ParserFunctions]].
** Linking only the immediately related articles while hiding the rest.
** Avoiding repeating links to the same article within a template.
* They should not be too small. A navigation template with fewer than a handful of links can easily be replaced by "See also" sections or relevant {{tl|main article}} and {{tl|see also}} links within the articles' sections, as well as be merged into a larger template.
* As [[BattleTechWiki:What BattleTechWiki is not#BattleTechWiki is not a mirror or a repository of links, images, or media files|BattleTechWiki is not a repository of links]], navigation templates do not provide [[BattleTechWiki:External links|external links]] to other websites.

=== Navigation templates provide navigation among ''existing'' articles ===
* ''Red links'' should normally be avoided unless they are very likely to be developed into articles that satisfy the [[BattleTechWiki:Notability|general notability guideline]] or one of the [[BattleTechWiki:Notability#Subject-specific notability guidelines|subject-specific notability guidelines]], and should not be included where [[BattleTechWiki:What BattleTechWiki is not|BattleTechWiki would be serving a non-encyclopedic purpose]] if articles were created from the red links.
* Red links can be retained in navigation templates that represent a well-defined and complete set of data, where deleting red links would leave an incomplete and misleading result. Even then, editors are encouraged to [[BattleTechWiki:Write the article first|write the article first]].
* Likewise, [[BattleTechWiki:Redirect|redirects]] should also normally be avoided. The general exception to this is when the redirect represents a distinct sub-topic of an article rather than simply being an alternative name.
* Unlinked text should be avoided. 

=== Navigation templates provide navigation between ''related'' articles ===
* If the articles are not established as related by [[BattleTechWiki:Identifying reliable sources|reliable sources]] in the actual articles, then it is probably not a good idea to interlink them. Additionally, relatedness is a necessary but not a sufficient condition]] for article inclusion in a navigation template.
* Articles included in a navigation template must be more than ''loosely-related''. While [[BattleTechWiki:Categories, lists, and navigation templates#Overlapping categories, lists and navigation templates are not considered duplicative|navigation templates that overlap with categories and lists are not considered duplicative]], the subjects of navigation templates need to be narrower and more specific topics than the subjects of many categories or lists. Otherwise, many templates will become oversized or lead to clutter on articles included in templates.
* Navigation templates should only be created for subjects where every article related to the subject will be included because including an arbitrary selection of articles related to the template's subject can [[BattleTechWiki:Neutral point of view|present a point of view]] or give the subjects of the select articles included [[BattleTechWiki:Neutral point of view#Due and undue weight|undue weight]].
* For complex topics, a navigation box can provide a comprehensive introduction to a topic. Editors who work on the subsidiary articles in isolation may be unaware of this context. The navigation template provides an easy way for the subsidiary articles, even when they begin as stubs, to instantly inherit the conceptual structure of the main article.

=== Navigation templates are not arbitrarily decorative ===
{{See also|BattleTechWiki:Manual of Style/Icons}}
* There should be justification for a template to deviate from the colors and styles contained in [[Module:Navbox/styles.css]] and [[Module:Sidebar/styles.css]].
* There are two basic layouts:
** On the right side of page like {{tl|SBSnav}} (For meta-template, see {{tl|sidebar}})
** Footer boxes—for example {{tl|BattleTechWiki templates}}, designed to appear at the bottom of each article, stacked with other similar templates. ''See also: [[BattleTechWiki:Manual of Style/Layout#Standard appendices and footers|BattleTechWiki:Footers]] for information on placement''
*** For footer boxes, {{tl|Navbox}} is the standard.
**** Existing hard-coded collapsible elements should be converted to one of the templates in [[:Category:Collapse templates]]. This standardizes the look and eases future maintenance.
**** The width of footer boxes should be 100% unless the convention for that type of article is otherwise. It looks inconsistent if multiple boxes in the same article have varying widths.

== Advantages ==
{{see also|BattleTechWiki:Categories, lists, and navigation templates#Advantages}}
Advantages of using navigation templates rather than listing all the links under "[[BattleTechWiki:Manual of Style/Embedded lists#Related topics (navigational lists)|See also]]" sections include:

* reduction of clutter in that [[BattleTechWiki:Manual of Style/Layout|area of the article]] before "References" and "External links",
* compactness of the template compared to a standard list or table, in the case of many links,
* if the most immediately related links are kept under "See also", the reader has a better idea of scope,
* less directly related links are out of the way or in some cases hidden by default,
* ease of maintenance in updating the template as articles get created or deleted,
* aesthetically pleasing appearance to many users,
* new articles in a subject area immediately gain the basic [[BattleTechWiki:Manual of Style/Linking#General points on linking style|link structure]] of existing related articles, eliminating the need for many editors to individually build up their own links and rewrite background material.
* when a new article or an older article that was [[BattleTechWiki:Orphan|orphaned]] is placed in a navbox, the page instantly has a large number of links to it

== Alternatives ==

In certain cases, there are alternatives preferable over the creation of a new navigation template.

* If the group of articles overlaps significantly with an existing [[BattleTechWiki:Categorization|category]] or [[BattleTechWiki:Stand-alone lists|stand-alone list]], consider adding a link to one of these to the see also section.
* For a series of articles whose only shared characteristic is that they hold the same position or title, such as peerage or world champion sporting titles, consider using [[Information:Succession Box|Succession Box templates]]. Variant templates for persons who have held several notable offices are shown at [[Information:Succession_Box/Templates]].
* For relating articles across different categories in a logical sequence, use a [[Information:Succession Box|Succession Box template]].
* Use one of these [[BattleTechWiki:Hatnote|Hatnote]]s: {{Tl|Broader}}, {{Tl|Further}} or {{Tl|Main}}.

== Template limits ==
{{main|Help:Templates#Template limits}}

There are [[BattleTechWiki:Template limits|limits to the number of templates]] an article may have. When a page exceeds this limit it may look fine in preview but, after the edit is saved, one or more footer navboxes display as wikilinks to the now excess navboxes (for example, displaying a link to "Template:Navbox" rather than the Navbox template itself). Solutions for this problem include (a) removing a template, and (b) setting up the footer navboxes so the least important one becomes the "extra" navbox (the one the reader will have to navigate to a separate page to in order to view).

== See also ==

* [[BattleTechWiki:Template namespace]] for an introduction to templates
* [[BattleTechWiki:Requested templates]] for help in editing templates
* [[BattleTechWiki:Categories, lists, and navigation templates]], for an actual guideline on the subject
* [[BattleTechWiki:Template index]], for other types of templates
* [[BattleTechWiki:Manual of Style/Infoboxes]]
* [[BattleTechWiki:Redirect#Bypass redirects in navigational templates]]
* [[BattleTechWiki:WikiProject Navigation templates]]
* {{tl|Quicktemplates}}, a table of templates
* {{tl|BattleTechWiki editor navigation}}, an amalgamation of navboxes 

{{Navigation templates}}
{{BattleTechWiki templates}}

[[Category:essays about templates]]
[[Category:navigation templates|+]]
[[Category:BattleTechWiki template help]]