Wikipedia

Wikipedia:Navigation template

(Redirected from Wikipedia:NAV-WITHIN)
For the navigation template guideline, see Wikipedia:Categories, lists, and navigation templates § Navigation templates.
For the Navbox template page, see Template:Navbox
"WP:NAV" redirects here. For navigational popups, see WP:NAVPOP. For polling in discussions, see WP:NOTVOTE.
Linking and
page manipulation
Linking and diffs
Categorization
Moving and redirecting
Merging
Splitting
Importing and copying
Protecting
Additional

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.

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.

The usual way to create navigation templates is to use the {{navbox}} or {{sidebar}} master templates. This simplifies the process of creating a functional and consistent template.

Do not rely solely on navboxes for links to articles highly relevant to a particular article. Navboxes are not displayed on the mobile website for Wikipedia, which accounts for around half of readers. See Phabricator ticket T124168 for progress on the mobile issue. See Phabricator ticket T124168 for work on making navboxes' appearance better on mobile.

Navboxes are categorized under Category:Navigational boxes. Some WikiProjects maintain a list of their navigation templates.

Types

The two main types of navigation template are navboxes and sidebars. The two serve similar purposes: to allow related subjects to link to each other easily in a consistent manner.

  • Navboxes are footer templates that sit below the standard article appendices and are laid out horizontally. They are created using the {{navbox}} template. An example navbox template is shown below:

Geodesy
 
Fundamentals
Concepts
Technologies
Standards (history)
NGVD 29 Sea Level Datum 1929
OSGB36 Ordnance Survey Great Britain 1936
SK-42 Systema Koordinat 1942 goda
ED50 European Datum 1950
SAD69 South American Datum 1969
GRS 80 Geodetic Reference System 1980
ISO 6709 Geographic point coord. 1983
NAD 83 North American Datum 1983
WGS 84 World Geodetic System 1984
NAVD 88 N. American Vertical Datum 1988
ETRS89 European Terrestrial Ref. Sys. 1989
GCJ-02 Chinese obfuscated datum 2002
Geo URI Internet link to a point 2010
  • Sidebars sit alongside content, in the same manner as infoboxes, and are predominantly laid out vertically. They are created using the {{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 style of any navigation template depends on its articles, how they are most intuitively presented, and previously established convention.

Shortcut
  • 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 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 groups within the template are collapsible child navboxes that have Wikipedia articles about their subjects and the smaller navigation templates would still satisfy most or all of the guidelines for good navboxes.
    • For example, {{EMD diesels}} lists all models of diesel locomotives built by one manufacturer, but is too large to be transcluded on each of their articles. Instead, the individual sections of {{EMD diesels}} were split out into their own templates: {{EMD GPs}}, {{EMD SDs}}, etc.
    • Doing the above with only one template using ParserFunctions.
    • Linking only the immediately related articles while hiding the rest, like in the case of Johnny Cash.
    • 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 {{main article}} and {{see also}} links within the articles' sections, as well as be merged into a larger template. (See essays "Not everything needs a navbox and "A navbox on every page".)
  • As Wikipedia is not a repository of links, navigation templates do not provide external links to other websites.
Shortcut
  • Red links should normally be avoided unless they are very likely to be developed into articles that satisfy the general notability guideline or one of the subject-specific notability guidelines, and should not be included where Wikipedia 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 (geographic divisions, annual events, filmographies, etc.), where deleting red links would leave an incomplete and misleading result. Even then, editors are encouraged to write the article first.
  • Likewise, redirects should also normally be avoided for the reasons outlined in WP:NAVNOREDIRECT. 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.
  • Note: In navigation boxes about musical ensembles, it may be appropriate to list all of the members of the ensemble, to avoid the perception that the ensemble is a solo act, provided that at least one member of the ensemble is notable.
Shortcut
  • If the articles are not established as related by 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 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 present a point of view or give the subjects of the select articles included undue weight.
  • For complex topics in science, technology, history, etc., a navigation box can provide a comprehensive introduction to a topic. For example, {{Wind power}} links to subsidiary and supporting topics that provide background and context necessary for understanding the main Wind power article. While the main Wind power article already contains inline links to the subsidiary articles, the subsidiary articles themselves are smaller and their prose may not place them into the overall context with each other. 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.
Shortcuts
See also: Wikipedia: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.
  • Per MOS:DECOR, images are rarely appropriate in navboxes. Just like colors and styles, they should have a justification to appear. Specifically, there should be no national or regional flags or coats of arms. A rare example of an appropriate image is this: a map shows (in green) the location of a region within the state of Kazakhstan, and this is consistently implemented for all state's regions.
  • There are two basic layouts:
    • On the right side of page—for example {{History of China}}.
    • Footer boxes—for example {{Health in China}}, designed to appear at the bottom of each article, stacked with other similar templates. See also: Wikipedia:Footers for information on placement
      • For footer boxes, {{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: Wikipedia:A navbox on every page § Benefits of navboxes; and Wikipedia:Categories, lists, and navigation templates § Advantages

Advantages of using navigation templates rather than listing all the links under "See also" sections include:

  • reduction of clutter in that 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 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 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.

Template limits

Main page: Help:Templates § Template limits

There are 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

Navigation templates comparison
Template Collapsible Image Groups Style (body)
parameter/s
{{Navbox}} collapsible Left/right of body Yes Yes
{{Navbox with collapsible groups}} collapsible Left/right of body and/or in each list Yes Yes
{{Navbox with columns}} collapsible Left/right of columns No Yes
Collapsible attributes
Type CSS classes JavaScript Collapses when Custom
initial state		 Nesting
Collapsible tables mw-collapsible jQuery.makeCollapsible 2 or more autocollapse on page Yes Yes
Retrieved from "https://en.wikipedia.org/w/index.php?title=Wikipedia:Navigation_template&oldid=1251800543#Navigation_templates_provide_navigation_within_Wikipedia"