Template:Nav/doc

This is a documentation subpage for Template:Nav.
It may contain usage information, categories and other content that is not part of the original template page.

Usage

This template provides navigation links to the previous, next, and root pages of the book automatically from the table of contents thanks to Module:Printable version. This makes reordering a book significantly easier; simply rearrange the links in the book's table of contents, without the painstaking process of editing navigation links on all affected or adjacent pages. {{BookCat}} is automatically included as well (unless nocat is set), further reducing copy-and-paste boilerplate.

The table of contents is usually the root page of the book. If the /TOC subpage exists, or the TOC/1 parameter is set, that page is used instead. It is recommended to call this template as just {{Nav}} with no parameters, unless you intentionally want to create an example of this template being used on a book or page different than the current one.

Examples

{{Nav}} on Python Programming/Lists gives:

Strings

Python Programming
Lists

Tuples

{{Nav}} on PHP Programming/The if Structure gives:

Arrays

PHP Programming
The if Structure

The switch Structure

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Nav

Pages navigation links

Template parameters
Parameter		Description	Type	Status
Table of contents	`1` `TOC`	Name of a page that links to every page in this book; if unset, the book's /TOC subpage (if existent) or root page will be used	String	optional
Current page name	`2` `page`	Current page name	String	optional
Don't autocategorize	`nocat`	If set, don't automatically categorize this article based on its hierarchy in the book	Boolean	optional