Template:Auto navigation/doc

From Wikibooks, open books for an open world
Jump to navigation Jump to search

Theory of operation[edit source]

This template (shown above with dummy links) adds one or more links to the top or bottom of a page, separated from the rest of the content by two centered, gray horizontal lines five pixels high and width equal to 94% of the page as rendered. It is designed to assist the reader to more easily consume the book in its entirety, the links being analogues of the traditional page turning performed on physically printed volumes and placed at the extremes of the content, where such behavior is naturally triggered.

The available links it can provide are:

  1. The next page in the book
  2. The book's previous page
  3. The page one level higher, listed as "Home"
  4. The eponymous category page to the book's title, sorted by the subpage names unless an additional parameter is specified (see below)

Usage[edit source]

Parameters[edit source]

All parameters are optional.

  1. The name of the next page, as the first unnamed parameter.
  2. The name of the previous page, as the second unnamed parameter.
  3. deep as the third unnamed parameter or the value to the |filing= parameter if only the next page is being shown; this indicates pages at that level of the book should be categorized by the chapter they appear in rather than the book's titular category.
  4. bottom as the last unnamed parameter when the template is displaying the links to both adjacent pages, or as the value of the |border= parameter if only showing the next page; this places the horizontal lines below the links rather than above them, allowing the template to be displayed in a manner appropriate to placement at the top of the page rather than the bottom.

Examples[edit source]

TemplateData[edit source]

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for Auto navigation

Places links at the top or bottom of a page to its adjacent book pages, as well as the book's home page

Template parameters

This template prefers inline formatting of parameters.

Next page1

no description

Page namerequired
Previous page2

no description

Page namesuggested
Categorization stylefiling 3

no description

Suggested values
Horizontal separator placementborder 3 4

no description

Suggested values
top bottom

See also[edit source]