r2 - 22 Apr 2006 - 07:51:56 - TWikiContributorYou are here: Astrophysics Wiki >  TWiki Web  > TopicReferencePlugin

TopicReferencePlugin

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

You type You Get
%TOPICREFERENCELIST% List of orphan topics
%TOPICREFERENCELIST{<attributes>}% see attribute table below

Attributedown Description Default
format="..." Format of output. $topic can be used for the topic name. $count for reference count Bullet list e.g.
"   * [[$topic]] ($count)"
header="..." Text at top of list none
type="listtype" or "listtype" listtype: orphans - all topics with ref count of 0
hasref - all topics with references
all or allrefs - all topics and ref counts
orphans
web="Webname" Web to process Current Web

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"}%
      * %TOPICREFERENCELIST{"allrefs"}%

  • List topics with references using format
      * %TOPICREFERENCELIST{type="hasref" header="| *Topic* | *Reference Count* |" format="| [[$topic]] | $count |"}%

Rendered Example, Orphans in the Main web

Plugin output (pre-rendered):

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 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 TopicReferencePlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/TopicReferencePlugin.txt Plugin topic
    data/TWiki/TopicReferencePlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/TopicReferencePlugin.pm Plugin Perl module
  • Configure the Plugin:
    • TWiki 4.0 and up: 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
License: GPL (GNU General Public License)
Plugin Version: 12 Oct 2006 (V1.002)
Change History:  
12 Oct 2006: Enhancments: Added type, header and format attributes;
Bugs: fixed issue with whitespace preceeding tag (default bullet item wasn't being rendered properly)
19 Apr 2006: Changed name of plugin (formerly OrphanFindPlugin), modified for better speed and added default, added web option
15 Apr 2006: 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

-- TWiki:Main.JeffCrawford - 19 Apr 2006

Edit | WYSIWYG | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r2 < r1 | More topic actions

key Log In or Register
Information

Main Web Users Groups Index Search Changes Notifications Statistics Preferences


Webs Main Sandbox TWiki Zen Information

Main Web Users Groups Index Search Changes Notifications Statistics Preferences


Webs Main Sandbox TWiki Zen





 
Astrophysics Wiki


Edit Wysiwyg Attach Printable
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Astrophysics Wiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TopicReferencePlugin