[gate-cvs] SF.net SVN: gate:[14102] userguide/trunk/jape.tex

[<joh...@us...>]

Revision: 14102
          http://gate.svn.sourceforge.net/gate/?rev=14102&view=rev
Author:   johann_p
Date:     2011-06-29 21:30:16 +0000 (Wed, 29 Jun 2011)

Log Message:
-----------
Document the ctx.isPREnabled() use for Controller... blocks.

Modified Paths:
--------------
    userguide/trunk/jape.tex

Modified: userguide/trunk/jape.tex
===================================================================
--- userguide/trunk/jape.tex	2011-06-29 21:07:30 UTC (rev 14101)
+++ userguide/trunk/jape.tex	2011-06-29 21:30:16 UTC (rev 14102)
@@ -1709,7 +1709,7 @@
 processing resource
 starts processing, finishes processing, or processing is aborted 
 (see the JavaDoc for \texttt{ControllerAwarePR} for more information and
-warnings about using this feature).
+warnings about using this feature). 
 These code blocks have to be defined after any \texttt{Import:} block
 but before the first phase in the file using the \texttt{ControllerStarted:},
  \texttt{ControllerFinished:} and \texttt{ControllerAborted:} keywords:
@@ -1745,6 +1745,11 @@
      which signalled the aborting exception
 \end{itemize}
 
+Note that these blocks are invoked even when the JAPE processing resource is
+disabled in a conditional pipeline. If you want to adapt or avoid the processing
+inside a block in case the processing resource is disabled, use the method
+\verb=ctx.isPREnabled()= to check if the processing resource is not disabled.
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \sect[sec:jape:speed]{Optimising for Speed}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.