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 2010/03/15 14:55:17 UTC
svn commit: r923229 - in /myfaces/extensions/scripting/trunk/src/site:
resources/images/ xdoc/
Author: werpu
Date: Mon Mar 15 13:55:17 2010
New Revision: 923229
URL: http://svn.apache.org/viewvc?rev=923229&view=rev
Log:
https://issues.apache.org/jira/browse/EXTSCRIPT-41
splitting up the users guide adding new chapters
Added:
myfaces/extensions/scripting/trunk/src/site/resources/images/intellij_source.jpg
myfaces/extensions/scripting/trunk/src/site/resources/images/netbeans_source1.jpg
myfaces/extensions/scripting/trunk/src/site/resources/images/netbeans_source2.jpg
myfaces/extensions/scripting/trunk/src/site/xdoc/using_advanced.xml
- copied, changed from r923228, myfaces/extensions/scripting/trunk/src/site/xdoc/usersguide.xml
myfaces/extensions/scripting/trunk/src/site/xdoc/using_general.xml (with props)
myfaces/extensions/scripting/trunk/src/site/xdoc/using_intellij.xml (with props)
myfaces/extensions/scripting/trunk/src/site/xdoc/using_netbeans.xml (with props)
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/index.xml
myfaces/extensions/scripting/trunk/src/site/xdoc/installation.xml
myfaces/extensions/scripting/trunk/src/site/xdoc/usersguide.xml
Added: myfaces/extensions/scripting/trunk/src/site/resources/images/intellij_source.jpg
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/resources/images/intellij_source.jpg?rev=923229&view=auto
==============================================================================
Files myfaces/extensions/scripting/trunk/src/site/resources/images/intellij_source.jpg (added) and myfaces/extensions/scripting/trunk/src/site/resources/images/intellij_source.jpg Mon Mar 15 13:55:17 2010 differ
Added: myfaces/extensions/scripting/trunk/src/site/resources/images/netbeans_source1.jpg
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/resources/images/netbeans_source1.jpg?rev=923229&view=auto
==============================================================================
Files myfaces/extensions/scripting/trunk/src/site/resources/images/netbeans_source1.jpg (added) and myfaces/extensions/scripting/trunk/src/site/resources/images/netbeans_source1.jpg Mon Mar 15 13:55:17 2010 differ
Added: myfaces/extensions/scripting/trunk/src/site/resources/images/netbeans_source2.jpg
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/resources/images/netbeans_source2.jpg?rev=923229&view=auto
==============================================================================
Files myfaces/extensions/scripting/trunk/src/site/resources/images/netbeans_source2.jpg (added) and myfaces/extensions/scripting/trunk/src/site/resources/images/netbeans_source2.jpg Mon Mar 15 13:55:17 2010 differ
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=923229&r1=923228&r2=923229&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/configentries.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/configentries.xml Mon Mar 15 13:55:17 2010
@@ -19,6 +19,12 @@
-->
<document>
+ <section name="Navigation Top">
+ <a href="using_netbeans.html"><<Back to the Netbeans Users Guide</a>
+ or
+ <a href="exampleconfig.html">On to the Appendix: Example Configuration>></a>
+ </section>
+
<section name="Appendix: Configuration Entries">
<subsection name="General Information">
<p>
@@ -98,5 +104,13 @@
</tr>
</tbody>
</table>
+
+ <section name="Navigation Bottom">
+ <a href="using_netbeans.html"><<Back to the Netbeans Users Guide</a>
+ or
+ <a href="exampleconfig.html">On to the Appendix: Example Configuration>></a>
+ </section>
+
+
</section>
</document>
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=923229&r1=923228&r2=923229&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/exampleconfig.xml Mon Mar 15 13:55:17 2010
@@ -20,6 +20,9 @@
-->
<document>
+ <section name="Navigation Top">
+ <a href="configentries.html"><<Appendix Configuration Entries</a>
+ </section>
<section name="Appendix: Example Configuration">
<subsection name="General Information">
<p>
@@ -30,7 +33,7 @@
</subsection>
<subsection name="Simple Configuration">
- <source><![CDATA[
+ <source><![CDATA[
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
@@ -89,7 +92,7 @@
]]></source>
</subsection>
<subsection name="Full Configuration">
- <source><![CDATA[
+ <source><![CDATA[
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
@@ -229,4 +232,7 @@
]]></source>
</subsection>
</section>
+ <section name="Navigation Bottom">
+ <a href="configentries.html"><<Appendix Configuration Entries</a>
+ </section>
</document>
\ No newline at end of file
Modified: myfaces/extensions/scripting/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/xdoc/index.xml?rev=923229&r1=923228&r2=923229&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/index.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/index.xml Mon Mar 15 13:55:17 2010
@@ -25,11 +25,16 @@
</properties>
<body>
+ <section name="Navigation Top">
+ <a href="installation.html">On to the General Installation Guide>></a>
+ </section>
+
<section name="Introduction">
<subsection name="General Introduction">
<p>Welcome and hello to MyFaces Extension-Scripting, short Ext-Scripting. Ext-Scripting is an extensions
- project for MyFaces. It tries to add scripting and rapid prototyping (artifact level hot deployment) capabilities to JSF by adding
+ project for MyFaces. It tries to add scripting and rapid prototyping (artifact level hot deployment)
+ capabilities to JSF by adding
scripting languages and JSP like recompilation mechanisms.
Following link to the a video on YouTube shows you what Ext-Scripting can do for you:
@@ -38,7 +43,8 @@
<p>
<center>
<object width="640px" height="480px">
- <param name="movie" value="http://www.youtube.com/v/vUCCTCMjTPE&hl=de_DE&fs=1&"></param>
+ <param name="movie"
+ value="http://www.youtube.com/v/vUCCTCMjTPE&hl=de_DE&fs=1&"></param>
<param name="allowFullScreen" value="true"></param>
<param name="allowscriptaccess" value="always"></param>
<embed src="http://www.youtube.com/v/vUCCTCMjTPE&hl=de_DE&fs=1&"
@@ -48,7 +54,8 @@
</center>
</p>
<p>
- As the video shows, you can make changes to almost all JSF artifacts on the fly, and at the next reload the
+ As the video shows, you can make changes to almost all JSF artifacts on the fly, and at the next
+ reload the
changes are present. The result is a reduction in server restarts and better turn around times. The
same rapid prototyping approach which is normally present in scripting languages and scripting
language based frameworks.
@@ -60,7 +67,7 @@
</subsection>
</section>
- <section name="Documentation">
+ <section name="Documentation">
<p>
Ext-Scritpting provides extensive documentation. Feel free
to browse our
@@ -112,6 +119,9 @@
</section>
+ <section name="Navigation Bottom">
+ <a href="installation.html">On to the General Installation Guide>></a>
+ </section>
</body>
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=923229&r1=923228&r2=923229&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/installation.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/installation.xml Mon Mar 15 13:55:17 2010
@@ -24,6 +24,14 @@
</properties>
<body>
+ <section name="Navigation Top">
+ <a href="index.html"><<Back to the Start Page</a>
+ or
+
+ <a href="using_general.html">On to the General Users Guide>></a>
+ </section>
+
+
<section name="Checkout and Build">
<p>
Currently as time of writing, Ext-Scripting does not have a release yet, so the only means of
@@ -42,14 +50,14 @@
<li>Maven 2.0.9 or higher</li>
</ul>
<p>
- After checkout, a full build can be obtained from the root directory of your checkout via <b>mvn
+ After checkout, a full build can be obtained from the root directory of your checkout via<b>mvn
clean install</b>.
</p>
<p>
Once finished, a valid build is installed, which can be used further on. Additionally you can find
two blueprint projects which you can use as starting points for your own projects under
<b><checkoutDir>/examples</b>
- , which can be kickstarted via <b>mvn jetty:run-exploded</b>.
+ , which can be kickstarted via<b>mvn jetty:run-exploded</b>.
</p>
</section>
<section name="Setup of Ext-Scripting">
@@ -194,13 +202,26 @@
</param-value>
</context-param>
]]></source>
- <ul>
- <li><b>org.apache.myfaces.scripting.groovy.LOADER_PATHS</b> can be a comma separated list of paths which point to the actual Groovy sources.</li>
- <li><b>org.apache.myfaces.scripting.java.LOADER_PATHS</b> does the same for Java sources..</li>
- </ul>
+ <ul>
+ <li>
+ <b>org.apache.myfaces.scripting.groovy.LOADER_PATHS</b>
+ can be a comma separated list of paths which point to the actual Groovy sources.
+ </li>
+ <li>
+ <b>org.apache.myfaces.scripting.java.LOADER_PATHS</b>
+ does the same for Java sources..
+ </li>
+ </ul>
</subsection>
</section>
+ <section name="Navigation Bottom">
+ <a href="index.html"><<Back to the Start Page</a>
+ or
+
+ <a href="using_general.html">On to the General Users Guide>></a>
+ </section>
+
</body>
</document>
\ No newline at end of file
Modified: myfaces/extensions/scripting/trunk/src/site/xdoc/usersguide.xml
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/xdoc/usersguide.xml?rev=923229&r1=923228&r2=923229&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/usersguide.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/usersguide.xml Mon Mar 15 13:55:17 2010
@@ -24,6 +24,12 @@
</properties>
<body>
+ <section name="Navigation Top">
+ <a href="installation.html"><<Back to the Setup Guide</a> or
+ <a href="using_general.html">On to the General Users Guide>></a>
+ </section>
+
+
<section name="Users Guide">
<p>
After having set up MyFaces Ext-Scripting (if you do not have done so please go to our<a
@@ -72,379 +78,31 @@
but you are on your own.
</p>
</section>
- <section name="usage">
- <p>
- Using Ext-Scripting once properly setup is straight forward. Usually it comes down to editing, reloading
- on
- the browser editing, reloading the page, .... However if you edit within a running configurations keep
- an
- eye on the console/log output. All compile errors and messages go automatically into the log.
- </p>
- <center>
- <img src="images/development-states.jpg" width="386px" height="337px"/>
- </center>
- <div class="objectAnnotation">Image: Development Lifecycle</div>
-
- <p>
- The development cycle also can seen in the following video (which is the same as on our
- <a href="index.html">Introduction page</a>)
- and in the following videos in the Users Guide.
- </p>
- <center>
- <object width="640px" height="480px">
- <param name="movie"
- value="http://www.youtube.com/v/vUCCTCMjTPE&hl=de_DE&fs=1&"></param>
- <param name="allowFullScreen" value="true"></param>
- <param name="allowscriptaccess" value="always"></param>
- <embed src="http://www.youtube.com/v/vUCCTCMjTPE&hl=de_DE&fs=1&"
- type="application/x-shockwave-flash" allowscriptaccess="always"
- allowfullscreen="true" width="640px" height="480px"></embed>
- </object>
- </center>
- <div class="objectAnnotation">Video: Development Lifecycle in Action</div>
-
- <p>
- As you can see, there is no need for any recompile anymore, no server restart
- everything is done dynamically, and you get instant results.
- </p>
- </section>
-
- <section name="Advanced Features">
- <p>
- Under normal circumstances you, should be set up by now and you can start coding happily.
- However since this is a framework based reloading mechanism it is wise to dig a little bit deeper
- and to know what is happening under the hood and why things behave like they do.
- If you are interested then read on.
- </p>
- </section>
-
- <section name="Helper Components">
- <subsection name="Overview">
- <p>Additionally to the standard reloading feature, Ext-Scripting provides two components
- which hopefully will make the life of every programmer easier.
- </p>
- <br/>
- <ul>
- <li>The Compiler Output Component</li>
- <li>The Change History Component</li>
- </ul>
- <p>
- Note currently and for the foreseeable future only Facelets as page description language
- will be supported by the components.
- </p>
- </subsection>
-
- <subsection name="Setup">
- <p>To use the components following namespace has to be included</p>
- <p>
- <source><![CDATA[xmlns:exs="http://myfaces.apache.org/ext-scripting"]]></source>
- </p>
- <p>Example</p>
- <p>
- <source><![CDATA[
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xmlns:ui="http://java.sun.com/jsf/facelets"
- xmlns:f="http://java.sun.com/jsf/core"
- xmlns:exs="http://myfaces.apache.org/ext-scripting"
- xmlns:h="http://java.sun.com/jsf/html">
-<h:head>]]></source>
- </p>
- </subsection>
-
- <subsection name="The Compiler Output Component">
- <p>One of the cornerstones of Ext-Scripting is the dynamic recompilation.
- Every file changed, is reloaded, while you hit refresh on the browser.
- </p>
- <p>
- Now, under normal circumstances, the compiler errors and warnings are written to the console log
- as following:
- <source><![CDATA[
- Java Compiler, Error on line:
- org/apache/myfaces/javaloader/blog/Blog.java:30:
- class, interface, or enum expected30]]></source>
- </p>
- <p>
- Now, trying to catch those errors within the log is "mildly spoken" annoying
- and time consuming.
- Exactly for bypassing this problem a compiler output component
- can be used either in your page or preferably in a second page.
-
- </p>
- <p>The following Video shows the compiler output component in action</p>
- <p>
- <center>
- <object width="640px" height="505px">
- <param name="movie"
- value="http://www.youtube.com/v/v56ru9ZJyhQ&hl=de_DE&fs=1&hd=1"></param>
- <param name="allowFullScreen" value="true"></param>
- <param name="allowscriptaccess" value="always"></param>
- <embed src="http://www.youtube.com/v/v56ru9ZJyhQ&hl=de_DE&fs=1&hd=1"
- type="application/x-shockwave-flash" allowscriptaccess="always"
- allowfullscreen="true"
- width="640px" height="505px"></embed>
- </object>
- </center>
- <div class="objectAnnotation">Video: Compiler Component in Action</div>
-
- </p>
- <p>
- <h4>Usage of the Compiler Output Component</h4>
- </p>
- <p>The compiler output component currently is presented as Facelets only component as follows</p>
- <source>
- <![CDATA[<exs:compilerOutput errorsLabel="Errors:" warningsLabel="Warnings:" scriptingLanguage=""/>]]></source>
-
- <p>Following attributes can be used</p>
- <p>
- <table>
- <thead>
- <tr>
- <td>Attribute Name</td>
- <td>Possible Values</td>
- <td>Description</td>
- </tr>
- </thead>
- <tr>
- <td>errorsLabel</td>
- <td>All values are allowed</td>
- <td>A Label which is displayed in above all errors to notify the user that the error section
- starts here
- </td>
- </tr>
- <tr>
- <td>WarningsLabel</td>
- <td>All values are allowed</td>
- <td>A Label which is displayed in above all errors to notify the user that the warning
- section
- starts here
- </td>
- </tr>
- <tr>
- <td>scriptingLanguage</td>
- <td>Java, Groovy or an empty String</td>
- <td>Scripting language filter, here you can set which scripting engines
- compile errors should be displayed, currently Java or Groovy are supported as values
- if you leave the attribute empty or set nothing then everything is displayed
- </td>
- </tr>
-
- </table>
- </p>
-
- <img src="images/compiler_output.png" width="600px" height="270px" alt="Image Compiler Output"
- title="Image Compiler Output"/>
- <div class="objectAnnotation">Image: Compiler Output Component</div>
- </subsection>
- <subsection name="The Change History Component">
- <p>The second cornerstone of Ext-Scripting is change tracking and dependency detection.
- Now if you have changed a file, Ext-Scripting tracks the changes and also marks
- most classes which have a dependency to your class as changed.
- </p>
- <p>
- Again usually the output is pushed into the log as following:
- </p>
- <p>
- <source>
- <![CDATA[INFO: [EXT-SCRIPTING] Tainting: org/apache/myfaces/javaloader/componentTest/MyComponentTag.java]]></source>
- </p>
- <p>
- Again, to get a quick overview within your running page, or preferably an extra page, you can use
- a specialized component which gives you a quick overview over the change history of the system.
- </p>
- <p>
- Here our change history component comes into play. With it you can track a certain number of changes
- done over time including their marked dependencies.
- </p>
- <p>
- <center>
- <img src="images/change_history.jpg" width="550px" height="45px" alt="change history component"
- />
- <div class="objectAnnotation">Image: Change History Component in Action</div>
- </center>
- </p>
- </subsection>
-
- <p>
- <h4>Usage</h4>
- </p>
- <p>The change history component can be currently used in Facelets only as follows</p>
- <source><![CDATA[<exs:taintHistory noEntries="5" />]]></source>
-
-
- <p>Following attributes can be used</p>
- <p>
- <table>
- <thead>
- <tr>
- <td>Attribute Name</td>
- <td>Possible Values</td>
- <td>Description</td>
- </tr>
- </thead>
- <tr>
- <td>noEntries</td>
- <td>The <Integer Value> number of entries of the current history</td>
- <td>A positive Integer value which shows the last N entries of your history
- beginning with the latest change marker on top
- </td>
- </tr>
-
- </table>
- </p>
-
- </section>
-
- <section name="Debugging">
- <p>Ext-Scripting automatically compiles with the debug flags on. Debugging against a running configuration
- should be no problem. If the debugger can be pointed towards the sources, debugging should work without
- any sideeffects.
- </p>
- <p>
- Due to the fact that the debugger can pick up the debug info from the newly compiled class
- files. (Note - the class files are not altered in any way so in any case you just deal with normal Java
- classes)
- </p>
- TODO add video here
- </section>
-
- <section name="Page and Resource Reloading">
- <subsection name="Introduction">
- <p>One of the goals of Ext-Scripting is to prevent unnecessary restarts and redeploys during
- development. To
- enable this it provides custom functionality outside of the scope of providing scripting
- capabilities.
- One of those features is the page and resource reloading from your source directories.
- </p>
- </subsection>
- <subsection name="Basic Functionality">
- <p>Pages and web-resources like CSS files or images are loaded from your resource directory without
- having to redeploy the web
- application,
- 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.
- </p>
- <center>
- <img src="images/source-resource.jpg" width="557px" height="470px" alt="Page and Resource Reloading"
- title="Page and Resource Reloading"/>
- </center>
- </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
- recompile and load artifacts and the those which reference our changed ones. To enable this,
- Ext-Scripting
- does dependency detection on bytecode level as well as on artifact level. This functionality is enabled
- automatically you wont have anything further to do. You can see it working by watching the output log,
- if
- you change a class, you automatically will see that the system marks the classes which reference your
- changed class as tainted as well.
- </p>
- <p>
- You have to have in mind that data currently in ram cannot be recovered by the unloading and reloading
- happening, so everything stored for instance in application or session scope is lost that way.
- </p>
- <p>
- Following video shows the mechanism working:
- </p>
- <p></p>
- <center>
- <object width="640px" height="480px">
- <param name="movie" value="http://www.youtube.com/v/65Hp0tjj6SQ&hl=de_DE&fs=1&"></param>
- <param name="allowFullScreen" value="true"></param>
- <param name="allowscriptaccess" value="always"></param>
- <embed src="http://www.youtube.com/v/65Hp0tjj6SQ&hl=de_DE&fs=1&"
- type="application/x-shockwave-flash"
- allowscriptaccess="always" allowfullscreen="true" width="640px" height="480px"></embed>
- </object>
- </center>
- <p>
- This dependency detection works over all dynamic classes, no matter being it classes, interfaces,
- annotations, and it works over static and dynamic imports.
- </p>
- <p>
- Javabean dependencies also are detected on artifact level so that if the JSF IOC mechanism is used those
- bound over neutral Object classes also will reload the dependencies correctly.
- </p>
-
- </section>
-
-
- <section name="Dynamic Annotations">
-
- <p>One of the main features which Ext-Scripting provides over standard JSF is dynamic annotations.
- Dynamic annotations basically introduces a mechanism so that your standard JSF annotations like
- @ManagedBean or @FacesComponent or @ManagedProperty or even the scopes like @RequestScoped or
- @SessionScoped
- can be changed on the fly in a dynamic way.
- </p>
- <p>To enable this mechanism you don't have to do anything, it comes out of the box in a MyFaces 2.0
- environment.
- Following video demonstrates the mechanism
- </p>
-
- <center>
- <object width="640" height="505">
- <param name="movie" value="http://www.youtube.com/v/tikOR0XDnFw&hl=de_DE&fs=1&hd=1"></param>
- <param name="allowFullScreen" value="true"></param>
- <param name="allowscriptaccess" value="always"></param>
- <embed src="http://www.youtube.com/v/tikOR0XDnFw&hl=de_DE&fs=1&hd=1"
- type="application/x-shockwave-flash" allowscriptaccess="always" allowfullscreen="true"
- width="640" height="505"></embed>
- </object>
- </center>
+ <section name="Chapters">
+ <p>The Following Chapters should help you to guide you through the usage of Ext-Scripting</p>
+ <ul>
+ <li>
+ <a href="using_general.html">General users guide</a>
+ </li>
+ <li>
+ <a href="using_advanced.html">Advanced usage</a>
+ </li>
+ <li>
+ <a href="using_eclipse.html">Ext-Scripting in Eclipse</a>
+ </li>
+ <li>
+ <a href="using_intellij.html">Ext-Scripting in Intellij</a>
+ </li>
+ <li>
+ <a href="using_intellij.html">Ext-Scripting in Netbeans</a>
+ </li>
+ </ul>
</section>
- <section name="Supported Artifacts">
- <subsection name="JSF 1.2">
- <p>Ext-Scripting supports following JSF 1.2 artifact reloading:</p>
- <ul>
- <li>ApplicationFactory reloading on method call level</li>
- <li>FacesContextFactory reloading on method call level</li>
- <li>LifecycleFactory reloading on method call level</li>
- <li>RenderkitFactory reloading on method call level</li>
- <li>ElResolver</li>
- <li>Converter (on JSF level alone)</li>
- <li>Validator (on JSF level alone)</li>
- <li>Component reloading on component tree creation level (on JSF level alone)</li>
- <li>ViewHandler</li>
- <li>Lifecycle</li>
- <li>Renderer</li>
- <li>PhaseListener</li>
- <li>ManagedBeans reloading for all managed beans even session and application scoped ones on request
- level
- </li>
- <li>Support for either JavaC or JSR 199 depending on your JDK Version</li>
- <li>Support for Groovy and Java</li>
- </ul>
- </subsection>
- <subsection name="JSF 2.0">
- <p>Ext-Scripting supports following JSF 2.0 artifact reloading: Additionally to what is present for JSF
- 1.2
- </p>
- <ul>
- <li>Component limitations have been lifted for Facelets as rendering language</li>
- <li>All major JSF 2 annotations can be used in a dynamic way, annotations can be moved removed or
- added on the fly
- </li>
- <li>Support for Reloading on ComponentTagHandler, ConverterTagHandler, BehaviorTagHandler,
- ValidatorTagHandler
- </li>
- <li>ResourceHandler</li>
- <li>Behavior</li>
- <li>BehaviorRenderer</li>
- <li>ComponentSystemEvent Support via dynamic Annotations</li>
- <li>Application System Event Support</li>
- </ul>
- </subsection>
+ <section name="Navigation Bottom">
+ <a href="installation.html"><<Back to the Setup Guide</a> or
- <subsection name="Visual Overview">
- <img src="images/ext-scripting-structure-fine.jpg"/>
- </subsection>
+ <a href="using_general.html">On to the General Users Guide>></a>
</section>
</body>
Copied: myfaces/extensions/scripting/trunk/src/site/xdoc/using_advanced.xml (from r923228, myfaces/extensions/scripting/trunk/src/site/xdoc/usersguide.xml)
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/xdoc/using_advanced.xml?p2=myfaces/extensions/scripting/trunk/src/site/xdoc/using_advanced.xml&p1=myfaces/extensions/scripting/trunk/src/site/xdoc/usersguide.xml&r1=923228&r2=923229&rev=923229&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/usersguide.xml (original)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/using_advanced.xml Mon Mar 15 13:55:17 2010
@@ -20,96 +20,22 @@
-->
<document>
<properties>
- <title>Users Guide</title>
+ <title>Advanced Users Guide</title>
</properties>
<body>
- <section name="Users Guide">
- <p>
- After having set up MyFaces Ext-Scripting (if you do not have done so please go to our<a
- href="installation.html">Installation Page</a>), you basically can start editing, and be done with
- the users
- guide.
- </p>
- <p>
- Well theoretically anyway, there are some things every user of Extension-Scripting has to take into
- consideration.
- </p>
- <p>
- First of all Ext-Scripting in its current incarnation tries to help the programmers every day life. That
- means, it tries to reduce the number of needed server restarts to the lowest possible minimum which is
- achievable within the boundaries of Java and JSF.
- </p>
- <p>
- You won't get a zero restart configuration, Extension-Scripting tries not to be perfect in this regard,
- but
- what you can achieve is a significant reduction on restarts by applying scripting languages and dynamic
- compilation.
- </p>
- <p>
- Secondly, we do not try to support every scripting language under the earth, the basic goal is first to
- get
- the basics right and then in subsequent releases to add additional scripting languages support.
- </p>
- <p>
- As is, every scripting language which can compile against the JVM can be supported, currently there is
- no
- support for the scripting language API of Java 6. The reason simply is that the API is too limiting for
- now
- in what Ext-Scripting tries to achieve. But future extensions like JSR 292 once available might be used
- to
- reduce the number of restarts needed.
- </p>
- <p>
- For now we cannot recommend to use Ext-Scripting in a production environment for live patches, although
- it
- theoretically would be possible, and we spent a lot of blood sweat and tears into making the system
- stable
- under multithreaded conditions. For now, however, we simply only can recommend to use Ext-Scripting for
- development and development only scenarios if you need to hot patch code (deployment without any changes
- however should be fine). So if you want to hot patch a running installations, we assume it should work
- fine,
- but you are on your own.
- </p>
+ <section name="Navigation Top">
+ <a href="using_general.html"><<Back to the General Users Guide</a>
+ or
+
+ <a href="using_eclipse.html">On to the Eclipse Users Guide>></a>
</section>
- <section name="usage">
- <p>
- Using Ext-Scripting once properly setup is straight forward. Usually it comes down to editing, reloading
- on
- the browser editing, reloading the page, .... However if you edit within a running configurations keep
- an
- eye on the console/log output. All compile errors and messages go automatically into the log.
- </p>
- <center>
- <img src="images/development-states.jpg" width="386px" height="337px"/>
- </center>
- <div class="objectAnnotation">Image: Development Lifecycle</div>
- <p>
- The development cycle also can seen in the following video (which is the same as on our
- <a href="index.html">Introduction page</a>)
- and in the following videos in the Users Guide.
- </p>
- <center>
- <object width="640px" height="480px">
- <param name="movie"
- value="http://www.youtube.com/v/vUCCTCMjTPE&hl=de_DE&fs=1&"></param>
- <param name="allowFullScreen" value="true"></param>
- <param name="allowscriptaccess" value="always"></param>
- <embed src="http://www.youtube.com/v/vUCCTCMjTPE&hl=de_DE&fs=1&"
- type="application/x-shockwave-flash" allowscriptaccess="always"
- allowfullscreen="true" width="640px" height="480px"></embed>
- </object>
- </center>
- <div class="objectAnnotation">Video: Development Lifecycle in Action</div>
- <p>
- As you can see, there is no need for any recompile anymore, no server restart
- everything is done dynamically, and you get instant results.
+ <section name="Introduction">
+ <p>Congratulations by the time you have reached this section, you probably have mastered the basics
+ of Ext-Scripting, you probably already can edit your local files and have them refreshed on the fly
</p>
- </section>
-
- <section name="Advanced Features">
<p>
Under normal circumstances you, should be set up by now and you can start coding happily.
However since this is a framework based reloading mechanism it is wise to dig a little bit deeper
@@ -389,7 +315,8 @@
<center>
<object width="640" height="505">
- <param name="movie" value="http://www.youtube.com/v/tikOR0XDnFw&hl=de_DE&fs=1&hd=1"></param>
+ <param name="movie"
+ value="http://www.youtube.com/v/tikOR0XDnFw&hl=de_DE&fs=1&hd=1"></param>
<param name="allowFullScreen" value="true"></param>
<param name="allowscriptaccess" value="always"></param>
<embed src="http://www.youtube.com/v/tikOR0XDnFw&hl=de_DE&fs=1&hd=1"
@@ -447,6 +374,13 @@
</subsection>
</section>
+ <section name="Navigation Bottom">
+ <a href="using_general.html"><<Back to the General Users Guide</a>
+ or
+
+ <a href="using_eclipse.html">On to the Eclipse Users Guide>></a>
+ </section>
+
+
</body>
-</document>
-
\ No newline at end of file
+</document>
\ No newline at end of file
Added: myfaces/extensions/scripting/trunk/src/site/xdoc/using_general.xml
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/xdoc/using_general.xml?rev=923229&view=auto
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/using_general.xml (added)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/using_general.xml Mon Mar 15 13:55:17 2010
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+<document>
+ <properties>
+ <title>General Users Guide</title>
+ </properties>
+
+ <body>
+ <section name="Navigation Top">
+ <a href="usersguide.html"><<Back to the Users Guide Start</a>
+ or
+ <a href="using_advanced.html">On to the Advanced Users Guide>></a>
+ </section>
+
+
+ <section name="General Users Guide">
+ <p>
+ Using Ext-Scripting once properly setup is straight forward. Usually it comes down to editing, reloading
+ on
+ the browser editing, reloading the page, .... However if you edit within a running configurations keep
+ an
+ eye on the console/log output. All compile errors and messages go automatically into the log.
+ </p>
+ <center>
+ <img src="images/development-states.jpg" width="386px" height="337px"/>
+ </center>
+ <div class="objectAnnotation">Image: Development Lifecycle</div>
+
+ <p>
+ The development cycle also can seen in the following video (which is the same as on our
+ <a href="index.html">Introduction page</a>)
+ and in the following videos in the Users Guide.
+ </p>
+ <center>
+ <object width="640px" height="480px">
+ <param name="movie"
+ value="http://www.youtube.com/v/vUCCTCMjTPE&hl=de_DE&fs=1&"></param>
+ <param name="allowFullScreen" value="true"></param>
+ <param name="allowscriptaccess" value="always"></param>
+ <embed src="http://www.youtube.com/v/vUCCTCMjTPE&hl=de_DE&fs=1&"
+ type="application/x-shockwave-flash" allowscriptaccess="always"
+ allowfullscreen="true" width="640px" height="480px"></embed>
+ </object>
+ </center>
+ <div class="objectAnnotation">Video: Development Lifecycle in Action</div>
+
+ <p>
+ As you can see, there is no need for any recompile anymore, no server restart
+ everything is done dynamically, and you get instant results.
+ </p>
+ </section>
+
+ <section name="Navigation Bottom">
+ <a href="usersguide.html"><<Back to the Users Guide Start</a>
+ or
+ <a href="using_advanced.html">On to the Advanced Users Guide>></a>
+ </section>
+
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/extensions/scripting/trunk/src/site/xdoc/using_general.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/extensions/scripting/trunk/src/site/xdoc/using_general.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: myfaces/extensions/scripting/trunk/src/site/xdoc/using_intellij.xml
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/src/site/xdoc/using_intellij.xml?rev=923229&view=auto
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/using_intellij.xml (added)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/using_intellij.xml Mon Mar 15 13:55:17 2010
@@ -0,0 +1,100 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+ <properties>
+ <title>Using Ext-Scripting in Eclipse</title>
+ </properties>
+
+ <body>
+
+ <section name="Navigation Top">
+ <a href="using_eclipse.html"><<Back to the Eclipse Users Guide</a>
+ or
+
+ <a href="using_netbeans.html">On to the NetBeans Users Guide>></a>
+ </section>
+
+
+ <section name="Introduction">
+ <p>
+ Intellij is very specific because it allows mixed programming out of the box, hence it is the ideal
+ partner for mixing it with Ext-Scripting. However while setting everything up you have to be aware
+ of several specifics.
+ </p>
+ <ul>
+ <li>Ext-Scripting does its own incremental compile cycle depending on the sources changed</li>
+ <li>Deployment and Redeployment is not needed as long as Ext-Scripting itself can pick up the changes
+ </li>
+ </ul>
+ </section>
+ <section name="Setting up Eclipse">
+ <subsection name="Prerequirements">
+
+ <p>Secondly make sure that your project compiles properly
+ and can be properly deployed from eclipse. Turn off any auto deployment mechanisms
+ which might trigger unnecessary restarts.
+ </p>
+
+ <p>If you use scripting languages make sure to have the proper
+ plugin installed for the scripting language of your choice
+ </p>
+ </subsection>
+ </section>
+ <section name="Setting up Ext-Scripting specifics">
+ <p>
+ If you only have one sourcepath you might have a look at the package whitelisting
+ to mark only the packages you actively want to edit for this deployment cycle.
+ This speeds up startup time and helps generally to avoid restarts.
+ </p>
+ <p>
+ If you use different paths then you can work by including the added source paths as sources
+ like WEB-INF/java or WEB-INF/groovy (not classes compiled via Ext-Scripting always have higher loading
+ priority than what can be found in WEB-INF/classes), so there is no need to change any target
+ directories
+ source directories always are enough.
+
+ To change your source directories open
+ <b>File->Project Structure ->Modules-><Your Web Module></b>
+ and mark your script directories as source paths:
+
+ <img src="images/intellij_source.jpg" alt="setting the sourcepath from Intellij"/>
+ </p>
+ <p>
+ You can leave your compile target directory unchanged
+ </p>
+ <p>
+ If you prefer your own source paths to be the sources of everything set the
+ <b>org.apache.myfaces.scripting.java.LOADER_PATHS</b>
+ or
+ <b>org.apache.myfaces.scripting.groovy.LOADER_PATHS</b>
+ accordingly in your web.xml the same goes for the resource roots.
+ </p>
+
+ </section>
+
+
+ <section name="Navigation Bottom">
+ <a href="using_eclipse.html"><<Back to the Eclipse Users Guide</a>
+ or
+ <a href="using_netbeans.html">On to the NetBeans Users Guide>></a>
+ </section>
+
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/extensions/scripting/trunk/src/site/xdoc/using_intellij.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/extensions/scripting/trunk/src/site/xdoc/using_intellij.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: 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=923229&view=auto
==============================================================================
--- myfaces/extensions/scripting/trunk/src/site/xdoc/using_netbeans.xml (added)
+++ myfaces/extensions/scripting/trunk/src/site/xdoc/using_netbeans.xml Mon Mar 15 13:55:17 2010
@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+ <properties>
+ <title>Using Ext-Scripting in Eclipse</title>
+ </properties>
+
+ <body>
+
+ <section name="Navigation Top">
+ <a href="using_intellij.html"><<Back to the Intellij Users Guide</a>
+ or
+ <a href="configentries.html">On to the Appendix: Config Entries>></a>
+ </section>
+
+
+ <section name="Introduction">
+ <p>
+ Netbeans also works perfectly in conjunction with Ext-Scripting
+ pretty much everything said for Eclipse and Intellij also applies to NetBeans.
+ The biggest restriction is if you want to use netbeans in conjunction with maven
+ only one source folder is picked up and you cannot use additional source folders
+ like for instance Intellij or Eclipse allow. So either dont use maven or
+ use package whitelisting as workaround if you want to use Netbeans.
+
+ </p>
+ <ul>
+ <li>Ext-Scripting does its own incremental compile cycle depending on the sources changed</li>
+ <li>Deployment and Redeployment is not needed as long as Ext-Scripting itself can pick up the changes
+ </li>
+ </ul>
+ </section>
+ <section name="Setting up Eclipse">
+ <subsection name="Prerequirements">
+
+ <p>Secondly make sure that your project compiles properly
+ and can be properly deployed from eclipse. Turn off any auto deployment mechanisms
+ which might trigger unnecessary restarts.
+ </p>
+
+ <p>If you use scripting languages make sure to have the proper
+ plugin installed for the scripting language of your choice
+ </p>
+ </subsection>
+ </section>
+ <section name="Setting up Ext-Scripting specifics">
+ <p>
+ If you only have one sourcepath you might have a look at the package whitelisting
+ to mark only the packages you actively want to edit for this deployment cycle.
+ This speeds up startup time and helps generally to avoid restarts.
+ </p>
+ <p>
+ If you use different paths then you can work by including the added source paths as sources
+ like WEB-INF/java or WEB-INF/groovy (not classes compiled via Ext-Scripting always have higher loading
+ priority than what can be found in WEB-INF/classes), so there is no need to change any target
+ directories
+ source directories always are enough.
+
+ To change your source directories open
+ <b>File->Project Properties -> Sources - > Source Package Folders</b>
+ and press the Add Folder button
+ </p>
+ <img src="images/netbeans_source1.jpg" alt="setting the sourcepath from Intellij"/>
+ <p>
+ After that you get a file dialog where you can choose your source directory.
+ </p>
+ <img src="images/netbeans_source2.jpg" alt="setting the sourcepath from Intellij"/>
+ <p>
+ You can leave your compile target directory unchanged
+ </p>
+ <p>
+ If you prefer your own source paths to be the sources of everything set the
+ <b>org.apache.myfaces.scripting.java.LOADER_PATHS</b>
+ or
+ <b>org.apache.myfaces.scripting.groovy.LOADER_PATHS</b>
+ accordingly in your web.xml the same goes for the resource roots.
+ </p>
+
+ </section>
+
+ <section name="Navigation Bottom">
+ <a href="using_intellij.html"><<Back to the Intellij Users Guide</a>
+ or
+ <a href="configentries.html">On to the Appendix: Config Entries>></a>
+ </section>
+
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/extensions/scripting/trunk/src/site/xdoc/using_netbeans.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: myfaces/extensions/scripting/trunk/src/site/xdoc/using_netbeans.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL