SourceForge.net Logo
September 6, 2011
GPL
ProWikiCenter
Cdml Toc

From: CdmlElements

Description

This CmdlElement automatically creates a "table of contents" based on the headers used within the page. This enables a better organization and an increased readability of the pages. Links to the headers and back to the "toc" are also created.


Example

The table of contents in this example:

contents of this page
Description   
Example   
Notes   
Parameters   
Preface   
Introduction   
Chapter 1   
Chapter 2   
Conclusions   
Discussion   

is generated from the following input:

[[toc]contents of this page]


Notes    

The little white arrow in the headers represent the link back to the table of contents.


Parameters    

The parameters of CdmlTable can be used (as far as they apply).

There are a few additional parameters:

  • linepadding: this is additional vertical space between the lines of the toc (default:2)
  • indentation: this is an addition left margin for all lines in the toc (default:5)
  • depth: this is the amount of indentation used for each level (default:20)
  • link: to turn off the "back to top" links use link=0 (default:1)
Note:

  • As a default the table is left-aligned, the parameter "distance" is set to 40 (and can be changed).
  • If you don't want a title and don't want the default title either, turn the title off by defining "-" or "none".

Example-page:

Preface    

x

x

x

Introduction    

x

x

x

Chapter 1    

x

x

x

Chapter 2    

x

x

x

Conclusions    

x

x

x

Discussion    

x

x

x


FolderWikiFeatures FolderCdml