You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tapestry.apache.org by ms...@apache.org on 2007/08/25 22:05:41 UTC

svn commit: r569727 - in /tapestry/tapestry4/trunk/src/site/xdoc/usersguide: configuration.xml script.xml spec.xml

Author: mschulte
Date: Sat Aug 25 13:05:41 2007
New Revision: 569727

URL: http://svn.apache.org/viewvc?rev=569727&view=rev
Log:
fixes TAPESTRY-1680, removed/resolved out-of-date warnings in configuration docs.

Modified:
    tapestry/tapestry4/trunk/src/site/xdoc/usersguide/configuration.xml
    tapestry/tapestry4/trunk/src/site/xdoc/usersguide/script.xml
    tapestry/tapestry4/trunk/src/site/xdoc/usersguide/spec.xml

Modified: tapestry/tapestry4/trunk/src/site/xdoc/usersguide/configuration.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/usersguide/configuration.xml?rev=569727&r1=569726&r2=569727&view=diff
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/usersguide/configuration.xml (original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/usersguide/configuration.xml Sat Aug 25 13:05:41 2007
@@ -40,17 +40,13 @@
         </p>
 
         <dl>
-            <dt>Java 1.2.2</dt>
-            <dd>
-                Operates correctly. Requires the Xerces parser to be in the classpath (usually
-                provided by the servlet container).
-            </dd>
-            <dt>Java 1.3.x</dt>
-            <dd>
-                Operates correctly. Requires the Xerces parser to be in the classpath (usually
-                provided by the servlet container).
-            </dd>
-            <dt>Java 1.4.x (recommended)</dt>
+            <dt>Java 1.4.x</dt>
+            <dd>Operates correctly.</dd>
+            
+            <dt>Java 1.5.x (recommended)</dt>
+            <dd>Operates correctly. Annotation-configuration can be used.</dd>
+            
+            <dt>Java 1.6.x </dt>
             <dd>Operates correctly.</dd>
         </dl>
 
@@ -178,14 +174,9 @@
             </p>
 
             <p>
-            <span class="warn">
-                <strong>Fixme:</strong>
-                <p>
-                This documentation is out of date with respect to
-                <a href="http://hivemind.apache.org/hivemind1/">HiveMind</a>
-                . In 4.0, the servlet will create and initialize a HiveMind Registry.
-                </p>
-            </span>
+             Since Tapestry 4.0, the application specification is complemented and greatly 
+             extended by the <a href="hivemind.html">HiveMind configurations</a>.
+
             </p>
 
             <p>
@@ -230,7 +221,7 @@
 
         </subsection><!-- configuration.deployment-descriptor -->
 
-        <subsection name="Application Property Source">
+        <subsection name="Property Sources">
             <p>
                 Tapestry occasionally must obtain a value for a configuration property. These
                 configuration properties are items that are frequently optional, and don't fit into
@@ -239,12 +230,13 @@
             </p>
 
             <p>
-                Tapestry is very flexible about where values for such properties may be obtained. In
-                general, the search path for configuration properties is:
+                Tapestry is very flexible about where values for such properties may be obtained.
+                There are three kinds of property sources with different search paths which are used
+                in different contexts; these are: global, application and component property sources.
             </p>
 
-            <p>
-            <ul>
+             In general, the search path for configuration properties is:
+            <ul> 
                 <li>
                     As a
                     <a href="spec.html#spec.meta">&lt;meta&gt;</a>
@@ -267,7 +259,7 @@
                     symbols.
                 </li>
             </ul>
-            </p>
+            
 
             <p>
                 It is expected that some configuration properties are not defined at any level;
@@ -277,36 +269,40 @@
             <p>Applications are free to leverage this lookup mechanism as well.</p>
             
             <p>
-            <span class="info">
-                <strong>fixme:</strong>
-                <p>
-                    Need to reference the ApplicationPropertySource, GlobalPropertySource and ComponentPropertySource services here.
-                </p>
-            </span>
+             Within the framework the following three services provide access to properties
+             from the above-mentioned sources:
+             <ul>
+               <li> The <a href="../tapestry-framework/hivedoc/service/tapestry.props.ComponentPropertySource.html">
+                     ComponentPropertySource </a> serves the need of components, looking
+                     up properties starting at component-spec-level and working its way upwards</li>
+               <li> The <a href="../tapestry-framework/hivedoc/service/tapestry.props.ApplicationPropertySource.html">
+                     ApplicationPropertySource </a> provides access to application-scoped
+                     properties where "application" means tapestry application as opposed to web 
+                     application (see next item).</li>
+               <li> The <a href="../tapestry-framework/hivedoc/service/tapestry.props.GlobalPropertySource.html">
+                     GlobalPropertySource </a> provides access to much the same properties as the
+                     ApplicationPropertySource omitting the application-specification itself since
+                     there might be multiple tapestry applications living within the same
+                     web application.</li>
+              </ul>
+            
             </p>
             
             <p>
                 Applications may also want to change or augment the default search path; this is
-                accomplished by overriding
-                <a
-                    href="../apidocs/org/apache/tapestry/engine/AbstractEngine.html">
-                    AbstractEngine
-                </a>
-                method
-                <code>createPropertySource()</code>
+                accomplished by 
+                <ol> 
+                  <li> writing a HiveMind service implementing the interface
+                <a href="../apidocs/org/apache/tapestry/engine/IPropertySource.html">
+                    IPropertySource</a>
+                  </li>
+                <li> contributing it to the <a href="../tapestry-framework/hivedoc/config/tapestry.props.ApplicationPropertySources.html">tapestry.props.ApplicationPropertySource 
+                   configuration point</a></li>
+                </ol>
                 . For example, some configuration data could be drawn from a database.
             </p>
 
-            <p>
-            <span class="info">
-                <strong>Fixme:</strong>
-                <p>
-                The previous paragraph is out of date; extension of the search path will involve a
-                HiveMind contribution, details to be provided.
-                </p>
-            </span>
-            </p>
-
+            
         </subsection><!-- configuration.app-property-source -->
 
         <subsection name="Global Property Source">

Modified: tapestry/tapestry4/trunk/src/site/xdoc/usersguide/script.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/usersguide/script.xml?rev=569727&r1=569726&r2=569727&view=diff
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/usersguide/script.xml (original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/usersguide/script.xml Sat Aug 25 13:05:41 2007
@@ -96,6 +96,7 @@
   "http://jakarta.apache.org/tapestry/dtd/Script_3_0.dtd"&gt;</source>
             </subsection><!-- DOCTYPE -->
 
+			<a name="script.body"></a>
             <subsection name="&lt;body&gt; element">
 
 
@@ -116,6 +117,7 @@
                         href="#script.unique">&lt;unique&gt;</a>)*</source>
             </subsection>
 
+			<a name="script.foreach"></a>
             <subsection name="&lt;foreach&gt; element">
 
 
@@ -176,7 +178,7 @@
                         href="#script.unique">&lt;unique&gt;</a>)*</source>
             </subsection>
 
-
+			<a name="script.if"></a>
             <subsection name="&lt;if&gt; element">
 
 
@@ -223,6 +225,7 @@
 
             </subsection>
 
+			<a name="script.if-not"></a>
             <subsection name="&lt;if-not&gt; element">
 
 
@@ -237,7 +240,7 @@
             </subsection>
 
 
-
+			<a name="script.include-script"></a>
             <subsection name="&lt;include-script&gt; element">
 
 
@@ -280,6 +283,8 @@
                 </table>
 
             </subsection>
+            
+            <a name="script.initialization"></a>
             <subsection name="&lt;initialization&gt; element">
 
 
@@ -301,6 +306,7 @@
                         href="#script.unique">&lt;unique&gt;</a>)*</source>
             </subsection>
 
+			<a name="script.input-symbol"></a>
             <subsection name="&lt;input-symbol&gt; element">
 
 
@@ -357,7 +363,9 @@
                 </table>
 
             </subsection>
-
+            
+            
+			<a name="script.let"></a>
             <subsection name="&lt;let&gt; element">
 
 
@@ -424,7 +432,8 @@
 
 
             </subsection>
-
+	
+			<a name="script.script"></a>
             <subsection name="&lt;script&gt; element">
 
 
@@ -446,7 +455,7 @@
 
             </subsection><!-- script -->
 
-
+			<a name="script.set"></a>
             <subsection name="&lt;set&gt; element">
 
 
@@ -494,6 +503,7 @@
 
             </subsection><!-- script.set -->
 
+			<a name="script.unique"></a>
             <subsection name="&lt;unique&gt; element">
 
 

Modified: tapestry/tapestry4/trunk/src/site/xdoc/usersguide/spec.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/usersguide/spec.xml?rev=569727&r1=569726&r2=569727&view=diff
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/usersguide/spec.xml (original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/usersguide/spec.xml Sat Aug 25 13:05:41 2007
@@ -240,9 +240,10 @@
 
             </section><!-- changes -->
 
+			<a name="spec.property-injection"></a>
+			
             <section name="Property Injection">
-
-
+			
                 <p>
                     Several of the specification elements are concerned with
                     <a href="injection.html">property injection</a>
@@ -303,9 +304,10 @@
 
             </section>
 
+			<a name="spec.application"></a>
+			
             <section name="&lt;application&gt; element">
-
-
+            
 
                 <p>
                     <em>root element</em>
@@ -366,9 +368,10 @@
 
             </section><!-- spec.application -->
 
-
+			<a name="spec.asset"></a>
+			
             <section name="&lt;asset&gt; element">
-
+			
 
                 <p>
                     Specifies the location of an asset, a file (typically an image or stylesheet)
@@ -459,8 +462,10 @@
             </section><!-- spec.asset -->
 
 
+			<a name="spec.bean"></a>
+			
             <section name="&lt;bean&gt; element">
-
+			
 
                 <p>
                     Appears in:
@@ -596,8 +601,9 @@
 
             </section><!-- spec.bean -->
 
+			<a name="spec.binding"></a>
             <section name="&lt;binding&gt; element">
-
+			
 
                 <p>
                     Appears in:
@@ -694,8 +700,9 @@
 
             </section><!-- spec.binding -->
 
+			<a name="spec.component"></a>
             <section name="&lt;component&gt; element">
-
+			
 
                 <p>
                     Appears in:
@@ -806,9 +813,9 @@
 
 
 
-
+			<a name="spec.component-specification"></a>
             <section name="&lt;component-specification&gt; element">
-
+			
 
                 <p>
                     <em>root element</em>
@@ -928,8 +935,9 @@
             </section><!-- spec.component-specification -->
 
 
+			<a name="spec.component-type"></a>
             <section name="&lt;component-type&gt; element">
-
+			
 
                 <p>
                     Appears in:
@@ -979,8 +987,10 @@
 
             </section><!-- spec.component-type -->
 
+			<a name="spec.configure"></a>
+			
             <section name="&lt;configure&gt; element">
-
+			
 
                 <p>
                     Appears in:
@@ -1033,9 +1043,10 @@
             </section><!-- spec.configure -->
 
 
-
+			<a name="spec.description"></a>
+			
             <section name="&lt;description&gt; element">
-
+			
 
                 <p>
                     Appears in:
@@ -1059,8 +1070,10 @@
 
             </section><!-- spec.description -->
 
+			<a name="spec.extension"></a>
+			
             <section name="&lt;extension&gt; element">
-
+			
 
                 <p>
                     Appears in:
@@ -1127,8 +1140,9 @@
 
             </section><!-- spec.extension -->
 
+			<a name="spec.inject"></a>
             <section name="&lt;inject&gt; element">
-
+			
 
                 <p>
                     Appears in:
@@ -1196,8 +1210,9 @@
 
             </section><!-- spec.inject -->
 
-
+			<a name="spec.library"></a>
             <section name="&lt;library&gt; element">
+			
 
 
                 <p>
@@ -1257,8 +1272,10 @@
 
             </section><!-- spec.library -->
 
+			<a name="spec.library-specification"></a>
             <section name="&lt;library-specification&gt; element">
-
+			
+			
 
                 <p>
                     <em>root element</em>
@@ -1284,9 +1301,10 @@
 
             </section><!-- spec.library-specification -->
 
-
+			<a name="spec.meta"></a>
+			
             <section name="&lt;meta&gt; element">
-
+			
 
                 <p>
                     Appears in:
@@ -1339,9 +1357,9 @@
 
             </section><!-- spec.meta -->
 
-
+			<a name="spec.page"></a>
             <section name="&lt;page&gt; element">
-
+			
 
                 <p>
                     Appears in:
@@ -1393,8 +1411,9 @@
 
             </section><!-- spec.page -->
 
+			<a name="spec.page-specification"></a>
             <section name="&lt;page-specification&gt; element">
-
+			
 
                 <p>
                     <em>root element</em>
@@ -1463,8 +1482,9 @@
 
             </section><!-- spec.page-specification -->
 
+			<a name="spec.parameter"></a>
             <section name="&lt;parameter&gt; element">
-
+			
 
                 <p>
                     Appears in:
@@ -1599,6 +1619,8 @@
                 </span>
 
             </section><!-- spec.parameter -->
+            
+            <a name="property"></a>
             <section name="&lt;property&gt; element">
 
 
@@ -1702,8 +1724,9 @@
 
             </section><!-- spec.property -->
 
+			<a name="spec.reserved-parameter"></a>
             <section name="&lt;reserved-parameter&gt; element">
-
+			
 
                 <p>
                     Appears in:
@@ -1750,10 +1773,10 @@
 
 
             </section><!-- spec.reserved-parameter -->
-
-
+	
+			<a name="spec.set"></a>
             <section name="&lt;set&gt; element">
-
+			
 
                 <p>
                     Appears in: