Template:Header Nav

From StrategyWiki, the free strategy guide and walkthrough wiki

This page has been transcluded from Template:Header Nav/Documentation.

This high-risk template or image has been protected indefinitely. It is widely used and is at significant risk of vandalism. If you would like to edit this page, bring it up on the talk page, contact a sysop, or bring it up on the forums. Protection is not an endorsement of the current version, which is inevitably the wrong version.

This template is used at the top of (just about) every article to ease navigation around guides. Custom versions should not be made; if you think you have a need to create one, you don't. You're probably looking for the custom parameter or a Custom Nav page (see below).

Contents

Usage

Add the template to a page like this:

{{Header Nav
|game=Game name
|num=Number from 0 to 5 (main guide page only)
|custom=custom non-hidden links (optional)
}}

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

{{Header Nav|game=The Legend of Zelda: Ocarina of Time}}

The Legend of Zelda: Ocarina of Time | Table of Contents | Walkthrough

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.
  • 5 represents a featured guide, these guides fulfill all the criteria for a featured guide and have successfully gone through the nomination process. Guides at this completion level need {{featured}} in their Table of Contents.

Usage of custom

To put custom links on every page in a guide, a Custom Nav page needs to be created (e.g. Chip's Challenge/Custom Nav), which will be included in the Header Nav for each page in that guide after the Walkthrough link but before any other custom links. This is the recommended way to include standard custom links on Header Navs in a guide, and apart from creating the Custom Nav page, no other modifications to the guide have to be made.

To add extra links to the Header Nav for a specific page, use the custom parameter for the Header Nav on that page. To make the look and feel standard, put a {{!}} between links. Example usage:

{{Header Nav
|game=The Legend of Zelda: Ocarina of Time
|custom=[[The Legend of Zelda: Ocarina of Time/Maps|Maps]] {{!}} [[The Legend of Zelda:Ocarina of Time/Controls|Controls]] 
}}

Example output:

The Legend of Zelda: Ocarina of Time | Table of Contents | Walkthrough | Maps | Controls

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:

{{Header Nav|game=Pinball|onepage=1}}

Example output:

Pinball

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.

Retrieved from "http://strategywiki.org/wiki/Template:Header_Nav"