---+!! <nop>%TOPIC%

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

%TOC%

---++ Syntax Rules

   * Lists are generated with the following:
      * %TO%NOP%PICREFLIST{"(argument)"}%

| *Argument* | *Description* |
| all | Show all topics for the web and their reference counts (e.g. number of times a topic is referenced from another topic) |
| orphans | Show all topics with a ref count of 0 |
| hasref | Show all topics with references (excluded orphans) |
| dangling | Show all dangling link Topics (topic doesn't exist but is referenced) (not available yet) |

---++ Examples

   * List all topics and reference counts
      * %TO%NOP%PICREFLIST{"all"}%

   * List orphaned topics
      * %TO%NOP%PICREFLIST{"orphans"}%

   * List topics with references (non-zero)
      * %TO%NOP%PICREFLIST{"hasref"}%

   * List dangling references with non-existing topics (not available yet)
      * %TO%NOP%PICREFLIST{"dangling"}%

---++ Plugin Settings

   * One line description, is shown in the %TWIKIWEB%.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 ==%TOPIC%.zip== in your twiki installation directory. Content:
     | *File:* | *Description:* |
     | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
     | ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository |
     | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
   * Configure the Plugin:
      * TWiki 4.0 and up: Run the [[%SCRIPTURL%/configure%SCRIPTSUFFIX%][configure]] script to enable the Plugin
      * Change the Plugin settings as needed
   * Test if the installation was successful:
        %TOPICLIST{"orphans"}%

---++ Plugin Info

|  Plugin Author: | TWiki:Main.JeffCrawford |
|  Copyright: | &copy; 2006, TWiki:Main.JeffCrawford |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Plugin Version: | 15 Apr 2006 (V1.000) |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  15 Apr 2006: | Initial version |
|  TWiki Dependency: | $TWiki::Plugins::VERSION 1.1 |
|  CPAN Dependencies: | none |
|  Other Dependencies: | none |
|  Perl Version: | 5.005 |
|  [[TWiki:Plugins/Benchmark][Benchmarks]]: | %TWIKIWEB%.GoodStyle nn%, %TWIKIWEB%.FormattedSearch nn%, %TOPIC% nn% |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |

__Related Topics:__ %TWIKIWEB%.TWikiPlugins, %TWIKIWEB%.DeveloperDocumentationCategory, %TWIKIWEB%.AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences

-- TWiki:Main.JeffCrawford - 15 Apr 2006
