Template:Header Nav/Documentation: Difference between revisions

Template page
VisualWikitext
w:c:strategywiki>Skizzerz
m (→‎Usage of num: fixing)
m (29 revisions imported: Imported from https://strategywiki.org/)
 
(17 intermediate revisions by 7 users not shown)
Line 1: Line 1:
----
{{high-risk}}
<includeonly>The documentation for this template is transcluded from [[Template:All Game Nav/Documentation]].  Click <span class="plainlinks">[http://strategywiki.org/w/index.php?title=Template:All_Game_Nav/Documentation&action=edit here]</span> to edit it.</includeonly>
 
<noinclude>This documentation is transcluded into [[Template:All Game Nav]] so that it may be edited without requiring an update for all uses of Template:All Game Nav.</noinclude>
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.
----
 
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
{{All Game Nav
|game=Game name
|game=Game Name Goes Here
|num=Number from 0 to 5 (main guide page only)
|num=(optional number from 0 to 4)
|custom=custom non-hidden links (optional)
|custom=(optional custom nonhidden links)
}}</pre>
}}
</pre>


This looks as follows when added to the guide without num:
This looks as follows when added to the guide without num:
{{All Game Nav|game=The Legend of Zelda: Ocarina of Time}}
<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 ===
=== Usage of num ===
'''The num variable can ''only'' on the main page of guides to represent the overall completion level of the guide.'''
{{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]].


* '''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.
=== Usage of custom ===
* '''1''' represents a ''low level of completion''. There is some useful information present, but it is neither organized nor plentiful.  
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.
* '''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.


=== Usage of custom ===
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:
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:


<pre>
<pre>{{Header Nav
{{All Game 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>


Example output:
Example output:
{{All Game 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]]  
}}
 
=== 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:
 
<pre>
{{All Game Nav
|game=Pinball
|onepage=1
}}
</pre>
 
Example output:
{{All Game 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.
 
=== Usage of parent ===
If your guide is one of a few guides which all need to share a Table of Contents and Walkthrough page, set the value of parent to the main page where the TOC and Walkthrough subpages are located.  This will use the Table of Contents and Walkthrough links from the parent page rather than the guide with the All Game Nav.
 
<pre>
{{All Game Nav
|game=Super Street Fighter II
|parent=Street Fighter II
}}
</pre>
 
Example output:
{{All Game Nav
|game=Super Street Fighter II
|parent=Street Fighter II
}}
}}


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]]</noinclude>

Latest revision as of 18:28, 28 October 2023

High-risk
High-risk

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 Discord. Protection is not an endorsement of the current version, which is inevitably the wrong version.

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
|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}}
Main Page | Table of Contents | Gameplay | Walkthrough

Table of Contents

Table of Contents

Usage of num[edit source]

For more details on this topic, see 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 guide completion stage categories.

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

Main Page | Table of Contents | Gameplay | Walkthrough | Maps | Controls

Table of Contents

Table of Contents
Retrieved from "http://turingcomplete.wiki/w/index.php?title=Template:Header_Nav/Documentation&oldid=1129"