TocPlugin < Plugins

---++ <nop>%TOPIC%

Table of contents and cross-reference management

This plugin adds powerful support for generation and maintenance of tables of contents and cross-references within a TWiki web. Originally developed for use by Motorola documentation teams using the Dec2000 release, it has been packaged as a plugin and updated for the Sep 2001 release.

---+++ Syntax Rules

Adds a number of new tags:
   * %<nop>SECTIONn% - inserts an anchored section header
   * %<nop>CONTENTS% - generates a table of contents for a topic or an entire web, with full expansion depth control
   * %<nop>REF% - inserts a symbolically named cross-reference URL
   * %<nop>ANCHOR% - inserts a symbolically named jump target

The Plugins.<nop>TocPluginHelp topic in the installation contains complete help information.

---+++ Plugin Installation Instructions

   * Download the ZIP file from the Plugin web (see below). Contents:
   | *File:* | *Description:* |
   | ==%TOPIC%.xml== | Ant build file |
   | ==data/Plugins/%TOPIC%.txt== | Plugin topic |
   | ==data/Plugins/TocPluginHelp.txt== | Plugin help |
   | ==data/Plugins/WebOrder.txt== | Order topic for Plugins web |
   | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
   | ==lib/TWiki/Plugins/TocPlugin/Attrs.pm== | Library component |
   | ==lib/TWiki/Plugins/TocPlugin/Anchor.pm== | Library component |
   | ==lib/TWiki/Plugins/TocPlugin/Section.pm== | Library component |
   | ==lib/TWiki/Plugins/TocPlugin/TOC.pm== | Library component |
   | ==lib/TWiki/Plugins/TocPlugin/TOCIF.pm== | Library component |
   | ==lib/TWiki/Plugins/TocPlugin/TopLevelSection.pm== | Library component |
   | ==lib/TWiki/Plugins/TocPlugin/test.zip== | Test code |
   * Unzip ==%TOPIC%.zip== in your twiki installation directory.
   * Add ==Plugins.%TOPIC%== to the ==INSTALLEDPLUGINS== variable in %TWIKIWEB%.TWikiPreferences (or any WebPreferences topic).
   * If you see a link here: %REF{topic=TocPluginHelp,type=Section,name=installation}% then installation was successful
   * Check the TocPluginHelp topic. You should see expanded section numbers.
   * Add the following line to the "TWiki Plugins" section of %TWIKIWEB%.TextFormattingRules:
      * Plugins.%TOPIC%: Table of contents and cross-reference management

---+++ Plugin Info

|  One Line Description: | Table of contents and cross-reference management |
|  Plugin Author: | Main.CrawfordCurrie |
|  Plugin Version: | 1.0 |
|  Change History: | 15 Sep 2001: Initial version |
| | 23 Sep 2001: Directories restructured according to Plugin requirements, and turned into a zip file |
| | 1 Oct 2001: Corrected directory naming (no thanks to WindowsME!) |
|  CPAN Dependencies: | none |
|  Other Dependencies: | none |
|  Perl Version: | 5.0 |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |

__Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins

---++++ Copyright
This code is a development of the Architectures and Systems
Platforms group of Motorola Inc. and is protected by the following
copyrights:
   * Copyright (C) 2001 Motorola. All Rights Reserved.

---++++ License
As required for the publication of all extensions to TWiki, this
software is published under the terms of the GNU General Public
License.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details, published at
http://www.gnu.org/copyleft/gpl.html
1. Table of Contents and Cross-Reference Plugin		1. Table of Contents and Cross-Reference Plugin
Prev		Home