Changeset 14361

Timestamp:

03/17/12 20:13:44 (14 months ago)

Author:

KipLubliner

Message:

Item11437: Update Published API

Location:

branches/Release01x01/core

Files:

• data/System/PerlDoc.txt (modified) (1 diff)
• data/System/PublishedAPI.txt (modified) (1 diff)
• lib/Foswiki/IncludeHandlers/doc.pm (modified) (1 diff)

branches/Release01x01/core/data/System/PerlDoc.txt

@@ -12 +12 @@
     <div class="foswikiFormDescription">
       Enter a module name that to extract the perl documentation, e.g. <a href="%SCRIPTURLPATH{"view"}%/%WEB%/%TOPIC%?module=Foswiki::Func%IF{"$publicOnly = 'on'" then=";publicOnly=on"}%">Foswiki::Func</a> or, <a href="%SCRIPTURLPATH{"view"}%/%WEB%/%TOPIC%?module=Foswiki::Meta%IF{"$publicOnly = 'on'" then=";publicOnly=on"}%">Foswiki::Meta</a>.<br/>
-      See also [[DevelopingPlugins][Developing plugins]], [[Foswiki:Development.DevelopersBible][Developer's Bible]], [[Foswiki:Development.TechnicalOverview][Technical Overview]] 
+      See also PublishedAPI, [[DevelopingPlugins][Developing plugins]], [[Foswiki:Development.DevelopersBible][Developer's Bible]], [[Foswiki:Development.TechnicalOverview][Technical Overview]] 
     </div>
   </div>

branches/Release01x01/core/data/System/PublishedAPI.txt

@@ -1 @@
-| package | Foswiki |
-| package | Foswiki::Access |
-| package | Foswiki::AccessControlException |
-| package | Foswiki::AggregateIterator |
-| package | Foswiki::Attrs |
-| package | Foswiki::Engine |
-| package | Foswiki::Extensions |
-| package | Foswiki::Func |
-| package | Foswiki::Iterator |
-| package | Foswiki::LineIterator |
-| package | Foswiki::ListIterator |
-| package | Foswiki::LoginManager |
-| package | Foswiki::LoginManager::ApacheLogin |
-| package | Foswiki::LoginManager::TemplateLogin |
-| package | Foswiki::Meta |
-| package | Foswiki::OopsException |
-| package | Foswiki::PageCache |
-| package | Foswiki::Plugins |
-| package | Foswiki::Prefs |
-| package | Foswiki::Query |
-| package | Foswiki::Render |
-| package | Foswiki::Request |
-| package | Foswiki::Request::Upload |
-| package | Foswiki::Response |
-| package | Foswiki::Sandbox |
-| package | Foswiki::Search::InfoCache |
-| package | Foswiki::Time |
-| package | Foswiki::UI |
-| package | Foswiki::UI::Register |
-| package | Foswiki::Users |
-| package | Foswiki::Validation |
-| package | Foswiki::WebFilter |
+| *Name* | *First Published* | *Comment* |
+| [[%SYSTEMWEB%.PerlDoc?module=Foswiki::Func][Foswiki::Func]] | 1.1.5 | Main API. |
+| [[%SYSTEMWEB%.PerlDoc?module=Foswiki::Attrs][Foswiki::Attrs]] | 1.1.5 | Parameter passing for custom macros |
+| [[%SYSTEMWEB%.PerlDoc?module=Foswiki::Request][Foswiki::Request]] | 1.1.5 | URL parameters |
+| [[%SYSTEMWEB%.PerlDoc?module=Foswiki::Sandbox][Foswiki::Sandbox]] | 1.1.5 | Calls to external commands; untainting |
+| [[%SYSTEMWEB%.PerlDoc?module=Foswiki::Meta][Foswiki::Meta]] | 1.1.5 | Metadata for webs or topics.  %X% This class may be changed after refactorings of the Foswiki internals, so please try to use Foswiki::Func instead if possible.  Incompatible changes will only be made during a major release. |
+| [[%SYSTEMWEB%.PerlDoc?module=Foswiki::AccessControlException][Foswiki::AccessControlException]] | 1.1.5 | Exception used raise an access control violation. |
+| [[%SYSTEMWEB%.PerlDoc?module=Foswiki::OopsException][Foswiki::OopsException]] | 1.1.5 | Exception used to raise a request to output a preformatted page. |
+| [[%SYSTEMWEB%.PerlDoc?module=Foswiki::Iterator][Foswiki::Iterator]] | 1.1.5 | |
+| [[%SYSTEMWEB%.PerlDoc?module=Foswiki::Plugins][Foswiki::Plugins]] | 1.1.5 | Just to access $SESSION and $VERSION |
+| [[%SYSTEMWEB%.PerlDoc?module=Foswiki::Time][Foswiki::Time]] | 1.1.5 | Time handling functions. |

branches/Release01x01/core/lib/Foswiki/IncludeHandlers/doc.pm

@@ -238 +238 @@
     my @ret;
     for my $line ( split /\r?\n/, $text ) {
-        $line =~ /^\|\s*package\s*\|\s*(.*?)\s*\|/
+        #| [[%SYSTEMWEB%.PerlDoc?module=Foswiki::Func][Foswiki::Func]] | 1.1.5 | Main API. |
+        $line =~ /^\|\s*\[\[.*?PerlDoc.*?\]\[(.*?)\]\]/
           and push @ret, $1;
     }