myfaces-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From we...@apache.org
Subject svn commit: r936314 - in /myfaces/extensions/scripting/trunk/src/site: site.xml xdoc/configentries.xml xdoc/exampleconfig.xml xdoc/installation.xml xdoc/setup_steps.xml xdoc/using_advanced.xml xdoc/using_netbeans.xml
Date Wed, 21 Apr 2010 14:17:50 GMT
Author: werpu
Date: Wed Apr 21 14:17:50 2010
New Revision: 936314

URL: http://svn.apache.org/viewvc?rev=936314&view=rev
Log:
improving the documentation

Modified:
    myfaces/extensions/scripting/trunk/src/site/site.xml
    myfaces/extensions/scripting/trunk/src/site/xdoc/configentries.xml
    myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig.xml
    myfaces/extensions/scripting/trunk/src/site/xdoc/installation.xml
    myfaces/extensions/scripting/trunk/src/site/xdoc/setup_steps.xml
    myfaces/extensions/scripting/trunk/src/site/xdoc/using_advanced.xml
    myfaces/extensions/scripting/trunk/src/site/xdoc/using_netbeans.xml

Modified: myfaces/extensions/scripting/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/site.xml?rev=936314&r1=936313&r2=936314&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/site.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/site.xml Wed Apr 21 14:17:50 2010
@@ -52,8 +52,9 @@
       <item name="Installation Beta 1" href="install_beta_1.html" />
 
       <item name="Users Guide" href="usersguide.html"/>
-      <item name="Appendix A: Configuration Entries" href="configentries.html" />
-      <item name="Appendix B: Example Configurations" href="exampleconfig.html" />
+      <item name="Appendix A: Setup Checklist" href="setup_steps.html" />
+      <item name="Appendix B: Configuration Entries" href="configentries.html" />
+      <item name="Appendix C: Example Configurations" href="exampleconfig.html" />
     </menu>
 
     <menu name="Foundation">

Modified: myfaces/extensions/scripting/trunk/src/site/xdoc/configentries.xml
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/xdoc/configentries.xml?rev=936314&r1=936313&r2=936314&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/configentries.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/configentries.xml Wed Apr 21 14:17:50
2010
@@ -20,9 +20,9 @@
 -->
 <document>
     <section name="Navigation Top">
-        <a href="using_netbeans.html">&lt;&lt;Back to the Netbeans Users Guide</a>
+        <a href="setup_steps.html">&lt;&lt;Back to the appendix: Setup steps</a>
         or
-        <a href="exampleconfig.html">On to the Appendix: Example Configuration&gt;&gt;</a>
+        <a href="exampleconfig.html">On to the appendix: Example Configuration&gt;&gt;</a>
     </section>
     
     <section name="Appendix: Configuration Entries">
@@ -79,17 +79,20 @@
                     <td>Additional comma separated loader paths to allow direct editing
of resources on the sources
                         directory instead of editing in the deployment directory
                     </td>
+                    <td>Important notice, in most cases this path will point to the
root of your web application directory
+                    (ie: src/main/webapp in a standard Maven2 structure or &lt;project-root&gt;/webapp
for a standard
+                    Eclipse project structure)</td>
                 </tr>
                 <tr>
                     <td>facelets.RESOURCE_RESOLVER</td>
                     <td>NO</td>
                     <td>org.apache.myfaces.extensions.scripting.facelet.ReroutingResourceResolver</td>
-                    <td>Enables the loading of xhtml facelet pages from your sourcedir
if
+                    <td>Enables the loading of xhtml facelet pages from your source
directory, if
                         org.apache.myfaces.extensions.scripting.resource.LOADER_PATHS is
set properly
                     </td>
                 </tr>
                 <tr>
-                    <td>org.apache.myfaces. scripting.PGK_WHITELIST</td>
+                    <td>org.apache.myfaces.scripting.PGK_WHITELIST</td>
                     <td>NO</td>
                     <td>a comma separate list of whitelisted packages</td>
                     <td>Enables package whitelisting, a mechanism which allows to compile
and reload only from
@@ -108,7 +111,7 @@
         <section name="Navigation Bottom">
             <a href="using_netbeans.html">&lt;&lt;Back to the Netbeans Users
Guide</a>
             or
-            <a href="exampleconfig.html">On to the Appendix: Example Configuration&gt;&gt;</a>
+            <a href="exampleconfig.html">On to the appendix: Example Configuration&gt;&gt;</a>
         </section>
 
 

Modified: myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig.xml
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig.xml?rev=936314&r1=936313&r2=936314&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig.xml Wed Apr 21 14:17:50
2010
@@ -21,7 +21,7 @@
 
 <document>
     <section name="Navigation Top">
-        <a href="configentries.html">&lt;&lt;Appendix Configuration Entries</a>
+        <a href="configentries.html">&lt;&lt;appendix Configuration Entries</a>
     </section>
     <section name="Appendix: Example Configuration">
         <subsection name="General Information">
@@ -233,6 +233,6 @@
         </subsection>
     </section>
     <section name="Navigation Bottom">
-        <a href="configentries.html">&lt;&lt;Appendix Configuration Entries</a>
+        <a href="configentries.html">&lt;&lt;appendix Configuration Entries</a>
     </section>
 </document>    
\ No newline at end of file

Modified: myfaces/extensions/scripting/trunk/src/site/xdoc/installation.xml
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/xdoc/installation.xml?rev=936314&r1=936313&r2=936314&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/installation.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/installation.xml Wed Apr 21 14:17:50
2010
@@ -44,6 +44,26 @@
             </ul>
         </section>
 
+
+        <section name="Setup overview">
+            <subsection name="General Setup Information" >
+             <p>
+
+                Ext-Scripting has a complete appendix list over all configuration and setup
options
+                for a quick overview please visit the following links. If you need detailed
+                setup information, then read further on.
+             </p>
+            </subsection>
+            <subsection name="Links">
+                <p>
+                    <ul><a href="setup_steps.html">Appendix: Configuration Setup
Steps</a> </ul>
+                    <ul><a href="exampleconfig.html">Appendix: Example Configurations</a>
</ul>
+                    <ul><a href="configentries.html">Appendix: List of Configuration
Options</a> </ul>
+                </p>
+            </subsection>
+        </section>
+
+
         <section name="Checklist">
             <p>
 
@@ -193,7 +213,7 @@
     </filter>
     <filter-mapping>
         <filter-name>scriptingFilter</filter-name>
-        <url-pattern>/*</url-pattern>
+        <url-pattern>/*.jsf</url-pattern>
         <dispatcher>REQUEST</dispatcher>
         <dispatcher>FORWARD</dispatcher>
         <dispatcher>INCLUDE</dispatcher>
@@ -203,12 +223,16 @@
                     <b>MUST</b>
                     be set otherwise Ext-Scripting will not be enabled!
                 </p>
+                <p> For the filter pattern you can use every pattern which enables
your web pages,
+                the standard cases are, either <b>*.jsf</b> or <b>/faces/*</b>
+                Note you <b>must</b> use the same pattern as described in the
configuration
+                part of your Faces Servlet.</p>
                 <h4>Additional Optional Steps</h4>
                 <p>Ext-Scripting exposes a number configuration parameters which can
be set via context parameters in
                     your web.xml
                 </p>
 
-                <h4>Adjust the web.xml Root source paths</h4>
+                <h4>Adjust the web.xml Root source paths.</h4>
                 <p>Since the goal of Ext-Scripting is to provide scriptability to a
running web application, it has to
                     know where to find the sources. For this, a default location has been
chosen
                     according to the standards set by the Mojarra Groovy Extension.
@@ -272,6 +296,7 @@
 
             </subsection>
         </section>
+
         <section name="Navigation Bottom">
             <a href="index.html">&lt;&lt;Back to the Start Page</a>
             or

Modified: myfaces/extensions/scripting/trunk/src/site/xdoc/setup_steps.xml
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/xdoc/setup_steps.xml?rev=936314&r1=936313&r2=936314&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/setup_steps.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/setup_steps.xml Wed Apr 21 14:17:50 2010
@@ -24,43 +24,62 @@
 
     <body>
 
-        <section name="Short setup overview">
-            <p>This section is only a checklist of things to do at the setup for details
follow the explanations below
-            </p>
-
-            <p>
-                Manual setup
-                <ul>
-                    <li>Check if your installation environment is setup</li>
-                    <li>Download the appropriate meta bundle and place it in WEB-INF/lib</li>
-                    <li>Download groovy-all.jar and place it in WEB-INF/lib</li>
-                    <li>Prepare your script paths</li>
-                    <li>Add your web.xml entries</li>
-                    <li>mvn clean install ...</li>
-                </ul>
-            </p>
-            <p>
-                Build via maven
-                <ul>
-                    <li>Check if your installation environment is setup</li>
-                    <li>Add your pom xml dependencies and the repository entry</li>
-                    <li>Prepare your script paths</li>
-                    <li>Add your web.xml entries</li>
-                    <li>mvn clean install ...</li>
-                </ul>
-            </p>
-
-            <p>
-                Build via ide
-                <ul>
-                    <li>Check if your installation environment is setup</li>
-                    <li>Download the appropriate meta bundle and add it to your dependency
and deployment settings</li>
-                    <li>Download groovy-all.jar and add it to your dependency and deployment
settings</li>
-                    <li>Prepare your script paths</li>
-                    <li>Add your web.xml entries</li>
-                    <li>mvn clean install ...</li>
-                </ul>
-            </p>
+        <section name="Navigation Top">
+            <a href="using_netbeans.html">&lt;&lt;Back to the Netbeans Users
Guide</a>
+            or
+            <a href="configentries.html">On to the configuration entries overview&gt;&gt;</a>
         </section>
+
+        <section name="Appendix: Setup Steps">
+
+
+            <subsection name="Short setup overview">
+                <p>This section is only a checklist of things to do at the setup for
details follow the explanations
+                    below
+                </p>
+
+                <p>
+                    Manual setup
+                    <ul>
+                        <li>Check if your installation environment is setup</li>
+                        <li>Download the appropriate meta bundle and place it in WEB-INF/lib</li>
+                        <li>Download groovy-all.jar and place it in WEB-INF/lib</li>
+                        <li>Prepare your script paths</li>
+                        <li>Add your web.xml entries</li>
+                        <li>mvn clean install ...</li>
+                    </ul>
+                </p>
+                <p>
+                    Build via maven
+                    <ul>
+                        <li>Check if your installation environment is setup</li>
+                        <li>Add your pom xml dependencies and the repository entry</li>
+                        <li>Prepare your script paths</li>
+                        <li>Add your web.xml entries</li>
+                        <li>mvn clean install ...</li>
+                    </ul>
+                </p>
+
+                <p>
+                    Build via ide
+                    <ul>
+                        <li>Check if your installation environment is setup</li>
+                        <li>Download the appropriate meta bundle and add it to your
dependency and deployment settings
+                        </li>
+                        <li>Download groovy-all.jar and add it to your dependency and
deployment settings</li>
+                        <li>Prepare your script paths</li>
+                        <li>Add your web.xml entries</li>
+                        <li>mvn clean install ...</li>
+                    </ul>
+                </p>
+            </subsection>
+        </section>
+
+        <section name="Navigation Bottom">
+                   <a href="using_netbeans.html">&lt;&lt;Back to the Netbeans
Users Guide</a>
+                   or
+                   <a href="configentries.html">On to the configuration entries overview&gt;&gt;</a>
+               </section>
+
     </body>
 </document>
\ No newline at end of file

Modified: myfaces/extensions/scripting/trunk/src/site/xdoc/using_advanced.xml
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/xdoc/using_advanced.xml?rev=936314&r1=936313&r2=936314&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/using_advanced.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/using_advanced.xml Wed Apr 21 14:17:50
2010
@@ -250,15 +250,46 @@
                     changes on them can be watched on the fly simple by a browser reload.
There is no need to adjust
                     your web application server or your IDE for auto deployment mechanisms.
Unnecessary web application
                     restarts for changed resources can be avoided that way.
+                    <b>Note while page reloading works on the fly for both JSF 1.2
and JSF 2.x+, resource reloading
+                    only works for JSF2.x+, if you need similar functionality for JSF 1.x
 you can use
+                    a third party resource loading library like <a href="weblets.dev.java.net">Weblets</a>.
</b>
                 </p>
                 <center>
                     <img src="images/source-resource.jpg" width="557px" height="470px"
alt="Page and Resource Reloading"
                          title="Page and Resource Reloading"/>
                 </center>
             </subsection>
+            <subsection name="Setup and Usage">
+                <p> The central point of setting up your resource reloading are two
configuration parameters</p>
+                <ul>
+                    <li>org.apache.myfaces.extensions.scripting.resource.LOADER_PATHS</li>
+                    <li>facelets.RESOURCE_RESOLVER</li>
+                </ul>
+                <p>
+                The first parameter <b>org.apache.myfaces.extensions.scripting.resource.LOADER_PATHS</b>
defines
+                the root path for your resources (aka everything web related, like xhtml
facelet templates css files etc..).
+                Note, despite being called resource LOADER_PATH in most cases this path will
just be pointed
+                to the your <b>source web application root directory</b>.
+                (ie: src/main/webapp in a standard Maven2 structure or &lt;project-root&gt;/webapp
for a standard
+                    Eclipse project structure.
+                The name resource just refers to the fact that for Ext-Scripting every web
related file is seen as resource
+                </p>
+                <p>
+                    The second parameter <b>facelets.RESOURCE_RESOLVER</b> is
responsible for enabling the resouce loading
+                    of facelet templates and pages, since Facelets does not have an auto
plugging mechanism this has to be
+                    set to a standard value which is <b>org.apache.myfaces.extensions.scripting.facelet.ReroutingResourceResolver</b>
+                </p>
+                <p>
+                    For further reference please also visit out <a href="configentries.html">Appendix:
Configuration Entries Overview</a>
+                    page.
+                </p>
+            </subsection>
+
+
         </section>
 
 
+
         <section name="Advanced Dependency Detection">
             <p>
                 Ext-Scripting tries to avoid as many server restarts as possible. To enable
this it needs to unload

Modified: myfaces/extensions/scripting/trunk/src/site/xdoc/using_netbeans.xml
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/xdoc/using_netbeans.xml?rev=936314&r1=936313&r2=936314&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/using_netbeans.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/using_netbeans.xml Wed Apr 21 14:17:50
2010
@@ -27,7 +27,7 @@
         <section name="Navigation Top">
             <a href="using_intellij.html">&lt;&lt;Back to the Intellij Users
Guide</a>
             or
-            <a href="configentries.html">On to the Appendix: Config Entries&gt;&gt;</a>
+            <a href="setup_steps.html">On to the appendix: Setup Steps&gt;&gt;</a>
         </section>
 
 
@@ -98,7 +98,7 @@
         <section name="Navigation Bottom">
             <a href="using_intellij.html">&lt;&lt;Back to the Intellij Users
Guide</a>
             or
-            <a href="configentries.html">On to the Appendix: Config Entries&gt;&gt;</a>
+            <a href="configentries.html">On to the appendix: Config Entries&gt;&gt;</a>
         </section>
 
     </body>



Mime
View raw message