TocPlugin
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.
Syntax Rules
Adds a number of new tags:
- %SECTIONn% - inserts an anchored section header
- %CONTENTS% - generates a table of contents for a topic or an entire web, with full expansion depth control
- %REF% - inserts a symbolically named cross-reference URL
- %ANCHOR% - inserts a symbolically named jump target
The TWiki.TocPluginHelp topic in the installation contains complete help information.
TocPlugin Settings
- Set SHORTDESCRIPTION = Sophisticated table of contents generation
Plugin Installation Instructions
- Download the ZIP file from the Plugin web (see below). Contents:
File: | Description: |
data/TWiki/TocPlugin.txt | Plugin topic |
data/TWiki/TocPluginHelp.txt | Plugin help |
data/TWiki/WebOrder.txt | Order topic for TWiki web |
lib/TWiki/Plugins/TocPlugin.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 |
lib/TWiki/Plugins/TocPlugin/build.xml | Ant build file |
- Unzip
TocPlugin.zip
in your twiki installation directory.
- (Dakar) Visit
configure
in your TWiki installation, and enable the plugin in the {Plugins} section.
- If you see a link here: 1.1. Installation and Configuration then installation was successful
- Check the TocPluginHelp topic. You should see expanded section numbers.
Plugin Info
Related Topics: TWikiPreferences,
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) 2002 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