Menu
▾
▴
[TWiki-Dev] [SVN] PeterThoeny r20965 - in twiki/branches/TWikiRelease05x00/SingletonWikiWordPlugin: data/TWiki lib/TWiki/Plugins lib/TWiki/Plugins/SingletonWikiWordPlugin
Author: PeterThoeny Date: 2011-04-06 01:50:40 -0500 (Wed, 06 Apr 2011) New Revision: 20965 Trac url: http://develop.twiki.org/trac/changeset/20965 Modified: twiki/branches/TWikiRelease05x00/SingletonWikiWordPlugin/data/TWiki/SingletonWikiWordPlugin.txt twiki/branches/TWikiRelease05x00/SingletonWikiWordPlugin/lib/TWiki/Plugins/SingletonWikiWordPlugin.pm twiki/branches/TWikiRelease05x00/SingletonWikiWordPlugin/lib/TWiki/Plugins/SingletonWikiWordPlugin/MANIFEST Log: Item6638: Doc improvements Modified: twiki/branches/TWikiRelease05x00/SingletonWikiWordPlugin/data/TWiki/SingletonWikiWordPlugin.txt =================================================================== --- twiki/branches/TWikiRelease05x00/SingletonWikiWordPlugin/data/TWiki/SingletonWikiWordPlugin.txt 2011-04-06 06:49:10 UTC (rev 20964) +++ twiki/branches/TWikiRelease05x00/SingletonWikiWordPlugin/data/TWiki/SingletonWikiWordPlugin.txt 2011-04-06 06:50:40 UTC (rev 20965) @@ -1,49 +1,75 @@ ----++ SingletonWikiWordPlugin +%META:TOPICINFO{author="TWikiContributor" date="1302071656" format="1.1" version="$Rev$"}% +---+!! !SingletonWikiWordPlugin +<!-- + Contributions to this plugin are appreciated. Please update the plugin page at + http://twiki.org/cgi-bin/view/Plugins/SingletonWikiWordPlugin or provide feedback at + http://twiki.org/cgi-bin/view/Plugins/SingletonWikiWordPluginDev. + If you are a TWiki contributor please update the plugin in the SVN repository. +--> +<sticky><div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;"> +%TOC{title="Page contents"}% +</div></sticky> +%SHORTDESCRIPTION% +---++ 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 <nop>.Ontology In fact, you can already force a single word link to a WikiWord by enclosing it in double square brackets, like this: -<nop>[<nop>[.Ontology]] +=[<nop>[.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 +The syntax was chosen to be an extension of the Web.Topic syntax. -Test: -| *Written as* | *Test* | *If it is installed properly you see* | *If it isn't, you will see* | -| .Singleword | .Singleword | [[Singleword]] | <nop>.Singleword | +---++ Examples - +| *Write* | *Renders as* | *If it is installed properly you see* | *If it isn't, you will see* | +| =.Singleword= | .Singleword | [[Singleword]] | <nop>.Singleword | ----+++ Syntax Rules(none) ----+++ %TOPIC% - * One line description, shown in the %TWIKIWEB%.TextFormattingRules topic: - * Set SHORTDESCRIPTION = This plugin holds a function to implement the features listed on http://twiki.org/cgi-bin/view/Codev/?topic=SingletonWikiWord. +---++ Plugin Installation & Configuration - * Set DEBUG to 1 to get debug messages in =data/debug.txt=. Default: =0= - * Set DEBUG = 0 +__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. - * There are no customisable settings + * For an __automated installation__, run the [[%SCRIPTURL{configure}%][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 ==%TOPIC%.zip== in your twiki installation directory. Content: + | *File:* | *Description:* | + | ==data/TWiki/%TOPIC%.txt== | Plugin topic | + | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module | + * Set the ownership of the extracted directories and files to the webserver user. + * Install the dependencies (if any). ----+++ Plugin Installation Instructions + * Plugin __configuration and testing__: + * Run the [[%SCRIPTURL{configure}%][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. - * To install this plug-in you must install this topic and the .pm file. +---++ Plugin Info + * One line description, is shown in the %SYSTEMWEB%.TextFormattingRules topic: + * Set SHORTDESCRIPTION = Automatically link singleton words that are prefixed by a dot + * Debug flag: + * Set DEBUG = 0 ----+++ Plugin Info | Plugin Author: | TWiki:Main.MartinCleaver | -| Plugin Version: | 15 Apr 2003 | -| Change History: | none | +| Copyright: | © 2003 TWiki:Main.MartinCleaver <br /> © 2008-2011 TWiki:TWiki.TWikiContributor | +| License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) | +| Plugin Version: | 2011-04-05 | +| Change History: | <!-- versions below in reverse order --> | +| 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.0 | -| Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% | -| Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev | +| Perl Version: | 5.005 | +| TWiki:Plugins.Benchmark: | %SYSTEMWEB%.GoodStyle nn%, %SYSTEMWEB%.FormattedSearch nn%, %TOPIC% 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:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins - --- TWiki:Main.MartinCleaver - 28 Nov 2001 <br> - +__Related Topics:__ %SYSTEMWEB%.TWikiPlugins, %SYSTEMWEB%.UserDocumentationCategory, %SYSTEMWEB%.TWikiPreferences Modified: twiki/branches/TWikiRelease05x00/SingletonWikiWordPlugin/lib/TWiki/Plugins/SingletonWikiWordPlugin/MANIFEST =================================================================== --- twiki/branches/TWikiRelease05x00/SingletonWikiWordPlugin/lib/TWiki/Plugins/SingletonWikiWordPlugin/MANIFEST 2011-04-06 06:49:10 UTC (rev 20964) +++ twiki/branches/TWikiRelease05x00/SingletonWikiWordPlugin/lib/TWiki/Plugins/SingletonWikiWordPlugin/MANIFEST 2011-04-06 06:50:40 UTC (rev 20965) @@ -1,2 +1,2 @@ -data/TWiki/SingletonWikiWordPlugin.txt NEW -lib/TWiki/Plugins/SingletonWikiWordPlugin.pm NEW +data/TWiki/SingletonWikiWordPlugin.txt 0644 +lib/TWiki/Plugins/SingletonWikiWordPlugin.pm 0644 Modified: twiki/branches/TWikiRelease05x00/SingletonWikiWordPlugin/lib/TWiki/Plugins/SingletonWikiWordPlugin.pm =================================================================== --- twiki/branches/TWikiRelease05x00/SingletonWikiWordPlugin/lib/TWiki/Plugins/SingletonWikiWordPlugin.pm 2011-04-06 06:49:10 UTC (rev 20964) +++ twiki/branches/TWikiRelease05x00/SingletonWikiWordPlugin/lib/TWiki/Plugins/SingletonWikiWordPlugin.pm 2011-04-06 06:50:40 UTC (rev 20965) @@ -1,8 +1,8 @@ +# Plugin for TWiki Enterprise Collaboration Platform, http://TWiki.org/ # -# TWiki WikiClone ($wikiversion has version info) -# # Copyright (C) 2000-2001 Andrea Sterbini, a.s...@fl... -# Copyright (C) 2001 Peter Thoeny, Peter@Thoeny.com +# Copyright (C) 2001 Peter Thoeny, Peter[at]Thoeny.org +# Copyright (C) 2008-2011 TWiki Contributors # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License @@ -19,25 +19,17 @@ # http://twiki.org/cgi-bin/view/Codev/?topic=SingletonWikiWord # ========================= -package TWiki::Plugins::SingletonWikiWordPlugin; # change the package name!!! +package TWiki::Plugins::SingletonWikiWordPlugin; # ========================= use vars qw( $web $topic $user $installWeb $VERSION $RELEASE $debug - $exampleCfgVar ); -# This should always be $Rev$ so that TWiki can determine the checked-in -# status of the plugin. It is used by the build automation tools, so -# you should leave it alone. $VERSION = '$Rev$'; +$RELEASE = '2011-04-05'; -# This is a free-form string you can use to "name" your own plugin version. -# It is *not* used by the build automation tools, but is reported as part -# of the version number in PLUGINDESCRIPTIONS. -$RELEASE = 'Dakar'; - # ========================= sub initPlugin { @@ -67,10 +59,6 @@ # This is the place to define customized tags and variables # Called by sub handleCommonTags, after %INCLUDE:"..."% $_[0] =~ s/(\s+)\.([A-Z]+[a-z]*)/"$1".&TWiki::Func::internalLink("[[$2]]",$web,$web,"",1)/geo; - - # do custom extension rule, like for example: - # $_[0] =~ s/%XYZ%/&handleXyz()/geo; - # $_[0] =~ s/%XYZ{(.*?)}%/&handleXyz($1)/geo; } sub writeDebug |