Changeset 812 for trunk/core/lib/Foswiki.pm

Timestamp:

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

Author:

CrawfordCurrie

Message:

Item175: corrected references to TWiki in comments and error messages

File:

• trunk/core/lib/Foswiki.pm (modified) (43 diffs)

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 ) = @_;