Changeset 812

Timestamp:

11/19/08 16:05:12 (3 years ago)

Author:

CrawfordCurrie

Message:

Item175: corrected references to TWiki in comments and error messages

Location:

trunk

Files:

• TWikiCompatibilityPlugin/lib/TWiki/Plugins/TWikiCompatibilityPlugin.pm (modified) (3 diffs)
• core/data/System/Plugins.txt (modified) (21 diffs)
• core/data/TWiki/WebPreferences.txt (added)
• core/lib/Foswiki.pm (modified) (43 diffs)
• core/lib/Foswiki/Attach.pm (modified) (1 diff)
• core/lib/Foswiki/Attrs.pm (modified) (3 diffs)
• core/lib/Foswiki/Compatibility.pm (modified) (1 diff)
• core/lib/Foswiki/Configure/CSS.pm (modified) (4 diffs)
• core/lib/Foswiki/Configure/Checker.pm (modified) (2 diffs)
• core/lib/Foswiki/Configure/Checkers/BasicSanity.pm (modified) (1 diff)
• core/lib/Foswiki/Configure/Checkers/CGISetup.pm (modified) (7 diffs)
• core/lib/Foswiki/Configure/Checkers/MSWin32.pm (modified) (2 diffs)
• core/lib/Foswiki/Configure/Checkers/Sessions/ExpireAfter.pm (modified) (1 diff)
• core/lib/Foswiki/Configure/Checkers/Site/Locale.pm (modified) (1 diff)
• core/lib/Foswiki/Configure/Checkers/UseLocale.pm (modified) (3 diffs)
• core/lib/Foswiki/Configure/FoswikiCfg.pm (modified) (2 diffs)
• core/lib/Foswiki/Configure/Load.pm (modified) (6 diffs)
• core/lib/Foswiki/Configure/UIs/AUTH.pm (modified) (1 diff)
• core/lib/Foswiki/Configure/UIs/EXTENSIONS.pm (modified) (2 diffs)
• core/lib/Foswiki/Configure/UIs/UPDATE.pm (modified) (2 diffs)
• core/lib/Foswiki/Engine.pm (modified) (3 diffs)
• core/lib/Foswiki/Form.pm (modified) (1 diff)
• core/lib/Foswiki/Form/Label.pm (modified) (1 diff)
• core/lib/Foswiki/Form/Select.pm (modified) (1 diff)
• core/lib/Foswiki/Func.pm (modified) (46 diffs)
• core/lib/Foswiki/I18N.pm (modified) (4 diffs)
• core/lib/Foswiki/I18N/Extract.pm (modified) (4 diffs)
• core/lib/Foswiki/LoginManager.pm (modified) (3 diffs)
• core/lib/Foswiki/LoginManager/ApacheLogin.pm (modified) (2 diffs)
• core/lib/Foswiki/LoginManager/Session.pm (modified) (1 diff)
• core/lib/Foswiki/Merge.pm (modified) (2 diffs)
• core/lib/Foswiki/Meta.pm (modified) (3 diffs)
• core/lib/Foswiki/Net.pm (modified) (3 diffs)
• core/lib/Foswiki/Net/UserCredAgent.pm (modified) (1 diff)
• core/lib/Foswiki/Plugin.pm (modified) (2 diffs)
• core/lib/Foswiki/Plugins.pm (modified) (4 diffs)
• core/lib/Foswiki/Plurals.pm (modified) (1 diff)
• core/lib/Foswiki/Prefs/PrefsCache.pm (modified) (1 diff)
• core/lib/Foswiki/Query/HoistREs.pm (modified) (1 diff)
• core/lib/Foswiki/Query/Node.pm (modified) (1 diff)
• core/lib/Foswiki/Render.pm (modified) (8 diffs)
• core/lib/Foswiki/Sandbox.pm (modified) (2 diffs)
• core/lib/Foswiki/Search.pm (modified) (1 diff)
• core/lib/Foswiki/Store.pm (modified) (5 diffs)
• core/lib/Foswiki/Store/RcsFile.pm (modified) (1 diff)
• core/lib/Foswiki/Store/RcsLite.pm (modified) (1 diff)
• core/lib/Foswiki/Store/RcsWrap.pm (modified) (1 diff)
• core/lib/Foswiki/Templates.pm (modified) (2 diffs)
• core/lib/Foswiki/Time.pm (modified) (3 diffs)
• core/lib/Foswiki/UI.pm (modified) (5 diffs)
• core/lib/Foswiki/UI/Oops.pm (modified) (1 diff)
• core/lib/Foswiki/UI/Register.pm (modified) (2 diffs)
• core/lib/Foswiki/UI/Rest.pm (modified) (2 diffs)
• core/lib/Foswiki/UI/Save.pm (modified) (1 diff)
• core/lib/Foswiki/UI/Statistics.pm (modified) (2 diffs)
• core/lib/Foswiki/UI/View.pm (modified) (1 diff)
• core/lib/Foswiki/UserMapping.pm (modified) (2 diffs)
• core/lib/Foswiki/Users.pm (modified) (5 diffs)
• core/lib/Foswiki/Users/BaseUserMapping.pm (modified) (5 diffs)
• core/lib/Foswiki/Users/Password.pm (modified) (3 diffs)

trunk/TWikiCompatibilityPlugin/lib/TWiki/Plugins/TWikiCompatibilityPlugin.pm

@@ -25 +25 @@
 use strict;
 
-require TWiki::Func;    # The plugins API
-require TWiki::Plugins; # For the API version
+require Foswiki::Func;    # The plugins API
+require Foswiki::Plugins; # For the API version
 use vars qw( $VERSION $RELEASE $SHORTDESCRIPTION $debug $pluginName $NO_PREFS_IN_TOPIC );
 $VERSION = '$Rev$';
@@ -46 +46 @@
 sub initPlugin {
     my( $topic, $web, $user, $installWeb ) = @_;
-
-    # check for Plugins.pm versions
-    if( $TWiki::Plugins::VERSION < 1.026 ) {
-        TWiki::Func::writeWarning( "Version mismatch between $pluginName and Plugins.pm" );
-        return 0;
-    }
-
-    my $setting = $TWiki::cfg{Plugins}{TWikiCompatibilityPlugin}{ExampleSetting} || 0;
-    $debug = $TWiki::cfg{Plugins}{TWikiCompatibilityPlugin}{Debug} || 0;
-
-    TWiki::Func::registerTagHandler( 'EXAMPLETAG', \&_EXAMPLETAG );
-    TWiki::Func::registerRESTHandler('example', \&restExample);
-
     return 1;
-}
-
-# The function used to handle the %EXAMPLETAG{...}% variable
-# You would have one of these for each variable you want to process.
-sub _EXAMPLETAG {
-    my($session, $params, $theTopic, $theWeb) = @_;
-    # $session  - a reference to the TWiki session object (if you don't know
-    #             what this is, just ignore it)
-    # $params=  - a reference to a TWiki::Attrs object containing parameters.
-    #             This can be used as a simple hash that maps parameter names
-    #             to values, with _DEFAULT being the name for the default
-    #             parameter.
-    # $theTopic - name of the topic in the query
-    # $theWeb   - name of the web in the query
-    # Return: the result of processing the variable
-
-    # For example, %EXAMPLETAG{'hamburger' sideorder="onions"}%
-    # $params->{_DEFAULT} will be 'hamburger'
-    # $params->{sideorder} will be 'onions'
 }
 
@@ -87 +55 @@
 If the TWiki web does not exist, change the request to the %SYSTEMWEB%
 
-This may not be enough for Plugins that do have intopic preferences.
+This may not be enough for Plugins that do have in topic preferences.
 
 =cut
 
 sub earlyInitPlugin {
-    if (($TWiki::Plugins::SESSION->{webName} eq 'TWiki') &&
-            (!TWiki::Func::webExists($TWiki::Plugins::SESSION->{webName}))) {
-        my $TWikiWebTopicNameConversion = $TWiki::cfg{Plugins}{TWikiCompatibilityPlugin}{TWikiWebTopicNameConversion};
-        $TWiki::Plugins::SESSION->{webName} = $TWiki::cfg{SystemWebName};
-        if (defined($TWikiWebTopicNameConversion->{$TWiki::Plugins::SESSION->{topicName}})) {
-            $TWiki::Plugins::SESSION->{topicName} =
-                    $TWikiWebTopicNameConversion->{$TWiki::Plugins::SESSION->{topicName}};
+
+=pod
+
+Commented out because it redirects requests to value plugin topics for TWiki plugins, which are still in TWiki web - CDot
+
+    if (($Foswiki::Plugins::SESSION->{webName} eq 'TWiki') &&
+            (!Foswiki::Func::webExists($Foswiki::Plugins::SESSION->{webName}))) {
+        my $TWikiWebTopicNameConversion = $Foswiki::cfg{Plugins}{TWikiCompatibilityPlugin}{TWikiWebTopicNameConversion};
+        $Foswiki::Plugins::SESSION->{webName} = $Foswiki::cfg{SystemWebName};
+        if (defined($TWikiWebTopicNameConversion->{$Foswiki::Plugins::SESSION->{topicName}})) {
+            $Foswiki::Plugins::SESSION->{topicName} =
+                    $TWikiWebTopicNameConversion->{$Foswiki::Plugins::SESSION->{topicName}};
         }
     }
-    my $MainWebTopicNameConversion = $TWiki::cfg{Plugins}{TWikiCompatibilityPlugin}{MainWebTopicNameConversion};
-    if (($TWiki::Plugins::SESSION->{webName} eq 'Main') &&
-            (defined($MainWebTopicNameConversion->{$TWiki::Plugins::SESSION->{topicName}}))) {
-        $TWiki::Plugins::SESSION->{topicName} =
-            $MainWebTopicNameConversion->{$TWiki::Plugins::SESSION->{topicName}};
+    my $MainWebTopicNameConversion = $Foswiki::cfg{Plugins}{TWikiCompatibilityPlugin}{MainWebTopicNameConversion};
+    if (($Foswiki::Plugins::SESSION->{webName} eq 'Main') &&
+            (defined($MainWebTopicNameConversion->{$Foswiki::Plugins::SESSION->{topicName}}))) {
+        $Foswiki::Plugins::SESSION->{topicName} =
+            $MainWebTopicNameConversion->{$Foswiki::Plugins::SESSION->{topicName}};
     }
     
     #Map TWIKIWEB to SYSTEMWEB and MAINWEB to USERSWEB
     #TODO: should we test for existance and other things?
-    TWiki::Func::setPreferencesValue('TWIKIWEB', 'SYSTEMWEB');
-    TWiki::Func::setPreferencesValue('MAINWEB', 'USERSWEB');
-    
+    Foswiki::Func::setPreferencesValue('TWIKIWEB', 'SYSTEMWEB');
+    Foswiki::Func::setPreferencesValue('MAINWEB', 'USERSWEB');
+
+=cut
+
     return;
 }
 
-=pod
-
----++ initializeUserHandler( $loginName, $url, $pathInfo )
-   * =$loginName= - login name recovered from $ENV{REMOTE_USER}
-   * =$url= - request url
-   * =$pathInfo= - pathinfo from the CGI query
-Allows a plugin to set the username. Normally TWiki gets the username
-from the login manager. This handler gives you a chance to override the
-login manager.
-
-Return the *login* name.
-
-This handler is called very early, immediately after =earlyInitPlugin=.
-
-*Since:* TWiki::Plugins::VERSION = '1.010'
-
-=cut
-
-sub DISABLE_initializeUserHandler {
-    # do not uncomment, use $_[0], $_[1]... instead
-    ### my ( $loginName, $url, $pathInfo ) = @_;
-
-    TWiki::Func::writeDebug( "- ${pluginName}::initializeUserHandler( $_[0], $_[1] )" ) if $debug;
-}
-
-=pod
-
----++ registrationHandler($web, $wikiName, $loginName )
-   * =$web= - the name of the web in the current CGI query
-   * =$wikiName= - users wiki name
-   * =$loginName= - users login name
-
-Called when a new user registers with this TWiki.
-
-*Since:* TWiki::Plugins::VERSION = '1.010'
-
-=cut
-
-sub DISABLE_registrationHandler {
-    # do not uncomment, use $_[0], $_[1]... instead
-    ### my ( $web, $wikiName, $loginName ) = @_;
-
-    TWiki::Func::writeDebug( "- ${pluginName}::registrationHandler( $_[0], $_[1] )" ) if $debug;
-}
-
-=pod
-
----++ commonTagsHandler($text, $topic, $web, $included, $meta )
-   * =$text= - text to be processed
-   * =$topic= - the name of the topic in the current CGI query
-   * =$web= - the name of the web in the current CGI query
-   * =$included= - Boolean flag indicating whether the handler is invoked on an included topic
-   * =$meta= - meta-data object for the topic MAY BE =undef=
-This handler is called by the code that expands %<nop>TAGS% syntax in
-the topic body and in form fields. It may be called many times while
-a topic is being rendered.
-
-For variables with trivial syntax it is far more efficient to use
-=TWiki::Func::registerTagHandler= (see =initPlugin=).
-
-Plugins that have to parse the entire topic content should implement
-this function. Internal TWiki
-variables (and any variables declared using =TWiki::Func::registerTagHandler=)
-are expanded _before_, and then again _after_, this function is called
-to ensure all %<nop>TAGS% are expanded.
-
-__NOTE:__ when this handler is called, &lt;verbatim> blocks have been
-removed from the text (though all other blocks such as &lt;pre> and
-&lt;noautolink> are still present).
-
-__NOTE:__ meta-data is _not_ embedded in the text passed to this
-handler. Use the =$meta= object.
-
-*Since:* $TWiki::Plugins::VERSION 1.000
-
-=cut
-
-sub DISABLE_commonTagsHandler {
-    # do not uncomment, use $_[0], $_[1]... instead
-    ### my ( $text, $topic, $web, $included, $meta ) = @_;
-    
-    # If you don't want to be called from nested includes...
-    #   if( $_[3] ) {
-    #   # bail out, handler called from an %INCLUDE{}%
-    #         return;
-    #   }
-
-    TWiki::Func::writeDebug( "- ${pluginName}::commonTagsHandler( $_[2].$_[1] )" ) if $debug;
-
-    # do custom extension rule, like for example:
-    # $_[0] =~ s/%XYZ%/&handleXyz()/ge;
-    # $_[0] =~ s/%XYZ{(.*?)}%/&handleXyz($1)/ge;
-}
-
-=pod
-
----++ beforeCommonTagsHandler($text, $topic, $web, $meta )
-   * =$text= - text to be processed
-   * =$topic= - the name of the topic in the current CGI query
-   * =$web= - the name of the web in the current CGI query
-   * =$meta= - meta-data object for the topic MAY BE =undef=
-This handler is called before TWiki does any expansion of it's own
-internal variables. It is designed for use by cache plugins. Note that
-when this handler is called, &lt;verbatim> blocks are still present
-in the text.
-
-__NOTE__: This handler is called once for each call to
-=commonTagsHandler= i.e. it may be called many times during the
-rendering of a topic.
-
-__NOTE:__ meta-data is _not_ embedded in the text passed to this
-handler.
-
-__NOTE:__ This handler is not separately called on included topics.
-
-=cut
-
-sub DISABLE_beforeCommonTagsHandler {
-    # do not uncomment, use $_[0], $_[1]... instead
-    ### my ( $text, $topic, $web, $meta ) = @_;
-
-    TWiki::Func::writeDebug( "- ${pluginName}::beforeCommonTagsHandler( $_[2].$_[1] )" ) if $debug;
-}
-
-=pod
-
----++ afterCommonTagsHandler($text, $topic, $web, $meta )
-   * =$text= - text to be processed
-   * =$topic= - the name of the topic in the current CGI query
-   * =$web= - the name of the web in the current CGI query
-   * =$meta= - meta-data object for the topic MAY BE =undef=
-This handler is after TWiki has completed expansion of %TAGS%.
-It is designed for use by cache plugins. Note that when this handler
-is called, &lt;verbatim> blocks are present in the text.
-
-__NOTE__: This handler is called once for each call to
-=commonTagsHandler= i.e. it may be called many times during the
-rendering of a topic.
-
-__NOTE:__ meta-data is _not_ embedded in the text passed to this
-handler.
-
-=cut
-
-sub DISABLE_afterCommonTagsHandler {
-    # do not uncomment, use $_[0], $_[1]... instead
-    ### my ( $text, $topic, $web, $meta ) = @_;
-
-    TWiki::Func::writeDebug( "- ${pluginName}::afterCommonTagsHandler( $_[2].$_[1] )" ) if $debug;
-}
-
-=pod
-
----++ preRenderingHandler( $text, \%map )
-   * =$text= - text, with the head, verbatim and pre blocks replaced with placeholders
-   * =\%removed= - reference to a hash that maps the placeholders to the removed blocks.
-
-Handler called immediately before TWiki syntax structures (such as lists) are
-processed, but after all variables have been expanded. Use this handler to 
-process special syntax only recognised by your plugin.
-
-Placeholders are text strings constructed using the tag name and a 
-sequence number e.g. 'pre1', "verbatim6", "head1" etc. Placeholders are 
-inserted into the text inside &lt;!--!marker!--&gt; characters so the 
-text will contain &lt;!--!pre1!--&gt; for placeholder pre1.
-
-Each removed block is represented by the block text and the parameters 
-passed to the tag (usually empty) e.g. for
-<verbatim>
-<pre class='slobadob'>
-XYZ
-</pre>
-the map will contain:
-<pre>
-$removed->{'pre1'}{text}:   XYZ
-$removed->{'pre1'}{params}: class="slobadob"
-</pre>
-Iterating over blocks for a single tag is easy. For example, to prepend a 
-line number to every line of every pre block you might use this code:
-<verbatim>
-foreach my $placeholder ( keys %$map ) {
-    if( $placeholder =~ /^pre/i ) {
-       my $n = 1;
-       $map->{$placeholder}{text} =~ s/^/$n++/gem;
-    }
-}
-</verbatim>
-
-__NOTE__: This handler is called once for each rendered block of text i.e. 
-it may be called several times during the rendering of a topic.
-
-__NOTE:__ meta-data is _not_ embedded in the text passed to this
-handler.
-
-Since TWiki::Plugins::VERSION = '1.026'
-
-=cut
-
-sub DISABLE_preRenderingHandler {
-    # do not uncomment, use $_[0], $_[1]... instead
-    #my( $text, $pMap ) = @_;
-}
-
-=pod
-
----++ postRenderingHandler( $text )
-   * =$text= - the text that has just been rendered. May be modified in place.
-
-__NOTE__: This handler is called once for each rendered block of text i.e. 
-it may be called several times during the rendering of a topic.
-
-__NOTE:__ meta-data is _not_ embedded in the text passed to this
-handler.
-
-Since TWiki::Plugins::VERSION = '1.026'
-
-=cut
-
-sub DISABLE_postRenderingHandler {
-    # do not uncomment, use $_[0], $_[1]... instead
-    #my $text = shift;
-}
-
-=pod
-
----++ beforeEditHandler($text, $topic, $web )
-   * =$text= - text that will be edited
-   * =$topic= - the name of the topic in the current CGI query
-   * =$web= - the name of the web in the current CGI query
-This handler is called by the edit script just before presenting the edit text
-in the edit box. It is called once when the =edit= script is run.
-
-__NOTE__: meta-data may be embedded in the text passed to this handler 
-(using %META: tags)
-
-*Since:* TWiki::Plugins::VERSION = '1.010'
-
-=cut
-
-sub DISABLE_beforeEditHandler {
-    # do not uncomment, use $_[0], $_[1]... instead
-    ### my ( $text, $topic, $web ) = @_;
-
-    TWiki::Func::writeDebug( "- ${pluginName}::beforeEditHandler( $_[2].$_[1] )" ) if $debug;
-}
-
-=pod
-
----++ afterEditHandler($text, $topic, $web, $meta )
-   * =$text= - text that is being previewed
-   * =$topic= - the name of the topic in the current CGI query
-   * =$web= - the name of the web in the current CGI query
-   * =$meta= - meta-data for the topic.
-This handler is called by the preview script just before presenting the text.
-It is called once when the =preview= script is run.
-
-__NOTE:__ this handler is _not_ called unless the text is previewed.
-
-__NOTE:__ meta-data is _not_ embedded in the text passed to this
-handler. Use the =$meta= object.
-
-*Since:* $TWiki::Plugins::VERSION 1.010
-
-=cut
-
-sub DISABLE_afterEditHandler {
-    # do not uncomment, use $_[0], $_[1]... instead
-    ### my ( $text, $topic, $web ) = @_;
-
-    TWiki::Func::writeDebug( "- ${pluginName}::afterEditHandler( $_[2].$_[1] )" ) if $debug;
-}
-
-=pod
-
----++ beforeSaveHandler($text, $topic, $web, $meta )
-   * =$text= - text _with embedded meta-data tags_
-   * =$topic= - the name of the topic in the current CGI query
-   * =$web= - the name of the web in the current CGI query
-   * =$meta= - the metadata of the topic being saved, represented by a TWiki::Meta object.
-
-This handler is called each time a topic is saved.
-
-__NOTE:__ meta-data is embedded in =$text= (using %META: tags). If you modify
-the =$meta= object, then it will override any changes to the meta-data
-embedded in the text. Modify *either* the META in the text *or* the =$meta=
-object, never both. You are recommended to modify the =$meta= object rather
-than the text, as this approach is proof against changes in the embedded
-text format.
-
-*Since:* TWiki::Plugins::VERSION = '1.010'
-
-=cut
-
-sub DISABLE_beforeSaveHandler {
-    # do not uncomment, use $_[0], $_[1]... instead
-    ### my ( $text, $topic, $web ) = @_;
-
-    TWiki::Func::writeDebug( "- ${pluginName}::beforeSaveHandler( $_[2].$_[1] )" ) if $debug;
-}
-
-=pod
-
----++ afterSaveHandler($text, $topic, $web, $error, $meta )
-   * =$text= - the text of the topic _excluding meta-data tags_
-     (see beforeSaveHandler)
-   * =$topic= - the name of the topic in the current CGI query
-   * =$web= - the name of the web in the current CGI query
-   * =$error= - any error string returned by the save.
-   * =$meta= - the metadata of the saved topic, represented by a TWiki::Meta object 
-
-This handler is called each time a topic is saved.
-
-__NOTE:__ meta-data is embedded in $text (using %META: tags)
-
-*Since:* TWiki::Plugins::VERSION 1.025
-
-=cut
-
-sub DISABLE_afterSaveHandler {
-    # do not uncomment, use $_[0], $_[1]... instead
-    ### my ( $text, $topic, $web, $error, $meta ) = @_;
-
-    TWiki::Func::writeDebug( "- ${pluginName}::afterSaveHandler( $_[2].$_[1] )" ) if $debug;
-}
-
-=pod
-
----++ afterRenameHandler( $oldWeb, $oldTopic, $oldAttachment, $newWeb, $newTopic, $newAttachment )
-
-   * =$oldWeb= - name of old web
-   * =$oldTopic= - name of old topic (empty string if web rename)
-   * =$oldAttachment= - name of old attachment (empty string if web or topic rename)
-   * =$newWeb= - name of new web
-   * =$newTopic= - name of new topic (empty string if web rename)
-   * =$newAttachment= - name of new attachment (empty string if web or topic rename)
-
-This handler is called just after the rename/move/delete action of a web, topic or attachment.
-
-*Since:* TWiki::Plugins::VERSION = '1.11'
-
-=cut
-
-sub DISABLE_afterRenameHandler {
-    # do not uncomment, use $_[0], $_[1]... instead
-    ### my ( $oldWeb, $oldTopic, $oldAttachment, $newWeb, $newTopic, $newAttachment ) = @_;
-
-    TWiki::Func::writeDebug( "- ${pluginName}::afterRenameHandler( " .
-                             "$_[0].$_[1] $_[2] -> $_[3].$_[4] $_[5] )" ) if $debug;
-}
-
-=pod
-
----++ beforeAttachmentSaveHandler(\%attrHash, $topic, $web )
-   * =\%attrHash= - reference to hash of attachment attribute values
-   * =$topic= - the name of the topic in the current CGI query
-   * =$web= - the name of the web in the current CGI query
-This handler is called once when an attachment is uploaded. When this
-handler is called, the attachment has *not* been recorded in the database.
-
-The attributes hash will include at least the following attributes:
-   * =attachment= => the attachment name
-   * =comment= - the comment
-   * =user= - the user id
-   * =tmpFilename= - name of a temporary file containing the attachment data
-
-*Since:* TWiki::Plugins::VERSION = 1.025
-
-=cut
-
-sub DISABLE_beforeAttachmentSaveHandler {
-    # do not uncomment, use $_[0], $_[1]... instead
-    ###   my( $attrHashRef, $topic, $web ) = @_;
-    TWiki::Func::writeDebug( "- ${pluginName}::beforeAttachmentSaveHandler( $_[2].$_[1] )" ) if $debug;
-}
-
-=pod
-
----++ afterAttachmentSaveHandler(\%attrHash, $topic, $web, $error )
-   * =\%attrHash= - reference to hash of attachment attribute values
-   * =$topic= - the name of the topic in the current CGI query
-   * =$web= - the name of the web in the current CGI query
-   * =$error= - any error string generated during the save process
-This handler is called just after the save action. The attributes hash
-will include at least the following attributes:
-   * =attachment= => the attachment name
-   * =comment= - the comment
-   * =user= - the user id
-
-*Since:* TWiki::Plugins::VERSION = 1.025
-
-=cut
-
-sub DISABLE_afterAttachmentSaveHandler {
-    # do not uncomment, use $_[0], $_[1]... instead
-    ###   my( $attrHashRef, $topic, $web ) = @_;
-    TWiki::Func::writeDebug( "- ${pluginName}::afterAttachmentSaveHandler( $_[2].$_[1] )" ) if $debug;
-}
-
-=pod
-
----++ mergeHandler( $diff, $old, $new, \%info ) -> $text
-Try to resolve a difference encountered during merge. The =differences= 
-array is an array of hash references, where each hash contains the 
-following fields:
-   * =$diff= => one of the characters '+', '-', 'c' or ' '.
-      * '+' - =new= contains text inserted in the new version
-      * '-' - =old= contains text deleted from the old version
-      * 'c' - =old= contains text from the old version, and =new= text
-        from the version being saved
-      * ' ' - =new= contains text common to both versions, or the change
-        only involved whitespace
-   * =$old= => text from version currently saved
-   * =$new= => text from version being saved
-   * =\%info= is a reference to the form field description { name, title,
-     type, size, value, tooltip, attributes, referenced }. It must _not_
-     be wrtten to. This parameter will be undef when merging the body
-     text of the topic.
-
-Plugins should try to resolve differences and return the merged text. 
-For example, a radio button field where we have 
-={ diff=>'c', old=>'Leafy', new=>'Barky' }= might be resolved as 
-='Treelike'=. If the plugin cannot resolve a difference it should return 
-undef.
-
-The merge handler will be called several times during a save; once for 
-each difference that needs resolution.
-
-If any merges are left unresolved after all plugins have been given a 
-chance to intercede, the following algorithm is used to decide how to 
-merge the data:
-   1 =new= is taken for all =radio=, =checkbox= and =select= fields to 
-     resolve 'c' conflicts
-   1 '+' and '-' text is always included in the the body text and text
-     fields
-   1 =&lt;del>conflict&lt;/del> &lt;ins>markers&lt;/ins>= are used to 
-     mark 'c' merges in text fields
-
-The merge handler is called whenever a topic is saved, and a merge is 
-required to resolve concurrent edits on a topic.
-
-*Since:* TWiki::Plugins::VERSION = 1.1
-
-=cut
-
-sub DISABLE_mergeHandler {
-}
-
-=pod
-
----++ modifyHeaderHandler( \%headers, $query )
-   * =\%headers= - reference to a hash of existing header values
-   * =$query= - reference to CGI query object
-Lets the plugin modify the HTTP headers that will be emitted when a
-page is written to the browser. \%headers= will contain the headers
-proposed by the core, plus any modifications made by other plugins that also
-implement this method that come earlier in the plugins list.
-<verbatim>
-$headers->{expires} = '+1h';
-</verbatim>
-
-Note that this is the HTTP header which is _not_ the same as the HTML
-&lt;HEAD&gt; tag. The contents of the &lt;HEAD&gt; tag may be manipulated
-using the =TWiki::Func::addToHEAD= method.
-
-*Since:* TWiki::Plugins::VERSION 1.1
-
-=cut
-
-sub DISABLE_modifyHeaderHandler {
-    my ( $headers, $query ) = @_;
-
-    TWiki::Func::writeDebug( "- ${pluginName}::modifyHeaderHandler()" ) if $debug;
-}
-
-=pod
-
----++ redirectCgiQueryHandler($query, $url )
-   * =$query= - the CGI query
-   * =$url= - the URL to redirect to
-
-This handler can be used to replace TWiki's internal redirect function.
-
-If this handler is defined in more than one plugin, only the handler
-in the earliest plugin in the INSTALLEDPLUGINS list will be called. All
-the others will be ignored.
-
-*Since:* TWiki::Plugins::VERSION 1.010
-
-=cut
-
-sub DISABLE_redirectCgiQueryHandler {
-    # do not uncomment, use $_[0], $_[1] instead
-    ### my ( $query, $url ) = @_;
-
-    TWiki::Func::writeDebug( "- ${pluginName}::redirectCgiQueryHandler( query, $_[1] )" ) if $debug;
-}
-
-=pod
-
----++ renderFormFieldForEditHandler($name, $type, $size, $value, $attributes, $possibleValues) -> $html
-
-This handler is called before built-in types are considered. It generates 
-the HTML text rendering this form field, or false, if the rendering 
-should be done by the built-in type handlers.
-   * =$name= - name of form field
-   * =$type= - type of form field (checkbox, radio etc)
-   * =$size= - size of form field
-   * =$value= - value held in the form field
-   * =$attributes= - attributes of form field 
-   * =$possibleValues= - the values defined as options for form field, if
-     any. May be a scalar (one legal value) or a ref to an array
-     (several legal values)
-
-Return HTML text that renders this field. If false, form rendering
-continues by considering the built-in types.
-
-*Since:* TWiki::Plugins::VERSION 1.1
-
-Note that since TWiki-4.2, you can also extend the range of available
-types by providing a subclass of =TWiki::Form::FieldDefinition= to implement
-the new type (see =TWiki::Plugins.JSCalendarContrib= and
-=TWiki::Plugins.RatingContrib= for examples). This is the preferred way to
-extend the form field types, but does not work for TWiki < 4.2.
-
-=cut
-
-sub DISABLE_renderFormFieldForEditHandler {
-}
-
-=pod
-
----++ renderWikiWordHandler($linkText, $hasExplicitLinkLabel, $web, $topic) -> $linkText
-   * =$linkText= - the text for the link i.e. for =[<nop>[Link][blah blah]]=
-     it's =blah blah=, for =BlahBlah= it's =BlahBlah=, and for [[Blah Blah]] it's =Blah Blah=.
-   * =$hasExplicitLinkLabel= - true if the link is of the form =[<nop>[Link][blah blah]]= (false if it's ==<nop>[Blah]] or =BlahBlah=)
-   * =$web=, =$topic= - specify the topic being rendered (only since TWiki 4.2)
-
-Called during rendering, this handler allows the plugin a chance to change
-the rendering of labels used for links.
-
-Return the new link text.
-
-*Since:* TWiki::Plugins::VERSION 1.1
-
-=cut
-
-sub DISABLE_renderWikiWordHandler {
-    my( $linkText, $hasExplicitLinkLabel, $web, $topic ) = @_;
-    return $linkText;
-}
-
-=pod
-
----++ completePageHandler($html, $httpHeaders)
-
-This handler is called on the ingredients of every page that is
-output by the standard TWiki scripts. It is designed primarily for use by
-cache and security plugins.
-   * =$html= - the body of the page (normally &lt;html>..$lt;/html>)
-   * =$httpHeaders= - the HTTP headers. Note that the headers do not contain
-     a =Content-length=. That will be computed and added immediately before
-     the page is actually written. This is a string, which must end in \n\n.
-
-*Since:* TWiki::Plugins::VERSION 1.2
-
-=cut
-
-sub DISABLE_completePageHandler {
-    #my($html, $httpHeaders) = @_;
-    # modify $_[0] or $_[1] if you must change the HTML or headers
-}
-
-=pod
-
----++ restExample($session) -> $text
-
-This is an example of a sub to be called by the =rest= script. The parameter is:
-   * =$session= - The TWiki object associated to this session.
-
-Additional parameters can be recovered via de query object in the $session.
-
-For more information, check %SYSTEMWEB%.CommandAndCGIScripts#rest
-
-*Since:* TWiki::Plugins::VERSION 1.1
-
-=cut
-
-sub restExample {
-   #my ($session) = @_;
-   return "This is an example of a REST invocation\n\n";
-}
-
 1;

trunk/core/data/System/Plugins.txt

@@ -3 +3 @@
 ---+ Plugins
 
-_Add functionality to TWiki with readily available plugins; create plugins based on APIs_
+_Add functionality to Foswiki with readily available plugins; create plugins based on APIs_
 
 %TOC%
@@ -9 +9 @@
 ---++ Overview
 
-You can add plugins to extend TWiki functionality, without altering the core code. A plug-in approach lets you:
-
-   * add virtually unlimited features while keeping the main TWiki code compact and efficient;
-   * heavily customize an installation and still do clean updates to new versions of TWiki;
-   * rapidly develop new TWiki functions in Perl using the plugin API.
-
-Everything to do with TWiki plugins - demos, new releases, downloads, development, general discussion - is available at TWiki.org, in the <b> TWiki:Plugins </b> web.
-
-TWiki plugins are developed and contributed by interested members of the community. Plugins are provided on an 'as is' basis; they are not a part of TWiki, but are independently developed and maintained.
-
-__Relevant links on TWiki.org:__
-   * TWiki:Support.PluginsSupplement - __%T% tip:__ supplemental documentation on plugins
-   * TWiki:Plugins.PluginPackage - list of all contributed plugin packages
-   * TWiki:Plugins.PluginDevelopment - discussion and feedback on contributed plugins
-   * TWiki:Plugins.PluginBrainstorming - open forum for new plugin ideas
-   * TWiki:Plugins.PluginPackageHowTo - template to create a new plugin package
+You can add plugins to extend Foswiki functionality, without altering the core code. A plug-in approach lets you:
+
+   * add virtually unlimited features while keeping the main Foswiki code compact and efficient;
+   * heavily customize an installation and still do clean updates to new versions of Foswiki;
+   * rapidly develop new Foswiki functions in Perl using the plugin API.
+
+Everything to do with Foswiki plugins - demos, new releases, downloads, development, general discussion - is available at Foswiki.org, in the <b> Foswiki:Extensions </b> web.
+
+Foswiki plugins are developed and contributed by interested members of the community. Plugins are provided on an 'as is' basis; they are not a part of Foswiki, but are independently developed and maintained.
+
+Most TWiki&trade; plugins can also be used with Foswiki if the TWikiCompatibilityPlugin is installed.
 
 __See other types of extensions:__ ContributedAddOns, [[Contribs]], [[Skins]]
@@ -31 +26 @@
 ---++ Installing Plugins
 
-Each TWiki plugin comes with its own documentation: step-by-step installation instructions, a detailed description of any special requirements, version details, and a working example for testing. Many plugins have an install script that automates these steps for you.
+Each Foswiki plugin comes with its own documentation: step-by-step installation instructions, a detailed description of any special requirements, version details, and a working example for testing. Many plugins have an install script that automates these steps for you.
 
 *Special Requirements:* Some plugins need certain Perl modules to be preinstalled on the host system. Plugins may also use other resources, like graphics, other modules, applications, and templates. You should be able to find detailed instructions in the plugin's documentation.
 
-Each plugin has a standard release topic, located in the TWiki:Plugins web at TWiki.org. There's usually a number of other related topics, such as a developers page, and an appraisal page.
+Each plugin has a standard release topic, located in the Foswiki:Extensions web at Foswiki.org. There's usually a number of other related topics, such as a developers page, and an appraisal page.
 
 #PreTesting
 ---+++ On-Site Pretesting
 
-The recommended approach to testing new plugins before making them public is to create a second local TWiki installation, and test the plugin there. You can allow selected users access to the test area. Once you are satisfied that it won't compromise your main installation, you can install it there as well.
-
-InstalledPlugins shows which plugins are: 1) installed, 2) loading properly, and 3) what TWiki:Codev.PluginHandlers they invoke. Any failures are shown in the Errors section. The =[[VarFAILEDPLUGINS][%<nop>FAILEDPLUGINS%]]= macro can be used to debug failures. You may also want to check your webserver error log and the various TWiki log files.
+The recommended approach to testing new plugins before making them public is to create a second local Foswiki installation, and test the plugin there. You can allow selected users access to the test area. Once you are satisfied that it won't compromise your main installation, you can install it there as well.
+
+InstalledPlugins shows which plugins are: 1) installed, 2) loading properly, and 3) what plugin handlers they invoke. Any failures are shown in the Errors section. The =[[VarFAILEDPLUGINS][%<nop>FAILEDPLUGINS%]]= macro can be used to debug failures. You may also want to check your webserver error log and the various Foswiki log files.
 
 ---+++ Some Notes on Plugin Performance
 
-The performance of the system depends to some extent on the number of plugins installed and on the plugin implementation. Some plugins impose no measurable performance decrease, some do. For example, a Plugin might use many Perl libraries that need to be initialized with each page view (unless you run mod_perl). You can only really tell the performance impact by installing the plugin and by measuring the performance with and without the new plugin. Use the TWiki:Plugins.PluginBenchmarkAddOn, or test manually with the Apache =ab= utility. Example on Unix:%BR% =time wget -qO /dev/null <nop>%SCRIPTURLPATH{"view"}%/%SYSTEMWEB%/AbcPlugin=
+The performance of the system depends to some extent on the number of plugins installed and on the plugin implementation. Some plugins impose no measurable performance decrease, some do. For example, a Plugin might use many Perl libraries that need to be initialized with each page view (unless you run mod_perl). You can only really tell the performance impact by installing the plugin and by measuring the performance with and without the new plugin, on real data.
 
 %T% If you need to install an "expensive" plugin, but you only need its functionality only in a subset of your data, you can disable it elsewhere by defining the %<nop>DISABLEDPLUGINS% setting.
@@ -78 +73 @@
    * =Set SHORTDESCRIPTION = Control attributes of tables and sorting of table columns=
  
-[[Preference settings]] of active plugins can be retrieved anywhere in TWiki with =%&lt;pluginname&gt;_&lt;var&gt;%=, such as =%<nop>TABLEPLUGIN_SHORTDESCRIPTION%=. They can also be redefined with the =%&lt;pluginname&gt;_&lt;var&gt;%= setting at a lower level in the [[%LOCALSITEPREFS%]] or at the web level. For an easier upgrade it is recommended to customize plugin preference settings in <nop>%LOCALSITEPREFS% only.
+[[Preference settings]] of active plugins can be retrieved anywhere in Foswiki with =%&lt;pluginname&gt;_&lt;var&gt;%=, such as =%<nop>TABLEPLUGIN_SHORTDESCRIPTION%=. They can also be redefined with the =%&lt;pluginname&gt;_&lt;var&gt;%= setting at a lower level in the [[%LOCALSITEPREFS%]] or at the web level. For an easier upgrade it is recommended to customize plugin preference settings in <nop>%LOCALSITEPREFS% only.
 
 ---+++ Listing Active Plugins
@@ -84 +79 @@
 Plugin status macros let you list all active plugins wherever needed.
 
-This site is running TWiki version *%WIKIVERSION%*, plugin API version
+This site is running Foswiki version *%WIKIVERSION%*, plugin API version
 *%PLUGINVERSION{}%*
 
 #ActivatedPlugins
 ---++++ =%<nop>ACTIVATEDPLUGINS%=
-On this TWiki site, the enabled plugins are: %ACTIVATEDPLUGINS%.
+On this Foswiki site, the enabled plugins are: %ACTIVATEDPLUGINS%.
 
 ---++++ =%<nop>PLUGINDESCRIPTIONS%=
@@ -99 +94 @@
 
 #PluginAPI
----++ The TWiki Plugin API
-
-The Application Programming Interface (API) for TWiki plugins provides the specifications for hooking into the core TWiki code from your external Perl plugin module.
+---++ The Foswiki Plugin API
+
+The Application Programming Interface (API) for Foswiki plugins provides the specifications for hooking into the core Foswiki code from your external Perl plugin module.
 
 ---+++ Available Core Functions
 
-The TWikiFuncDotPm module (=lib/TWiki/Func.pm=) describes *all* the interfaces available to plugins. Plugins should *only* use the interfaces described in this module.
-
-__%X% Note:__ If you use other core functions not described in =Func.pm=, you run the risk of creating security holes. Also, your plugin will likely break and require updating when you upgrade to a new version of TWiki.
+The FoswikiFuncDotPm module (=lib/Foswiki/Func.pm=) describes *all* the interfaces available to plugins. Plugins should *only* use the interfaces described in this module.
+
+__%X% Note:__ If you use other core functions not described in =Func.pm=, you run the risk of creating security holes. Also, your plugin will likely break and require updating when you upgrade to a new version of Foswiki.
 
 ---+++ Predefined Hooks
 
-In addition to TWiki core functions, plugins can use *predefined hooks*, or *callbacks*, as described in the =lib/TWiki/Plugins/EmptyPlugin.pm= module.
+In addition to Foswiki core functions, plugins can use *predefined hooks*, or *callbacks*, as described in the =lib/Foswiki/Plugins/EmptyPlugin.pm= module.
 
    * All but the initPlugin are disabled. To enable a callback, remove =DISABLE_= from the function name.
 
-TWiki:Codev/StepByStepRenderingOrder helps you decide which rendering handler to use.
+Foswiki:Codev/StepByStepRenderingOrder helps you decide which rendering handler to use.
 
 #FastPluginHints
@@ -124 +119 @@
         =eval { require IPC::Run }= %BR%
         =return "&lt;font color=\"red\"&gt;SamplePlugin: Can't load required modules ($@)&lt;/font&gt;" if $@;=
-   * Keep the main plugin package as small as possible; create other packages that are loaded if and only if they are used. For example, create sub-packages of !BathPlugin in =lib/TWiki/Plugins/BathPlugin/=.
-   * Avoid using preferences in the plugin topic; set =$NO_PREFS_IN_TOPIC= if you possibly can, as that will stop TWiki from reading the plugin topic for every page. Use [[#ConfigSpec][Config.spec]] instead. 
+   * Keep the main plugin package as small as possible; create other packages that are loaded if and only if they are used. For example, create sub-packages of !BathPlugin in =lib/Foswiki/Plugins/BathPlugin/=.
+   * Avoid using preferences in the plugin topic; set =$NO_PREFS_IN_TOPIC= if you possibly can, as that will stop Foswiki from reading the plugin topic for every page. Use [[#ConfigSpec][Config.spec]] instead. 
    * Use registered tag handlers
    * [[#MeasurePerformance][Measure the performance]] to see the difference
@@ -138 +133 @@
       * The plugin initialization code does not register a plugin that returns 0 (or that has no =initPlugin= handler).
 
-   * =$TWiki::Plugins::VERSION= in the =TWiki::Plugins= module contains the TWiki plugin API version, currently *%PLUGINVERSION{}%*.
+   * =$Foswiki::Plugins::VERSION= in the =Foswiki::Plugins= module contains the Foswiki plugin API version, currently *%PLUGINVERSION{}%*.
       * You can also use the =[[VarPLUGINVERSION][%<nop>PLUGINVERSION{}%]]= macro to query the plugin API version or the version of installed plugins.
 
 ---+++ Security
 
-   * Badly written plugins can open huge security holes in TWiki. This is especially true if care isn't taken to prevent execution of arbitrary commands on the server.
-   * Don't allow sensitive configuration data to be edited by users. it is better to add sensitive configuration options to the =%TWiki::cfg= hash than adding it as preferences in the plugin topic.
+   * Badly written plugins can open huge security holes in Foswiki. This is especially true if care isn't taken to prevent execution of arbitrary commands on the server.
+   * Don't allow sensitive configuration data to be edited by users. it is better to add sensitive configuration options to the =%Foswiki::cfg= hash than adding it as preferences in the plugin topic.
       * [[#ConfigSpec][Integrating with <code>configure</code>]] describes the steps
-      * TWiki:Plugins.MailInContrib has an example
-      * TWiki:Plugins.BuildContrib can help you with this
-   * Always use the TWiki::Sandbox to execute commands.
+      * Foswiki:Plugins.MailInContrib has an example
+      * Foswiki:Plugins.BuildContrib can help you with this
+   * Always use the Foswiki::Sandbox to execute commands.
    * Always audit the plugins you install, and make sure you are happy with the level of security provided. While every effort is made to monitor plugin authors activities, at the end of the day they are uncontrolled user contributions.
 
@@ -154 +149 @@
 ---++ Creating Plugins
 
-With a reasonable knowledge of the Perl scripting language, you can create new plugins or modify and extend existing ones. Basic plug-in architecture uses an Application Programming Interface (API), a set of software instructions that allow external code to interact with the main program. The [[#PluginAPI][TWiki Plugin API]] provides the programming interface for TWiki.
+With a reasonable knowledge of the Perl scripting language, you can create new plugins or modify and extend existing ones. Basic plug-in architecture uses an Application Programming Interface (API), a set of software instructions that allow external code to interact with the main program. The [[#PluginAPI][Foswiki Plugin API]] provides the programming interface for Foswiki.
 
 ---+++ Anatomy of a Plugin
 
-A (very) basic TWiki plugin consists of two files:
+A (very) basic Foswiki plugin consists of two files:
 
    * a Perl module, e.g. =MyFirstPlugin.pm=
    * a documentation topic, e.g. =MyFirstPlugin.txt=
 
-The Perl module can be a block of code that talks to with TWiki alone, or it can include other elements, like other Perl modules (including other plugins), graphics, TWiki templates, external applications (ex: a Java applet), or just about anything else it can call.
-In particular, files that should be web-accessible (graphics, Java applets ...) are best placed as attachments of the =MyFirstPlugin= topic. Other needed Perl code is best placed in a =lib/TWiki/Plugins/MyFirstPlugin/= directory.
-
-The plugin API handles the details of connecting your Perl module with main TWiki code. When you're familiar with the [[#PluginAPI][Plugin API]], you're ready to develop plugins.
-
-_The TWiki:Plugins.BuildContrib module provides a lot of support for plugins development, including a plugin creator, automatic publishing support, and automatic installation script writer. If you plan on writing more than one plugin, you probably need it_.
+The Perl module can be a block of code that talks to with Foswiki alone, or it can include other elements, like other Perl modules (including other plugins), graphics, Foswiki templates, external applications (ex: a Java applet), or just about anything else it can call.
+In particular, files that should be web-accessible (graphics, Java applets ...) are best placed as attachments of the =MyFirstPlugin= topic. Other needed Perl code is best placed in a =lib/Foswiki/Plugins/MyFirstPlugin/= directory.
+
+The plugin API handles the details of connecting your Perl module with main Foswiki code. When you're familiar with the [[#PluginAPI][Plugin API]], you're ready to develop plugins.
+
+_The Foswiki:Plugins.BuildContrib module provides a lot of support for plugins development, including a plugin creator, automatic publishing support, and automatic installation script writer. If you plan on writing more than one plugin, you probably need it_.
 
 ---+++ Creating the Perl Module 
 
-Copy file =lib/TWiki/Plugins/EmptyPlugin.pm= to =&lt;name&gt;Plugin.pm=. The =EmptyPlugin.pm= module contains mostly empty functions, so it does nothing, but it's ready to be used. Customize it. Refer to the [[#PluginAPI][Plugin API]] specs for more information.
+Copy file =lib/Foswiki/Plugins/EmptyPlugin.pm= to =&lt;name&gt;Plugin.pm=. The =EmptyPlugin.pm= module contains mostly empty functions, so it does nothing, but it's ready to be used. Customize it. Refer to the [[#PluginAPI][Plugin API]] specs for more information.
 
 If your plugin uses its own modules and objects, you must include the name of the plugin in the package name. For example, write =Package <nop>MyFirstPlugin::Attrs;= instead of just =Package Attrs;=. Then call it using:
 <pre>
-use TWiki::Plugins::MyFirstPlugin::Attrs;
+use Foswiki::Plugins::MyFirstPlugin::Attrs;
 $var = MyFirstPlugin::Attrs->new();
 </pre>
@@ -185 +180 @@
 The plugin documentation topic contains usage instructions and version details. It serves the plugin files as %SYSTEMWEB%.FileAttachments for downloading. (The doc topic is also included _in_ the [[#CreatePluginPackage][distribution package]].) To create a documentation topic:
 
-   1. *Copy* the plugin topic template from TWiki.org. To copy the text, go to TWiki:Plugins/PluginPackage and:
+   1. *Copy* the plugin topic template from Foswiki.org. To copy the text, go to Foswiki:Plugins/PluginPackage and:
       * enter the plugin name in the "How to Create a Plugin" section
       * click Create
@@ -194 +189 @@
       * paste &amp; save new plugin topic on your site
    1. *Customize* your plugin topic.
-      * Important: In case you plan to publish your plugin on TWiki.org, use Interwiki names for author names and links to TWiki.org topics, such as TWiki:Main/%WIKINAME%. This is important because links should work properly in a plugin topic installed on any TWiki, not just on TWiki.org.
+      * Important: In case you plan to publish your plugin on Foswiki.org, use Interwiki names for author names and links to Foswiki.org topics, such as Foswiki:Main/%WIKINAME%. This is important because links should work properly in a plugin topic installed on any Foswiki, not just on Foswiki.org.
    1. *Document* the performance data you gathered while [[#MeasurePerformance][measuring the performance]]
    1. *Save* your topic, for use in [[#CreatePluginPackage][packaging]] and [[#PublishPlugin][publishing]] your plugin.
@@ -200 +195 @@
 <blockquote style="background-color:#f5f5f5">
 *OUTLINE: Doc Topic Contents* <br />
-Check the plugins web on TWiki.org for the latest plugin doc topic template. Here's a quick overview of what's covered:
+Check the plugins web on Foswiki.org for the latest plugin doc topic template. Here's a quick overview of what's covered:
 
 *Syntax Rules:* &lt;<i>Describe any special text formatting that will be rendered.</i>&gt;" 
@@ -206 +201 @@
 *Example:* &lt;<i>Include an example of the plugin in action. Possibly include a static HTML version of the example to compare if the installation was a success!</i>&gt;"
 
-*Plugin Settings:* &lt;<i>Description and settings for custom plugin settings, and those required by TWiki.</i>&gt;"
-
-   * *Plugins Preferences* &lt;<i>If user settings are needed, link to [[%SYSTEMWEB%.PreferenceSettings][preference settings]] and explain the role of the plugin name prefix
+*Plugin Settings:* &lt;<i>Description and settings for custom plugin settings, and those required by Foswiki.</i>&gt;"
+
+   * *Plugins Preferences* &lt;<i>If user settings are needed, link to [[%SYSTEMWEB%.PreferenceSettings][preference settings]] and explain the role of the plugin name prefix</i>
 
 *Plugin Installation Instructions:* &lt;<i>Step-by-step set-up guide, user help, whatever it takes to install and run, goes here.</i>&gt;"
 
-*Plugin Info:* &lt;<i>Version, credits, history, requirements - entered in a form, displayed as a table. Both are automatically generated when you create or edit a page in the TWiki:Plugins web.</i>&gt;"
+*Plugin Info:* &lt;<i>Version, credits, history, requirements - entered in a form, displayed as a table. Both are automatically generated when you create or edit a page in the Foswiki:Plugins web.</i>&gt;
 </blockquote>
 
@@ -218 +213 @@
 ---+++ Packaging for Distribution
 
-The TWiki:Plugins.BuildContrib is a powerful build environment that is used by the TWiki project to build TWiki itself, as well as many of the plugins. You don't *have* to use it, but it is highly recommended!
+The Foswiki:Plugins.BuildContrib is a powerful build environment that is used by the Foswiki project to build Foswiki itself, as well as many of the plugins. You don't *have* to use it, but it is highly recommended!
 
 If you don't want (or can't) use the !BuildContrib, then a minimum plugin release consists of a Perl module with a WikiName that ends in =Plugin=, ex: =MyFirstPlugin.pm=, and a documentation page with the same name(=MyFirstPlugin.txt=).
 
-   1. Distribute the plugin files in a directory structure that mirrors TWiki. If your plugin uses additional files, include them all:
-      * =lib/TWiki/Plugins/MyFirstPlugin.pm=
-      * =data/TWiki/MyFirstPlugin.txt=
-      * =pub/TWiki/MyFirstPlugin/uparrow.gif= [a required graphic]
+   1. Distribute the plugin files in a directory structure that mirrors Foswiki. If your plugin uses additional files, include them all:
+      * =lib/Foswiki/Plugins/MyFirstPlugin.pm=
+      * =data/Foswiki/MyFirstPlugin.txt=
+      * =pub/Foswiki/MyFirstPlugin/uparrow.gif= [a required graphic]
    2. Create a zip archive with the plugin name (=MyFirstPlugin.zip=) and add the entire directory structure from Step 1. The archive should look like this:
-      * =lib/TWiki/Plugins/MyFirstPlugin.pm=
-      * =data/TWiki/MyFirstPlugin.txt=
-      * =pub/TWiki/MyFirstPlugin/uparrow.gif=
+      * =lib/Foswiki/Plugins/MyFirstPlugin.pm=
+      * =data/Foswiki/MyFirstPlugin.txt=
+      * =pub/Foswiki/MyFirstPlugin/uparrow.gif=
 
 #MeasurePerformance
 ---+++ Measuring and Improving the Plugin Performance
 
-A high quality plugin performs well. You can use the TWiki:Plugins.PluginBenchmarkAddOn to measure your TWiki:Plugins.PluginBenchmarks. The data is needed as part of the Documentation Topic.
+A high quality plugin performs well. You can use the Foswiki:Plugins.PluginBenchmarkAddOn to measure your Foswiki:Plugins.PluginBenchmarks. The data is needed as part of the Documentation Topic.
 
 See also [[#FastPluginHints][Hints on Writing Fast Plugins]].
@@ -241 +236 @@
 ---+++ Publishing for Public Use
 
-You can release your tested, packaged plugin to the TWiki community through the TWiki:Plugins web. All plugins submitted to TWiki.org are available for download and further development in TWiki:Plugins/PluginPackage.
+You can release your tested, packaged plugin to the Foswiki community through the Foswiki:Plugins web. All plugins submitted to Foswiki.org are available for download and further development in Foswiki:Plugins/PluginPackage.
 
 Publish your plugin by following these steps:
-   1. *Post* the plugin documentation topic in the TWiki:Plugins/PluginPackage:
+   1. *Post* the plugin documentation topic in the Foswiki:Plugins/PluginPackage:
       * enter the plugin name in the "How to Create a Plugin" section, for example =MyFirstPlugin=
       * paste in the topic text from [[#CreatePluginTopic][Writing the Documentation Topic]] and save
    1. *Attach* the distribution zip file to the topic, ex: =MyFirstPlugin.zip=
-   1. *Link* from the doc page to a new, blank page named after the plugin, and ending in =Dev=, ex: =MyFirstPluginDev=. This is the discussion page for future development. (User support for plugins is handled in TWiki:Support.)
-   1. *Put* the plugin into the SVN repository, see TWiki:Plugins/ReadmeFirst (optional)
+   1. *Link* from the doc page to a new, blank page named after the plugin, and ending in =Dev=, ex: =MyFirstPluginDev=. This is the discussion page for future development. (User support for plugins is handled in Foswiki:Support.)
+   1. *Put* the plugin into the SVN repository, see Foswiki:Plugins/ReadmeFirst (optional)
 
 %N% Once you have done the above steps once, you can use the !BuildContrib to upload updates to your plugin.
 
-Thank you very much for sharing your plugin with the TWiki community :-)
+Thank you very much for sharing your plugin with the Foswiki community :-)
 
 #RecommendedStorageOfPluginData
 ---++ Recommended Storage of Plugin Specific Data
 
-Plugins sometimes need to store data. This can be plugin internal data such as cache data, or data generated for browser consumption such as images. Plugins should store data using TWikiFuncDotPm functions that support saving and loading of topics and attachments.
+Plugins sometimes need to store data. This can be plugin internal data such as cache data, or data generated for browser consumption such as images. Plugins should store data using FoswikiFuncDotPm functions that support saving and loading of topics and attachments.
 
 ---+++ Plugin Internal Data
 
-You can create a plugin "work area" using the =TWiki::Func::getWorkArea()= function, which gives you a persistent directory where you can store data files. By default they will not be web accessible. The directory is guaranteed to exist, and to be writable by the webserver user. For convenience, =TWiki::Func::storeFile()= and =TWiki::Func::readFile()= are provided to persistently store and retrieve simple data in this area.
+You can create a plugin "work area" using the =Foswiki::Func::getWorkArea()= function, which gives you a persistent directory where you can store data files. By default they will not be web accessible. The directory is guaranteed to exist, and to be writable by the webserver user. For convenience, =Foswiki::Func::storeFile()= and =Foswiki::Func::readFile()= are provided to persistently store and retrieve simple data in this area.
 
 ---+++ Web Accessible Data
 
-__Topic-specific data__ such as generated images can be stored in the topic's attachment area, which is web accessible. Use the =TWiki::Func::saveAttachment()= function to store the data.
+__Topic-specific data__ such as generated images can be stored in the topic's attachment area, which is web accessible. Use the =Foswiki::Func::saveAttachment()= function to store the data.
 
 Recommendation for file name:
@@ -274 +269 @@
    * Example: =_GaugePlugin_img123.gif=
 
-__Web specific data__ can be stored in the plugin's attachment area, which is web accessible. Use the =TWiki::Func::saveAttachment()= function to store the data.
+__Web specific data__ can be stored in the plugin's attachment area, which is web accessible. Use the =Foswiki::Func::saveAttachment()= function to store the data.
 
 Recommendation for file names in plugin attachment area:
@@ -286 +281 @@
 Some extensions have setup requirements that are best integrated into =configure= rather than trying to use [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. These extensions use =Config.spec= files to publish their configuration requirements.
 
-=Config.spec= files are read during configuration. Once a =Config.spec= has defined a configuration item, it is available for edit through the standard =configure= interface. =Config.spec= files are stored in the 'plugin directory' e.g. =lib/TWiki/Plugins/BathPlugin/Config.spec=.
+=Config.spec= files are read during configuration. Once a =Config.spec= has defined a configuration item, it is available for edit through the standard =configure= interface. =Config.spec= files are stored in the 'plugin directory' e.g. =lib/Foswiki/Plugins/BathPlugin/Config.spec=.
 
 ---+++ Structure of a <code>Config.spec</code> file
@@ -299 +294 @@
 # **SELECT Plastic,Rubber,Metal**
 # Select the plug type
-$TWiki::cfg{BathPlugin}{PlugType} = 'Plastic';
+$Foswiki::cfg{BathPlugin}{PlugType} = 'Plastic';
 
 # **NUMBER**
 # Enter the chain length in cm
-$TWiki::cfg{BathPlugin}{ChainLength} = '30';
+$Foswiki::cfg{BathPlugin}{ChainLength} = '30';
 
 # **BOOLEAN EXPERT**
 # Turn this option off to disable the water temperature alarm
-$TWiki::cfg{BathPlugin}{TempSensorEnabled} = '1';
+$Foswiki::cfg{BathPlugin}{TempSensorEnabled} = '1';
 </verbatim>
-The type (e.g. =**SELECT**= ) tells =configure= to how to prompt for the value. It also tells configure how to do some basic checking on the value you actually enter. All the comments between the type and the configuration item are taken as part of the description. The configuration item itself defines the default value for the configuration item. The above spec defines the configuration items =$TWiki::cfg{BathPlugin}{PlugType}=, =$TWiki::cfg{BathPlugin}{ChainLength}=, and =$TWiki::cfg{BathPlugin}{TempSensorEnabled}= for use in your plugin. For example,
-<verbatim>
-if( $TWiki::cfg{BathPlugin}{TempSensorEnabled} && $curTemperature > 50 ) {
+The type (e.g. =**SELECT**= ) tells =configure= to how to prompt for the value. It also tells configure how to do some basic checking on the value you actually enter. All the comments between the type and the configuration item are taken as part of the description. The configuration item itself defines the default value for the configuration item. The above spec defines the configuration items =$Foswiki::cfg{BathPlugin}{PlugType}=, =$Foswiki::cfg{BathPlugin}{ChainLength}=, and =$Foswiki::cfg{BathPlugin}{TempSensorEnabled}= for use in your plugin. For example,
+<verbatim>
+if( $Foswiki::cfg{BathPlugin}{TempSensorEnabled} && $curTemperature > 50 ) {
     die "The bathwater is too hot for comfort";
 }
@@ -340 +335 @@
 | H | means the option is not visible in =configure= |
 
-See =lib/TWiki.spec= for many more examples.
+See =lib/Foswiki.spec= for many more examples.
 
 =Config.spec= files are also used for other (non-plugin) extensions. in this case they are stored under the =Contrib= directory instead of the =Plugins= directory.
 
-TWiki:TWiki/SpecifyingConfigurationItemsForExtensions has supplemental documentation on configure settings.
+Foswiki:Foswiki/SpecifyingConfigurationItemsForExtensions has supplemental documentation on configure settings.
 
 #MaintainPlugins
@@ -351 +346 @@
 ---+++ Discussions and Feedback on Plugins
 
-Each published plugin has a plugin development topic on TWiki.org. Plugin development topics are named after your plugin and end in =Dev=, such as =MyFirstPluginDev=. The plugin development topic is a great resource to discuss feature enhancements and to get feedback from the TWiki community.
-
----+++ Maintaining Compatibility with Earlier TWiki Versions
-
-The plugin interface (TWikiFuncDotPm functions and plugin handlers) evolve over time. TWiki introduces new API functions to address the needs of plugin authors. Plugins using unofficial TWiki internal functions may no longer work on a TWiki upgrade.
-
-Organizations typically do not upgrade to the latest TWiki for many months. However, many administrators still would like to install the latest versions of a plugin on their older TWiki installation. This need is fulfilled if plugins are maintained in a compatible manner. 
-
-__%T% Tip:__ Plugins can be written to be compatible with older and newer TWiki releases. This can be done also for plugins using unofficial TWiki internal functions of an earlier release that no longer work on the latest TWiki codebase. 
-Here is an example; the TWiki:Support.PluginsSupplement has more details.
-
-<verbatim>
-    if( $TWiki::Plugins::VERSION >= 1.1 ) {
-        @webs = TWiki::Func::getListOfWebs( 'user,public' );
+Each published plugin has a plugin development topic on Foswiki.org. Plugin development topics are named after your plugin and end in =Dev=, such as =MyFirstPluginDev=. The plugin development topic is a great resource to discuss feature enhancements and to get feedback from the Foswiki community.
+
+---+++ Maintaining Compatibility with Earlier Foswiki Versions
+
+The plugin interface (FoswikiFuncDotPm functions and plugin handlers) evolve over time. Foswiki introduces new API functions to address the needs of plugin authors. Plugins using unofficial Foswiki internal functions may no longer work on a Foswiki upgrade.
+
+Organizations typically do not upgrade to the latest Foswiki for many months. However, many administrators still would like to install the latest versions of a plugin on their older Foswiki installation. This need is fulfilled if plugins are maintained in a compatible manner. 
+
+__%T% Tip:__ Plugins can be written to be compatible with older and newer Foswiki releases. This can be done also for plugins using unofficial Foswiki internal functions of an earlier release that no longer work on the latest Foswiki codebase. 
+Here is an example; the Foswiki:Support.PluginsSupplement has more details.
+
+<verbatim>
+    if( $Foswiki::Plugins::VERSION >= 1.1 ) {
+        @webs = Foswiki::Func::getListOfWebs( 'user,public' );
     } else {
-        @webs = TWiki::Func::getPublicWebList( );
+        @webs = Foswiki::Func::getPublicWebList( );
     }
 </verbatim>
@@ -372 +367 @@
 ---+++ Handling deprecated functions
 
-From time-to-time, the TWiki developers will add new functions to the interface (either to TWikiFuncDotPm, or new handlers). Sometimes these improvements mean that old functions have to be deprecated to keep the code manageable. When this happens, the deprecated functions will be supported in the interface for at least one more TWiki release, and probably longer, though this cannot be guaranteed.
-
-When a plugin defines deprecated handlers, a warning will be shown in the list generated by %<nop>FAILEDPLUGINS%. Admins who see these warnings should check TWiki.org and if necessary, contact the plugin author, for an updated version of the plugin.
-
-Updated plugins may still need to define deprecated handlers for compatibility with old TWiki versions. In this case, the plugin package that defines old handlers can suppress the warnings in %<nop>FAILEDPLUGINS%.
-
-This is done by defining a map from the handler name to the =TWiki::Plugins= version _in which the handler was first deprecated_. For example, if we need to define the =endRenderingHandler= for compatibility with =TWiki::Plugins= versions before 1.1, we would add this to the plugin:
-
-<verbatim>
-package TWiki::Plugins::SinkPlugin;
-use vars qw( %TWikiCompatibility );
-$TWikiCompatibility{endRenderingHandler} = 1.1;
+From time-to-time, the Foswiki developers will add new functions to the interface (either to FoswikiFuncDotPm, or new handlers). Sometimes these improvements mean that old functions have to be deprecated to keep the code manageable. When this happens, the deprecated functions will be supported in the interface for at least one more Foswiki release, and probably longer, though this cannot be guaranteed.
+
+When a plugin defines deprecated handlers, a warning will be shown in the list generated by %<nop>FAILEDPLUGINS%. Admins who see these warnings should check Foswiki.org and if necessary, contact the plugin author, for an updated version of the plugin.
+
+Updated plugins may still need to define deprecated handlers for compatibility with old Foswiki versions. In this case, the plugin package that defines old handlers can suppress the warnings in %<nop>FAILEDPLUGINS%.
+
+This is done by defining a map from the handler name to the =Foswiki::Plugins= version _in which the handler was first deprecated_. For example, if we need to define the =endRenderingHandler= for compatibility with =Foswiki::Plugins= versions before 1.1, we would add this to the plugin:
+
+<verbatim>
+package Foswiki::Plugins::SinkPlugin;
+use vars qw( %FoswikiCompatibility );
+$FoswikiCompatibility{endRenderingHandler} = 1.1;
 </verbatim>
-If the currently-running TWiki version is 1.1 _or later_, then the _handler will not be called_ and _the warning will not be issued_. TWiki with versions of =TWiki::Plugins= before 1.1 will still call the handler as required.
+If the currently-running Foswiki version is 1.1 _or later_, then the _handler will not be called_ and _the warning will not be issued_. Foswiki with versions of =Foswiki::Plugins= before 1.1 will still call the handler as required.
 
 %STOPINCLUDE%
-__Related Topics:__ DeveloperDocumentationCategory, AdminDocumentationCategory, TWiki:Support.PluginsSupplement
-
+__Related Topics:__ DeveloperDocumentationCategory, AdminDocumentationCategory, Foswiki:Support.PluginsSupplement
+

trunk/core/lib/Foswiki.pm

@@ -4 +4 @@
 =pod
 
----+ package TWiki
-
-TWiki operates by creating a singleton object (known as the Session
+---+ package Foswiki
+
+Foswiki operates by creating a singleton object (known as the Session
 object) that acts as a point of reference for all the different
 modules in the system. This package is the class for this singleton,
@@ -31 +31 @@
                         not consistently used. Avoid.
    * =security=         Foswiki::Access singleton
-   * =SESSION_TAGS=     Hash of TWiki variables whose value is specific to
+   * =SESSION_TAGS=     Hash of preference settings whose value is specific to
                         the current request.
    * =store=            Foswiki::Store singleton
@@ -88 +88 @@
 # Token character that must not occur in any normal text - converted
 # to a flag character if it ever does occur (very unlikely)
-# TWiki uses $TranslationToken to mark points in the text. This is
+# Foswiki uses $TranslationToken to mark points in the text. This is
 # normally \0, which is not a useful character in any 8-bit character
 # set we can find, nor in UTF-8. But if you *do* encounter problems
@@ -100 +100 @@
 =pod
 
----++ StaticMethod getTWikiLibDir() -> $path
+---++ StaticMethod getLibDir() -> $path
 
 Returns the full path of the directory containing Foswiki.pm
@@ -106 +106 @@
 =cut
 
-sub getTWikiLibDir {
+sub getLibDir {
     if ($twikiLibDir) {
         return $twikiLibDir;
@@ -124 +124 @@
     if ( $twikiLibDir =~ /^\./ ) {
         print STDERR
-"WARNING: TWiki lib path $twikiLibDir is relative; you should make it absolute, otherwise some scripts may not run from the command line.";
+"WARNING: Foswiki lib path $twikiLibDir is relative; you should make it absolute, otherwise some scripts may not run from the command line.";
         my $bin;
 
@@ -356 +356 @@
         import POSIX qw( locale_h LC_CTYPE LC_COLLATE );
 
-        # SMELL: mod_perl compatibility note: If TWiki is running under Apache,
+        # SMELL: mod_perl compatibility note: If Foswiki is running under Apache,
         # won't this play with the Apache process's locale settings too?
         # What effects would this have?
@@ -388 +388 @@
 
         # No locales needed/working, or Perl 5.005, so just use
-        # any additional national characters defined in TWiki.cfg
+        # any additional national characters defined in LocalSite.cfg
         $regex{upperAlpha} = 'A-Z' . $Foswiki::cfg{UpperNational};
         $regex{lowerAlpha} = 'a-z' . $Foswiki::cfg{LowerNational};
@@ -423 +423 @@
     $regex{headerPatternNoTOC} = '(\!\!+|%NOTOC%)';
 
-    # TWiki concept regexes
+    # Foswiki concept regexes
     $regex{wikiWordRegex} =
 qr/[$regex{upperAlpha}]+[$regex{lowerAlphaNum}]+[$regex{upperAlpha}]+[$regex{mixedAlphaNum}]*/o;
@@ -511 +511 @@
 
     # initialize lib directory early because of later 'cd's
-    getTWikiLibDir();
+    getLibDir();
 
     # initialize the runtime engine
@@ -567 +567 @@
         # We still don't have Codev.UnicodeSupport
         $this->writeWarning( 'UTF-8 not yet supported as site charset -'
-              . 'TWiki is likely to have problems' );
+              . 'Foswiki is likely to have problems' );
         return $text;
     }
@@ -1115 +1115 @@
 ---++ ObjectMethod getScriptUrl( $absolute, $script, $web, $topic, ... ) -> $scriptURL
 
-Returns the URL to a TWiki script, providing the web and topic as
+Returns the URL to a Foswiki script, providing the web and topic as
 "path info" parameters.  The result looks something like this:
 "http://host/twiki/bin/$script/$web/$topic".
@@ -1121 +1121 @@
 
 If $absolute is set, generates an absolute URL. $absolute is advisory only;
-TWiki can decide to generate absolute URLs (for example when run from the
+Foswiki can decide to generate absolute URLs (for example when run from the
 command-line) even when relative URLs have been requested.
 
@@ -1167 +1167 @@
 
         # See http://www.ietf.org/rfc/rfc2396.txt for the definition of
-        # "absolute URI". TWiki bastardises this definition by assuming
+        # "absolute URI". Foswiki bastardises this definition by assuming
         # that all relative URLs lack the <authority> component as well.
         $url = $this->{urlHost} . $url;
@@ -1210 +1210 @@
 Composes a pub url. If $absolute is set, returns an absolute URL.
 If $absolute is set, generates an absolute URL. $absolute is advisory only;
-TWiki can decide to generate absolute URLs (for example when run from the
+Foswiki can decide to generate absolute URLs (for example when run from the
 command-line) even when relative URLs have been requested.
 
@@ -1231 +1231 @@
 
         # See http://www.ietf.org/rfc/rfc2396.txt for the definition of
-        # "absolute URI". TWiki bastardises this definition by assuming
+        # "absolute URI". Foswiki bastardises this definition by assuming
         # that all relative URLs lack the <authority> component as well.
         $url = $this->{urlHost} . $url;
@@ -1321 +1321 @@
 Normalize a Web<nop>.<nop>TopicName
 
-See TWikiFuncDotPm for a full specification of the expansion (not duplicated
+See =Foswiki::Func= for a full specification of the expansion (not duplicated
 here)
 
@@ -1355 +1355 @@
 ---++ ClassMethod new( $loginName, $query, \%initialContext )
 
-Constructs a new TWiki object. Parameters are taken from the query object.
+Constructs a new Foswiki object. Parameters are taken from the query object.
 
    * =$loginName= is the login username (*not* the wikiname) of the user you
@@ -1415 +1415 @@
     # SMELL: can this be done in a BEGIN block? Or is the environment
     # set per-query?
-    # Item4382: Default $ENV{PATH} must be untainted because TWiki runs
+    # TWikibug:Item4382: Default $ENV{PATH} must be untainted because Foswiki runs
     # with use strict and calling external programs that writes on the disk
     # will fail unless Perl seens it as set to safe value.
@@ -1540 +1540 @@
     }
 
-    # Item3270 - here's the appropriate place to enforce TWiki spec:
+    # Item3270 - here's the appropriate place to enforce Foswiki spec:
     # All topic name sources are evaluated, site charset applied
     # SMELL: This untaint unchecked is duplicate of one just above
@@ -1599 +1599 @@
     $Foswiki::Plugins::SESSION = $this;
 
-    Monitor::MARK("TWiki session created");
+    Monitor::MARK("Foswiki session created");
 
     return $this;
@@ -2113 +2113 @@
 # Return value: $tableOfContents
 # Handles %<nop>TOC{...}% syntax.  Creates a table of contents
-# using TWiki bulleted
+# using Foswiki bulleted
 # list markup, linked to the section headings of a topic. A section heading is
 # entered in one of the following forms:
@@ -2329 +2329 @@
     else {
         $text =
-            CGI::h1('TWiki Installation Error')
+            CGI::h1('Foswiki Installation Error')
           . 'Template "'
           . $template
@@ -2551 +2551 @@
 
 Escape special characters to HTML numeric entities. This is *not* a generic
-encoding, it is tuned specifically for use in TWiki.
+encoding, it is tuned specifically for use in Foswiki.
 
 HTML4.0 spec:
@@ -2568 +2568 @@
 characters (except for \n and \r) using numeric entities.
 
-FURTHER this method also encodes characters that are special in TWiki
+FURTHER this method also encodes characters that are special in Foswiki
 meta-language.
 
@@ -2628 +2628 @@
 In two cases, no URL encoding is needed:  For EBCDIC mainframes, we assume that 
 site charset URLs will be translated (outbound and inbound) by the web server to/from an
-EBCDIC character set. For sites running in UTF-8, there's no need for TWiki to
+EBCDIC character set. For sites running in UTF-8, there's no need for Foswiki to
 do anything since all URLs and attachment filenames are already in UTF-8.
 
@@ -2809 +2809 @@
 }
 
-# Process TWiki %TAGS{}% by parsing the input tokenised into
+# Process Foswiki %TAGS{}% by parsing the input tokenised into
 # % separated sections. The parser is a simple stack-based parse,
 # sufficient to ensure nesting of tags is correct, but no more
@@ -3095 +3095 @@
 
 Adds a function to the dispatch table of the REST interface 
-for a given subject. See TWikiScripts#rest for more info.
+for a given subject. See System.CommandAndCGIScripts#rest for more info.
 
    * =$subject= - The subject under which the function will be registered.
@@ -3106 +3106 @@
 </verbatim>
 where:
-   * =\%session= - a reference to the TWiki session object (may be ignored)
+   * =\%session= - a reference to the Foswiki session object (may be ignored)
    * =$subject= - The invoked subject (may be ignored)
    * =$verb= - The invoked verb (may be ignored)
@@ -3190 +3190 @@
     $this->renderer->putBackBlocks( \$text, $verbatim, 'verbatim' );
 
-    # TWiki Plugin Hook (for cache Plugins only)
+    # Foswiki Plugin Hook (for cache Plugins only)
     $this->{plugins}
       ->dispatch( 'afterCommonTagsHandler', $text, $theTopic, $theWeb, $meta );
@@ -3203 +3203 @@
 Add =$html= to the HEAD tag of the page currently being generated.
 
-Note that TWiki variables may be used in the HEAD. They will be expanded
+Note that macros may be used in the HEAD. They will be expanded
 according to normal variable expansion rules.
 
@@ -3210 +3210 @@
    * =_DEFAULT= optional, id of the head block. Used to generate a comment in the output HTML.
    * =text= optional, text to use for the head block. Mutually exclusive with =topic=.
-   * =topic= optional, full TWiki path name of a topic that contains the full text to use for the head block. Mutually exclusive with =text=. Example: =topic="%WEB%.MyTopic"=.
+   * =topic= optional, full Foswiki path name of a topic that contains the full text to use for the head block. Mutually exclusive with =text=. Example: =topic="%WEB%.MyTopic"=.
    * =requires= optional, comma-separated list of id's of other head blocks this one depends on.
 =%<nop>ADDTOHEAD%= expands in-place to the empty string, unless there is an error in which case the variable expands to an error string.
@@ -3241 +3241 @@
     my ( $this, $tag, $header, $requires ) = @_;
 
-    # Expand TWiki variables in the header
+    # Expand macros in the header
     $header =
       $this->handleCommonTags( $header, $this->{webName}, $this->{topicName} );
@@ -3332 +3332 @@
 
 Static method to construct a new singleton session instance.
-It creates a new TWiki and sets the Plugins $SESSION variable to
+It creates a new Foswiki and sets the Plugins $SESSION variable to
 point to it, so that Foswiki::Func methods will work.
 
@@ -3359 +3359 @@
     if ( $theUrl && $theUrl ne $query->url() ) {
         die
-'Sorry, this version of TWiki does not support the url parameter to Foswiki::initialize being different to the url in the query';
+'Sorry, this version of Foswiki does not support the url parameter to Foswiki::initialize being different to the url in the query';
     }
     my $twiki = new Foswiki( $theRemoteUser, $query );
@@ -3749 +3749 @@
 
 #deprecated functionality, now implemented using %ENV%
-#move to compatibility plugin in TWiki5
+#move to compatibility plugin in Foswiki 2.0
 sub HTTP_HOST_deprecated {
     return $_[0]->{request}->header('Host') || '';
@@ -3755 +3755 @@
 
 #deprecated functionality, now implemented using %ENV%
-#move to compatibility plugin in TWiki5
+#move to compatibility plugin in Foswiki 2.0
 sub REMOTE_ADDR_deprecated {
     return $_[0]->{request}->remoteAddress() || '';
@@ -3761 +3761 @@
 
 #deprecated functionality, now implemented using %ENV%
-#move to compatibility plugin in TWiki5
+#move to compatibility plugin in Foswiki 2.0
 sub REMOTE_PORT_deprecated {
 
     # CGI/1.1 (RFC 3875) doesn't specify REMOTE_PORT,
     # but some webservers implement it. However, since
-    # it's not RFC compliant, TWiki should not rely on
+    # it's not RFC compliant, Foswiki should not rely on
     # it. So we get more portability.
     return '';
@@ -3772 +3772 @@
 
 #deprecated functionality, now implemented using %ENV%
-#move to compatibility plugin in TWiki5
+#move to compatibility plugin in Foswiki
 sub REMOTE_USER_deprecated {
     return $_[0]->{request}->remoteUser() || '';
@@ -4130 +4130 @@
 # Spacing of WikiWords is now done with %SPACEOUT%
 # (and the private routine _SPACEOUT).
-# Move to compatibility module in TWiki5
+# Move to compatibility module in Foswiki 2.0
 sub SPACEDTOPIC_deprecated {
     my ( $this, $params, $theTopic ) = @_;
@@ -4381 +4381 @@
 
 #deprecated functionality, now implemented using %USERINFO%
-#move to compatibility plugin in TWiki5
+#move to compatibility plugin in Foswiki 2.0
 sub WIKINAME_deprecated {
     my ( $this, $params ) = @_;
@@ -4392 +4392 @@
 
 #deprecated functionality, now implemented using %USERINFO%
-#move to compatibility plugin in TWiki5
+#move to compatibility plugin in Foswiki 2.0
 sub USERNAME_deprecated {
     my ( $this, $params ) = @_;
@@ -4403 +4403 @@
 
 #deprecated functionality, now implemented using %USERINFO%
-#move to compatibility plugin in TWiki5
+#move to compatibility plugin in Foswiki 2.0
 sub WIKIUSERNAME_deprecated {
     my ( $this, $params ) = @_;

trunk/core/lib/Foswiki/Attach.pm

@@ -312 +312 @@
         # Some browsers wait with rendering a page until the size of
         # embedded images is known, e.g. after all images of a page are
-        # downloaded. When you upload an image to TWiki and checkmark
-        # the link checkbox, TWiki will generate the width and height
+        # downloaded. When you upload an image to Foswiki and checkmark
+        # the link checkbox, Foswiki will generate the width and height
         # img parameters, speeding up the page rendering.
         my $stream =

trunk/core/lib/Foswiki/Attrs.pm

@@ -27 +27 @@
 
 Class of attribute sets, designed for parsing and storing attribute values
-from a TWiki tag e.g. =%<nop>TAG{"joe" fred="bad" joe="mad"}%=
+from a macro e.g. =%<nop>MACRO{"joe" fred="bad" joe="mad"}%=
 
 An attribute set is a hash containing an entry for each parameter. The
@@ -36 +36 @@
 the _first_ instance is always taken.
 
-As well as the default TWiki syntax (parameter values double-quoted)
+As well as the default Foswiki syntax (parameter values double-quoted)
 this class also parses single-quoted values, unquoted spaceless
 values, spaces around the =, and commas as well as spaces separating values.
@@ -60 +60 @@
 
    * =$string= - String containing attribute specification
-   * =$friendly= - if true, the parse will be according to the extended syntax pioneered by the original Contrib::Attrs. Otherwise it will be strict as per traditional TWiki syntax.
+   * =$friendly= - if true, the parse will be according to the extended syntax pioneered by the original Contrib::Attrs. Otherwise it will be strict as per traditional syntax.
 
 Parse a standard attribute string containing name=value pairs and create a new

trunk/core/lib/Foswiki/Compatibility.pm

@@ -26 +26 @@
 ---+ package Foswiki::Compatibility
 
-Support for compatibility with old TWiki versions. Packaged
+Support for compatibility with old versions. Packaged
 separately because 99.999999% of the time this won't be needed.
 

trunk/core/lib/Foswiki/Configure/CSS.pm

@@ -13 +13 @@
 __DATA__
 
-/* TWiki base CSS */
+/* Foswiki base CSS */
 
 .twikiMakeVisible,
@@ -96 +96 @@
 the css and html code.
 
-Reworked for TWiki: (c) Arthur Clemens @ visiblearea.com
+Reworked for Foswiki: (c) Arthur Clemens @ visiblearea.com
 */
 
@@ -440 +440 @@
 
 /*      -----------------------------------------------------------
-        TWiki styles
+        Foswiki styles
         -----------------------------------------------------------     */
 
@@ -1340 +1340 @@
 
 /*      -----------------------------------------------------------
-        TWiki styles
+        Foswiki styles
         -----------------------------------------------------------     */
 

trunk/core/lib/Foswiki/Configure/Checker.pm

@@ -145 +145 @@
 # Since Windows (without Cygwin) makes it hard to capture stderr
 # ('2>&1' works only on Win2000 or higher), and Windows will usually have
-# GNU tools in any case (installed for TWiki since there's no built-in
+# GNU tools in any case (installed for Foswiki since there's no built-in
 # diff, grep, patch, etc), we only check for these tools on Unix/Linux
 # and Cygwin.
@@ -343 +343 @@
         $mess .= $this->ERROR(
             $err . <<HERE
-TWiki will probably not work with this RCS setup. Either correct the setup, or
+Foswiki will probably not work with this RCS setup. Either correct the setup, or
 switch to RcsLite. To enable RCSLite you need to change the setting of
 {StoreImpl} to 'RcsLite'.

trunk/core/lib/Foswiki/Configure/Checkers/BasicSanity.pm

@@ -44 +44 @@
     unless ( $this->{LocalSiteDotCfg} ) {
         $this->{LocalSiteDotCfg} = Foswiki::findFileOnPath('Foswiki.spec') || '';
-        $this->{LocalSiteDotCfg} =~ s/TWiki\.spec/LocalSite.cfg/;
+        $this->{LocalSiteDotCfg} =~ s/Foswiki\.spec/LocalSite.cfg/;
     }
 

trunk/core/lib/Foswiki/Configure/Checkers/CGISetup.pm

@@ -55 +55 @@
 is risky because mod_perl will remember old values of configuration
 variables. You are *highly* recommended not to run configure under
-mod_perl (though the rest of TWiki can be run with mod_perl, of course)
+mod_perl (though the rest of Foswiki can be run with mod_perl, of course)
 HERE
     }
@@ -102 +102 @@
         $n .= $this->WARN(<<HERE);
 Perl version is older than 5.6.0.
-TWiki has only been successfully tested on Perl 5.6.X and 5.8.X,
+Foswiki has only been successfully tested on Perl 5.6.X and 5.8.X,
 and there have been reports that it does not run on 5.5.
-You will need to upgrade Perl libraries and tweak the TWiki
-code to make TWiki work on older versions of Perl
+You will need to upgrade Perl libraries and tweak the Foswiki
+code to make Foswiki work on older versions of Perl
 HERE
     }
@@ -148 +148 @@
     $block .= $this->setting( '@INC library path',
         join( CGI::br(), @INC ) . $this->NOTE(<<HERE) );
-This is the Perl library path, used to load TWiki modules,
+This is the Perl library path, used to load Foswiki modules,
 third-party modules used by some plugins, and Perl built-in modules.
 HERE
@@ -177 +177 @@
           'Foswiki.pm (Version: <strong>' . $Foswiki::VERSION . '</strong>) found';
     }
-    $block .= $this->setting( 'TWiki module in @INC path', $mess );
+    $block .= $this->setting( 'Foswiki module in @INC path', $mess );
 
     # Check that each of the required Perl modules can be loaded, and
@@ -241 +241 @@
         $n .= $this->ERROR(<<HERE);
 Version $Foswiki::cfg{DETECTED}{ModPerlVersion} of mod_perl is known to have major bugs that prevent
-its use with TWiki. 1.99_12 or higher is recommended.
+its use with Foswiki. 1.99_12 or higher is recommended.
 HERE
     }
@@ -259 +259 @@
         $Foswiki::cfg{DETECTED}{originalPath} . $this->NOTE(<<HERE) );
 This is the PATH value passed in from the web server to this
-script - it is reset by TWiki scripts to the PATH below, and
+script - it is reset by Foswiki scripts to the PATH below, and
 is provided here for comparison purposes only.
 HERE
@@ -306 +306 @@
 }
 
-# The perl modules that are required by TWiki.
+# The perl modules that are required by Foswiki.
 sub _loadDEPENDENCIES {
     my $this = shift;

trunk/core/lib/Foswiki/Configure/Checkers/MSWin32.pm

@@ -15 +15 @@
     my $n = $perl5shell . $this->NOTE(<<HERE);
 This environment variable is used by Win32 Perls to run
-commands from TWiki scripts - it determines which shell program is used to run
+commands from Foswiki scripts - it determines which shell program is used to run
 commands that use 'pipes'.  Examples of shell programs are cmd.exe,
 command.com (aka 'DOS Prompt'), and Cygwin's 'bash'
@@ -29 +29 @@
     if ($isActivePerl) {
         $n .= $this->WARN(<<HERE);
-ActiveState Perl on IIS does not support safe pipes, which is the mechanism used by TWiki to prevent a range
+ActiveState Perl on IIS does not support safe pipes, which is the mechanism used by Foswiki to prevent a range
 of attacks aimed at arbitrary command execution on the server. You are <b>highly</b> recommended not to use this
 particular configuration on a public server (one exposed to the internet)

trunk/core/lib/Foswiki/Configure/Checkers/Sessions/ExpireAfter.pm

@@ -31 +31 @@
     if ( $Foswiki::cfg{Sessions}{ExpireAfter} < 0 ) {
         $e .= $this->WARN(<<'MESSAGE');
-TWiki will *not* clean up sessions automatically. Make sure you
+Foswiki will *not* clean up sessions automatically. Make sure you
 have a cron job running.
 MESSAGE

trunk/core/lib/Foswiki/Configure/Checkers/Site/Locale.pm

@@ -59 +59 @@
     # Check for unusable multi-byte encodings as site character set
     # - anything that enables a single ASCII character such as '[' to be
-    # matched within a multi-byte character cannot be used for TWiki.
-    # Refuse to work with character sets that allow TWiki syntax
+    # matched within a multi-byte character cannot be used for Foswiki.
+    # Refuse to work with character sets that allow Foswiki syntax
     # to be recognised within multi-byte characters.
     # FIXME: match other problematic multi-byte character sets

trunk/core/lib/Foswiki/Configure/Checkers/UseLocale.pm

@@ -110 +110 @@
     # Warn against Perl 5.6 or lower for UTF-8
     if ( $] < 5.008 ) {
-        $n .= $this->WARN( "Perl 5.8 is required if you are using TWiki's",
-            "experimental UTF-8 support\n" );
+        $n .= $this->WARN( "Perl 5.8 is required if you are using Foswiki",
+            " experimental UTF-8 support\n" );
     }
 
@@ -127 +127 @@
 not set in Config.pm, see <i>Perl's Unicode Model</i> in 'perldoc
 perluniintro') - re-compilation of Perl will be required before it can be
-used to enable TWiki's experimental UTF-8 support.
+used to enable Foswiki's experimental UTF-8 support.
 HERE
         );
@@ -145 +145 @@
 This version of Perl was not compiled with locale support ('d_setlocale' not
 set in Config.pm) - re-compilation of Perl will be required before it can be
-used to support TWiki internationalisation.
+used to support internationalisation.
 HERE
         );

trunk/core/lib/Foswiki/Configure/FoswikiCfg.pm

@@ -298 +298 @@
         # If not found on the path, park it beside Foswiki.spec
         $lsc = Foswiki::findFileOnPath('Foswiki.spec') || '';
-        $lsc =~ s/TWiki\.spec/LocalSite.cfg/;
+        $lsc =~ s/Foswiki\.spec/LocalSite.cfg/;
     }
 
@@ -308 +308 @@
     else {
         $this->{content} = <<'HERE';
-# Local site settings for TWiki. This file is managed by the 'configure'
+# Local site settings for Foswiki. This file is managed by the 'configure'
 # CGI script, though you can also make (careful!) manual changes with a
 # text editor.

trunk/core/lib/Foswiki/Configure/Load.pm

@@ -28 +28 @@
 This module consists of just a single subroutine =readConfig=.  It allows to
 safely modify configuration variables _for one single run_ without affecting
-normal TWiki operation.
+normal Foswiki operation.
 
 =cut
@@ -40 +40 @@
 ---++ StaticMethod readConfig()
 
-In normal TWiki operations as a web server this routine is called by the
+In normal Foswiki operations as a web server this routine is called by the
 =BEGIN= block of =Foswiki.pm=.  However, when benchmarking/debugging it can be
 replaced by custom code which sets the configuration hash.  To prevent us from
@@ -46 +46 @@
 =$cfg{ConfigurationFinished}= as an indicator.
 
-Note that this method is called by TWiki and configure, and *only* reads
+Note that this method is called by Foswiki and configure, and *only* reads
 Foswiki.spec= to get defaults. Other spec files (those for extensions) are
 *not* read.
@@ -89 +89 @@
       PubDir TemplateDir ScriptUrlPath LocalesDir ) {
 
-        # We can't do this, because it prevents TWiki being run without
+        # We can't do this, because it prevents Foswiki being run without
         # a LocalSite.cfg, which we don't want
         # die "$var must be defined in LocalSite.cfg"
@@ -121 +121 @@
 ---++ StaticMethod expandValue($string) -> $boolean
 
-Expands references to TWiki configuration items which occur in the
+Expands references to Foswiki configuration items which occur in the
 value of other configuration items.  Use expand($hashref) if the item
 is not a plain scalar.
@@ -138 +138 @@
 ---++ StaticMethod readDefaults() -> \@errors
 
-This is only called by =configure= to initialise the TWiki config hash with
+This is only called by =configure= to initialise the Foswiki config hash with
 default values from the .spec files.
 

trunk/core/lib/Foswiki/Configure/UIs/AUTH.pm

@@ -102 +102 @@
  </li>
  <li>
-  If you are running TWiki on a public website, you are
+  If you are running Foswiki on a public website, you are
   <strong>strongly</strong> advised to totally disable saving from
   <code>configure</code> by making <code>lib/LocalSite.cfg</code> readonly once

trunk/core/lib/Foswiki/Configure/UIs/EXTENSIONS.pm

@@ -29 +29 @@
     version          => 'Most Recent Version',
     installedVersion => 'Installed Version',
-    testedOn         => 'Tested On TWiki',
+    testedOn         => 'Tested On Foswiki',
     testedOnOS       => 'Tested On OS',
     install          => 'Action',
@@ -159 +159 @@
     my $page = <<INTRO;
 To install an extension from this page, click on the link in the 'Action' column.<p />Note that the webserver user has to be able to
-write files everywhere in your TWiki installation. Otherwise you may see
+write files everywhere in your Foswiki installation. Otherwise you may see
 'No permission to write' errors during extension installation.
 INTRO

trunk/core/lib/Foswiki/Configure/UIs/UPDATE.pm

@@ -47 +47 @@
     }
 
-    # Put in a link to the front page of the TWiki
+    # Put in a link to the front page of the Foswiki
     my $url =
 "$Foswiki::cfg{DefaultUrlHost}$Foswiki::cfg{ScriptUrlPath}/view$Foswiki::cfg{ScriptSuffix}/";
@@ -59 +59 @@
           . '.' )
       . CGI::p()
-      . CGI::a( { href => $url }, "Go to the TWiki front page" ) . " or ";
+      . CGI::a( { href => $url }, "Go to the Foswiki front page" ) . " or ";
 }
 

trunk/core/lib/Foswiki/Engine.pm

@@ -28 +28 @@
 ---+!! package Foswiki::Engine
 
-The engine class is a singleton that implements details about TWiki's
+The engine class is a singleton that implements details about Foswiki's
 execution mode. This is the base class and implements basic behavior.
 
@@ -73 +73 @@
 ---++ ObjectMethod run()
 
-Start point to TWiki Runtime Engines.
+Start point to Runtime Engines.
 
 =cut
@@ -139 +139 @@
             # tell the browser where to look for more help
             my $text =
-'TWiki detected an internal error - please check your TWiki logs and webserver logs for more information.'
+'Foswiki detected an internal error - please check your Foswiki logs and webserver logs for more information.'
               . "\n\n";
             $mess =~ s/ at .*$//s;

trunk/core/lib/Foswiki/Form.pm

@@ -15 +15 @@
 derived from Foswiki::Form::FieldDefinition. These objects are responsible
 for the actual syntax and semantics of the field type. Form definitions
-are parsed from TWiki tables, and the types are mapped by name to a
+are parsed from Foswiki tables, and the types are mapped by name to a
 class declared in Foswiki::Form::* - for example, the =text= type is mapped
 to =Foswiki::Form::Text= and the =checkbox= type to =Foswiki::Form::Checkbox=.

trunk/core/lib/Foswiki/Form/Label.pm

@@ -12 +12 @@
     my ( $this, $web, $topic, $value ) = @_;
 
-    # Changing labels through the URL is a feature for TWiki applications,
+    # Changing labels through the URL is a feature for Foswiki applications,
     # even though it's not accessible for standard edits. Some contribs
     # may want to override this to make labels editable.

trunk/core/lib/Foswiki/Form/Select.pm

@@ -29 +29 @@
 ---++ getDefaultValue() -> $value
 The default for a select is always the empty string, as there is no way in
-TWiki form definitions to indicate selected values. This defers the decision
+Foswiki form definitions to indicate selected values. This defers the decision
 on a value to the browser.
 

trunk/core/lib/Foswiki/Func.pm

@@ -8 +8 @@
 %STARTINCLUDE%
 
-_Official list of stable TWiki functions for Plugin developers_
+_Official list of stable Foswiki functions for Plugin developers_
 
 This module defines official functions that [[%SYSTEMWEB%.Plugins][Plugins]]
-can use to interact with the TWiki engine and content.
-
-Refer to TWiki.EmptyPlugin and lib/Foswiki/Plugins/EmptyPlugin.pm for a template Plugin and documentation on how to write a Plugin.
+can use to interact with the Foswiki engine and content.
+
+Refer to lib/Foswiki/Plugins/EmptyPlugin.pm for a template Plugin and documentation on how to write a Plugin.
 
 Plugins should *only* use functions published in this module. If you use
-functions in other TWiki libraries you might create a security hole and
-you will probably need to change your Plugin when you upgrade TWiki.
+functions in other Foswiki libraries you might create a security hole and
+you will probably need to change your Plugin when you upgrade Foswiki.
 
 Deprecated functions will still work in older code, though they should
@@ -26 +26 @@
 of the Foswiki::Plugins module.
 
-Notes on use of =$Foswiki::Plugins::VERSION= (from TWiki 1.2 forwards):
+Notes on use of =$Foswiki::Plugins::VERSION=:
    * If the *major* version (e.g. =1.=) is the same then any plugin coded
      to use any *earlier* revision of the =1.= API will still work. No
@@ -329 +329 @@
 
 The context is a set of identifiers that are set
-during specific phases of TWiki processing. For example, each of
+during specific phases of processing. For example, each of
 the standard scripts in the 'bin' directory each has a context
 identifier - the view script has 'view', the edit script has 'edit'
@@ -380 +380 @@
    * =$web= - new web
    * =$topic= - new topic
-Change the TWiki context so it behaves as if it was processing =$web.$topic=
+Change the Foswiki context so it behaves as if it was processing =$web.$topic=
 from now on. All the preferences will be reset to those of the new topic.
 Note that if the new topic is not readable by the logged in user due to
@@ -420 +420 @@
 ---+++ popTopicContext()
 
-Returns the TWiki context to the state it was in before the
+Returns the Foswiki context to the state it was in before the
 =pushTopicContext= was called.
 
@@ -447 +447 @@
 ---+++ getPreferencesValue( $key, $web ) -> $value
 
-Get a preferences value from TWiki or from a Plugin
+Get a preferences value from Foswiki or from a Plugin
    * =$key= - Preferences key
    * =$web= - Name of web, optional. Current web if not specified; does not apply to settings of Plugin topics
@@ -463 +463 @@
       * =my $webColor = Foswiki::Func::getPreferencesValue( 'WEBBGCOLOR', 'Sandbox' );=
 
-*NOTE:* As of TWiki4.1, if =$NO_PREFS_IN_TOPIC= is enabled in the plugin, then
+*NOTE:* If =$NO_PREFS_IN_TOPIC= is enabled in the plugin, then
 preferences set in the plugin topic will be ignored.
 
@@ -492 +492 @@
 *Since:* Foswiki::Plugins::VERSION 1.021 (27 Mar 2004)
 
-*NOTE:* As of TWiki4.1, if =$NO_PREFS_IN_TOPIC= is enabled in the plugin, then
+*NOTE:* If =$NO_PREFS_IN_TOPIC= is enabled in the plugin, then
 preferences set in the plugin topic will be ignored.
 
@@ -510 +510 @@
 ---+++ getPreferencesFlag( $key, $web ) -> $value
 
-Get a preferences flag from TWiki or from a Plugin
+Get a preferences flag from Foswiki or from a Plugin
    * =$key= - Preferences key
    * =$web= - Name of web, optional. Current web if not specified; does not apply to settings of Plugin topics
@@ -522 +522 @@
       * =my $showHelp = Foswiki::Func::getPreferencesFlag( "MYPLUGIN_SHOWHELP" );=
 
-*NOTE:* As of TWiki4.1, if =$NO_PREFS_IN_TOPIC= is enabled in the plugin, then
+*NOTE:* If =$NO_PREFS_IN_TOPIC= is enabled in the plugin, then
 preferences set in the plugin topic will be ignored.
 
@@ -546 +546 @@
 *Since:* Foswiki::Plugins::VERSION 1.021 (27 Mar 2004)
 
-*NOTE:* As of TWiki4.1, if =$NO_PREFS_IN_TOPIC= is enabled in the plugin, then
+*NOTE:* If =$NO_PREFS_IN_TOPIC= is enabled in the plugin, then
 preferences set in the plugin topic will be ignored.
 
@@ -579 +579 @@
 =pod
 
----+++ getWikiToolName( ) -> $name
-
-Get toolname as defined in TWiki.cfg
-
-Return: =$name= Name of tool, e.g. ='TWiki'=
-
-*Since:* Foswiki::Plugins::VERSION 1.000 (27 Feb 2001)
-
-=cut
-
-sub getWikiToolName {
-    return $Foswiki::cfg{WikiToolName};
-}
-
-=pod
-
----+++ getMainWebname( ) -> $name
-
-Get name of Main web as defined in TWiki.cfg
-
-Return: =$name= Name, e.g. ='Main'=
-
-*Since:* Foswiki::Plugins::VERSION 1.000 (27 Feb 2001)
-
-=cut
-
-sub getMainWebname {
-    return $Foswiki::cfg{UsersWebName};
-}
-
-=pod
-
----+++ getTwikiWebname( ) -> $name
-
-Get name of TWiki documentation web as defined in TWiki.cfg
-
-Return: =$name= Name, e.g. ='TWiki'=
-
-*Since:* Foswiki::Plugins::VERSION 1.000 (27 Feb 2001)
-
-=cut
-
-sub getTwikiWebname {
-    return $Foswiki::cfg{SystemWebName};
-}
-
-=pod
-
 ---++ User Handling and Access Control
 ---+++ getDefaultUserName( ) -> $loginName
@@ -646 +598 @@
    * =$user= can be a login, wikiname or web.wikiname
 Return the cUID of the specified user. A cUID is a unique identifier which
-is assigned by TWiki for each user.
+is assigned by Foswiki for each user.
 BEWARE: While the default TopicUserMapping uses a cUID that looks like a user's
 LoginName, some characters are modified to make them compatible with rcs.
@@ -776 +728 @@
 ---+++ userToWikiName( $loginName, $dontAddWeb ) -> $wikiName
 Translate a login name to a Wiki name
-   * =$loginName=  - Login name, e.g. ='jdoe'=. Since TWiki 4.2.1 this may
+   * =$loginName=  - Login name, e.g. ='jdoe'=. This may
      also be a wiki name. This will normally be transparent, but may be
      relevant if you have login names that are also valid wiki names.
@@ -845 +797 @@
 undef, returns the registered email addresses for the logged-in user.
 
-Since TWiki 4.2.1, $user may also be a login name, or the name of a group.
+$user may also be a login name, or the name of a group.
 
 *Since:* Foswiki::Plugins::VERSION 1.2
@@ -1029 +981 @@
 ---+++ isGroup( $group ) -> $boolean
 
-Checks if =$group= is the name of a group known to TWiki.
+Checks if =$group= is the name of a user group.
 
 =cut
@@ -1079 +1031 @@
 [[%SYSTEMWEB%.AccessControl]] rules
    * =$type=     - Access type, required, e.g. ='VIEW'=, ='CHANGE'=.
-   * =$id=  - WikiName of remote user, required, e.g. ="PeterThoeny"=. From
-     TWiki 4.2.1, $id may also be a login name.
+   * =$id=  - WikiName of remote user, required, e.g. ="RickShaw"=.
+     $id may also be a login name.
      If =$id= is '', 0 or =undef= then access is *always permitted*.
    * =$text=     - Topic text, optional. If 'perl false' (undef, 0 or ''),
@@ -1087 +1039 @@
       1 You are setting different access controls in the text to those defined
       in the stored topic,
-      1 You already have the topic text in hand, and want to help TWiki avoid
+      1 You already have the topic text in hand, and want to help avoid
         having to read it again,
       1 You are providing a =$meta= parameter.
@@ -1100 +1052 @@
 
 *Note* the weird parameter order is due to compatibility constraints with
-earlier TWiki releases.
+earlier releases.
 
 *Tip* if you want, you can use this method to check your own access control types. For example, if you:
@@ -1936 +1888 @@
 list of loaded templates, overwriting any previous definition.
 
-How TWiki searches for templates is described in SkinTemplates.
+How Foswiki searches for templates is described in SkinTemplates.
 
 If template text is found, extracts include statements and fully expands them.
@@ -1958 +1910 @@
 
 A template is defined using a %TMPL:DEF% statement in a template
-file. See the documentation on TWiki templates for more information.
+file. See the documentation on Foswiki templates for more information.
 
 =cut
@@ -2002 +1954 @@
 The =$passthru= parameter allows you to pass the parameters that were passed
 to the current query on to the target URL, as long as it is another URL on the
-same TWiki installation. If =$passthru= is set to a true value, then TWiki
+same installation. If =$passthru= is set to a true value, then Foswiki
 will save the current URL parameters, and then try to restore them on the
 other side of the redirect. Parameters are stored on the server in a cache
@@ -2018 +1970 @@
 </verbatim>
 =$passthru= does nothing if =$url= does not point to a script in the current
-TWiki installation.
+Foswiki installation.
 
 *Since:* Foswiki::Plugins::VERSION 1.000 (7 Dec 2002)
@@ -2039 +1991 @@
    * =$header= - the HTML to be added to the <head> section. The HTML must be valid in a HEAD tag - no checks are performed.
    * =requires= optional, comma-separated list of id's of other head blocks this one depends on.
-   
-All TWiki variables present in =$header= will be expanded before being inserted into the =<head>= section.
+
+All macros present in =$header= will be expanded before being inserted into the =<head>= section.
 
 Note that this is _not_ the same as the HTTP header, which is modified through the Plugins =modifyHeaderHandler=.
@@ -2089 +2041 @@
 ---+++ renderText( $text, $web ) -> $text
 
-Render text from TWiki markup into XHTML as defined in [[%SYSTEMWEB%.TextFormattingRules]]
+Render text from TML into XHTML as defined in [[%SYSTEMWEB%.TextFormattingRules]]
    * =$text= - Text to render, e.g. ='*bold* text and =fixed font='=
    * =$web=  - Web name, optional, e.g. ='Main'=. The current web is taken if missing
@@ -2110 +2062 @@
 
 Render topic name and link label into an XHTML link. Normally you do not need to call this funtion, it is called internally by =renderText()=
-   * =$pre=        - Text occuring before the TWiki link syntax, optional
+   * =$pre=        - Text occuring before the link syntax, optional
    * =$web=        - Web name, required, e.g. ='Main'=
    * =$topic=      - Topic name to link to, required, e.g. ='WebNotify'=
@@ -2182 +2134 @@
 returns a single email address, where a user may in fact have several.
 
-Since TWiki 4.2.1, $wikiName may also be a login name.
+$wikiName may also be a login name.
 
 =cut
@@ -2238 +2190 @@
 ---++ Special handlers
 
-Special handlers can be defined to make functions in plugins behave as if they were built-in to TWiki.
+Special handlers can be defined to make functions in plugins behave as if they were built-in.
 
 =cut
@@ -2248 +2200 @@
 Should only be called from initPlugin.
 
-Register a function to handle a simple variable. Handles both %<nop>VAR% and %<nop>VAR{...}%. Registered variables are treated the same as TWiki internal variables, and are expanded at the same time. This is a _lot_ more efficient than using the =commonTagsHandler=.
+Register a function to handle a simple variable. Handles both %<nop>VAR% and %<nop>VAR{...}%. Registered variables are treated the same as internal macros, and are expanded at the same time. This is a _lot_ more efficient than using the =commonTagsHandler=.
    * =$var= - The name of the variable, i.e. the 'MYVAR' part of %<nop>MYVAR%. The variable name *must* match /^[A-Z][A-Z0-9_]*$/ or it won't work.
    * =\&fn= - Reference to the handler function.
-   * =$syntax= can be 'classic' (the default) or 'context-free'. 'classic' syntax is appropriate where you want the variable to support classic TWiki syntax i.e. to accept the standard =%<nop>MYVAR{ "unnamed" param1="value1" param2="value2" }%= syntax, as well as an unquoted default parameter, such as =%<nop>MYVAR{unquoted parameter}%=. If your variable will only use named parameters, you can use 'context-free' syntax, which supports a more relaxed syntax. For example, %MYVAR{param1=value1, value 2, param3="value 3", param4='value 5"}%
+   * =$syntax= can be 'classic' (the default) or 'context-free'. 'classic' syntax is appropriate where you want the variable to support classic syntax i.e. to accept the standard =%<nop>MYVAR{ "unnamed" param1="value1" param2="value2" }%= syntax, as well as an unquoted default parameter, such as =%<nop>MYVAR{unquoted parameter}%=. If your variable will only use named parameters, you can use 'context-free' syntax, which supports a more relaxed syntax. For example, %MYVAR{param1=value1, value 2, param3="value 3", param4='value 5"}%
 
 *Since:* Foswiki::Plugins::VERSION 1.1
@@ -2260 +2212 @@
 </verbatim>
 where:
-   * =\%session= - a reference to the TWiki session object (may be ignored)
+   * =\%session= - a reference to the session object (may be ignored)
    * =\%params= - a reference to a Foswiki::Attrs object containing parameters. This can be used as a simple hash that maps parameter names to values, with _DEFAULT being the name for the default parameter.
    * =$topic= - name of the topic in the query
@@ -2284 +2236 @@
 =%<nop>EXEC{"ps -Af" silent="on"}%=
 
-Registered tags differ from tags implemented using the old TWiki approach (text substitution in =commonTagsHandler=) in the following ways:
+Registered tags differ from tags implemented using the old approach (text substitution in =commonTagsHandler=) in the following ways:
    * registered tags are evaluated at the same time as system tags, such as %SERVERTIME. =commonTagsHandler= is only called later, when all system tags have already been expanded (though they are expanded _again_ after =commonTagsHandler= returns).
    * registered tag names can only contain alphanumerics and _ (underscore)
@@ -2328 +2280 @@
 </verbatim>
 where:
-   * =\%session= - a reference to the TWiki session object (may be ignored)
+   * =\%session= - a reference to the Foswiki session object (may be ignored)
 
 From the REST interface, the name of the plugin must be used
@@ -2379 +2331 @@
 ---+++ decodeFormatTokens($str) -> $unencodedString
 
-TWiki has an informal standard set of tokens used in =format=
+Foswiki has an informal standard set of tokens used in =format=
 parameters that are used to block evaluation of paramater strings.
 For example, if you were to write
@@ -2386 +2338 @@
 
 then %<nop>WURBLE would be expanded *before* %<NOP>MYTAG is evaluated. To avoid
-this TWiki uses escapes in the format string. For example:
+this Foswiki uses escapes in the format string. For example:
 
 =%<nop>MYTAG{format="$percntWURBLE$percnt"}%=
 
 This lets you enter arbitrary strings into parameters without worrying that
-TWiki will expand them before your plugin gets a chance to deal with them
+Foswiki will expand them before your plugin gets a chance to deal with them
 properly. Once you have processed your tag, you will want to expand these
 tokens to their proper value. That's what this function does.
@@ -2468 +2420 @@
 
 Gets a private directory for Plugin use. The Plugin is entirely responsible
-for managing this directory; TWiki will not read from it, or write to it.
+for managing this directory; Foswiki will not read from it, or write to it.
 
 The directory is guaranteed to exist, and to be writable by the webserver
@@ -2546 +2498 @@
 ---+++ getRegularExpression( $name ) -> $expr
 
-Retrieves a TWiki predefined regular expression or character class.
+Retrieves a Foswiki predefined regular expression or character class.
    * =$name= - Name of the expression to retrieve.  See notes below
 Return: String or precompiled regular expression matching as described below.
@@ -2552 +2504 @@
 *Since:* Foswiki::Plugins::VERSION 1.020 (9 Feb 2004)
 
-__Note:__ TWiki internally precompiles several regular expressions to
+__Note:__ Foswiki internally precompiles several regular expressions to
 represent various string entities in an <nop>I18N-compatible manner. Plugins
 authors are encouraged to use these in matching where appropriate. The
 following are guaranteed to be present. Others may exist, but their use
-is unsupported and they may be removed in future TWiki versions.
+is unsupported and they may be removed in future Foswiki versions.
 
 In the table below, the expression marked type 'String' are intended for
@@ -2620 +2572 @@
 | *Input*                               | *Return* |
 | <tt>( '%<nop>USERSWEB%', 'Topic' )</tt>     | <tt>( 'Main', 'Topic' ) </tt>  |
-| <tt>( '%<nop>SYSTEMWEB%', 'Topic' )</tt>    | <tt>( 'TWiki', 'Topic' ) </tt>  |
-| <tt>( '', '%<nop>DOCWEB%.Topic' )</tt>    | <tt>( 'TWiki', 'Topic' ) </tt>  |
+| <tt>( '%<nop>SYSTEMWEB%', 'Topic' )</tt>    | <tt>( 'System', 'Topic' ) </tt>  |
+| <tt>( '', '%<nop>DOCWEB%.Topic' )</tt>    | <tt>( 'System', 'Topic' ) </tt>  |
 
 =cut
@@ -2833 +2785 @@
 ---++ Deprecated functions
 
-From time-to-time, the TWiki developers will add new functions to the interface (either to TWikiFuncDotPm, or new handlers). Sometimes these improvements mean that old functions have to be deprecated to keep the code manageable. When this happens, the deprecated functions will be supported in the interface for at least one more TWiki release, and probably longer, though this cannot be guaranteed.
-
-Updated plugins may still need to define deprecated handlers for compatibility with old TWiki versions. In this case, the plugin package that defines old handlers can suppress the warnings in %<nop>FAILEDPLUGINS%.
+From time-to-time, the Foswiki developers will add new functions to the interface (either to =Foswiki::Func=, or new handlers). Sometimes these improvements mean that old functions have to be deprecated to keep the code manageable. When this happens, the deprecated functions will be supported in the interface for at least one more release, and probably longer, though this cannot be guaranteed.
+
+Updated plugins may still need to define deprecated handlers for compatibility with old Foswiki versions. In this case, the plugin package that defines old handlers can suppress the warnings in %<nop>FAILEDPLUGINS%.
 
 This is done by defining a map from the handler name to the =Foswiki::Plugins= version _in which the handler was first deprecated_. For example, if we need to define the =endRenderingHandler= for compatibility with =Foswiki::Plugins= versions before 1.1, we would add this to the plugin:
 <verbatim>
 package Foswiki::Plugins::SinkPlugin;
-use vars qw( %TWikiCompatibility );
-$TWikiCompatibility{endRenderingHandler} = 1.1;
-</verbatim>
-If the currently-running TWiki version is 1.1 _or later_, then the _handler will not be called_ and _the warning will not be issued_. TWiki with versions of =Foswiki::Plugins= before 1.1 will still call the handler as required.
+use vars qw( %FoswikiCompatibility );
+$FoswikiCompatibility{endRenderingHandler} = 1.1;
+</verbatim>
+If the currently-running code version is 1.1 _or later_, then the _handler will not be called_ and _the warning will not be issued_. TWiki with versions of =Foswiki::Plugins= before 1.1 will still call the handler as required.
 
 The following functions are retained for compatibility only. You should
@@ -2854 +2806 @@
 *DEPRECATED* since 1.1 - use =getScriptUrl= instead.
 
-Return: =$path= URL path of TWiki scripts, e.g. ="/cgi-bin"=
+Return: =$path= URL path of bin scripts, e.g. ="/cgi-bin"=
 
 *WARNING:* you are strongly recommended *not* to use this function, as the
@@ -2868 +2820 @@
     return $Foswiki::Plugins::SESSION->getScriptUrl( 0, '' );
 }
+
+
+=pod
+
+---+++ getWikiToolName( ) -> $name
+
+*DEPRECATED* in Foswiki; use $Foswiki::cfg{WikiToolName} instead
+
+=cut
+
+sub getWikiToolName { return $Foswiki::cfg{WikiToolName}; }
+
+=pod
+
+---+++ getMainWebname( ) -> $name
+
+*DEPRECATED* in Foswiki; use $Foswiki::cfg{UsersWebName} instead
+
+=cut
+
+sub getMainWebname { return $Foswiki::cfg{UsersWebName}; }
+
+=pod
+
+---+++ getTwikiWebname( ) -> $name
+
+*DEPRECATED* in Foswiki; use $Foswiki::cfg{SystemWebName} instead
+
+=cut
+
+sub getTwikiWebname { return $Foswiki::cfg{SystemWebName}; }
 
 =pod
@@ -2880 +2863 @@
 Return: =$url=                     URL, e.g. ="http://example.com:80/cgi-bin/oops.pl/ Main/WebNotify?template=oopslocked&amp;param1=joe"=
 
-*DEPRECATED* since 1.1, the recommended approach is to throw an [[TWikiOopsExceptionDotPm][oops exception]].
+*DEPRECATED* since 1.1, the recommended approach is to throw an oops exception.
 <verbatim>
    use Error qw( :try );
@@ -2964 +2947 @@
 *DEPRECATED* since 1.1 - use =getListOfWebs= instead.
 
-Get list of all public webs, e.g. all webs that do not have the =NOSEARCHALL= flag set in the WebPreferences
-
-Return: =@webs= List of all public webs, e.g. =( 'Main',  'Know', 'TWiki' )=
+Get list of all public webs, e.g. all webs *and subwebs* that do not have the =NOSEARCHALL= flag set in the WebPreferences
+
+Return: =@webs= List of all public webs *and subwebs*
 
 *Since:* Foswiki::Plugins::VERSION 1.000 (07 Dec 2002)
@@ -3009 +2992 @@
 *DEPRECATED* since 1.1 - use the "Webs, Topics and Attachments" functions to manipulate topics instead
 
-Get data directory (topic file root)
-
-Return: =$dir= Data directory, e.g. ='/twiki/data'=
-
-This function violates store encapsulation and is therefore *deprecated*.
-
-*Since:* Foswiki::Plugins::VERSION 1.000 (07 Dec 2002)
-
 =cut
 
@@ -3029 +3004 @@
 *DEPRECATED* since 1.1 - use the "Webs, Topics and Attachments" functions to manipulateattachments instead
 
-Get pub directory (file attachment root). Attachments are in =$dir/Web/TopicName=
-
-Return: =$dir= Pub directory, e.g. ='/htdocs/twiki/pub'=
-
-This function violates store encapsulation and is therefore *deprecated*.
-
-Use =readAttachment= and =saveAttachment= instead.
-
-*Since:* Foswiki::Plugins::VERSION 1.000 (07 Dec 2002)
-
-=cut
-
-sub getPubDir {
-    return $Foswiki::cfg{PubDir};
-}
-
-=pod
-
----+++ checkDependencies( $moduleName, $dependenciesRef ) -> $error
-
-*DEPRECATED* since 1.1 - use TWiki:Plugins.BuildContrib and define DEPENDENCIES that can be statically
-evaluated at install time instead. It is a lot more efficient.
-
-*Since:* Foswiki::Plugins::VERSION 1.025 (01 Aug 2004)
-
-=cut
-
+=cut
+
+sub getPubDir { return $Foswiki::cfg{PubDir}; }
+
+# Removed; it was never used
 sub checkDependencies {
-    my ( $context, $deps ) = @_;
-    my $report = '';
-    my $depsOK = 1;
-    foreach my $dep (@$deps) {
-        my ( $ok, $ver ) = ( 1, 0 );
-        my $msg   = '';
-        my $const = '';
-
-        eval "require $dep->{package}";
-        if ($@) {
-            $msg .= "it could not be found: $@";
-            $ok = 0;
-        }
-        else {
-            if ( defined( $dep->{constraint} ) ) {
-                $const = $dep->{constraint};
-                eval "\$ver = \$$dep->{package}::VERSION;";
-                if ($@) {
-                    $msg .= "the VERSION of the package could not be found: $@";
-                    $ok = 0;
-                }
-                else {
-                    eval "\$ok = ( \$ver $const )";
-                    if ( $@ || !$ok ) {
-                        $msg .= " $ver is currently installed: $@";
-                        $ok = 0;
-                    }
-                }
-            }
-        }
-        unless ($ok) {
-            $report .=
-"WARNING: $dep->{package}$const is required for $context, but $msg\n";
-            $depsOK = 0;
-        }
-    }
-    return undef if ($depsOK);
-
-    return $report;
+    die "checkDependencies removed; contact plugin author or maintainer and tell them to use BuildContrib DEPENDENCIES instead";
 }
 
@@ -3120 +3035 @@
 
 As per the GPL, removal of this notice is prohibited.
-
----++ API History
-
----+++ twiki-20010901-release (Athens)
-$Foswiki::Plugins::VERSION 1.000
----++++ EmptyPlugin.pm
-   * =commonTagsHandler($text, $topic, $web)=
-   * =endRenderingHandler($text)=
-   * =outsidePREHandler($text)=
-   * =insidePREHandler($text)=
-   * =startRenderingHandler($text, $web)=
----++++ Func.pm
-   * =checkAccessPermission($type, $login, $topicText, $topicName, $webName) -> $boolean=
-   * =expandCommonVariables($text, $topic, $web) -> $text=
-   * =extractNameValuePair($attrs, $name) -> $value=
-   * =formatGmTime($time) -> $text=
-   * =getCgiQuery() -> $query=
-   * =getDataDir() -> $dir=
-   * =getDefaultUserName() -> $loginName=
-   * =getMainWebname() -> $name=
-   * =getOopsUrl($web, $topic, $template, @theParams) -> $url=
-   * =getPreferencesFlag($key) -> $boolean=
-   * =getPreferencesValue($key, $web) -> $value=
-   * =getPublicWebList() -> @webs=
-   * =getPubDir() -> $dir=
-   * =getPubUrlPath() -> $path=
-   * =getRevisionInfo($webName, $topic, $rev, $attachment) -> ($date, $user, $rev, $comment)=
-   * =getScriptUrl($web, $topic, $script) -> $url=
-   * =getScriptUrlPath() -> $path=
-   * =getSessionValue($key) -> $value=
-   * =getSkin() -> $skin=
-   * =getTopicList($web) -> @topics=
-   * =getTwikiWebname() -> $name=
-   * =getUrlHost() -> $host=
-   * =getViewUrl($web, $topic) -> $url=
-   * =getWikiName() -> $wikiName=
-   * =getWikiUserName($text) -> $wikiName=
-   * =getWikiToolName() -> $name=
-   * =internalLink($preamble, $web, $topic, $linkText, $anchor, $createLink) -> $text=
-   * =isGuest() -> $boolean=
-   * =permissionsSet($web) -> $boolean=
-   * =readFile($filename) -> $text=
-   * =readTemplate($name, $skin) -> $text=
-   * =readTopic($webName, $topic) -> ($meta, $text)=
-   * =redirectCgiQuery($query, $url)=
-   * =renderText($text, $web) -> $text=
-   * =saveFile($filename, $text)=
-   * =setSessionValue($key, $value)=
-   * =topicExists($web, $topic) -> $boolean=
-   * =userToWikiName($user, $dontAddWeb) -> $wikiName=
-   * =webExists($web) -> $boolean=
-   * =wikiToUserName($wiki) -> $loginName=
-   * =writeDebug($text)=
-   * =writeHeader($query)=
-   * =writeWarning($text)=
-
----+++ TWikiRelease01Feb2003 (Beijing)
-$Foswiki::Plugins::VERSION 1.010
----++++ EmptyPlugin.pm
-   * =afterEditHandler($text, $topic, $web)=
-   * =beforeEditHandler($text, $topic, $web)=
-   * =beforeSaveHandler($text, $topic, $web)=
-   * =initializeUserHandler($loginName, $url, $pathInfo)=
-   * =redirectCgiQueryHandler($query, $url)=
-   * =registrationHandler($web, $wikiName, $loginName)=
-   * =writeHeaderHandler($query)=
----++++ Func.pm
-   * =checkTopicEditLock($web, $topic) ->($oopsUrl, $loginName, $unlockTime)=
-   * =readTopicText($web, $topic, $rev, $ignorePermissions) -> $text=
-   * =saveTopicText($web, $topic, $text, $ignorePermissions, $dontNotify) -> $oopsUrl=
-   * =setTopicEditLock($web, $topic, $lock) -> $oopsUrl=
-
----+++ twiki-20040902-release (Cairo)
-$Foswiki::Plugins::VERSION 1.025
----++++ EmptyPlugin.pm
-   * =afterCommonTagsHandler($text, $topic, $web)=
-   * =afterSaveHandler($text, $topic, $web, $error)=
-   * =beforeCommonTagsHandler($text, $topic, $web)=
-   * =earlyInitPlugin()=
----++++ Func.pm
-   * =afterAttachmentSaveHandler(\%attrHash, $topic, $web, $error)=
-   * =beforeAttachmentSaveHandler(\%attrHash, $topic, $web)=
-   * =checkDependencies($moduleName, $dependenciesRef) -> $error=
-   * =extractParameters($attr) -> %params=
-   * =formatTime($time, $format, $timezone) -> $text=
-   * =getPluginPreferencesFlag($key) -> $boolean=
-   * =getPluginPreferencesValue($key) -> $value=
-   * =getRegularExpression($regexName) -> $pattern=
-
----+++ TWikiRelease04x00x00 (Dakar)
-$Foswiki::Plugins::VERSION 1.1
----++++ EmptyPlugin.pm
-   * =mergeHandler($diff, $old, $new, \%info) -> $text=
-   * =modifyHeaderHandler(\%headers, $query)=
-   * =postRenderingHandler($text)=
-   * =preRenderingHandler($text, \%map)=
-   * =renderFormFieldForEditHandler($name, $type, $size, $value, $attributes, $possibleValues) -> $html=
-   * =renderWikiWordHandler($linkText, $hasExplicitLinkLabel, $web, $topic) -> $linkText=
-
-   * <strike> =endRenderingHandler($text)= </strike>
-   * <strike> =startRenderingHandler($text, $web)= </strike>
----++++ Func.pm
-   * =addToHEAD($id, $header)=
-   * =attachmentExists($web, $topic, $attachment) -> $boolean=
-   * =clearSessionValue($key) -> $boolean=
-   * =checkDependencies($moduleName, $dependenciesRef) -> $error=
-   * =createWeb($newWeb, $baseWeb, $opts)=
-   * =expandTemplate($def ) -> $string=
-   * =expandVariablesOnTopicCreation($text) -> $text=
-   * =getContext() -> \%hash=
-   * =getListOfWebs($filter) -> @webs=
-   * =getScriptUrl($web, $topic, $script, @params) -> $url=
-   * =getRevisionAtTime($web, $topic, $time) -> $rev=
-   * =getWorkArea($pluginName) -> $directorypath=
-   * =isValidWikiWor