TIP OrphansPlugin is not installed on Foswiki.org.

Orphans Plugin

Locate orphaned topics in Foswiki webs

This Plugin assists in the management of topics within a Foswiki 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:
Action Lost Topic References Referees
delete JohnLocke 4 TheFaithless
delete SayidJarrah 8 HugoReyes. FrenchChick
delete KateAusten 15 JackShepherd, JamesSawyer
delete WaltLloyd 16 MichaelDawson, TheLost
delete MichaelDawson 23 TheOthers, TheIrritating
delete JamesSawyer 42 TheHidden, TheOthers, TheFaithful

Tools

The plugin is used from a page in the System web, ManageOrphanedPages.

There is also WebOrphans, which may be included from a similarly named topic in other webs. By default OrphansPlugin adds a WebOrphans topic to your System, Main, Sandbox and _default webs.

Syntax Rules

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

Supported parameters:
Parameter and Values Description Default
web="..." Foswiki web to search Current web "Extensions"
allwebs="on"
allwebs="off"
Searches in all public webs for references to topic when detecting orphans "off"
allrefs="on"
allrefs="off"
Analyses count of references to each topic when searching for orphans, and includes them in the output table "off"

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.
  2. 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.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

  • 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

Another great Foswiki extension from the wikiringlogo20x20.png WikiRing - working together to improve your wiki experience!

Many thanks to the following sponsors for supporting this work:

Author: Foswiki:Main.CrawfordCurrie
Version: 5442 (2009-11-07)
Release: 07 Nov 2009
Change History:  
7 Nov 2009 Foswikitask:Item2335: port plugin to Foswiki
7 Sep 2007 TWikibug:Item4571: corrected noautolink handling, and hopefully improved UTF-8 handling as well
11498 Ported to Foswiki-4
25 Mar 2004: Initial version
Dependencies: None
Perl Version: 5.008 and up
Plugin Home: http://foswiki.org/Extensions/OrphansPlugin
Support: http://foswiki.org/Support/OrphansPlugin

Related Topics: DefaultPreferences, SitePreferences, Plugins

Topic revision: r3 - 27 Jan 2010, PaulHarvey - This page was cached on 25 Sep 2016 - 14:37.

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License