Difference between revisions of "Template:UseTOC"

From PC-BSD Wiki
Jump to: navigation, search
Line 1: Line 1:
 +
<noinclude>This is the documentation content for the versioned template.</noimclude>
 
{| class="noprint" align="left" style="margin-left:-7px; margin-right:20px; margin-top:2px; margin-bottom:1px"
 
{| class="noprint" align="left" style="margin-left:-7px; margin-right:20px; margin-top:2px; margin-bottom:1px"
 
|
 
|

Revision as of 22:02, 22 December 2013

This is the documentation content for the versioned template.</noimclude>

Contents

Description

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.

Usage

{{UseTOC{{putVers}}|Nav}} invokes the NavHeader as 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:

Description

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.

Usage

Navigation

{{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:
Preface
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

Flat HTML

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

Modification

How to insert new pages into the Table Of Contents

{{UseTOC{{putVers}}|Toc}} invokes a list of Table Of Contents links similar to below:
Preface
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.

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox