Table of Contents Plugin

Name
Table of Contents Plugin
Author
eTouch Systems
Author URL
http://www.etouch.net
Recent Version 1.0
Plugin UI Available
Yes
Enabled for Wiki
Yes
Enabled for Blog
No
Enabled for Hosted Instance
Yes
MacroId

Download Jar
Not needed.Comes bundled with Samepage


Description

This plugin creates a Table of Contents based on either the format headings( H1 through H6) or the anchors in a page.

Installation

This plugin comes bundled with Samepage.

Usage

To Insert this plugin click on the  button in WYSIWYG editor. From the list of plugins being shown in the screen, click on "Table of Contents Plugin".
To Edit this plugin, Right Click on the Plugin Syntax in the WYSIWYG Editor. Select "Edit this Plugin" from the Context Menu.
Below is the Screen shot of the screen that comes while inserting/editing a plugin.

Screenshot


Parameter Name
Description
Required
Example Value
Default Value
Show in Div
To display the table of contents in a box.
Options
  • Yes
  • No
Yes
Yes
Yes
Border Width Width of the border.
Enter any numerical value.
No
None
None
Border Style
Style of the Border.

Options
  • None
  • Hidden
  • Dotted
  • Dashed
  • Solid
  • Double
  • Groove
  • Ridge
  • Inset
  • Outset

No
Dotted
None
Border Color
Color of the border
No
#cccccc
#cccccc
Background Color
Color of the background
No
#F9F9F9 #F9F9F9
Show Numbers
To number the entries in the table of contents
Options
  • Yes
  • No
No
Yes
No
Show Header
To display a header with the caption "Contents"
Options
  • Yes
  • No

No
Yes No
Show Anchor
To create the table of contents using on the anchors in the page instead of the headings H1 through H6
Options
  • Yes
  • No

No
Yes No

 


Sample Generated Syntax:
$toc{ show_div="" div_border_width="" div_border_ div_border_ div_bg show_number="" show_header="" show_anchor=""}

Output

Sample output is shown in the below screenshot

Screenshot