Editing Template:Header Nav/Documentation

{{high-risk}}

This template is used '''at the top''' of every guide page to ease navigation around guides. For simple games with only a single page guide, use {{t|Header Bar}} instead.

== Usage ==
Add the template to a page like this:
<pre>{{Header Nav
|game=Game name
|num=Number from 0 to 5 (main guide page only)
|custom=custom non-hidden links (optional)
}}</pre>

This looks as follows when added to the guide without num:
<pre>{{Header Nav|game=The Legend of Zelda: Ocarina of Time}}</pre>

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

=== Usage of num ===
{{details|StrategyWiki:Guide/Adding more information#Guide completion stages}}
The num variable belongs ''only'' on the main page of guides to represent the overall completion level of the guide. It has a value between '''0''' and '''5'''. This parameter will categorize the guide into one of the [[:Category:Guides by completion stage|guide completion stage categories]].

=== 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 <nowiki>{{!}}</nowiki> between links. Example usage:

<pre>{{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]] 
}}</pre>

Example output:
{{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]] 
}}

<noinclude>[[Category:Template documentation]]</noinclude>
Description	What you type	What you get
Italic	''Italic text''	Italic text
Bold	'''Bold text'''	Bold text
Bold & italic	'''''Bold & italic text'''''	*Bold & italic text*