TopicReferencePlugin

<--
   Contributions to this TWiki plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/TopicReferencePlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/TopicReferencePluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Introduction

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

• Lists are generated with the following:
  • %TOPICREFERENCELIST{"(argument)" [web="webname"]}%

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"}%

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 and topic reference 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
  lib/TWiki/Plugins/TopicReferencePlugin.pm	Plugin Perl module

• Configure the plugin:
  • 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

Plugin Author:	TWiki:Main.JeffCrawford
Copyright:	© 2006, TWiki:Main.JeffCrawford © 2006-2010 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2010-11-09 (V1.002)
Change History:	<-- versions below in reverse order -->
2010-11-09:	TWikibug:Item6530: Doc improvements
2006-04-19:	Changed name of plugin (formerly OrphanFindPlugin), modified for better speed and added default, added web option
2006-04-15:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Benchmarks:	GoodStyle 99%, FormattedSearch 99%, TopicReferencePlugin 58%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/TopicReferencePlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/TopicReferencePluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/TopicReferencePluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences