Orphans Plugin

Introduction

This Plugin assists in the management of topics within a TWiki web by locating orphaned topics (topics that have no parent, or their parent has been deleted).

Orphaned topics are displayed in a table, optionally with a reference count. Example:

Tools

The plugin is used from a page in the TWiki web, ManageOrphanedPages. Normally you should be able to get away with just this topic, though you can use the plugin from any topic in any web if you want to.

Syntax Rules

Write %FINDORPHANS{ parameters }% anywhere in a topic.

Supported parameters:

Example: %FINDORPHANS{web="Myproject" allwebs="on" allrefs="off"}%

When the topic is viewed the Plugin will generate a table of topics in the selected web, with reference counts if you requested them, and an action link that allows you to delete the topic directly (prompts you to move it to the Trash web).

Notes 1 Before you can delete a topic, a final check for any topics that reference it is performed. If you searched in all webs, then the check also searches in all webs, but if you searched in the current web only, then only the current web is searched for confirmation. If you want to be absolutely sure that no useful references exist, always select allwebs.

1. References from the WebStatistics topic are not counted.

Plugin Installation Instructions

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

Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.

• If you have TWiki 4.2 or later, you can install from the configure interface (Go to Plugins->Find More Extensions)
  • See the installation supplement on TWiki.org for more information.
• If you have any problems, then you can still install manually from the command-line:
  1. Download one of the .zip or .tgz archives
  2. Unpack the archive in the root directory of your TWiki installation.
  3. Run the installer script ( perl <module>_installer )
  4. Run configure and enable the module, if it is a plugin.
  5. Repeat for any missing dependencies.
• If you are still having problems, then instead of running the installer script:
  1. Make sure that the file permissions allow the webserver user to access all files.
  2. Check in any installed files that have existing ,v files in your existing install (take care not to lock the files when you check in)
  3. Manually edit LocalSite.cfg to set any configuration variables.

• Test if the plugin is correctly installed by visiting the ManageOrphanedPages topic, select a web and see if the table is expanded correctly.

Plugin Info

Many thanks to the following sponsors for supporting this work:

• Wind River

Plugin Author:	TWiki:Main.CrawfordCurrie
Copyright:	© 2004, Wind River; © 2004-2010, TWiki:TWiki/TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	18561 (2010-04-30)
Change History:
2010-04-30:	TWikibug:Item6433 - doc improvements; changing TWIKIWEB to SYSTEMWEB
7 Sep 2007	Bugs:Item4571 corrected noautolink handling, and hopefully improved UTF-8 handling as well
11498	Ported to TWiki-4
25 Mar 2004:	Initial version
Dependencies:	None
Perl Version:	5.008 and up
TWiki:Plugins/Benchmark:	GoodStyle 99%, FormattedSearch 99%, ManageOrphanedPages 95%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/OrphansPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/OrphansPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/OrphansPluginAppraisal

Related Topics: ManageOrphanedPages, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences