SingletonWikiWordPlugin

Introduction

This designates that a single word is a reference to a single word. To show TWiki that it should be linked to, write a dot before it.

Hence if you have the WikiWord Ontology you can link to it as .Ontology

In fact, you can already force a single word link to a WikiWord by enclosing it in double square brackets, like this: [[.Ontology]]

This plugin allows you to write it without the square brackets.

The syntax was chosen to be an extension of the Web.Topic syntax.

Examples

Plugin Installation & Configuration

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.

• For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

• Or, follow these manual installation steps:
  • Download the ZIP file from the Plugins home (see below).
  • Unzip SingletonWikiWordPlugin.zip in your twiki installation directory. Content:

    File:	Description:
    data/TWiki/SingletonWikiWordPlugin.txt	Plugin topic
    lib/TWiki/Plugins/SingletonWikiWordPlugin.pm	Plugin Perl module

  • Set the ownership of the extracted directories and files to the webserver user.
  • Install the dependencies (if any).

• Plugin configuration and testing:
  • Run the configure script and enable the plugin in the Plugins section.
  • Configure additional plugin settings in the Extensions section if needed.
  • Test if the installation was successful: See example above.

Plugin Info

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Automatically link singleton words that are prefixed by a dot
• Debug flag:
  • Set DEBUG = 0

Plugin Author:	TWiki:Main.MartinCleaver
Copyright:	© 2003 TWiki:Main.MartinCleaver © 2008-2011 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2011-04-05
Change History:
2011-04-05:	TWikibug:Item6638: Doc improvements -- TWiki:Main.PeterThoeny
2003-04-15:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
TWiki:Plugins.Benchmark:	GoodStyle nn%, FormattedSearch nn%, SingletonWikiWordPlugin nn%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/SingletonWikiWordPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/SingletonWikiWordPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/SingletonWikiWordPluginAppraisal

Related Topics: TWikiPlugins, UserDocumentationCategory, TWikiPreferences