Changeset 7889

Timestamp:

06/23/10 05:12:40 (2 years ago)

Author:

DanDascalescu

Message:

Item8841: improved the description of the $session parameter passed to _EXAMPLETAG

File:

• branches/Release01x00/EmptyPlugin/lib/Foswiki/Plugins/EmptyPlugin.pm (modified) (2 diffs)

branches/Release01x00/EmptyPlugin/lib/Foswiki/Plugins/EmptyPlugin.pm

@@ -37 +37 @@
 __NOTE:__ Foswiki:Development.StepByStepRenderingOrder helps you decide which
 rendering handler to use. When writing handlers, keep in mind that these may
-be invoked on included topics. For example, if a plugin generates links to the 
-current topic, these need to be generated before the =afterCommonTagsHandler= 
-is run. After that point in the rendering loop we have lost the information 
+be invoked on included topics. For example, if a plugin generates links to the
+current topic, these need to be generated before the =afterCommonTagsHandler=
+is run. After that point in the rendering loop we have lost the information
 that the text had been included from another topic.
 
@@ -145 +145 @@
 #sub _EXAMPLETAG {
 #    my($session, $params, $theTopic, $theWeb) = @_;
-#    # $session  - a reference to the Foswiki session object (if you don't know
-#    #             what this is, just ignore it)
+#    # $session  - a reference to the Foswiki session object
+#    #             (you probably won't need it, but documented in Foswiki.pm)
 #    # $params=  - a reference to a Foswiki::Attrs object containing
 #    #             parameters.