Template:Header Nav/Documentation

The documentation for this template is transcluded from Template:Header Nav/Documentation. Click here to edit it. This documentation is transcluded into Template:Header Nav so that it may be edited without requiring an update for all uses of Template:Header Nav.

This template is used at the top of (just about) every article to ease navigation around guides. Custom versions can be made, but deference should usually be given to this standard template.

Usage
Add the template to a page like this:

This looks as follows when added to the guide without num:

Usage of num
Always be sure to use the num variable only on the main page of guides to represent the overall completion level of the guide.


 * 0 represents an abysmal level of completion for a guide that has just been created. There is nearly no useful information present in a level-0 guide.
 * 1 represents a low level of completion. There is some useful information present, but it is neither organized nor plentiful.
 * 2 represents a halfway point, or a guide that is half "complete"
 * 3 represents a level of near completion, or a guide which is almost "complete". Such a guide may be missing only a few small sections or require only a limited amount of cleaning.
 * 4 represents a "complete" and "perfected guide", these guides provide all known useful information to the reader in a clear and organized manner. Additions to these guides are definitely useful and no guide is ever really finished on StrategyWiki.

Usage of custom
The custom variable is for adding extra links to be always visible to the right of the walkthrough link. To make the look and feel standard, put a | in between each link, separated by spaces, and enclosed in nowiki tags, so it wont break template markup.. example usage:

Example output:

Usage of onepage
If your guide is one page, and is only ever going to be one page, assign any value to the one page variable. This will hide the Table of Contents and Walkthrough links which do not apply to your page. Example usage:

Example output:

This should not be considered an acceptable alternative to sub-paging large guides. Single page guides are only acceptable for very simple games or compilation games which redirect to expanded guides for the games they contain.

Usage of parent
If your guide is one of a few guides which all need to share a Table of Contents and Walkthrough page, set the value of parent to the main page where the TOC and Walkthrough subpages are located. This will use the Table of Contents and Walkthrough links from the parent page rather than the guide with the Header Nav.

Example output:

This should not be considered an acceptable alternative to sub-paging large guides. Single page guides are only acceptable for very simple games or compilation games which redirect to expanded guides for the games they contain.