Difference between revisions of "Template:UseTOC"

From PC-BSD Wiki
Jump to: navigation, search
m (Protected "Template:UseTOC": Template security (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite)))
 
(34 intermediate revisions by one user not shown)
Line 1: Line 1:
{{
+
<noinclude>
{{#switch: {{{1}}}
+
{|class=simplecenter
|test = testing3
+
|[[file:toc-edit.png|thumb|1024px|center|'''How to insert new pages into the Table Of Contents''']]
|toc
+
|}</noinclude><includeonly>
|TOC  = TableOfContents
+
{| class="noprint" align="left" style="margin-left:-7px; margin-right:20px; margin-top:2px; margin-bottom:1px"
|nav
+
|
|NAV  = DoNavHeader
+
|-
|flat = makeFlat
+
|__FORCETOC__
}}}}
+
| __TOC__
 +
|}
 +
== Description ==
 +
{{note|class=rightfloat|width=35%|icon64=Translators should localize the following templates used: 
 +
:* {{translate-me-link|template:Word-previous|txt=Word-previous}}
 +
:* {{translate-me-link|template:Word-next|txt=Word-next}},
 +
:* {{translate-me-link|template:Phrase-return to table of contents|txt=Phrase-return to table of contents}}, and
 +
:* {{translate-me-link|template:Phrase-table of contents|txt=Phrase-table of contents}} }}
 +
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===
 +
'''<nowiki>{{UseTOC{{</nowiki>putVers}}|Nav}}''' invokes the NavHeader output similar to below:<br/>
 +
{|class=simplecenter
 +
|
 +
{| class="navheader noprint screen"
 +
|class="navleft"|{{NavHeaderLeft|{{{back}}}{{putLang}}|{{{forward}}}{{putLang}}|{{#if:{{{l7dBack|}}}|{{{l7dBack}}}|{{{back}}}}}|{{#if:{{{l7dForward|}}}|{{{l7dForward}}}|{{{forward}}}}}}}
 +
|class="navheaderbuffer"|
 +
|class="navmiddle"|{{NavHeaderMiddle}}
 +
|class="navheaderbuffer"|
 +
|class="navright"|{{NavHeaderRight|{{{back}}}{{putLang}}|{{{forward}}}{{putLang}}|{{#if:{{{l7dBack|}}}|{{{l7dBack}}}|{{{back}}}}}|{{#if:{{{l7dForward|}}}|{{{l7dForward}}}|{{{forward}}}}}}}
 +
|-
 +
|class="titleheader" colspan=5|<span target="{{PAGENAME}}"; id="{{PAGENAME}}"; class="titleheadertext">{{#if: {{getLang}}|{{:Translations:{{#titleparts: {{PAGENAME}}|1|1}}/Page display title/{{getLang}}}}|{{#titleparts: {{{custompagename|{{PAGENAME}}}}}|1}}}}</span>
 +
|}
 +
|}
 +
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:<br/>
 +
{|class=simplecenter
 +
|
 +
{{UseTOC{{putVers}}|Nav}}
 +
|}
 +
 
 +
===Table Of Contents===
 +
'''<nowiki>{{UseTOC{{putVers}}</nowiki>|Toc}}''' invokes a formatted list of page links similar to below:<br/>
 +
{{hierB|title=Preface}}<br/>
 +
{{hierB|1.|title=Introduction}}
 +
{{hier|1.1|title=Goals and Features}}
 +
{{hier|1.2|title=What's New|alt=What's New in {{getVers}}}}
 +
{{hier|1.3|title=PC-BSD® Releases}}
 +
{{hier|1.4|title=PC-BSD® for Linux Users}}
 +
===Flat HTML===
 +
'''<nowiki>{{UseTOC{{putVers}}</nowiki>|flat}}''' causes the {{local|link=flat_html}} page output (but is limited by page size which makes it incomplete/broken in actual use).<br/>
 +
 
 +
==Modification==
 +
{|class=simplecenter
 +
|[[file:toc-edit.png|thumb|1024px|center|'''How to insert new pages into the Table Of Contents''']]
 +
|}</includeonly>

Latest revision as of 19:48, 30 December 2013

How to insert new pages into the Table Of Contents
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox