Template:Header Nav: Difference between revisions

Latest revision as of 19:54, 28 October 2023

This page has been transcluded from Template:Header Nav/Documentation.

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

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:

Table of Contents

@@ Line 1: / Line 1: @@
-<includeonly>{{qif|test={{{num|}}}|then={{0{{{num}}}p}}&nbsp;}}[[{{{game}}}|'''{{{game}}}''']] | <span id="GuideToggleFrame">[[{{{game}}}/Table of Contents|Table of Contents]]</span> | [[{{{game}}}/Introduction|Introduction]] | [[{{{game}}}/Walkthrough|Walkthrough]] {{qif|test={{{tocpage|}}}|then= <br />
+<includeonly><div class="nav_box header_nav mw-collapsible mw-collapsed noprint"><div class="mw-collapsible-header">'''[[Turing_Complete_Wiki|Main Page]]''' | {{#ifeq:{{FULLPAGENAME}}|Turing_Complete_Wiki|[[#Table of Contents|Table of Contents]]|[[Table of Contents|Table of Contents]][[Category:Sub-pages]]}} | [[Gameplay|Gameplay]] | [[Walkthrough|Walkthrough]] {{#if:{{{custom|}}}|{{!}} {{{custom}}}}}</div><div class="mw-collapsible-content"><p class="toc_heading">Table of Contents</p>{{:Table of Contents}}{{-}}</div></div></includeonly><noinclude>
-<div style="clear:both;text-align:center;width:90%;margin:auto;" align="center" class="NavFrame">
+{{Documentation}}
-<div class="NavHead" style="clear:both;text-align:center;background:#dfdfdf;">Table of Contents</div>
-<div class="NavContent" style="clear:both;text-align:center;font-size: 90%;border-top-style: hidden">
-{{:{{{game}}}/{{{tocpage}}}}}</div>
-</div>
-}}</includeonly><noinclude>
-==Implementation==
-Add the template to a page like this:
-<nowiki>{{All Game Nav|game=Game Name Goes Here|num=(optional number from 0 to 4)|tocpage=(optional name of Table of Contents subpage)}}</nowiki>
-This looks as follows when added to the guide without num:<br />
-{{All Game Nav|game=The Legend of Zelda: Ocarina of Time}}
-Or, with num:<br />
-{{All Game Nav|game=The Legend of Zelda: Ocarina of Time|num=3}}
-===Usage of the Num Variable===
-Always be sure to use the num variable on the introduction page of guides to represent the overall completion level of the guide. You may also use num on pages of considerable length where it would be useful to ascertain the level of completion since it may be ordinarily difficult to tell with longer pages.
-* '''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 definitly useful and no guide is ever really finished on a StrategyWiki.
-=== Usage of Tocpage variable ===
-{{All Game Nav|game=The Legend of Zelda: Ocarina of Time|tocpage=Table of Contents}}
 [[Category:Templates]]</noinclude>