Skip to topic | Skip to bottom
TWiki.IncludeIndexPluginr1.1 - 11 Jun 2003 - 22:07 - TWikiGuesttopic end

Start of topic | Skip to actions
This plugin generates an index of all the pages included from one master page. This allows you to put together one huge document for print out plus a lean index for online browsing without extra maintenance.


Syntax Rules

%INCLUDEINDEX{"MasterPage" headers="n" format="string"}%

This discards everything from the included page, except:

  1. Headlines up to given level, the default is 4.
  2. %INLCUDEd pages, shown as defined by the format string. Default is "   * ", i.e. a bullet list.

The format string accepts the same syntax as a FormattedSearch. Use this to extract reports about your included pages. E.g. create a table of current revision information for all sub documents of a bigger manual:
%INCLUDEINDEX("MyProjectManual" headers="0" format="|[[$page]] |$rev |$author |$date |"}%

Include Strategy

In theory, you can continue to write your pages as always and glue some of them to a bigger document via %INCLUDE.
In practice, you might want to change your strategy a bit, to make it easier to re-use pages as building blocks for large docs. The following rules proved useful in bigger projects:

  1. Don't put headlines into the topic pages, i.e.:
  2. Concentrate headlines + includes in one master page
  3. Title this according to your print-out needs
  4. Create one index page using this plug-in, add links useful for online surfing, editorial hints etc.
  5. Use TWiki:Main.ColasNahaboos savemulti Checkpoint function to save the master document without lengthy rendering
  6. For really huge documents, where you want to print parts/chapters:
    1. create master page per printable chapter
    2. include master pages in global print page
    3. %INCLUDEINDEXes of master pages in index page

You write:

MyProject: MyProjectManual: Topic pages:
---+ My project

---++ See also:

  1. <a href=/cgi-bin/twiki/edit/MyProjectManual>edit structure</a>
  2. <a href=/cgi-bin/twiki/pdf/MyProjectManual>Print PDF</a>
---+ Foo Topic 1

---++ Bar Topic 2

---++ Three...

---+ Bar Topic X

Lorem ipsum dolet
Lorem ipsum dolet
Lorem ipsum dolet

You get:


  1. Foo Topic1
    1. Bar Topic2
    2. Three...
  2. Bar Topic X

See also:

  1. Edit structure
  2. Print PDF


Foo Topic 1

Lorem ipsum dolet

Foo Topic 2

Lorem ipsum dolet


Lorem ipsum dolet

Bar Topic X

Lorem ipsum dolet
Lorem ipsum dolet
Lorem ipsum dolet
Lorem ipsum dolet

Compare to Sectional Edit Plugin

The Sectional Edit Plugin addresses the same problem with a completely different approach: it keeps one (possibly huge) wiki page for your printed document. The wiki way is emulated by opening small sections for editing.

Advantages of Include Index Plugin:

  • You can reference the sub-topics as plain wiki pages
  • People can edit the sub-topics independently
  • Web Changes etc. work as expected.
  • Revision history of sub-documents is easy to track
  • Need to render full document only when saving the master doc, but not for sub-topics
Advantages of Sectional Edit Plugin:
  • More topics mean more names, mean more possiblities to screw up namespace
  • Sometimes, it is more convenient to edit many topics in one go
  • TWiki (shame!) doesn't support Wiki:WayBackMode (yet), It is very hard to get a previous version of a composite doc other than storing printouts

IncludeIndexPlugin Global Settings

  • There are no global settings necessary for this plugin, except
    • Set SHORTDESCRIPTION = Generate an index of pages included from a master page.
    • Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

  • Download the ZIP file from the Plugin web (see below)
  • Unzip in your twiki installation directory. Content: | File: | Description: | | data/TWiki/IncludeIndexPlugin.txt | Plugin topic | | lib/TWiki/Plugins/ | Plugin Perl module |
  • Test if the plugin is correctly installed: Between the following two horizontal rulers, the list of topics in the T Wiki Documentation should show up:

TWiki Reference Manual (01 Sep 2004 $Rev: 1742 $)

  1. T Wiki System Requirements
  2. T Wiki Installation Guide
  3. Windows Install Cookbook
  4. T Wiki Upgrade Guide
  5. T Wiki User Authentication
  6. T Wiki Access Control
  7. Text Formatting Rules
  8. T Wiki Variables
  9. File Attachment
  10. T Wiki Forms
  11. T Wiki Templates
  12. T Wiki Skins
  13. Formatted Search
  14. T Wiki Meta Data
  15. T Wiki Plugins
  16. T Wiki Func Module
  17. T Wiki Site Tools
  18. Managing Topics
  19. Managing Webs
  20. Managing Users
  21. Appendix File System
  22. T Wiki Css
  23. Appendix Encode UR Ls With UT F 8
  24. T Wiki History

Plugin Info

Plugin Author: TWiki:Main/PeterKlausner
Plugin Version: V1.000
Change History:  
Jun 2003: Posted for Feb2003 Bejing release
Jul 2002: Initial version for Dec2001 Athens release
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Plugin Home:
Source: CVSPlugins:InlcudeIndexPlugin

Related Topics:

Sectional Edit Plugin, Pdf Plugin?, TWikiPreferences, TWikiPlugins, Default Plugin
to top

You are here: TWiki > T Wiki Plugins > IncludeIndexPlugin

to top

Copyright © 1999-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback