From StrategyWiki, the video game walkthrough and strategy guide wiki
Jump to navigation Jump to search
m (category fix, Replaced: [[Category:Template documenation → [[Category:Template documentation)
(no more Custom Nav template)
 
(5 intermediate revisions by 2 users 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 ===
'''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 [[StrategyWiki:Featured guides|criteria for a featured guide]] and have successfully gone through the nomination process. Guides at this completion level need {{t|featured}} in their Table of Contents.


=== 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 {{t|!}} 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 39: 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: