TopicReferencePlugin

This plugin is used to help find orphaned topics. It can also be used to count the number of references to a particular topic.

Syntax Rules

"   * [[$topic]] ($count)"

Syntax Examples

• List orphaned topics

      * %TOPICREFERENCELIST{"orphans"}%
      * %TOPICREFERENCELIST%

• List orphaned topics in a different web

      * %TOPICREFERENCELIST{"orphans" web="MyWeb"}%

• List topics with references (non-zero)

      * %TOPICREFERENCELIST{"hasref"}%

• List all topics and reference counts

      * %TOPICREFERENCELIST{"all"}%
      * %TOPICREFERENCELIST{"allrefs"}%

• List topics with references using format

      * %TOPICREFERENCELIST{type="hasref" header="| *Topic* | *Reference Count* |" format="| [[$topic]] | $count |"}%

Rendered Example, Orphans in the Main web

%TOPICREFERENCELIST{"orphans" web="Main"}% 

Plugin Settings

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Find orphaned topics or topic ref counts.

• Debug plugin: (See output in data/debug.txt)
  • 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 TWiki server.

• Download the ZIP file from the Plugin web (see below)
• Unzip TopicReferencePlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/TopicReferencePlugin.txt	Plugin topic
  data/TWiki/TopicReferencePlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/TopicReferencePlugin.pm	Plugin Perl module

• Configure the Plugin:
  • TWiki 4.0 and up: Run the configure script to enable the Plugin
  • Change the Plugin settings as needed
• Test if the installation was successful (verify rendered example above)

Plugin Info

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWiki:Main.JeffCrawford - 19 Apr 2006