You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by we...@apache.org on 2012/03/19 16:26:05 UTC
svn commit: r1302504 - in /myfaces/extensions/scripting/trunk/src/site/xdoc:
configentries.xml configentries_102.xml exampleconfig.xml
exampleconfig_102.xml install_102.xml installation.xml
Author: werpu
Date: Mon Mar 19 15:26:04 2012
New Revision: 1302504
URL: http://svn.apache.org/viewvc?rev=1302504&view=rev
Log:
https://issues.apache.org/jira/browse/EXTSCRIPT-157 moving on with the 1.0.3 documentation and splitting off the 1.0.2 and earlier docs
Added:
myfaces/extensions/scripting/trunk/src/site/xdoc/configentries_102.xml
- copied, changed from r1302416, myfaces/extensions/scripting/trunk/src/site/xdoc/configentries.xml
myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig_102.xml
- copied, changed from r1302416, myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig.xml
myfaces/extensions/scripting/trunk/src/site/xdoc/install_102.xml
- copied, changed from r1302416, myfaces/extensions/scripting/trunk/src/site/xdoc/installation.xml
Modified:
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
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=1302504&r1=1302503&r2=1302504&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/configentries.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/configentries.xml Mon Mar 19 15:26:04 2012
@@ -48,13 +48,6 @@
<td>org.apache.myfaces.extensions.scripting.servlet.StartupServletContextPluginChainLoader</td>
<td>MyFaces Extension Point Setup</td>
</tr>
- <tr>
- <td>scriptingFilter</td>
- <td>YES</td>
- <td></td>
- <td>The scripting filter for further information look <a href="#scriptingFilter">below</a></td>
- </tr>
-
<tr>
<td>org.apache.myfaces.extensions.scripting.groovy.LOADER_PATHS</td>
Copied: myfaces/extensions/scripting/trunk/src/site/xdoc/configentries_102.xml (from r1302416, myfaces/extensions/scripting/trunk/src/site/xdoc/configentries.xml)
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/xdoc/configentries_102.xml?p2=myfaces/extensions/scripting/trunk/src/site/xdoc/configentries_102.xml&p1=myfaces/extensions/scripting/trunk/src/site/xdoc/configentries.xml&r1=1302416&r2=1302504&rev=1302504&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/configentries.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/configentries_102.xml Mon Mar 19 15:26:04 2012
@@ -22,7 +22,7 @@
<section name="Navigation Top">
<a href="setup_steps.html"><<Back to the appendix: Setup steps</a>
or
- <a href="exampleconfig.html">On to the appendix: Example Configuration>></a>
+ <a href="exampleconfig_102.html">On to the appendix: Example Configuration>></a>
</section>
<section name="Appendix: Configuration Entries">
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=1302504&r1=1302503&r2=1302504&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig.xml Mon Mar 19 15:26:04 2012
@@ -52,24 +52,6 @@
<param-value>org.apache.myfaces.extensions.scripting.servlet.StartupServletContextPluginChainLoader</param-value>
</context-param>
- <!-- ======================================================================================
- Scripting Filter
- Second step to enable Ext-Scripting
- ====================================================================================== -->
- <filter>
- <filter-name>scriptingFilter</filter-name>
- <filter-class>org.apache.myfaces.extensions.scripting.servlet.ScriptingServletFilter</filter-class>
- </filter>
- <filter-mapping>
- <filter-name>scriptingFilter</filter-name>
- <url-pattern>/*</url-pattern>
- <dispatcher>REQUEST</dispatcher>
- <dispatcher>FORWARD</dispatcher>
- <dispatcher>INCLUDE</dispatcher>
- <dispatcher>ERROR</dispatcher>
- </filter-mapping>
-
-
<!-- Faces Servlet -->
<servlet>
<servlet-name>Faces Servlet</servlet-name>
@@ -189,18 +171,7 @@
<param-value>Development</param-value>
</context-param>
- <filter>
- <filter-name>scriptingFilter</filter-name>
- <filter-class>org.apache.myfaces.extensions.scripting.servlet.ScriptingServletFilter</filter-class>
- </filter>
- <filter-mapping>
- <filter-name>scriptingFilter</filter-name>
- <url-pattern>/*</url-pattern>
- <dispatcher>REQUEST</dispatcher>
- <dispatcher>FORWARD</dispatcher>
- <dispatcher>INCLUDE</dispatcher>
- <dispatcher>ERROR</dispatcher>
- </filter-mapping>
+
<!-- Listener, to allow Jetty serving MyFaces apps -->
<listener>
Copied: myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig_102.xml (from r1302416, myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig.xml)
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig_102.xml?p2=myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig_102.xml&p1=myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig.xml&r1=1302416&r2=1302504&rev=1302504&view=diff
==============================================================================
(empty)
Copied: myfaces/extensions/scripting/trunk/src/site/xdoc/install_102.xml (from r1302416, myfaces/extensions/scripting/trunk/src/site/xdoc/installation.xml)
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/xdoc/install_102.xml?p2=myfaces/extensions/scripting/trunk/src/site/xdoc/install_102.xml&p1=myfaces/extensions/scripting/trunk/src/site/xdoc/installation.xml&r1=1302416&r2=1302504&rev=1302504&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/installation.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/install_102.xml Mon Mar 19 15:26:04 2012
@@ -32,9 +32,17 @@
</section>
<section name="General information">
- This page covers the general installation and integration process, it does not
- go into the details of the configuration.
+ This page covers the general installation and integration process of Apache MyFaces Extension scripting
+ 1.0.2 or earlier,it does not go into the details of the configuration.
+ As of ext-script 1.0.3 a number of legacy dependencies are dropped for easier maintainability such as
+ <ul>
+ <li>Support for Java 5 and earlier</li>
+ <li>Support for MyFaces 1.2.x</li>
+ <li>Support for Servlet 2.5 and earlier</li>
+ </ul>
+
+ If you need to use Ext-Scripting with one of those configurations stick to 1.0.2.
The section covers the setup via download or custom build. If you need configuration detail info
or info on how to setup your ide correctly please follow the links in the navigation to
@@ -55,8 +63,9 @@
<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>
+ <ul><a href="exampleconfig_102.html">Appendix: Example Configurations for 1.0.2 or earlier</a>
+ </ul>
+ <ul><a href="configentries_102.html">Appendix: List of Configuration Options for 1.02 or earlier</a> </ul>
</p>
</subsection>
</section>
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=1302504&r1=1302503&r2=1302504&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/installation.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/installation.xml Mon Mar 19 15:26:04 2012
@@ -105,7 +105,8 @@
</p>
<ul>
<li>A valid Subversion client</li>
- <li>Java 5 or higher</li>
+ <li>A valid servlet 3.0+ container</li>
+ <li>Java 6 or higher</li>
<li>Maven 2.0.9 or higher</li>
</ul>
<p>
@@ -165,15 +166,9 @@
</p>
<p/>
- <h4>MyFaces 1.2.8+</h4>
- <source><![CDATA[
- <dependency>
- <groupId>org.apache.myfaces.extensions.scripting</groupId>
- <artifactId>extscript-myfaces12-bundle</artifactId>
- <version>1.0-SNAPSHOT</version>
- </dependency>]]></source>
- <h4>MyFaces 2.+</h4>
+
+ <h4>MyFaces 2.1+</h4>
<source><![CDATA[
<dependency>
<groupId>org.apache.myfaces.extensions.scripting</groupId>
@@ -186,14 +181,12 @@
<subsection name="Manual Setup">
<p>If you do not like Maven or you prefer a manual setup, Ext-Scripting provides convenient meta bundles.
A manual setup
- comes down to the task of adding the appropriate meta bundle (extscript-myfaces12-bundle or
- extscript-myfaces20-bundle)
+ comes down to the task of adding the appropriate meta bundle (extscript-myfaces20-bundle)
to your WEB-INF/lib directory and adding a groovy-all.jar as additional dependency.
</p>
<p>you can obtain both jars after the build from:
<ul>
- <li><yourbuilderoot>/extscript-bundles/extscript-myfaces12-bundle/target/extscript-myfaces12-bundle-1.0-SNAPSHOT.jar</li>
- <li><yourbuilderoot>/extscript-bundles/extscript-myfaces20-bundle/target/extscript-myfaces20-bundle-1.0-SNAPSHOT.jar</li>
+ <li><yourbuilderoot>/extscript-bundles/extscript-myfaces20-bundle/target/extscript-myfaces20-bundle-1.0.3-SNAPSHOT.jar</li>
</ul>
</p>
<p>After having done that you are ready to setup the rest of the Ext-Scripting configuration manually as
@@ -203,7 +196,7 @@
<subsection name="Preparing the Necessary web.xml Entries">
- <h4>First Step</h4>
+ <h4>Most important step</h4>
<p>To enable Ext-Scripting you also have to add several entries to your web.xml file.</p>
<p>First a context param has to be set which attaches the Ext-Scripting plugins to MyFaces</p>
@@ -217,29 +210,7 @@
org.apache.myfaces.extensions.scripting.servlet.StartupServletContextPluginChainLoader
</param-value>
</context-param>]]></source>
- <h4>Second Step</h4>
- <p>Add Ext-Scriptings servlet filter to your servlet configuration</p>
- <source><![CDATA[
- <filter>
- <filter-name>scriptingFilter</filter-name>
- <filter-class>org.apache.myfaces.extensions.scripting.servlet.ScriptingServletFilter</filter-class>
- </filter>
- <filter-mapping>
- <filter-name>scriptingFilter</filter-name>
- <url-pattern>/*.jsf</url-pattern>
- <dispatcher>REQUEST</dispatcher>
- <dispatcher>FORWARD</dispatcher>
- <dispatcher>INCLUDE</dispatcher>
- <dispatcher>ERROR</dispatcher>
- </filter-mapping>]]></source>
- <p>The init parameter and the servlet filter
- <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
@@ -307,6 +278,25 @@
</li>
</ul>
+ <h4>Dynamic resource reloading</h4>
+ <p>additionally Ext-Scripting allows the reloading of dynamic webresources
+ like facelets templates images css files etc... For that additiona an additional config param is
+ available
+ </p>
+ <p>
+ <ul>
+ <li>
+ <b>org.apache.myfaces.extensions.scripting.resources.LOADER_PATHS</b>
+ This parameter points to the root of your dynamic resources, usually the same dir
+ as the root of your web application.
+ </li>
+ <li><b>facelets.RESOURCE_RESOLVER</b> also needs to be set to <b>org.apache.myfaces.extensions.scripting.facelet.ReroutingResourceResolver</b> if
+ you want dynamic facelet reloading enabled</li>
+ </ul>
+ </p>
+ This sums up the quick install and setup guide, if you want more detailed setup examples
+ go to our <a href="exampleconfig.html">Example Configurations</a> page, which shows
+ a set of different configurations.
</subsection>
</section>