From PC-BSD Wiki
Revision as of 02:45, 30 December 2013 by Tigersharke (Talk | contribs)

Jump to: navigation, search



NOTE: Translators should localize the following templates used:

This damn spiffy template enables a centralized Handbook Table of Contents which can be used in multiple ways. It calls an entirely automagical NavHeader template which uses the chronological relationship in the page names within the UseTOC template to choose the back and forward links. The same ordered list provides the Table Of Contents page links and provides for the flat_html page (although wiki page limits prevent this). It necessarily works within the versioned page system, which means that this template will need to be duplicated for each of the future versions.



{{UseTOC{{putVers}}|Nav}} invokes the NavHeader output similar to below:

But if the pages relating to the backward (left) or forward (right) icon/links are not yet defined by their translation, or if the page is not yet or no longer in the Table Of Contents then the result is as below:

Template loop detected: Template:UseTOC

Table Of Contents

{{UseTOC{{putVers}}|Toc}} invokes a formatted list of page links similar to below:
1. Introduction

1.1 Goals and Features
1.2 What's New in
1.3 PC-BSD® Releases
1.4 PC-BSD® for Linux Users


{{UseTOC{{putVers}}|flat}} causes the flat_html page output (but is limited by page size which makes it incomplete/broken in actual use).


How to insert new pages into the Table Of Contents


NOTE: Translators should localize the following templates used:

This template is not used directly, it is called by template:UseTOC. It uses a common information store in template:UseTOC to provide the appropriate "forward" and "back" links automatically. On any appropriate wiki page, the navigation header effectively 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 toThis the left beneath the line of the page name. The home/index link should be modified within the Template:NavHeaderMiddle itself. 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.