From StrategyWiki, the video game walkthrough and strategy guide wiki
Jump to navigation Jump to search
(→‎Usage of num: get rid of duplication)
(no more Custom Nav template)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{high-risk}}
{{high-risk}}


This template is used '''at the top''' of every guide page to ease navigation around guides. Custom versions are strongly discouraged. You're probably looking for the ''custom'' parameter or a Custom Nav page (see below).
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 ==
== Usage ==
Line 7: Line 7:
<pre>{{Header Nav
<pre>{{Header Nav
|game=Game name
|game=Game name
|num=Number from 0 to 5 (main guide page only)
|custom=custom non-hidden links (optional)
|custom=custom non-hidden links (optional)
}}</pre>
}}</pre>


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


{{Header Nav|game=The Legend of Zelda: Ocarina of Time}}
{{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 ===
=== 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 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:
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, each entry after the first should be a bullet point. Example usage:


<pre>{{Header Nav
<pre>{{Header Nav
|game=The Legend of Zelda: Ocarina of Time
|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]]  
|custom=[[The Legend of Zelda: Ocarina of Time/Maps|Maps]]
* [[The Legend of Zelda:Ocarina of Time/Controls|Controls]]  
}}</pre>
}}</pre>


Line 33: Line 29:
{{Header Nav
{{Header Nav
|game=The Legend of Zelda: Ocarina of Time
|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]]  
|custom=[[The Legend of Zelda: Ocarina of Time/Maps|Maps]]
* [[The Legend of Zelda: Ocarina of Time/Controls|Controls]]  
}}
}}


=== Usage of onepage ===
<noinclude>[[Category:Template documentation]]</noinclude>
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:
 
<pre>{{Header Nav|game=Pinball|onepage=1}}</pre>
 
Example output:
{{Header Nav|game=Pinball|onepage=1}}
 
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.
 
<noinclude>[[Category:Template documentation|H]]</noinclude>

Latest revision as of 22:32, 21 May 2024

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 {{Header Bar}} instead.

Usage[edit source]

Add the template to a page like this:

{{Header Nav
|game=Game name
|custom=custom non-hidden links (optional)
}}

This looks as follows when added to the guide:

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

Usage of custom[edit source]

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, each entry after the first should be a bullet point. 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: