TopicReferencePlugin
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"]}%
| Argument | Description |
|---|---|
| orphans | Show all topics with a ref count of 0 (default if you used %TOPICREFERENCELIST{}%) |
| hasref | Show all topics with references (excluded orphans) |
| all | Show all topics for the web and their reference counts (e.g. number of times a topic is referenced from another topic) |
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
Plugin output (simulated):
|
Plugin output (if enabled): %TOPICREFERENCELIST{"orphans" web="Main"}% |
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.zipin your twiki installation directory. Content:File: Description: data/TWiki/TopicReferencePlugin.txtPlugin topic lib/TWiki/Plugins/TopicReferencePlugin.pmPlugin 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 |
| I | Attachment | Action | Size | Date | Who | Comment |
|---|---|---|---|---|---|---|
 zip |
OrphanFindPlugin.zip | manage | 4.0 K | 2006-04-17 - 17:36 | UnknownUser | |
 md5 |
TopicReferencePlugin.md5 | manage | 0.2 K | 2010-11-10 - 02:00 | PeterThoeny | |
| tgz |
TopicReferencePlugin.tgz | manage | 4.8 K | 2010-11-10 - 02:00 | PeterThoeny | |
| zip |
TopicReferencePlugin.zip | manage | 6.2 K | 2010-11-10 - 02:00 | PeterThoeny | |
| EXT |
TopicReferencePlugin_installer | manage | 3.4 K | 2010-11-10 - 02:00 | PeterThoeny |
Topic revision: r15 - 2011-08-23 - PeterThoeny
Home 
Site map
Blog web
Index
Search
Search extensions
Search by tags
Changes
Notifications
RSS Feed
Statistics
Preferences
Community 
Readme first!
Rate extensions!
Add-Ons 
Development topics
Idea topics
Plugins 
Development topics
Idea topics
Skins 
Development topics
Idea topics
Code Contribs 
Development topics
Idea topics
Account 
Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.Copyright © 1999-2012 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.