Template:Header Nav/Documentation: Difference between revisions

Jump to navigation Jump to search

Template:Header Nav/Documentation (edit)

Revision as of 04:52, 11 February 2020

631 bytes removed ,  11 February 2020
remove onepage section, and clean up documentation
(→‎Usage of num: get rid of duplication)
(remove onepage section, and clean up documentation)
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 18: Line 18:
=== Usage of num ===
=== Usage of num ===
{{details|StrategyWiki:Guide/Adding more information#Guide completion stages}}
{{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]].
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 ===
Line 36: Line 36:
}}
}}


=== 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>
Retrieved from "https://strategywiki.org/wiki/Special:MobileDiff/848200"

Navigation menu