Changeset 920 for trunk/EmptyPlugin/lib/Foswiki/Plugins/EmptyPlugin.pm

Timestamp:

11/24/08 14:27:56 (4 years ago)

Author:

CrawfordCurrie

Message:

Item287: Rewrote significant chunk of plugins doc to simplify and improve developer doc. Added doc: protocol to %INCLUDE to support including core module documentation

File:

• trunk/EmptyPlugin/lib/Foswiki/Plugins/EmptyPlugin.pm (modified) (4 diffs)

trunk/EmptyPlugin/lib/Foswiki/Plugins/EmptyPlugin.pm

@@ -36 +36 @@
 for information on regarding deprecated handlers that are defined for
 compatibility with older Foswiki versions.
+
+__BNOTE:__ All but the initPlugin are disabled. To enable a callback, remove =DISABLE_= from the function name.
+
+%STARTINCLUDE%
 
 __NOTE:__ When writing handlers, keep in mind that these may be invoked
@@ -97 +101 @@
 a non-zero value. On non-fatal failure, should write a message
 using Foswiki::Func::writeWarning and return 0. In this case
-%FAILEDPLUGINS% will indicate which plugins failed.
+%<nop>FAILEDPLUGINS% will indicate which plugins failed.
 
 In the case of a catastrophic failure that will prevent the whole
@@ -105 +109 @@
 You may also call =Foswiki::Func::registerTagHandler= here to register
 a function to handle variables that have standard Foswiki syntax - for example,
-=%MYTAG{"my param" myarg="My Arg"}%. You can also override internal
+=%<nop>MYTAG{"my param" myarg="My Arg"}%. You can also override internal
 Foswiki variable handling functions this way, though this practice is unsupported
 and highly dangerous!
@@ -355 +359 @@
 XYZ
 </pre>
+</verbatim>
 the map will contain:
 <pre>