Difference between revisions of "Template:NavHeader"

From PC-BSD Wiki
Jump to: navigation, search
Line 17: Line 17:
 
=== Description ===
 
=== Description ===
 
This assumes local links and greatly simplifies the process of adding or editing the navigation header for handbook pages. As you can see from the above, the navigation header overlays the page name, while a duplicate page name is placed below. It is entirely transparent with regard to localization except for the word and phrase templates used. The ''contents'' box is forced to appear in all pages that contain at least one header and is placed to the left beneath the line of the page name. An alternative page name is an option with the ''custompagename'' variable assignment. The home/index link should be modified within the Template:NavHeaderMiddle itself, while below may be pasted into a page with minor modifications to define what will become each link and the text for each link's alternate label. Missing or malformed link info defaults to a [[Navigation Header|''Navigation Header error page'']] while properly formed but links to missing pages are added to the [[Special:WantedPages|''Special:wanted pages'']] list. Text ought to be formatted with desired capitalization.<br>
 
This assumes local links and greatly simplifies the process of adding or editing the navigation header for handbook pages. As you can see from the above, the navigation header overlays the page name, while a duplicate page name is placed below. It is entirely transparent with regard to localization except for the word and phrase templates used. The ''contents'' box is forced to appear in all pages that contain at least one header and is placed to the left beneath the line of the page name. An alternative page name is an option with the ''custompagename'' variable assignment. The home/index link should be modified within the Template:NavHeaderMiddle itself, while below may be pasted into a page with minor modifications to define what will become each link and the text for each link's alternate label. Missing or malformed link info defaults to a [[Navigation Header|''Navigation Header error page'']] while properly formed but links to missing pages are added to the [[Special:WantedPages|''Special:wanted pages'']] list. Text ought to be formatted with desired capitalization.<br>
{{note|icon64=Translators should localize the following templates used:  [[template:Word-previous]], [[template:Word-next]], [[template:Phrase-return to table of contents]], and [[template:Phrase-table of contents]]. }}
+
{{note|width=35%|icon64=Translators should localize the following templates used:   
 +
:::* [[template:Word-previous]],  
 +
:::* [[template:Word-next]],  
 +
:::* [[template:Phrase-return to table of contents]], and  
 +
:::* [[template:Phrase-table of contents]]. }}
 
===Usage===
 
===Usage===
 
'''<nowiki>{{</nowiki>NavHeader|back='''''<name of the previous page>'''''|forward='''''<name of the next page>'''''|l7dBack='''''<localized name of the previous page>'''''|l7dForward='''''<localized name of the next page>'''''|custompagename='''''<custom page name>'''''}}'''
 
'''<nowiki>{{</nowiki>NavHeader|back='''''<name of the previous page>'''''|forward='''''<name of the next page>'''''|l7dBack='''''<localized name of the previous page>'''''|l7dForward='''''<localized name of the next page>'''''|custompagename='''''<custom page name>'''''}}'''
 
[[Category:Navigation]][[category:templates]]
 
[[Category:Navigation]][[category:templates]]
 
</noinclude>[[category:Uses NavHeader]][[category:{{#titleparts: {{{custompagecategory|{{{custompagename|{{PAGENAME}} }}} }}}|1|1}}]][[category:{{#if: {{#titleparts: {{{custompagecategory|{{{custompagename|{{PAGENAME}} }}} }}}|1|2}}|{{#titleparts: {{{custompagecategory|{{{custompagename|{{PAGENAME}} }}} }}}|1|2}}|{{{custompagecategory|{{{custompagename|{{PAGENAME}} }}} }}} }}]]<!-- allowing transclusion *** no spaces or text beyond this line -->
 
</noinclude>[[category:Uses NavHeader]][[category:{{#titleparts: {{{custompagecategory|{{{custompagename|{{PAGENAME}} }}} }}}|1|1}}]][[category:{{#if: {{#titleparts: {{{custompagecategory|{{{custompagename|{{PAGENAME}} }}} }}}|1|2}}|{{#titleparts: {{{custompagecategory|{{{custompagename|{{PAGENAME}} }}} }}}|1|2}}|{{{custompagecategory|{{{custompagename|{{PAGENAME}} }}} }}} }}]]<!-- allowing transclusion *** no spaces or text beyond this line -->

Revision as of 14:47, 31 August 2013

Contents


Description

This assumes local links and greatly simplifies the process of adding or editing the navigation header for handbook pages. As you can see from the above, the navigation header overlays the page name, while a duplicate page name is placed below. It is entirely transparent with regard to localization except for the word and phrase templates used. The contents box is forced to appear in all pages that contain at least one header and is placed to the left beneath the line of the page name. An alternative page name is an option with the custompagename variable assignment. The home/index link should be modified within the Template:NavHeaderMiddle itself, while below may be pasted into a page with minor modifications to define what will become each link and the text for each link's alternate label. Missing or malformed link info defaults to a Navigation Header error page while properly formed but links to missing pages are added to the Special:wanted pages list. Text ought to be formatted with desired capitalization.

NOTE: Translators should localize the following templates used:

Usage

{{NavHeader|back=<name of the previous page>|forward=<name of the next page>|l7dBack=<localized name of the previous page>|l7dForward=<localized name of the next page>|custompagename=<custom page name>}}