Template:Header Nav/Documentation - Revision history

Gelthor: 29 revisions imported: Imported from https://strategywiki.org/

2023-10-28T18:28:58Z

29 revisions imported: Imported from https://strategywiki.org/

← Older revision	Revision as of 18:28, 28 October 2023
(No difference)

w:c:strategywiki>Prod: remove onepage section, and clean up documentation

2020-02-11T04:52:20Z

remove onepage section, and clean up documentation

← Older revision		Revision as of 04:52, 11 February 2020
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>

w:c:strategywiki>Prod: /* Usage of num */ get rid of duplication

2016-10-23T23:38:06Z

Usage of num: get rid of duplication

← Older revision		Revision as of 23:38, 23 October 2016
Line 17:		Line 17:

	=== Usage of num ===		=== 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.~~'''~~		{{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.~~
	* '''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 ===

w:c:strategywiki>Moydow at 21:14, 21 February 2015

2015-02-21T21:14:17Z

← Older revision		Revision as of 21:14, 21 February 2015
Line 29:		Line 29:
	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, put a <nowiki>{{!}}</nowiki> between links. Example usage:

	<pre>{{Header Nav		<pre>{{Header Nav

w:c:strategywiki>NajBot: category fix, Replaced: [[Category:Template documenation → [[Category:Template documentation

2009-04-17T19:33:31Z

category fix, Replaced: [[Category:Template documenation → [[Category:Template documentation

← Older revision		Revision as of 19:33, 17 April 2009
Line 52:		Line 52:
	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.

	<noinclude>[[Category:Template ~~documenation~~\|H]]</noinclude>		<noinclude>[[Category:Template documentation\|H]]</noinclude>

w:c:strategywiki>NajBot: category fix

2009-04-17T19:12:39Z

category fix

← Older revision		Revision as of 19:12, 17 April 2009
Line 51:		Line 51:

	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.

			<noinclude>[[Category:Template documenation\|H]]</noinclude>

w:c:strategywiki>Prod at 20:41, 24 May 2008

2008-05-24T20:41:41Z

← Older revision		Revision as of 20:41, 24 May 2008
Line 1:		Line 1:
	{{high-risk}}		{{high-risk}}

	This template is used '''at the top''' of ~~(just about)~~ every ~~article~~ to ease navigation around guides. Custom versions ~~should not be made; if you think you have a need to create one, you don't~~. 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. Custom versions are strongly discouraged. You're probably looking for the ''custom'' parameter or a Custom Nav page (see below).

	== Usage ==		== Usage ==

w:c:strategywiki>DrBob: Updated

2008-04-06T09:19:26Z

Updated

← Older revision		Revision as of 09:19, 6 April 2008
Line 1:		Line 1:
	{{high-risk}}		{{high-risk}}

	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 should not be made; if you think you have a need to create one, you don't. You're probably looking for the ''custom'' parameter or a Custom Nav page (see below).

	== Usage ==		== Usage ==

w:c:strategywiki>DrBob: Updated

2008-04-06T09:18:20Z

Updated

← Older revision		Revision as of 09:18, 6 April 2008
Line 1:		Line 1:
			{{high-risk}}

	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		\|game=Game name
	\|num=Number from 0 to 5 (~~optional~~)		\|num=Number from 0 to 5 (main guide page only)
	\|custom=custom ~~nonhidden~~ 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 without num:
Line 23:		Line 23:
	* '''2''' represents a ''halfway point'', or a guide that is half "complete"		* '''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.		* '''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.		* '''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 ~~went~~ through the nomination process.		* '''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 ===
	~~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:		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:

	<pre>		<pre>{{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]]
	}}		}}</pre>
	</pre>

	Example output:		Example output:

w:c:strategywiki>Prod: cleanup

2008-03-07T16:11:09Z

cleanup

← Older revision		Revision as of 16:11, 7 March 2008
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.