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

Howard Lewis Ship <[email protected]>
Newsgroups gmane.comp.java.tapestry.cvs
Message-ID <[email protected]> 
Update of /cvsroot/tapestry/Tapestry/doc/src/UsersGuide
In directory sc8-pr-cvs1:/tmp/cvs-serv11437/doc/src/UsersGuide

Modified Files:
      Tag: hship-2-3
	configuration.xml TapestryUsersGuide.xml state.xml spec.xml 
Log Message:
Keep up work on UsersGuide

Index: configuration.xml
===================================================================
RCS file: /cvsroot/tapestry/Tapestry/doc/src/UsersGuide/Attic/configuration.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
*** configuration.xml	27 Dec 2002 22:50:38 -0000	1.1.2.2
--- configuration.xml	2 Jan 2003 03:17:41 -0000	1.1.2.3
***************
*** 191,196 ****
--- 191,265 ----
  </para>
  		
+ <para>
+ The following table lists all the configuration values
+ currently used in Tapestry.
+ 	
+ <variablelist>
+ 	<title>Configuration Values</title>
+ 	
+ <varlistentry>
+ 	<term>net.sf.tapestry.asset.dir</term>
+ 	<term>net.sf.tapestry.asset.URL</term>
  	
+ 	<listitem>
+ 	<para>
+ 	These two values are used to handle private assets.  Private assets are assets
+ 	that are stored on the classpath, and not normally visible to client web browsers.
+ 	</para>
+ 	
+ 	<para>
+ 	By specifying these two configuration values, Tapestry can export private assets
+ 	to a directory that is visible to the client web browser.  The <literal>URL</literal>
+ 	value should map to the directory specified by the <literal>dir</literal> value.
+ 	</para>
+ 	</listitem>
+ </varlistentry>
+ 
+ <varlistentry>
+ 	<term>net.sf.tapestry.visit-class</term>
+ 	
+ 	<listitem>
+ 	<para>
+ 	The class name to instantiate as the 
+ 	<link linkend="intro.engine-service-visit">Visit object</link>.
+ 	</para>
+ 	</listitem>
+ </varlistentry>
+ 
+ 
+ <varlistentry>
+ 	<term>net.sf.tapestry.default-page-class</term>
+ 	
+ 	<listitem>
+ 	<para>
+ 	By default, any page that omits the
+ 	<varname>class</varname> attribute (in its &spec.page-specification;)
+ 	will be instantiated as &BasePage;.  If this is not desired,
+ 	the default may be overridden by specifying a fully
+ 	qualified class name.
+ 	</para>
+ 	</listitem>
+ </varlistentry>
+ 
+ <varlistentry>
+ 	<term>net.sf.tapestry.engine-class</term>
+ 	
+ 	<listitem>
+ 	<para>
+ 	The fully qualified class name to instantiate as the application engine.
+ 	This configuration value is only used when the 
+ 	application specification does not exist, or fails to
+ 	specify a class.  By default, &BaseEngine; is used if this configuration
+ 	value is also left unspecified.
+ 	</para>
+ 	</listitem>
+ </varlistentry>
+ 
+ </variablelist>
+ </para>
+ 
  </section>  <!-- configuration.search-path -->
+ 
+ 
  
  </chapter>

Index: TapestryUsersGuide.xml
===================================================================
RCS file: /cvsroot/tapestry/Tapestry/doc/src/UsersGuide/Attic/TapestryUsersGuide.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
*** TapestryUsersGuide.xml	27 Dec 2002 22:50:38 -0000	1.1.2.2
--- TapestryUsersGuide.xml	2 Jan 2003 03:17:41 -0000	1.1.2.3
***************
*** 25,29 ****
  <!ENTITY spec.configure '<link linkend="spec.configure"><sgmltag class="starttag">configure</sgmltag></link>'>
  <!ENTITY spec.component '<link linkend="spec.component"><sgmltag class="starttag">component</sgmltag></link>'>
! <!ENTITY spec.component-alias '<link linkend="spec.component-alias"><sgmltag class="starttag">component-alias</sgmltag></link>'>
  <!ENTITY spec.component-specification '<link linkend="spec.component-specification"><sgmltag class="starttag">component-specification</sgmltag></link>'>
  <!ENTITY spec.context-asset '<link linkend="spec.context-asset"><sgmltag class="starttag">context-asset</sgmltag></link>'>
--- 25,29 ----
  <!ENTITY spec.configure '<link linkend="spec.configure"><sgmltag class="starttag">configure</sgmltag></link>'>
  <!ENTITY spec.component '<link linkend="spec.component"><sgmltag class="starttag">component</sgmltag></link>'>
! <!ENTITY spec.component-type '<link linkend="spec.component-type"><sgmltag class="starttag">component-type</sgmltag></link>'>
  <!ENTITY spec.component-specification '<link linkend="spec.component-specification"><sgmltag class="starttag">component-specification</sgmltag></link>'>
  <!ENTITY spec.context-asset '<link linkend="spec.context-asset"><sgmltag class="starttag">context-asset</sgmltag></link>'>
***************
*** 31,35 ****
  <!ENTITY spec.extension '<link linkend="spec.extension"><sgmltag class="starttag">extension</sgmltag></link>'>
  <!ENTITY spec.external-asset '<link linkend="spec.external-asset"><sgmltag class="starttag">external-asset</sgmltag></link>'>
- <!ENTITY spec.field-binding '<link linkend="spec.field-binding"><sgmltag class="starttag">field-binding</sgmltag></link>'>
  <!ENTITY spec.inherited-binding '<link linkend="spec.inherited-binding"><sgmltag class="starttag">inherited-binding</sgmltag></link>'>
  <!ENTITY spec.library '<link linkend="spec.library"><sgmltag class="starttag">library</sgmltag></link>'>
--- 31,34 ----

Index: state.xml
===================================================================
RCS file: /cvsroot/tapestry/Tapestry/doc/src/UsersGuide/Attic/state.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
*** state.xml	30 Dec 2002 03:05:00 -0000	1.1.2.2
--- state.xml	2 Jan 2003 03:17:41 -0000	1.1.2.3
***************
*** 75,81 ****
  <programlisting>
  <![CDATA[
! <application name="Tapestry Component Workbench" 
! 	engine-class="net.sf.tapestry.engine.SimpleEngine">
!   <property name="net.sf.tapestry.visit-class">tutorial.workbench.Visit</property>
  
    ...
--- 75,80 ----
  <programlisting>
  <![CDATA[
! <application name="Tapestry Component Workbench">
!   <property name="net.sf.tapestry.visit-class" value="tutorial.workbench.Visit"/>
  
    ...
***************
*** 192,198 ****
  
  <para>
! Tapestry separates the persistant state of a page from any instance.  In Tapestry, a page may have many properties
  and may have many components, each with many properties but only a tiny number of all those
  properties needs to persist between request cycles.
  </para>
  
--- 191,208 ----
  
  <para>
! Tapestry separates the persistant state of a page from any instance.  This is very important, because
! from one request cycle to another, a different instance of the page may be used ... even when clustering is
! not used.  Again, Tapestry has many copies of any page in a pool, and pulls one instance out of the pool
! for each request.
! </para>
! 
! <para>
! In Tapestry, a page may have many properties
  and may have many components, each with many properties but only a tiny number of all those
  properties needs to persist between request cycles.
+ On a later request, the same or different page instance may be used.  With a little
+ assistance from the developer, 
+ the Tapestry framework can create the illusion that the same page instance is being used in
+ a later request.
  </para>
  
***************
*** 201,205 ****
  the framework of changes.  Tapestry will record the changes (using an &IPageRecorder;)
  and, in later request cycles, will restore the property
! using using the recorded value as the page instance is taken out of the page pool.
  </para>
  
--- 211,215 ----
  the framework of changes.  Tapestry will record the changes (using an &IPageRecorder;)
  and, in later request cycles, will restore the property
! using using the recorded value and whichever page instance is taken out of the page pool.
  </para>
  
***************
*** 277,281 ****
  By simply implementing this interface
  , Tapestry will register the component as a listener and ensure that
! it receives even notifications at the right time (this works for the two other
  page event interfaces, &PageRenderListener; and &PageCleanupListener; as well; simply
  implement the interface and leave the rest to the framework).
--- 287,291 ----
  By simply implementing this interface
  , Tapestry will register the component as a listener and ensure that
! it receives event notifications at the right time (this works for the two other
  page event interfaces, &PageRenderListener; and &PageCleanupListener; as well; simply
  implement the interface and leave the rest to the framework).

Index: spec.xml
===================================================================
RCS file: /cvsroot/tapestry/Tapestry/doc/src/UsersGuide/Attic/spec.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -C2 -d -r1.1.2.1 -r1.1.2.2
*** spec.xml	22 Dec 2002 13:47:58 -0000	1.1.2.1
--- spec.xml	2 Jan 2003 03:17:41 -0000	1.1.2.2
***************
*** 27,32 ****
  	<entry>application</entry>
  	<entry>&spec.application;</entry>
! 	<entry><literal>-//Howard Lewis Ship//Tapestry Specification 1.3//EN</literal></entry>
! 	<entry><literal>http://tapestry.sf.net/dtd/Tapestry_1_3.dtd</literal></entry>
  </row>
  
--- 27,32 ----
  	<entry>application</entry>
  	<entry>&spec.application;</entry>
! 	<entry><literal>-//Howard Lewis Ship//Tapestry Specification 1.4//EN</literal></entry>
! 	<entry><literal>http://tapestry.sf.net/dtd/Tapestry_1_4.dtd</literal></entry>
  </row>
  
***************
*** 35,40 ****
  	<entry>page</entry>
  	<entry>&spec.page-specification;</entry>
! 	<entry><literal>-//Howard Lewis Ship//Tapestry Specification 1.3//EN</literal></entry>
! 	<entry><literal>http://tapestry.sf.net/dtd/Tapestry_1_3.dtd</literal></entry>
  </row>
  
--- 35,40 ----
  	<entry>page</entry>
  	<entry>&spec.page-specification;</entry>
! 	<entry><literal>-//Howard Lewis Ship//Tapestry Specification 1.4//EN</literal></entry>
! 	<entry><literal>http://tapestry.sf.net/dtd/Tapestry_1_4.dtd</literal></entry>
  </row>
  
***************
*** 43,48 ****
  	<entry>jwc</entry>
  	<entry>&spec.component-specification;</entry>
! 	<entry><literal>-//Howard Lewis Ship//Tapestry Specification 1.3//EN</literal></entry>
! 	<entry><literal>http://tapestry.sf.net/dtd/Tapestry_1_3.dtd</literal></entry>
  </row>
  
--- 43,48 ----
  	<entry>jwc</entry>
  	<entry>&spec.component-specification;</entry>
! 	<entry><literal>-//Howard Lewis Ship//Tapestry Specification 1.4//EN</literal></entry>
! 	<entry><literal>http://tapestry.sf.net/dtd/Tapestry_1_4.dtd</literal></entry>
  </row>
  
***************
*** 51,56 ****
  	<entry>library</entry>
  	<entry>&spec.library-specification;</entry>
! 	<entry><literal>-//Howard Lewis Ship//Tapestry Specification 1.3//EN</literal></entry>
! 	<entry><literal>http://tapestry.sf.net/dtd/Tapestry_1_3.dtd</literal></entry>
  </row>
  
--- 51,56 ----
  	<entry>library</entry>
  	<entry>&spec.library-specification;</entry>
! 	<entry><literal>-//Howard Lewis Ship//Tapestry Specification 1.4//EN</literal></entry>
! 	<entry><literal>http://tapestry.sf.net/dtd/Tapestry_1_4.dtd</literal></entry>
  </row>
  
***************
*** 103,107 ****
  	<entry>name</entry>
  	<entry>string</entry>
! 	<entry>yes</entry>
  	<entry/>
  	<entry>User presentable name of application.</entry>
--- 103,107 ----
  	<entry>name</entry>
  	<entry>string</entry>
! 	<entry>no</entry>
  	<entry/>
  	<entry>User presentable name of application.</entry>
***************
*** 110,116 ****
  	<entry>engine-class</entry>
  	<entry>string</entry>
! 	<entry>yes</entry>
  	<entry/>
! 	<entry>Name of an implementation of IEngine to instantiate.</entry>
  </row>
  </tbody>
--- 110,117 ----
  	<entry>engine-class</entry>
  	<entry>string</entry>
! 	<entry>no</entry>
  	<entry/>
! 	<entry>Name of an implementation of &IEngine; to instantiate.  Defaults
! 	to &BaseEngine; if not specified.</entry>
  </row>
  </tbody>
***************
*** 124,128 ****
  <literallayout>
    &spec.description; *, &spec.property; *,
!   (&spec.page; | &spec.component-alias; | &spec.service; | &spec.library; | &spec.extension;) *
  </literallayout>
  </figure>
--- 125,129 ----
  <literallayout>
    &spec.description; *, &spec.property; *,
!   (&spec.page; | &spec.component-type; | &spec.service; | &spec.library; | &spec.extension;) *
  </literallayout>
  </figure>
***************
*** 445,449 ****
  <literallayout>
    &spec.property; *,
!   (&spec.binding; | &spec.field-binding; | &spec.inherited-binding; | &spec.static-binding; | &spec.string-binding;) *
  </literallayout>
  </figure>
--- 446,450 ----
  <literallayout>
    &spec.property; *,
!   (&spec.binding; | &spec.inherited-binding; | &spec.static-binding; | &spec.string-binding;) *
  </literallayout>
  </figure>
***************
*** 452,457 ****
  </section> <!-- spec.component -->
  
! <section id="spec.component-alias">
! 	<title><sgmltag class="starttag">component-alias</sgmltag> element</title>
  	
  <para>
--- 453,458 ----
  </section> <!-- spec.component -->
  
! <section id="spec.component-type">
! 	<title><sgmltag class="starttag">component-type</sgmltag> element</title>
  	
  <para>
***************
*** 465,469 ****
  
  <figure>
! 	<title><sgmltag class="starttag">component-alias</sgmltag> Attributes</title>
  <informaltable>
  <tgroup cols="5">
--- 466,470 ----
  
  <figure>
! 	<title><sgmltag class="starttag">component-type</sgmltag> Attributes</title>
  <informaltable>
  <tgroup cols="5">
***************
*** 498,502 ****
  </figure>
  
! </section> <!-- spec.component-alias -->
  
  
--- 499,503 ----
  </figure>
  
! </section> <!-- spec.component-type -->
  
  
***************
*** 537,545 ****
  	<entry>class</entry>
  	<entry>string</entry>
! 	<entry>yes</entry>
  	<entry/>
  	<entry>The Java class to instantiate, which must implement the
! 	interface &IComponent;.  Typically, this is
! 	&BaseComponent; or a subclass of it.</entry>
  </row>
  <row>
--- 538,546 ----
  	<entry>class</entry>
  	<entry>string</entry>
! 	<entry>no</entry>
  	<entry/>
  	<entry>The Java class to instantiate, which must implement the
! 	interface &IComponent;.  If not specified, &BaseComponent; is used.
! 	</entry>
  </row>
  <row>
***************
*** 821,896 ****
  </section> <!-- spec.external-asset -->
  
- <section id="spec.field-binding">
- 	<title><sgmltag class="starttag">field-binding</sgmltag> element</title>
- 
- <para>
- Appears in: &spec.component;
- </para>
- 
- <para>
- Binds a parameter of an embedded component to a public static final field.
- </para>
- 
- <note>
- <para>
- Although the same result can be accomplished using a &spec.binding;
- element and the OGNL expression
- <literal>@<replaceable>class-name</replaceable>@<replaceable>field-name</replaceable></literal>,
- using a <sgmltag class="starttag">field-binding</sgmltag>
- is more efficient, because Tapestry knows that the value is
- invariant.
- </para>
- </note>
- 
- <para>
- The class name must be the qualified class name.  If the package
- is ommitted, <literal>java.lang</literal> is assumed (this makes
- it easier to reference common fields
- such as <literal>Boolean.TRUE</literal>).
- </para>
- 
- <para>
- In an instantiated component, bindings can be accessed with
- the OGNL expression <literal>bindings.<replaceable>name</replaceable></literal>.
- </para>
- 
- 
- <figure>
- 	<title><sgmltag class="starttag">field-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 parameter to bind.</entry>
- </row>
- <row>
- 	<entry>field-name</entry>
- 	<entry>string</entry>
- 	<entry>yes</entry>
- 	<entry/>
- 	<entry>The name of a public static final field, in the form
- 	<literal><replaceable>class-name.field-name</replaceable></literal>.
- 	</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </figure>
- 
- 
- </section> <!-- spec.field-binding -->
  
  <section id="spec.inherited-binding">
--- 822,825 ----
***************
*** 1029,1033 ****
  <literallayout>
    &spec.description; *, &spec.property; *,
!   (&spec.page; | &spec.component-alias; | &spec.service; | &spec.library; | &spec.extension;) *
  </literallayout>
  </figure>
--- 958,962 ----
  <literallayout>
    &spec.description; *, &spec.property; *,
!   (&spec.page; | &spec.component-type; | &spec.service; | &spec.library; | &spec.extension;) *
  </literallayout>
  </figure>
***************
*** 1078,1082 ****
  	<entry/>
  	<entry>
! 	The complete resource path to the page's specification.
  	</entry>
  </row>
--- 1007,1013 ----
  	<entry/>
  	<entry>
! 	The path to the page's specification, which may be absolute
! 	 (start with a leading slash), or relative to the application or library
! 	 specification.
  	</entry>
  </row>
***************
*** 1120,1128 ****
  	<entry>class</entry>
  	<entry>string</entry>
! 	<entry>yes</entry>
  	<entry/>
  	<entry>The Java class to instantiate, which must implement the
  	interface &IPage;.  Typically, this is
! 	&BasePage; or a subclass of it.</entry>
  </row>
  </tbody>
--- 1051,1060 ----
  	<entry>class</entry>
  	<entry>string</entry>
! 	<entry>no</entry>
  	<entry/>
  	<entry>The Java class to instantiate, which must implement the
  	interface &IPage;.  Typically, this is
! 	&BasePage; or a subclass of it.  &BasePage; is the default if not otherwise
! 	 specified.</entry>
  </row>
  </tbody>
***************
*** 1332,1335 ****
--- 1264,1276 ----
  	<entry>The name of the property.</entry>
  </row>
+ <row>
+ 	<entry>value</entry>
+ 	<entry>string</entry>
+ 	<entry>no</entry>
+ 	<entry/>
+ 	<entry>The value for the property.  If omitted, the value is taken
+ 	from the character data (the text the tag wraps around).  If specified,
+ 	the character data is ignored.</entry>
+ </row>
  </tbody>
  </tgroup>
***************
*** 1558,1562 ****
  <para>
  Binds a parameter of an embedded component to a static value.  The value,
! which is stored as a string, is the wrapped contents
  of the <sgmltag class="starttag">static-binding</sgmltag> tag.  Leading
  and trailing whitespace is removed.
--- 1499,1505 ----
  <para>
  Binds a parameter of an embedded component to a static value.  The value,
! which is stored as a string, is specified
! as the <literal>value</literal> attribute, or as
! the wrapped contents
  of the <sgmltag class="starttag">static-binding</sgmltag> tag.  Leading
  and trailing whitespace is removed.
***************
*** 1589,1592 ****
--- 1532,1544 ----
  	<entry/>
  	<entry>The name of the parameter to bind.</entry>
+ </row>
+ <row>
+ 	<entry>value</entry>
+ 	<entry>string</entry>
+ 	<entry>no</entry>
+ 	<entry/>
+ 	<entry>The string value to be used.  If omitted, the wrapped character data
+ 	is used instead (which is more convienient if the value is large, or
+ 	contains problematic punctuation).</entry>
  </row>
  </tbody>



-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.