Home - this site is powered by TWiki(R)
TWiki  TopicReferencePlugin (compare)

Difference: TopicReferencePlugin (r3 vs. r2)


Find orphaned topics and topic reference counts


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"]}%
ArgumentSorted ascendingDescription
all Show all topics for the web and their reference counts (e.g. number of times a topic is referenced from another topic)
hasref Show all topics with references (excluded orphans)
orphans Show all topics with a ref count of 0 (default if you used %TOPICREFERENCELIST{}%)

Syntax Examples

  • List orphaned topics
    • %TOPICREFERENCELIST{"orphans"}%
  • 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

Rendered Example, Orphans in the Main web

Plugin output (simulated): Plugin output (if enabled): Used syntax:
%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:
    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:  
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

View topic | View difference side by side | History: r3 < r2 < r1 | More topic actions

Revision r3 - 2015-06-17 - 18:21 - TWikiAdminUser
Revision r2 - 2014-03-07 - 17:53 - TWikiAdminUser

This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2020 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TopicReferencePlugin.