CVS: Tapestry/doc/src/UsersGuide configuration.xml,1.1.2.3,1.1.2.4 TapestryUsersGuide.xml,1.1.2.3,1.1.2.4 spec.xml,1.1.2.2,1.1.2.3

Update of /cvsroot/tapestry/Tapestry/doc/src/UsersGuide
In directory sc8-pr-cvs1:/tmp/cvs-serv2683/doc/src/UsersGuide

Modified Files:
      Tag: hship-2-3
	configuration.xml TapestryUsersGuide.xml spec.xml 
Log Message:
Update documentation for <listener-binding>, configuration properties.

Index: configuration.xml
===================================================================
RCS file: /cvsroot/tapestry/Tapestry/doc/src/UsersGuide/Attic/configuration.xml,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -C2 -d -r1.1.2.3 -r1.1.2.4
*** configuration.xml	2 Jan 2003 03:17:41 -0000	1.1.2.3
--- configuration.xml	4 Jan 2003 02:47:53 -0000	1.1.2.4
***************
*** 171,174 ****
--- 171,179 ----
  		</para>
  	</listitem>
+ 	<listitem>
+ 		<para>
+ 		Hard-coded "factory" defaults (for some properties).
+ 		</para>
+ 	</listitem>
  </itemizedlist>
  
***************
*** 188,192 ****
  Applications may also want to change or augment
  the default search path; this is accomplished by overriding
! &AbstractEngine; method <function>createPropertySource()</function>.
  </para>
  		
--- 193,198 ----
  Applications may also want to change or augment
  the default search path; this is accomplished by overriding
! &AbstractEngine; method <function>createPropertySource()</function>.  For example,
! some configuration data could be drawn from a database.
  </para>
  		
***************
*** 255,258 ****
--- 261,323 ----
  	</listitem>
  </varlistentry>
+ 
+ <varlistentry>
+ 	<term>net.sf.tapestry.default-script-language</term>
+ 	
+ 	<listitem>
+ 	<para>
+ 	The name of a &BSF;-supported language, used when a
+ 	&spec.listener-binding; element does not specify
+ 	a language.  The "factory default" is "jython".
+ 	</para>
+ 	</listitem>
+ 	
+ 	
+ </varlistentry>
+ 
+ <varlistentry>
+ 	<term>net.sf.tapestry.enable-reset-service</term>
+ 	
+ 	<listitem>
+ 	<para>
+ 	If not specified as "true", then the <literal>reset</literal> service
+ 	will be non functional.  The reset service is used to force
+ 	the running Tapestry application to discard all cached data (including
+ 	templates, specifications, pooled objects and more).  This must
+ 	be explicitly enabled, and should only be used in development (in production,
+ 	it is too easily exploited as a denial of service attack).
+ 	</para>
+ 	
+ 	<para>
+ 	Unlike most other configuration values, this must be specified
+ 	as a JVM system property.
+ 	</para>
+ 	</listitem>
+ </varlistentry>
+ 
+ <varlistentry>
+ 	<term>net.sf.tapestry.disable-caching</term>
+ 	
+ 	<listitem>
+ 	<para>
+ 	If specified (as "true"), then the framework will discard all cached data
+ 	(specifications, templates, pooled objects, etc.) at the end of each request cycle.
+ 	</para>
+ 	
+ 	<para>
+ 	This slows down request handling but a significant amount, but is very
+ 	useful in devlopment; it means that changes to templates and specifications
+ 	are immediately visible to the application.  It also helps identify
+ 	any errors in managing persistent page state.
+ 	</para>
+ 	
+ 	<para>
+ 	This should never be enabled in production; the performance hit is too large.
+ 	Like <literal>net.sf.tapestry.enable-reset-service</literal>, this must
+ 	be specified as a JVM system property.
+ 	</para>
+ 	</listitem>
+ </varlistentry>
+ 	
  
  </variablelist>

Index: TapestryUsersGuide.xml
===================================================================
RCS file: /cvsroot/tapestry/Tapestry/doc/src/UsersGuide/Attic/TapestryUsersGuide.xml,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -C2 -d -r1.1.2.3 -r1.1.2.4
*** TapestryUsersGuide.xml	2 Jan 2003 03:17:41 -0000	1.1.2.3
--- TapestryUsersGuide.xml	4 Jan 2003 02:47:53 -0000	1.1.2.4
***************
*** 34,37 ****
--- 34,38 ----
  <!ENTITY spec.library '<link linkend="spec.library"><sgmltag class="starttag">library</sgmltag></link>'>
  <!ENTITY spec.library-specification '<link linkend="spec.library-specification"><sgmltag class="starttag">library-specification</sgmltag></link>'>
+ <!ENTITY spec.listener-binding '<link linkend="spec.listener-binding"><sgmltag class="starttag">listener-binding</sgmltag></link>'>
  <!ENTITY spec.page '<link linkend="spec.page"><sgmltag class="starttag">page</sgmltag></link>'>
  <!ENTITY spec.page-specification '<link linkend="spec.page-specification"><sgmltag class="starttag">page-specification</sgmltag></link>'>

Index: spec.xml
===================================================================
RCS file: /cvsroot/tapestry/Tapestry/doc/src/UsersGuide/Attic/spec.xml,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -C2 -d -r1.1.2.2 -r1.1.2.3
*** spec.xml	2 Jan 2003 03:17:41 -0000	1.1.2.2
--- spec.xml	4 Jan 2003 02:47:53 -0000	1.1.2.3
***************
*** 355,358 ****
--- 355,368 ----
  	<entry>The conversion to apply to the value.</entry>
  </row>
+ <row>
+ 	<entry>value</entry>
+ 	<entry/>
+ 	<entry>no</entry>
+ 	<entry/>
+ 	<entry>The value to configure, which will be converted before being assigned
+ 	to the property.  If not provided, the character data wrapped by the element
+ 	is used instead.
+ 	</entry>
+ </row>
  </tbody>
  </tgroup>
***************
*** 446,450 ****
  <literallayout>
    &spec.property; *,
!   (&spec.binding; | &spec.inherited-binding; | &spec.static-binding; | &spec.string-binding;) *
  </literallayout>
  </figure>
--- 456,460 ----
  <literallayout>
    &spec.property; *,
!   (&spec.binding; | &spec.inherited-binding; | &spec.listener-binding; | &spec.static-binding; | &spec.string-binding;) *
  </literallayout>
  </figure>
***************
*** 1019,1022 ****
--- 1029,1111 ----
  </section> <!-- spec.page -->
  
+ <section id="spec.listener-binding">
+ 	<title><sgmltag class="starttag">listener-binding</sgmltag> element</title>
+ 
+ <para>
+ Appears in: &spec.component;
+ </para>
+ 
+ 
+ <para>
+ A listener binding is used to create application logic, in the form
+ of a listener (for a &DirectLink;, &ActionLink;, &Form;, etc.)
+ in place within the specification, in 
+ a scripting language (such as &Jython; or JavaScript).  The script itself
+ is the wrapped character data for the <sgmltag class="starttag">listener-binding</sgmltag> 
+ element.
+ </para>
+ 
+ <para>
+ When the listener is triggered, the script is executed.  Three beans,
+ <varname>page</varname>, <varname>component</varname> and <varname>cycle</varname>
+ are pre-declared.
+ </para>
+ 
+ <para>
+ The <varname>page</varname> is the page activated by the request.  Usually, this is
+ the same as the page which contains the <varname>component</varname> ... in fact,
+ usually <varname>page</varname> and <varname>compoment</varname> are identical.
+ </para>
+ 
+ <para>
+ The <varname>component</varname> is the component from whose specification
+ the binding was created (that is, not the &DirectLink;, but the page or component
+ which embeds the &DirectLink;).
+ </para>
+ 
+ <para>
+ The <varname>cycle</varname> is the active request cycle, from which service parameters
+ may be obtained.
+ </para>
+ 
+ 
+ <figure>
+ 	<title><sgmltag class="starttag">listener-binding</sgmltag> Attributes</title>
+ <informaltable>
+ <tgroup cols="5">
+ <thead>
+ <row>
+   <entry>Name</entry>
+   <entry>Type</entry>
+   <entry>Required ?</entry>
+   <entry>Default Value</entry>
+   <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ 	<entry>name</entry>
+ 	<entry>string</entry>
+ 	<entry>yes</entry>
+ 	<entry/>
+ 	<entry>The name of the listener parameter to bind.</entry>
+ </row>
+ <row>
+ 	<entry>language</entry>
+ 	<entry>string</entry>
+ 	<entry>no</entry>
+ 	<entry/>
+ 	<entry>The name of a &BSF;-supported language that the script is written in.  The default,
+ 	if not specified, is <literal>jython</literal>.
+ 	</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </figure>
+ 
+ </section> <!-- spec.listener-binding -->
+ 
+ 
  <section id="spec.page-specification">
  	<title><sgmltag class="starttag">page-specification</sgmltag> element</title>
***************
*** 1238,1244 ****
  <para>
  The <sgmltag class="starttag">property</sgmltag> element is used to store meta-data
! about some other element (it is contained within).  Tapestr ignores this meta-data
! Any number of name/value pairs may be stored.  The value is the static text the <sgmltag class="starttag">property</sgmltag>
! tag wraps around.
  </para>
  
--- 1327,1334 ----
  <para>
  The <sgmltag class="starttag">property</sgmltag> element is used to store meta-data
! about some other element (it is contained within).  Tapestry ignores this meta-data
! Any number of name/value pairs may be stored.  The value is provided with
! the <varname>value</varname> attribute, or the 
! character data for the <sgmltag class="starttag">property</sgmltag> element.
  </para>
  



-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf