From StrategyWiki, the video game walkthrough and strategy guide wiki
Jump to navigation Jump to search
m (cs 5)
m (cleanup)
Line 1: Line 1:
----
<includeonly>The documentation for this template is transcluded from [[Template:Header Nav/Documentation]].  Click <span class="plainlinks">[http://strategywiki.org/w/index.php?title=Template:Header_Nav/Documentation&action=edit here]</span> to edit it.</includeonly>
<noinclude>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.</noinclude>
----
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.
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 ==
== Usage ==
Add the template to a page like this:
Add the template to a page like this:
<pre>
<pre>
{{Header Nav
{{Header Nav
|game=Game Name Goes Here
|game=Game name
|num=(optional number from 0 to 5)
|num=Number from 0 to 5 (optional)
|custom=(optional custom nonhidden links)
|custom=custom nonhidden links (optional)
}}
}}
</pre>
</pre>


This looks as follows when added to the guide without num:
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}}
{{Header Nav|game=The Legend of Zelda: Ocarina of Time}}


Line 33: Line 32:
{{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]] <nowiki><nowiki></nowiki>|<nowiki></nowiki></nowiki> [[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 40: Line 39:
{{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]] <nowiki>|</nowiki> [[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]]  
}}
}}


Line 46: Line 45:
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:
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>
<pre>{{Header Nav|game=Pinball|onepage=1}}</pre>
{{Header Nav
|game=Pinball
|onepage=1
}}
</pre>


Example output:
Example output:
{{Header Nav
{{Header Nav|game=Pinball|onepage=1}}
|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.
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.

Revision as of 16:11, 7 March 2008

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:

{{Header Nav
|game=Game name
|num=Number from 0 to 5 (optional)
|custom=custom nonhidden links (optional)
}}

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

{{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 criteria for a featured guide and have successfully went through the nomination process.

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:

{{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:

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:

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.