JBoss Tools SVN: r32991 - trunk/as/plugins/org.jboss.ide.eclipse.as.core/jbosscore/org/jboss/ide/eclipse/as/core/extensions/polling.
by jbosstools-commits＠lists.jboss.org
Author: rob.stryker(a)jboss.com
Date: 2011-07-18 00:27:06 -0400 (Mon, 18 Jul 2011)
New Revision: 32991
Modified:
trunk/as/plugins/org.jboss.ide.eclipse.as.core/jbosscore/org/jboss/ide/eclipse/as/core/extensions/polling/WebPortPoller.java
Log:
JBIDE-9353, reverting commit from JBIDE-9054
Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.core/jbosscore/org/jboss/ide/eclipse/as/core/extensions/polling/WebPortPoller.java
===================================================================
--- trunk/as/plugins/org.jboss.ide.eclipse.as.core/jbosscore/org/jboss/ide/eclipse/as/core/extensions/polling/WebPortPoller.java 2011-07-18 04:04:25 UTC (rev 32990)
+++ trunk/as/plugins/org.jboss.ide.eclipse.as.core/jbosscore/org/jboss/ide/eclipse/as/core/extensions/polling/WebPortPoller.java 2011-07-18 04:27:06 UTC (rev 32991)
@@ -9,13 +9,15 @@
import java.util.Properties;
import org.eclipse.wst.server.core.IServer;
-import org.jboss.ide.eclipse.as.core.server.IServerStatePoller;
+import org.jboss.ide.eclipse.as.core.server.IServerStatePoller.PollingException;
+import org.jboss.ide.eclipse.as.core.server.IServerStatePoller.RequiresInfoException;
+import org.jboss.ide.eclipse.as.core.server.IServerStatePoller2;
import org.jboss.ide.eclipse.as.core.server.internal.JBossServer;
import org.jboss.ide.eclipse.as.core.server.internal.PollThread;
import org.jboss.ide.eclipse.as.core.server.internal.ServerStatePollerType;
import org.jboss.ide.eclipse.as.core.util.ServerConverter;
-public class WebPortPoller implements IServerStatePoller {
+public class WebPortPoller implements IServerStatePoller2 {
public static final String WEB_POLLER_ID = "org.jboss.ide.eclipse.as.core.runtime.server.WebPoller"; //$NON-NLS-1$
private IServer server;
14 years, 9 months
- 1
- 0
JBoss Tools SVN: r32990 - trunk/as/plugins/org.jboss.ide.eclipse.as.core/jbosscore/org/jboss/ide/eclipse/as/core/server/internal/v7.
by jbosstools-commits＠lists.jboss.org
Author: rob.stryker(a)jboss.com
Date: 2011-07-18 00:04:25 -0400 (Mon, 18 Jul 2011)
New Revision: 32990
Modified:
trunk/as/plugins/org.jboss.ide.eclipse.as.core/jbosscore/org/jboss/ide/eclipse/as/core/server/internal/v7/JBoss7JSTPublisher.java
Log:
No Code Change: Just move a method up and delete commented out method
Modified: trunk/as/plugins/org.jboss.ide.eclipse.as.core/jbosscore/org/jboss/ide/eclipse/as/core/server/internal/v7/JBoss7JSTPublisher.java
===================================================================
--- trunk/as/plugins/org.jboss.ide.eclipse.as.core/jbosscore/org/jboss/ide/eclipse/as/core/server/internal/v7/JBoss7JSTPublisher.java 2011-07-18 02:56:55 UTC (rev 32989)
+++ trunk/as/plugins/org.jboss.ide.eclipse.as.core/jbosscore/org/jboss/ide/eclipse/as/core/server/internal/v7/JBoss7JSTPublisher.java 2011-07-18 04:04:25 UTC (rev 32990)
@@ -26,6 +26,18 @@
import org.jboss.ide.eclipse.as.core.util.ServerConverter;
public class JBoss7JSTPublisher extends AbstractServerToolsPublisher {
+
+ public IStatus publishModule(
+ IJBossServerPublishMethod method,
+ IServer server, IModule[] module,
+ int publishType, IModuleResourceDelta[] delta,
+ IProgressMonitor monitor) throws CoreException {
+ boolean useAS7Behavior = DeploymentMarkerUtils.supportsJBoss7MarkerDeployment(server);
+ if( useAS7Behavior )
+ return publishModuleToAS7(method, server, module, publishType, delta, monitor);
+ else
+ return super.publishModule(method, server, module, publishType, delta, monitor);
+ }
public IStatus publishModuleToAS7(
IJBossServerPublishMethod method,
@@ -49,43 +61,12 @@
return s;
}
return Status.OK_STATUS;
- }
+ }
- public IStatus publishModule(
- IJBossServerPublishMethod method,
- IServer server, IModule[] module,
- int publishType, IModuleResourceDelta[] delta,
- IProgressMonitor monitor) throws CoreException {
- boolean useAS7Behavior = DeploymentMarkerUtils.supportsJBoss7MarkerDeployment(server);
- if( useAS7Behavior )
- return publishModuleToAS7(method, server, module, publishType, delta, monitor);
- else
- return super.publishModule(method, server, module, publishType, delta, monitor);
- }
-
-
-// public static final String MARK_UNDEPLOY = "org.jboss.ide.eclipse.as.core.server.internal.v7.JBoss7JSTPublisher.markUndeploy"; //$NON-NLS-1$
-
private void markDeployed(IJBossServerPublishMethod method,IDeployableServer server,
IModule[] moduleTree, IProgressMonitor monitor ) throws CoreException {
IPath p = PublishUtil.getDeployPath(method, moduleTree, server);
DelegatingJBoss7ServerBehavior beh = ServerConverter.getJBoss7ServerBehavior(server.getServer());
beh.markDoDeploy(p);
}
-
-// public static void markUndeployed(
-// IJBossServerPublishMethod method,
-// IDeployableServer server, IModule[] moduleTree,
-// IProgressMonitor monitor) throws CoreException {
-// IPath p = PublishUtil.getDeployPath(method, moduleTree, server);
-// DeployableServerBehavior beh = ServerConverter.getDeployableServerBehavior(server.getServer());
-// Object o = beh.getPublishData(MARK_UNDEPLOY);
-// if( o == null || !(o instanceof ArrayList<?>)) {
-// o = new ArrayList<IPath>();
-// beh.setPublishData(MARK_UNDEPLOY, o);
-// }
-// ArrayList<IPath> list = (ArrayList<IPath>)o;
-// if( !list.contains(p))
-// list.add(p);
-// }
}
14 years, 9 months
- 1
- 0
JBoss Tools SVN: r32989 - in branches/jbosstools-3.2.x/ws/docs/reference: en-US and 2 other directories.
by jbosstools-commits＠lists.jboss.org
Author: irooskov(a)redhat.com
Date: 2011-07-17 22:56:55 -0400 (Sun, 17 Jul 2011)
New Revision: 32989
Modified:
branches/jbosstools-3.2.x/ws/docs/reference/en-US/Author_Group.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/Book_Info.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/Feedback.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.ent
branches/jbosstools-3.2.x/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/Preface.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/Revision_History.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/images/preference/Jbossws_preference.png
branches/jbosstools-3.2.x/ws/docs/reference/en-US/images/preference/Jbossws_preference_new.png
branches/jbosstools-3.2.x/ws/docs/reference/en-US/images/topdown/jbossws_facet.png
branches/jbosstools-3.2.x/ws/docs/reference/en-US/images/topdown/jbossws_newruntime.png
branches/jbosstools-3.2.x/ws/docs/reference/en-US/images/topdown/jbossws_ws_creation2.png
branches/jbosstools-3.2.x/ws/docs/reference/en-US/master.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/overview.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/preference.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-generate_a_sample_restful_web_service.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-new_project_example.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_JAX-RS.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_JAX-WS.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_resteasy_JAX-RS.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_restfulsample_JAX-RS.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/sample_web_service_wizards.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/testing_a_restful_web_service-web_service_test_view.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/testing_a_web_service-web_service_test_view.xml
branches/jbosstools-3.2.x/ws/docs/reference/en-US/topdown.xml
branches/jbosstools-3.2.x/ws/docs/reference/pom.xml
branches/jbosstools-3.2.x/ws/docs/reference/publican.cfg
Log:
updated for GA
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/Author_Group.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/Author_Group.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/Author_Group.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -1,15 +1,13 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
]>
-<authorgroup><author><firstname>Denny</firstname><surname>Xu</surname><email>dxu(a)redhat.com</email></author>
- <author><firstname>Grid</firstname><surname>Qian</surname><email>fqian(a)redhat.com</email></author><author>
+<authorgroup><author><firstname>Denny</firstname><surname>Xu</surname></author>
+ <author><firstname>Grid</firstname><surname>Qian</surname></author><author>
<firstname>Brian </firstname>
<surname>Fitzpatrick</surname>
- <email>bfitzpat(a)redhat.com</email>
</author>
<author>
<firstname>Ben </firstname>
<surname>Clare</surname>
- <email>bclare(a)redhat.com</email>
</author>
- <editor><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email></editor></authorgroup>
+ <editor><firstname>Isaac</firstname><surname>Rooskov</surname></editor></authorgroup>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/Book_Info.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/Book_Info.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/Book_Info.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -5,9 +5,9 @@
<title>JBoss Web Services User Guide</title>
<subtitle>Provides information relating to the JBoss Web Services module.</subtitle>
<productname>JBoss Developer Studio</productname>
- <productnumber>4.0</productnumber>
- <edition>4.0.0</edition>
- <pubsnumber>4</pubsnumber>
+ <productnumber>4.1</productnumber>
+ <edition>4.1.0</edition>
+ <pubsnumber>6</pubsnumber>
<abstract>
<para>The JBoss Web Services User Guide explains how to use the JBoss Web Services module to implement web services in Java.</para>
</abstract>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/Feedback.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/Feedback.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/Feedback.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -1,20 +1,92 @@
<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Document_Conventions.ent">
+%BOOK_ENTITIES;
+]>
+<appendix id="sect_JBoss-Getting_Help_and_Giving_Feedback" lang="en-US">
+ <title>Getting Help and Giving Feedback</title>
+ <section id="sect_JBoss-Do_You_Need_Help">
+ <title>Do You Need Help?</title>
+ <indexterm>
+ <primary>help</primary>
+ <secondary>getting help</secondary>
-<section id="sect-Beginners_Guide-We_Need_Feedback" lang="en-US">
- <title>We Need Feedback!</title>
- <indexterm>
- <primary>feedback</primary>
- <secondary>contact information for this manual</secondary>
- </indexterm>
- <para>
- If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA against JBoss Developer Studio: <ulink url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...">https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...</ulink>
- </para>
- <para>
- When submitting a bug report, be sure to mention the manual's name and to select the "documentation" component.
- </para>
- <para>
- If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.
- </para>
-</section>
+ </indexterm>
+ <para>
+ If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at <ulink url="http://access.redhat.com" />. Through the customer portal, you can:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ search or browse through a knowledgebase of technical support articles about Red Hat products.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ submit a support case to Red Hat Global Support Services (GSS).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ access other product documentation.
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+ <para>
+ Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. You can find a list of publicly available mailing lists at <ulink url="https://www.redhat.com/mailman/listinfo" />. Click on the name of any mailing list to subscribe to that list or to access the list archives.
+ </para>
+
+ </section>
+
+ <section id="jboss-feedback">
+ <title>Give us Feedback</title>
+ <!-- NOTE: You will need the following entities defined in your .ent file.
+ You will need to replace _YOUR_PRODUCT_HERE_, _YOUR_COMPONENT_
+ and _YOUR_SUMMARY_ - entities are not replaced in URLs.
+ <!ENTITY PRODUCT "JBoss Product Name">
+ <!ENTITY BZCOMPONENT "doc-triage">
+ <!ENTITY BZURL "<ulink url='https://bugzilla.example.com/enter_bug.cgi?product=_YOUR_PRODUCT_HERE_&am...'>http://bugzilla.redhat.com/</ulink>">
+
+ These entities should not affect translated documents, since Bugzilla is not localised.
+ --> <indexterm>
+ <primary>feedback</primary>
+ <secondary>contact information for this manual</secondary>
+
+ </indexterm>
+ <para>
+ If you find a typographical error, or know how this guide can be improved, we would love to hear from you. Submit a report in Bugzilla against the product <literal>&BZPRODUCT;</literal> and the component <literal>&BZCOMPONENT;</literal>. The following link will take you to a pre-filled bug report for this product: &BZURL;.
+ </para>
+ <para>
+ Fill out the following template in Bugzilla's <literal>Description</literal> field. Be as specific as possible when describing the issue; this will help ensure that we can fix it quickly.
+ </para>
+
+<screen>Document URL:
+
+
+Section Number and Name:
+
+
+Describe the issue:
+
+
+Suggestions for improvement:
+
+
+Additional information:
+
+
+</screen>
+ <para>
+ Be sure to give us your name so that you can receive full credit for reporting the issue.
+ </para>
+
+ </section>
+
+
+</appendix>
+
+
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.ent
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.ent 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.ent 2011-07-18 02:56:55 UTC (rev 32989)
@@ -1,8 +1,7 @@
<!ENTITY PRODUCT "JBoss">
<!ENTITY BOOKID "JBoss_Web_Services_User_Guide">
-<!ENTITY YEAR "2010">
+<!ENTITY YEAR "2011">
<!ENTITY HOLDER "Red Hat">
-
-
-<!--<!ENTITY HORIZ_LINE "───────────────────────────────────────────────────────────────">
--->
+<!ENTITY BZPRODUCT "JBoss Developer Studio">
+<!ENTITY BZCOMPONENT "Web Services User Guide">
+<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss%20Develope...'>http://bugzilla.redhat.com/</ulink>">
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -14,5 +14,6 @@
<xi:include href="sample_web_service_wizards.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="resteasy_simple_project_example.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="web_service_test_view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+<xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
</book>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/Preface.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/Preface.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/Preface.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -8,9 +8,5 @@
<para>
This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. To get more information on these conventions please refer to the <guilabel>Document Conventions</guilabel> manual, which can be found on the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index.html">Red Hat Documentation</ulink> website under the <guilabel>JBoss Developer Studio</guilabel> section.
</para>
- <!--<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- </xi:fallback>
- </xi:include>-->
</preface>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/Revision_History.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/Revision_History.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/Revision_History.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -5,6 +5,17 @@
<title>Revision History</title>
<simpara>
<revhistory>
+ <revision>
+ <revnumber>3.0</revnumber><date>Mon Jun 27 2011</date>
+ <author>
+ <firstname>Isaac</firstname><surname>Rooskov</surname><email></email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Updated with new information concerning JBoss Web Service Code Generation Configuration</member>
+ </simplelist>
+ </revdescription>
+ </revision>
<revision>
<revnumber>2.0</revnumber><date>Tue Nov 16 2010</date>
<author>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/images/preference/Jbossws_preference.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/images/preference/Jbossws_preference_new.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/images/topdown/jbossws_facet.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/images/topdown/jbossws_newruntime.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/images/topdown/jbossws_ws_creation2.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/master.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/master.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/master.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -28,31 +28,29 @@
</imageobject>
</inlinemediaobject>
</corpauthor>
- <author><firstname>Denny</firstname><surname>Xu</surname><email>dxu(a)redhat.com</email></author>
+ <author><firstname>Denny</firstname><surname>Xu</surname></author>
<author>
<firstname>Grid</firstname>
<surname>Qian</surname>
- <email>fqian(a)redhat.com</email>
</author>
<author>
<firstname>Brian </firstname>
<surname>Fitzpatrick</surname>
- <email>bfitzpatrick(a)redhat.com</email>
</author>
<author>
<firstname>Ben </firstname>
<surname>Clare</surname>
- <email>bclare(a)redhat.com</email>
</author>
-
+ <editor>
+ <firstname>Isaac</firstname>
+ <surname>Rooskov</surname>
+ </editor>
<copyright>
- <year>2008</year>
- <year>2009</year>
- <year>2010</year>
+ <year>2011</year>
<holder>JBoss by Red Hat</holder>
</copyright>
<releaseinfo>
- Version: 3.2.0.GA
+ Version: 3.2.1.GA
</releaseinfo>
<!--<abstract>
<title/>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/overview.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/overview.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/overview.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -1,14 +1,14 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="overview">
- <title>JBossWS Runtime Overview</title>
-
+ <title>JBossWS Runtime and Tools support Overview</title>
<para>JBossWS is a web service framework developed as a part of the JBoss Application Server. It implements the JAX-WS and JAX-RS specifications. JAX-WS (Java API for XML Web Services) defines a programming model and run-time architecture for implementing web services in Java, targeted at the Java Platform, Enterprise Edition 5 (Java EE 5). JAX-RS (Java API for RESTful Web Services) is a Java API that supports the creation of Representational State Transfer (REST) web services, using annotations. </para>
- <para>JBossWS integrates with most current JBoss Application Server releases as well as earlier ones, that did implement the J2EE 1.4 specifications. Even though JAX-RPC, the web service specification for J2EE 1.4, is still supported JBossWS does put a clear focus on JAX-WS.</para>
-
+ <para>JBossWS integrates with most current JBoss Application Server releases as well as earlier ones, that did implement the J2EE 1.4 specifications. Even though JAX-RPC, the web service specification for J2EE 1.4, is still supported JBossWS does put a clear focus on JAX-WS.</para>
+ <para>JBossWS Tool works with <property>JBossWS Runtime</property>. Users can easily create, deploy and run a Web Service(WSDL base or RESTful base) and a Web Service Client using JBossWS Tool and JBossWS Runtime.</para>
+ <para>Also JBossWS Tool gives a way to test a web service running on a server.</para>
<section>
<title>Key Features of JBossWS</title>
+
<para>For a start, we propose you to look through the table of main features of JBossWS Runtime:</para>
-
<table>
<title>Key Functionality for JBossWS</title>
@@ -71,9 +71,7 @@
</tbody>
</tgroup>
- </table>
-
-
+ </table>
</section>
<section>
<title>Other relevant resources on the topic</title>
@@ -82,15 +80,14 @@
<itemizedlist>
<listitem>
<para>
- <ulink url="http://www.jboss.org/community/wiki/JBossWS-FAQ#Tools">JBossWS Tools Wiki FAQ.</ulink>
+ <ulink url="http://www.jboss.org/community/wiki/JBossWS-FAQ#Tools">JBossWS Wiki FAQ.</ulink>
</para>
</listitem>
- </itemizedlist>
-
-
- </section>
-
-
-
-
+ <listitem>
+ <para>
+ <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBossWS Tools Forum.</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
+</section>
</chapter>
\ No newline at end of file
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/preference.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/preference.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/preference.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -1,104 +1,102 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="preference" revisionflag="added">
- <title>JBoss WS and development environment</title>
-
- <para>In this chapter you will learn how to change JBossWS preferences and how to set default server and runtime.</para>
- <section id="jbosswspreference">
-
-
- <title>JBossWS Preferences</title>
-
- <para>In this section you will know how JBossWS preferences can be modified during the
- development process.</para>
-
- <para>JBossWS preferences can be set on the JBossWS preference page. Click on
- <emphasis><property>Window > Preferences > JBoss Tools > Web > JBossWS
- Preferences</property>.</emphasis></para>
-
- <para>On this page you can manage the JBossWS Runtime. Use the appropriate buttons to
- <property>Add</property> more runtimes or to <property>Remove</property> those that
- are not needed.</para>
-
- <figure>
- <title>JBossWS Preferences Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/preference/Jbossws_preference.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Clicking on <emphasis>
- <property>Add</property>
- </emphasis> or <emphasis>
- <property>Edit</property>
- </emphasis> button will open the form where you can configure a new JBossWS runtime and
- change the path to JBossWS runtime home folder, modify the name and version of the
- existing JBossWS runtime settings. Press <property>Finish</property> to apply the
- changes.</para>
-
- <figure>
- <title>Edit JBossWS Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/preference/Jbossws_preference_new.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
-
-
- <para>WS container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file in the Project Explorer view, select <emphasis><property>Properties</property></emphasis>. Choose <emphasis><property>Java Source Attachment</property></emphasis> and select location (folder, JAR or zip) containing new source for the chosen .jar using one of the suggested options (workspace, external folder or file) or enter the path manually:</para>
-
- <figure>
- <title>Classpath Container: Java Source Attachment</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/preference/jbossws_container1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on <emphasis><property>Apply</property></emphasis> and then on <emphasis><property>Ok</property></emphasis>.</para>
- <para>To change JavaDoc Location choose <emphasis><property>Javadoc Location</property></emphasis> and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called <emphasis><property>package-list</property></emphasis>:</para>
-
- <figure>
- <title>Classpath Container: Javadoc Location</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/preference/jbossws_container2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on <emphasis><property>Apply</property></emphasis> and then on <emphasis><property>Ok</property></emphasis>.</para>
-
-
-
-
-
-
- </section>
- <section id="serverruntime">
- <title>Default Server and Runtime</title>
- <para>Open <emphasis>
- <property>Window > Preferences > Web Services > Server and Runtime</property></emphasis>. On this page, you can specify a default server and runtime.</para>
- <para>For ease of use, the better way is to set runtime to JBoss WS.</para>
- <para>After server and runtime are specified, click on the <property>Apply</property> button
- to save the values.</para>
- <figure>
- <title>Specifing a default server and runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/preference/jbossws_server_runtime.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the whole, this guide covers the fundamental concepts of work with tooling for
- <property>JBossWS</property>. It describes how to easily create a Web Service and a Web Service Client using
- JBossWS Runtime and adjust JBossWS and development environment as well.</para>
-
- <para>If the information on JBossWS tools in this guide isn't enough for you, ask
- questions on our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">forum</ulink>. Your comments and suggestions are also welcome.</para>
- </section>
+ <title>JBoss WS and development environment</title>
+ <para>
+ In this chapter you will learn how to change JBossWS preferences and how to set default server and runtime.
+ </para>
+
+ <section id="jbosswspreference">
+ <title>JBossWS Preferences</title>
+ <para>
+ In this section you will know how JBossWS preferences can be modified during the development process.
+ </para>
+
+ <para>
+ JBossWS preferences can be set on the JBossWS preference page. Click on <emphasis><property>Window > Preferences > JBoss Tools > Web > JBossWS Preferences</property>.</emphasis>
+ </para>
+
+ <para>
+ On this page you can manage the JBossWS Runtime. Use the appropriate buttons to <property>Add</property> more runtimes or to <property>Remove</property> those that are not needed.
+ </para>
+
+ <figure>
+ <title>JBossWS Preferences Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/preference/Jbossws_preference.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Clicking on <emphasis> <property>Add</property> </emphasis> or <emphasis> <property>Edit</property> </emphasis> button will open the form where you can configure a new JBossWS runtime and change the path to JBossWS runtime home folder, modify the name and version of the existing JBossWS runtime settings. Press <property>Finish</property> to apply the changes.
+ </para>
+
+ <figure>
+ <title>Edit JBossWS Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/preference/Jbossws_preference_new.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ WS container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file in the Project Explorer view, select <emphasis><property>Properties</property></emphasis>. Choose <emphasis><property>Java Source Attachment</property></emphasis> and select location (folder, JAR or zip) containing new source for the chosen .jar using one of the suggested options (workspace, external folder or file) or enter the path manually:
+ </para>
+
+ <figure>
+ <title>Classpath Container: Java Source Attachment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/preference/jbossws_container1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Click on <emphasis><property>Apply</property></emphasis> and then on <emphasis><property>Ok</property></emphasis>.
+ </para>
+
+ <para>
+ To change JavaDoc Location choose <emphasis><property>Javadoc Location</property></emphasis> and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called <emphasis><property>package-list</property></emphasis>:
+ </para>
+
+ <figure>
+ <title>Classpath Container: Javadoc Location</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/preference/jbossws_container2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Click on <emphasis><property>Apply</property></emphasis> and then on <emphasis><property>Ok</property></emphasis>.
+ </para>
+ </section>
+
+ <section id="serverruntime">
+ <title>Default Server and Runtime</title>
+ <para>
+ Open <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>Web Services</guimenuitem><guimenuitem>Server and Runtime</guimenuitem></menuchoice>. On this page, you can specify a default server and runtime.
+ </para>
+
+ <para>
+ For ease of use, the better way is to set runtime to JBoss WS.
+ </para>
+
+ <para>
+ After server and runtime are specified, click on the <property>Apply</property> button to save the values.
+ </para>
+
+ <figure>
+ <title>Specifying a default server and runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/preference/jbossws_server_runtime.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
</chapter>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-generate_a_sample_restful_web_service.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-generate_a_sample_restful_web_service.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-generate_a_sample_restful_web_service.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -209,7 +209,7 @@
</step>
<step><title>Browse the web.xml deployment descriptor</title>
<para>
- Double click the <filename>web.xml</filename> file and note the <parameter>jax.ws.rs.Application</parameter> paramater mapped to the <application>Application</application> class. Note also that:
+ Double click the <filename>web.xml</filename> file and note the <parameter>jax.ws.rs.Application</parameter> parameter mapped to the <application>Application</application> class. Note also that:
</para>
<itemizedlist>
<listitem>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-new_project_example.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-new_project_example.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-new_project_example.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -124,7 +124,7 @@
</step>
<step><title>Determine the URL for the web service</title>
<para>
- Double click the <filename>web.xml</filename> file and note the <parameter>jax.ws.rs.Application</parameter> paramater mapped to the <application>Application</application> class. Note also that:
+ Double click the <filename>web.xml</filename> file and note the <parameter>jax.ws.rs.Application</parameter> parameter mapped to the <application>Application</application> class. Note also that:
</para>
<itemizedlist>
<listitem>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_JAX-RS.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_JAX-RS.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_JAX-RS.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -216,7 +216,7 @@
</para>
</formalpara>
<figure id="figure-jbt-test_resteasy_JAX-RS_09">
- <title>Custmer data updated</title>
+ <title>Customer data updated</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_09.png" format="PNG"/>
@@ -263,7 +263,7 @@
</para>
</formalpara>
<figure id="figure-jbt-test_resteasy_JAX-RS_10">
- <title>Custmer data deleted</title>
+ <title>Customer data deleted</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_10.png" format="PNG"/>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_JAX-WS.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_JAX-WS.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_JAX-WS.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -59,7 +59,7 @@
<step>
<title>Select the required service attributes</title>
<para>
- Select the <guilabel>Service</guilabel>, <guibutton>Port</guibutton> and <guibutton>Operation</guibutton> from the combo boxes and click <guibutton>OK</guibutton>.
+ Select the <guilabel>Service</guilabel>, <guibutton>Port</guibutton> and <guibutton>Operation</guibutton> from the comboboxes and click <guibutton>OK</guibutton>.
</para>
<formalpara><title>Results:</title>
<para>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_resteasy_JAX-RS.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_resteasy_JAX-RS.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_resteasy_JAX-RS.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -216,7 +216,7 @@
</para>
</formalpara>
<figure id="figure-jbt-test_resteasy_JAX-RS_09">
- <title>Custmer data updated</title>
+ <title>Customer data updated</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_09.png" format="PNG"/>
@@ -263,7 +263,7 @@
</para>
</formalpara>
<figure id="figure-jbt-test_resteasy_JAX-RS_10">
- <title>Custmer data deleted</title>
+ <title>Customer data deleted</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_10.png" format="PNG"/>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_restfulsample_JAX-RS.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_restfulsample_JAX-RS.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/proc-jbt-test_restfulsample_JAX-RS.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -9,7 +9,7 @@
<substeps>
<step><title>Query the available options</title>
<para>
- Select <guilabel>OPTIONS</guilabel> from the available combo box options.
+ Select <guilabel>OPTIONS</guilabel> from the available combobox options.
</para>
</step>
<step>
@@ -46,7 +46,7 @@
<substeps>
<step>
<para>
- Having established that the <guilabel>GET</guilabel> request is valid, select <guilabel>GET</guilabel> from the available combo box options.
+ Having established that the <guilabel>GET</guilabel> request is valid, select <guilabel>GET</guilabel> from the available combobox options.
</para>
</step>
<step>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/sample_web_service_wizards.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/sample_web_service_wizards.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/sample_web_service_wizards.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -16,7 +16,7 @@
</listitem>
<listitem>
<para>
- <guilabel>Create a sample RESTful Web Service</guilabel> for a JAX-WS web service.
+ <guilabel>Create a sample RESTful Web Service</guilabel> for a JAX-RS web service.
</para>
</listitem>
</itemizedlist>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/testing_a_restful_web_service-web_service_test_view.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/testing_a_restful_web_service-web_service_test_view.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/testing_a_restful_web_service-web_service_test_view.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -4,31 +4,41 @@
%BOOK_ENTITIES;
]>-->
<section id="web_service_test_view-testing_a_restful_web_service">
- <title>Testing a RESTful Web Service</title>
+ <title>Testing a RESTful Web Service</title>
<para>
- Testing a RESTful (<acronym>JAX-RS</acronym>) web service is achieved by following a similar procedure to testing a JAX-WS web service. Instead of selecting the JAX-WS option in the combo box, the JAX-RS service is invoked by sending HTTP method requests of the form OPTIONS, GET, POST, PUT and DELETE. As there is no WSDL file associated with a JAX-RS service, the available options can be determined by selecting <guilabel>OPTIONS</guilabel> in the combo box.
+ Testing a RESTful (
+ <acronym>
+ JAX-RS
+ </acronym>
+ ) web service is achieved by following a similar procedure to testing a JAX-WS web service. Instead of selecting the JAX-WS option in the combobox, the JAX-RS service is invoked by sending HTTP method requests of the form OPTIONS, GET, POST, PUT and DELETE. As there is no WSDL file associated with a JAX-RS service, the available options can be determined by selecting <guilabel> OPTIONS </guilabel> in the combobox.
</para>
- <para>
- A JAX-RS web service can be tested by using the <guilabel>Web Service Tester View </guilabel> displayed in <xref linkend="figure-jbt-web_service_test_view"/>. The JAX-RS test is specified by:
+
+ <para>
+ A JAX-RS web service can be tested by using the <guilabel> Web Service Tester View </guilabel> displayed in <xref linkend="figure-jbt-web_service_test_view"/>. The JAX-RS test is specified by:
</para>
+
<orderedlist>
<listitem>
<para>
- Selecting the <guilabel>OPTIONS</guilabel> combo box option.
+ Selecting the <guilabel> OPTIONS </guilabel> combobox option.
</para>
</listitem>
+
<listitem id="restful_step2">
<para>
Entering the url of the JAX-RS web service.
</para>
</listitem>
- </orderedlist>
- <para>
- The test procedure is discussed in the following sections for both the <application>RestfulSample</application> and the <application>RESTEasy</application> sample projects developed earlier.
- </para>
- <xi:include href="restfulsample_project-web_service_test_view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="resteasy_sample_project-web_service_test_view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <!--
+ </orderedlist>
+
+ <para>
+ The test procedure is discussed in the following sections for both the <application>RestfulSample</application> and the <application>RESTEasy</application> sample projects developed earlier.
+ </para>
+
+ <xi:include href="restfulsample_project-web_service_test_view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="resteasy_sample_project-web_service_test_view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+<!--
<formalpara><title>Testing a JAX-RS web service - Preliminaries</title>
<para>
<xref linkend="proc-jbt-test_JAX-RS_prelim"/> lists the preliminary steps required before testing a JAX-RS web service project.
@@ -49,4 +59,4 @@
</formalpara>
<xi:include href="proc-jbt-test_JAX-RS.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-->
-</section>
\ No newline at end of file
+</section>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/testing_a_web_service-web_service_test_view.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/testing_a_web_service-web_service_test_view.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/testing_a_web_service-web_service_test_view.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -11,7 +11,7 @@
<orderedlist>
<listitem>
<para>
- Selecting the <guilabel>JAX-WS</guilabel> combo box option.
+ Selecting the <guilabel>JAX-WS</guilabel> combobox option.
</para>
</listitem>
<listitem id="step2">
Modified: branches/jbosstools-3.2.x/ws/docs/reference/en-US/topdown.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/en-US/topdown.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/en-US/topdown.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -1,403 +1,660 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="create_ws_topdown">
- <?dbhtml filename="topdown.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Web Service</keyword>
- <keyword>JBossWS Web Service runtime</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Creating a Web Service using JBossWS runtime</title>
- <para>In this chapter we provide you with the necessary steps to create a Web Service using
- JBossWS runtime. First you need to create a Dynamic Web project:</para>
-
- <section id="createproject">
- <title>Creating a Dynamic Web project</title>
-
- <para>Before creating a web service, you should have a Dynamic Web Project created:</para>
- <figure>
- <title>Dynamic Web Project</title>
- <mediaobject>
+<?dbhtml filename="topdown.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+
+ <keyword>Web Service</keyword>
+
+ <keyword>JBossWS Web Service runtime</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Creating a Web Service using JBossWS runtime</title>
+ <para>
+ In this chapter we provide you with the necessary steps to create a Web Service using JBossWS runtime. First you need to create a Dynamic Web project:
+ </para>
+
+ <section id="createproject">
+ <title>Creating a Dynamic Web project</title>
+ <para>
+ Before creating a web service, you should have a Dynamic Web Project created:
+ </para>
+
+ <figure>
+ <title>Dynamic Web Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/topdown/jbossws_webproject_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Create a Web project by selecting <emphasis> <property>New > Project... > Dynamic Web project</property></emphasis>. Enter the following information:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Project Name: enter a project name
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Target runtime: any server depending on your installation. If it is not listed, click <property>New</property> button and browse to the location where it is installed to. You may set <emphasis> <property>Target Runtime</property> </emphasis> to <emphasis> <property>None</property></emphasis>, in this case, you should read the section <xref linkend="addfacet"/>.
+ </para>
+
+ <figure>
+ <title>Dynamic Web Project Wizard</title>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/topdown/jbossws_webproject_1.png"/>
+ <imagedata fileref="images/topdown/jbossws_webproject_2.png"/>
</imageobject>
- </mediaobject>
- </figure>
- <para>Create a Web project by selecting <emphasis>
- <property>New > Project... > Dynamic Web project</property></emphasis>. Enter the following information: </para>
- <itemizedlist>
- <listitem>
- <para>Project Name: enter a project name</para>
- </listitem>
- <listitem>
- <para>Target runtime: any server depending on your installation. If it is not listed,
- click <property>New</property> button and browse to the location where it is installed to. You may set <emphasis>
- <property>Target Runtime</property>
- </emphasis> to <emphasis>
- <property>None</property></emphasis>, in this case, you should read the section <xref linkend="addfacet"/>.</para>
- <figure>
- <title>Dynamic Web Project Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/topdown/jbossws_webproject_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Configuration: You may <xref linkend="addfacet"/> by clicking the <property>Modify...</property> button. The opened page is like <property>Figure 2.4</property>.</para>
- </listitem>
- <listitem>
- <para>Configure Web Module values:</para>
- <figure>
- <title>Web Module Settings Configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/topdown/jbossws_webproject_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
- <para>If you added the JBoss Web Service facet to the project, now the <property>Finish</property> button is unavailable. You must click <property>Next</property> button to set more information about the JBoss Web Service facet. The page is like <property>Figure 2.5</property>. Then click on the <property>Finish</property> button.</para>
- <para>If you didn't add the JBoss Web Service facet to the project, click on the <property>Finish</property> button. Next you will need to add JBoss Web Service facet to the project.</para>
- </section>
-
- <section id="addfacet">
- <title>Configure JBoss Web Service facet settings</title>
- <para>If you have already created a new Dynamic Web project and not set the JBoss Web Service facet to the project, the next step is to add JBoss Web
- Service facet to the project. Right-click on the project, select its <emphasis><property>Properties</property></emphasis> and then find <emphasis>Project Facets</emphasis> in the tree-view on the left-side of the project properties dialog.
- Tick on the check box for JBoss Web Services. You will see what like this: </para>
- <figure id="figure_addfacet_0">
- <title>Choose JBoss Web Service Facet</title>
- <mediaobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>
+ Configuration: You may <xref linkend="addfacet"/> by clicking the <property>Modify...</property> button. The opened page is like <property>Figure 2.4</property>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Configure Web Module values:
+ </para>
+
+ <figure>
+ <title>Web Module Settings Configuration</title>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/topdown/jbossws_facet_0.png"/>
+ <imagedata fileref="images/topdown/jbossws_webproject_3.png"/>
</imageobject>
- </mediaobject>
- </figure>
- <para>At the bottom-left of the right-side of the project properties dialog, there is a error link: <emphasis><property>Further configuration required...</property></emphasis> . You must click the link to set more information about JBoss Web Service facet.</para>
- <para>Click on the <emphasis><property>Further configuration required...</property></emphasis> link. In the opened window</para>
- <figure id="figure_addfacet">
- <title>Configure JBoss Web Service Facet</title>
- <mediaobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ If you added the JBoss Web Service facet to the project, now the <property>Finish</property> button is unavailable. You must click <property>Next</property> button to set more information about the JBoss Web Service facet. The page is like <property>Figure 2.5</property>. Then click on the <property>Finish</property> button.
+ </para>
+
+ <para>
+ If you didn't add the JBoss Web Service facet to the project, click on the <property>Finish</property> button. Next you will need to add JBoss Web Service facet to the project.
+ </para>
+ </section>
+
+ <section id="addfacet">
+ <title>Configure JBoss Web Service facet settings</title>
+ <para>
+ If you have already created a new Dynamic Web project and not set the JBoss Web Service facet to the project, the next step is to add JBoss Web Service facet to the project. Right-click on the project, select its <emphasis><property>Properties</property></emphasis> and then find <emphasis>Project Facets</emphasis> in the tree-view on the left-side of the project properties dialog. Tick on the check box for JBoss Web Services. You will see what like this:
+ </para>
+
+ <figure id="figure_addfacet_0">
+ <title>Choose JBoss Web Service Facet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/topdown/jbossws_facet_0.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ At the bottom-left of the right-side of the project properties dialog, there is a error link: <emphasis><property>Further configuration required...</property></emphasis> . You must click the link to set more information about JBoss Web Service facet.
+ </para>
+
+ <para>
+ Click on the <emphasis><property>Further configuration required...</property></emphasis> link. In the opened window
+ </para>
+
+ <figure id="figure_addfacet">
+ <title>Configure JBoss Web Service Facet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/topdown/jbossws_facet.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Server Supplied JBossWS Runtime: If you have already set a JBoss runtime to the project's target runtime, you may choose <emphasis> <property>Server Supplied JBossWS Runtime</property> </emphasis> and then click <emphasis> <property>Ok</property> </emphasis> to finish the configuration of JBoss Web Service facet.
+ </para>
+
+ <para>
+ If the project has no <emphasis> <property>Target Runtime</property> </emphasis> settings, you should check the second radio button and specify a JBossWS runtime from the list. You also can create a new JBossWS runtime, click on the <emphasis> <property>New...</property> </emphasis> button will bring you to another dialog to configure new JBossWS runtime.
+ </para>
+
+ <figure id="figure_addfacet1">
+ <title>Configure JBossWS Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/topdown/jbossws_newruntime.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ See how to configure a new JBossWS runtime in the <xref linkend="preference"/> section.
+ </para>
+
+ <para>
+ After setting the information about JBoss Web Service facet, for saving the result, you should click the <property>Apply</property> or <property>OK</property> button at the bottom-right of the right-side of the project properties dialog.
+ </para>
+ </section>
+
+ <section id="topdownwebservice">
+ <title>Creating a Web Service from a WSDL document using JBossWS runtime</title>
+ <para>
+ In this chapter we provide you with the necessary steps to create a Web Service from a WSDL document using JBossWS runtime.
+ </para>
+
+ <para>
+ At first, please make sure that you have already created a dynamic Web project with JBoss Web Service facet installed.
+ </para>
+
+ <para>
+ See how to make it in the <xref linkend="createproject"/> section and in the <xref
+ linkend="addfacet"/> section.
+ </para>
+ <!--
+ <note>
+ <para>
+ To use the
+ <guilabel>
+ Simple Web Service
+ </guilabel>
+ wizard to create this Web Service, replace the
+ <guilabel>
+ Class
+ </guilabel>
+ and
+ <guilabel>
+ Applicaiton Class
+ </guilabel>
+ fields with your specific classes, within the instructions in <xref linkend="simple_web_service" />.
+ </para>
+ </note>
+ -->
+ <para>
+ To create a Web Service using JBossWS runtime select<emphasis> <property>File > New > Other > Web Services > Web Service</property> </emphasis> to run Web Service creation wizard.
+ </para>
+
+ <para>
+ Let's get through the wizard step-by-step:
+ </para>
+
+ <figure id="figure_create_ws_topdown">
+ <title>New Web Service Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/topdown/jbossws_ws_creation1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Select the stages of Web service development that you want to complete using the slider:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Develop: this will develop the WSDL definition and implementation of the Web service. This includes such tasks as creating modules that will contain generated code, WSDL files, deployment descriptors, and Java files when appropriate.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Assemble: this ensures the project that will host the Web service or client gets associated to an EAR when required by the target application server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Deploy: this will create the deployment code for the service.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Install: this will install and configure the Web module and EARs on the target server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Start: this will start the server once the service has been installed on it. The server-config.wsdd file will be generated.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Test: this will provide various options for testing the service, such as using the Web Service Explorer or sample JSPs.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select your server: the default server is displayed. If you want to deploy your service to a different server click the link to specify a different server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select your runtime: ensure the JBoss WS runtime is selected.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select the service project: the project selected in your workspace is displayed. To select a different project click on the project link. If you are deploying to JBoss Application Server you will also be asked to select the EAR associated with the project. Ensure that the project selected as the Client Web Project is different from the Service Web Project, or the service will be overwritten by the client's generated artifacts.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ If you want to create a client, select the type of proxy to be generated and repeat the above steps for the client. The better way is to create a web service client project separately.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ First, select <property>Top down Java bean Web Service</property> from the Web Service type list, and select a WSDL document from workspace, click on the Server name link on the page will bring you to another dialog. Here you can specify the server to a JBoss Server and Web Service runtime to JBossWS runtime:
+ </para>
+
+ <figure id="figure_create_ws_topdown_setserver">
+ <title>Select Server and Web Service runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/topdown/jbossws_ws_creation1_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Click on the <emphasis> <property>Finish</property> </emphasis> button to see the next wizard view opened:
+ </para>
+
+ <figure id="figure_create_ws_topdown1">
+ <title>New Web Service Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/topdown/jbossws_ws_creation1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Click on the <emphasis> <property>Next</property> </emphasis> button to proceed:
+ </para>
+
+ <figure id="figure_create_ws_topdown_codegen">
+ <title>New Web Service Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/topdown/jbossws_ws_creation2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis> <property>WSDL Service</property> </emphasis> : display the services in your WSDL file, you can select one to generate Web Service.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis> <property>Source Folder</property> </emphasis> : display the source codes folder in your web project, you can select one to generate java codes.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis> <property>Package name</property> </emphasis> : input a package name. You can click the Brown button to choose one. If you don't input a package name, system will generate one for you.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis> <property>JAX-WS specificaiton</property> </emphasis> : display the supported JAX-WS version, include, 2.0, 2.1, 2.2
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis> <property>Catalog file</property> </emphasis> : specify a catalog file.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis> <property>Binding files</property> </emphasis> : specify some binding files that are used by your WSDL file
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis> <property>Enable binding extension support (Only available for JBossWS 3.0 or later)</property> </emphasis> : select it if you need the binding extension support. Only work based on JBossWS 3.0 or later.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis> <property>Generate default Web Service implementation classes</property> </emphasis> : select it if you want to generate empty implementation classes for the selected WSDL Service.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis> <property>Update the default Web.xml</property> </emphasis> : update the Web.xml file with your Web Service servlets configured.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis> <property>Additional Options</property> </emphasis> : the senior options for the generating process. Only for the senior user.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Click on the <emphasis> <property>Next</property> </emphasis> or on the <emphasis> <property>Finish</property> </emphasis> button to generate code.
+ </para>
+
+ <para>
+ Once the Web Service code is generated, you can view the implementation class and add business logic to each method.
+ </para>
+
+ <figure id="figure_impl_code">
+ <title>The generated implementation Java code</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/topdown/jbossws_ws_Impl_code_view.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ View the Web.xml file:
+ </para>
+
+ <figure id="figure_webxml">
+ <title>Web.xml</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/topdown/jbossws_ws_webxml.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ In the next chapter you will find out how to create a Web service from a Java bean.
+ </para>
+ </section>
+
+ <section id="bottomupws">
+ <title>Creating a Web service from a Java bean using JBossWS runtime</title>
+ <para>
+ The Web Service wizard assists you in creating a new Web service, configuring it for deployment, and then deploying it to the server.
+ </para>
+
+ <para>
+ To create a Web service from a bean using JBoss WS:
+ </para>
+
+ <para>
+ Setup <xref linkend="preference"/>.
+ </para>
+
+ <para>
+ Create <xref linkend="createproject"/>.
+ </para>
+
+ <note>
+ <para>
+ To use the
+ <guilabel>
+ Simple Web Service
+ </guilabel>
+ wizard to create this Web Service, replace the
+ <guilabel>
+ Class
+ </guilabel>
+ and
+ <guilabel>
+ Applicaiton Class
+ </guilabel>
+ fields with your specific classes, within the instructions in <xref linkend="simple_web_service" />.
+ </para>
+ </note>
+
+ <para>
+ <xref linkend="addfacet"/>
+ </para>
+
+ <para>
+ Create a Web Service from a java bean:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Switch to the Java EE perspective <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Java EE</guimenuitem></menuchoice>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the Project Explorer view, select the bean that you created or imported into the source folder of your Web project.
+ </para>
+
+ <figure>
+ <title>Select the Bean Created</title>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/topdown/jbossws_facet.png"/>
+ <imagedata scale="80" fileref="images/topdown/jbossws_bottomup.png"/>
</imageobject>
- </mediaobject>
- </figure>
- <para>Server Supplied JBossWS Runtime: If you have already set a JBoss runtime to the
- project's target runtime, you may choose <emphasis>
- <property>Server Supplied JBossWS Runtime</property>
- </emphasis> and then click <emphasis>
- <property>Ok</property>
- </emphasis> to finish the configuration of JBoss Web Service facet. </para>
- <para>If the project has no <emphasis>
- <property>Target Runtime</property>
- </emphasis> settings, you should check the second radio button and specify a JBossWS
- runtime from the list. You also can create a new JBossWS runtime, click on the <emphasis>
- <property>New...</property>
- </emphasis> button will bring you to another dialog to configure new JBossWS runtime.</para>
- <figure id="figure_addfacet1">
- <title>Configure JBossWS Runtime</title>
- <mediaobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>. Select Web Services in order to display various Web service wizards. Select the Web Service wizard. Click on the <property>Next</property> button.
+ </para>
+
+ <figure>
+ <title>New Web Service</title>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/topdown/jbossws_newruntime.png"/>
+ <imagedata fileref="images/topdown/jbossws_bottomup_1.png"/>
</imageobject>
- </mediaobject>
- </figure>
- <para>See how to configure a new JBossWS runtime in the <xref linkend="preference"/> section.</para>
- <para>After setting the information about JBoss Web Service facet, for saving the result, you should click the <property>Apply</property> or <property>OK</property> button at the bottom-right of the right-side of the project properties dialog.</para>
- </section>
-
-
- <section id="topdownwebservice">
- <title>Creating a Web Service from a WSDL document using JBossWS runtime</title>
- <para>In this chapter we provide you with the necessary steps to create a Web Service from a
- WSDL document using JBossWS runtime.</para>
- <para>At first, please make sure that you have already created a dynamic Web project with
- JBoss Web Service facet installed. </para>
- <para>See how to make it in the <xref linkend="createproject"/> section and in the <xref
- linkend="addfacet"/> section.</para>
- <note>
- <para>
- To use the <guilabel>Simple Web Service</guilabel> wizard to create this Web Service, replace the <guilabel>Class</guilabel> and <guilabel>Applicaiton Class</guilabel> fields with your specific classes, within the instructions in <xref linkend="simple_web_service" />.
- </para>
- </note>
- <para>To create a Web Service using JBossWS runtime select<emphasis>
- <property>File > New > Other > Web Services > Web Service</property>
- </emphasis> to run Web Service creation wizard. </para>
- <para>Let's get through the wizard step-by-step:</para>
- <figure id="figure_create_ws_topdown">
- <title>New Web Service Wizard</title>
- <mediaobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>
+ On the first Web Service wizard page: select <property>Bottom up Java bean Web service</property> as your Web service type, and select the Java bean from which the service will be created:
+ </para>
+
+ <figure>
+ <title>Set Web Service Common values</title>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/topdown/jbossws_ws_creation1.png"/>
+ <imagedata fileref="images/topdown/jbossws_bottomup_2.png"/>
</imageobject>
- </mediaobject>
- </figure>
- <para>First, please select <property>Top down Java bean Web Service</property> from the Web
- Service type list, and select a WSDL document from workspace, click on the Server name
- link on the page will bring you to another dialog. Here you can specify the server to a
- JBoss Server and Web Service runtime to JBossWS runtime:</para>
- <figure id="figure_create_ws_topdown_setserver">
- <title>Select Server and Web Service runtime</title>
- <mediaobject>
+ </mediaobject>
+ </figure>
+ <!--
+ <itemizedlist>
+ <listitem>
+ <para>
+ Select the stages of Web service development that you want to complete using the slider:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Develop: this will develop the WSDL definition and implementation of the Web service. This includes such tasks as creating modules that will contain generated code, WSDL files, deployment descriptors, and Java files when appropriate.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Assemble: this ensures the project that will host the Web service or client gets associated to an EAR when required by the target application server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Deploy: this will create the deployment code for the service.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Install: this will install and configure the Web module and EARs on the target server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Start: this will start the server once the service has been installed on it. The server-config.wsdd file will be generated.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Test: this will provide various options for testing the service, such as using the Web Service Explorer or sample JSPs.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select your server: the default server is displayed. If you want to deploy your service to a different server click the link to specify a different server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select your runtime: ensure the JBoss WS runtime is selected.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select the service project: the project selected in your workspace is displayed. To select a different project click on the project link. If you are deploying to JBoss Application Server you will also be asked to select the EAR associated with the project. Ensure that the project selected as the Client Web Project is different from the Service Web Project, or the service will be overwritten by the client's generated artifacts.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ If you want to create a client, select the type of proxy to be generated and repeat the above steps for the client. The better way is to create a web service client project separately.
+ </para>
+ </listitem>
+ </itemizedlist>
+ -->
+
+ <para>
+ Click on the <property>Next</property> button.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ On the JBoss Web Service Code Generation Configuration page, set the following values:
+ </para>
+
+ <figure>
+ <title>Set Web Service values for Code Generation</title>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/topdown/jbossws_ws_creation1_1.png"/>
+ <imagedata fileref="images/topdown/jbossws_bottomup_3.png"/>
</imageobject>
- </mediaobject>
- </figure>
-
- <para>Click on the <emphasis>
- <property>Finish</property>
- </emphasis> button to see the next wizard view opened:</para>
-
- <figure id="figure_create_ws_topdown1">
- <title>New Web Service Wizard</title>
- <mediaobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Generate WSDL file: select it, you will get a generated WSDL file in your project. But this wsdl's service address location values are not a real address.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ After the Web service has been created, the following option can become available depending on the options you selected: Update the default web.xml file. If selected, you may test the web service by Explorer.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ Click on the <property>Next</property> button.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ On this page, the project is deployed to the server. You can start the server and test the web service. If you want to publish the web service to a UDDI registry, you may click the <property>Next</property> button to publish it. If not, you may click the <property>Finish</property> button.
+ </para>
+
+ <figure>
+ <title>Start a Server</title>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/topdown/jbossws_ws_creation1.png"/>
+ <imagedata fileref="images/topdown/jbossws_bottomup_4.png"/>
</imageobject>
- </mediaobject>
- </figure>
-
- <para>Click on the <emphasis>
- <property>Next</property>
- </emphasis> button to proceed:</para>
- <figure id="figure_create_ws_topdown_codegen">
- <title>New Web Service Wizard</title>
- <mediaobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ After the Web Service has been created, the following options may become available depending on the options selected:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ the generated web services code
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ If you selected to generate a WSDL file, you will get the file in your project's wsdl folder.
+ </para>
+
+ <figure>
+ <title>The Generated HelloWorldService.wsdl File in the wsdl Folder</title>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/topdown/jbossws_ws_creation2.png"/>
+ <imagedata scale="80" fileref="images/topdown/jbossws_bottomup_6.png"/>
</imageobject>
- </mediaobject>
- </figure>
- <para>On this page, the default package name comes from the namespace of the WSDL document,
- you also can change it to any valid package name you want. JAX-WS specification should be
- set to 2.0 if your JBossWS runtime in JBoss Server is JBossWS native runtime. You can
- specify a catalog file and binding files if you have them. If you want the wizard to
- generate empty implementation classes for the Web Service, check the <emphasis>
- <property>Generate default Web Service implementation classes</property>
- </emphasis> check box. If you want to update the default Web.xml file with the Web Service
- servlets configured, check the <emphasis>
- <property>Update the default Web.xml</property>
- </emphasis> check box. Click on the <emphasis>
- <property>Next</property>
- </emphasis> or on the <emphasis>
- <property>Finish</property>
- </emphasis> button to generate code.</para>
-
- <para>Once the Web Service code is generated, you can view the implementation class and add
- business logic to each method.</para>
- <figure id="figure_impl_code">
- <title>The generated implementation Java code</title>
- <mediaobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>
+ If you selected to update the default web.xml, you will test the web service in the browser. Open the Explorer, input the url for the web service according to web.xml plus <property>?wsdl</property>, you will get the WSDL file from Explorer.
+ </para>
+
+ <figure>
+ <title>The Updated web.xml file</title>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/topdown/jbossws_ws_Impl_code_view.png"/>
+ <imagedata scale="80" fileref="images/topdown/jbossws_bottomup_5.png"/>
</imageobject>
- </mediaobject>
- </figure>
- <para>View the Web.xml file:</para>
- <figure id="figure_webxml">
- <title>Web.xml</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/topdown/jbossws_ws_webxml.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-<para>In the next chapter you will find out how to create a Web service from a Java bean.</para>
- </section>
-
- <section id="bottomupws">
- <title>Creating a Web service from a Java bean using JBossWS runtime</title>
- <para>The Web Service wizard assists you in creating a new Web service, configuring it for
- deployment, and then deploying it to the server.</para>
- <para>To create a Web service from a bean using JBoss WS:</para>
- <para>Setup <xref linkend="preference"/>.</para>
- <para>Create <xref linkend="createproject"/>.</para>
- <note>
- <para>
- To use the <guilabel>Simple Web Service</guilabel> wizard to create this Web Service, replace the <guilabel>Class</guilabel> and <guilabel>Applicaiton Class</guilabel> fields with your specific classes, within the instructions in <xref linkend="simple_web_service" />.
- </para>
- </note>
- <para><xref linkend="addfacet"/></para>
- <para>Create a Web Service from a java bean: </para>
- <itemizedlist>
- <listitem>
- <para>Switch to the Java EE perspective <emphasis>
- <property>Window > Open Perspective > Java EE</property></emphasis>.</para>
- </listitem>
- <listitem>
- <para>In the Project Explorer view, select the bean that you created or imported into
- the source folder of your Web project.</para>
- <figure>
- <title>Select the Bean Created</title>
- <mediaobject>
- <imageobject>
- <imagedata scale="80" fileref="images/topdown/jbossws_bottomup.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Click <emphasis>
- <property>File > New > Other</property></emphasis>. Select Web Services in order to display various Web service wizards.
- Select the Web Service wizard. Click on the <property>Next</property> button.</para>
- <figure>
- <title>New Web Service</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/topdown/jbossws_bottomup_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>On the first Web Service wizard page: select <property>Bottom up Java bean Web
- service</property> as your Web service type, and select the Java bean from which
- the service will be created:</para>
- <figure>
- <title>Set Web Service Common values</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/topdown/jbossws_bottomup_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Select the stages of Web service development that you want to complete using
- the slider: </para>
- <itemizedlist>
- <listitem>
- <para>Develop: this will develop the WSDL definition and implementation of
- the Web service. This includes such tasks as creating modules that will
- contain generated code, WSDL files, deployment descriptors, and Java
- files when appropriate.</para>
- </listitem>
- <listitem>
- <para>Assemble: this ensures the project that will host the Web service or
- client gets associated to an EAR when required by the target application
- server.</para>
- </listitem>
- <listitem>
- <para>Deploy: this will create the deployment code for the service.</para>
- </listitem>
- <listitem>
- <para>Install: this will install and configure the Web module and EARs on
- the target server.</para>
- </listitem>
- <listitem>
- <para>Start: this will start the server once the service has been installed
- on it. The server-config.wsdd file will be generated.</para>
- </listitem>
- <listitem>
- <para>Test: this will provide various options for testing the service, such
- as using the Web Service Explorer or sample JSPs.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Select your server: the default server is displayed. If you want to deploy
- your service to a different server click the link to specify a different server.
- </para>
- </listitem>
- <listitem>
- <para>Select your runtime: ensure the JBoss WS runtime is selected.</para>
- </listitem>
- <listitem>
- <para>Select the service project: the project selected in your workspace is
- displayed. To select a different project click on the project link. If you are
- deploying to JBoss Application Server you will also be asked to select the EAR
- associated with the project. Ensure that the project selected as the Client Web
- Project is different from the Service Web Project, or the service will be
- overwritten by the client's generated artifacts.</para>
- </listitem>
- <listitem>
- <para>If you want to create a client, select the type of proxy to be generated
- and repeat the above steps for the client. The better way is to create a web
- service client project separately.</para>
- </listitem>
- </itemizedlist>
- <para>Click on the <property>Next</property> button.</para>
- </listitem>
- <listitem>
- <para>On the JBoss Web Service Code Generation Configuration page, set the following
- values:</para>
- <figure>
- <title>Set Web Service values for Code Generation</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/topdown/jbossws_bottomup_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Generate WSDL file: select it, you will get a generated WSDL file in your
- project. But this wsdl's service address location values are not a real
- address. </para>
- </listitem>
- <listitem>
- <para>After the Web service has been created, the following option can become
- available depending on the options you selected: Update the default web.xm
- file. If selected, you may test the web service by Explorer.</para>
- </listitem>
- </itemizedlist>
- <para>Click on the <property>Next</property> button.</para>
- </listitem>
- <listitem>
- <para>On this page, the project is deployed to the server. You can start the server and
- test the web service. If you want to publish the web service to a UDDI registry, you
- may click the <property>Next</property> button to publish it. If not, you may click
- the <property>Finish</property> button.</para>
- <figure>
- <title>Start a Server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/topdown/jbossws_bottomup_4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
- <para>After the Web Service has been created, the following options may become available
- depending on the options selected:</para>
- <itemizedlist>
- <listitem>
- <para>the generated web services code</para>
- </listitem>
- <listitem>
- <para>If you selected to generate a WSDL file, you will get the file in your project's wsdl folder.</para>
- <figure>
- <title>The Generated HelloWorldService.wsdl File in the wsdl Folder</title>
- <mediaobject>
- <imageobject>
- <imagedata scale="80" fileref="images/topdown/jbossws_bottomup_6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>If you selected to update the default web.xml, you will test the web service in
- the browser. Open the Explorer, input the url for the web service according to
- web.xml plus <property>?wsdl</property>, you will get the WSDL file from Explorer. </para>
- <figure>
- <title>The Updated web.xml file</title>
- <mediaobject>
- <imageobject>
- <imagedata scale="80" fileref="images/topdown/jbossws_bottomup_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
- <para>In the next chapter you will be able to create a Web Service Client from a WSDL document using JBoss WS.</para>
-
- </section>
-
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ In the next chapter you will be able to create a Web Service Client from a WSDL document using JBoss WS.
+ </para>
+ </section>
</chapter>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/pom.xml
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/pom.xml 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/pom.xml 2011-07-18 02:56:55 UTC (rev 32989)
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.jboss.tools</groupId>
@@ -10,229 +8,232 @@
<packaging>jdocbook</packaging>
<name>${bookname}-(${translation})</name>
- <properties>
- <translation>en-US</translation>
- <docname>WS_Reference_Guide</docname>
- <bookname>WS Reference Guide</bookname>
- </properties>
-
- <profiles>
+ <properties>
+ <translation>en-US</translation>
+ <docname>WS_Reference_Guide</docname>
+ <bookname>WS Reference Guide</bookname>
+ </properties>
+ <profiles>
+
<!-- mvn compile -->
- <profile>
- <id>all</id>
- <activation>
- <activeByDefault>true</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${docname}.pdf</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>all</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.4</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${docname}.pdf</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <useRelativeImageUris>true</useRelativeImageUris>
+ </options>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Phtml -->
- <profile>
- <id>html</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>html</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Phtml-single -->
- <profile>
- <id>html-single</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- </plugin>
+ <profile>
+ <id>html-single</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Ppdf -->
- <profile>
- <id>pdf</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${docname}.pdf</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>pdf</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${docname}.pdf</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Peclipse -->
- <profile>
- <id>eclipse</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
- </plugins>
- </build>
- </profile>
+ <profile>
+ <id>eclipse</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
- </profiles>
- <build>
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <dependencies>
- <dependency>
- <groupId>org.jboss.pressgang</groupId>
- <artifactId>pressgang-xslt</artifactId>
- <version>1.2.0</version>
- </dependency>
- <dependency>
- <groupId>org.jboss</groupId>
- <artifactId>jbossorg-jdocbook-style</artifactId>
- <version>1.1.1</version>
- <type>jdocbook-style</type>
- </dependency>
- </dependencies>
- <configuration>
- <sourceDirectory>${project.basedir}</sourceDirectory>
+ </profiles>
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <dependencies>
+ <dependency>
+ <groupId>org.jboss.pressgang</groupId>
+ <artifactId>pressgang-xslt</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss</groupId>
+ <artifactId>jbossorg-jdocbook-style</artifactId>
+ <version>1.1.1</version>
+ <type>jdocbook-style</type>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <sourceDirectory>${project.basedir}</sourceDirectory>
<!-- <sourceDocumentName>${docname}.xml</sourceDocumentName> -->
- <sourceDocumentName>master.xml</sourceDocumentName>
- <masterTranslation>en-US</masterTranslation>
- <imageResource>
- <directory>${project.basedir}/en-US</directory>
- <includes>
- <include>images/**/*</include>
- </includes>
- </imageResource>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${pdf.name}</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- <options>
- <xincludeSupported>true</xincludeSupported>
- <xmlTransformerType>saxon</xmlTransformerType>
- <docbookVersion>1.72.0</docbookVersion>
- <localeSeparator>-</localeSeparator>
- <transformerParameters>
- <property>
- <name>javax.xml.parsers.DocumentBuilderFactory</name>
- <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
- </property>
- <property>
- <name>javax.xml.parsers.SAXParserFactory</name>
- <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
- </property>
- </transformerParameters>
- </options>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
+ <sourceDocumentName>master.xml</sourceDocumentName>
+ <masterTranslation>en-US</masterTranslation>
+ <imageResource>
+ <directory>${project.basedir}/en-US</directory>
+ <includes>
+ <include>images/**/*</include>
+ </includes>
+ </imageResource>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${pdf.name}</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <xincludeSupported>true</xincludeSupported>
+ <xmlTransformerType>saxon</xmlTransformerType>
+ <docbookVersion>1.72.0</docbookVersion>
+ <localeSeparator>-</localeSeparator>
+ <transformerParameters>
+ <property>
+ <name>javax.xml.parsers.DocumentBuilderFactory</name>
+ <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
+ </property>
+ <property>
+ <name>javax.xml.parsers.SAXParserFactory</name>
+ <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
+ </property>
+ </transformerParameters>
+ </options>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
</project>
Modified: branches/jbosstools-3.2.x/ws/docs/reference/publican.cfg
===================================================================
--- branches/jbosstools-3.2.x/ws/docs/reference/publican.cfg 2011-07-18 02:52:59 UTC (rev 32988)
+++ branches/jbosstools-3.2.x/ws/docs/reference/publican.cfg 2011-07-18 02:56:55 UTC (rev 32989)
@@ -4,4 +4,3 @@
xml_lang: en-US
type: Book
brand: JBoss
-
14 years, 9 months
- 1
- 0
JBoss Tools SVN: r32988 - branches/jbosstools-3.2.x/ws/docs.
by jbosstools-commits＠lists.jboss.org
Author: irooskov(a)redhat.com
Date: 2011-07-17 22:52:59 -0400 (Sun, 17 Jul 2011)
New Revision: 32988
Removed:
branches/jbosstools-3.2.x/ws/docs/Web_Service_Test_View_deprecated/
Log:
removing deprecated book - will not be released
14 years, 9 months
- 1
- 0
JBoss Tools SVN: r32987 - in branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial: en-US and 1 other directory.
by jbosstools-commits＠lists.jboss.org
Author: irooskov(a)redhat.com
Date: 2011-07-17 22:52:04 -0400 (Sun, 17 Jul 2011)
New Revision: 32987
Modified:
branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Book_Info.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Feedback.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Preface.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Struts_Tools_Tutorial.ent
branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Struts_Tools_Tutorial.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/coding_files.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/generating_stub.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/introduction.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/master.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/struts_application.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/struts_validation.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/pom.xml
Log:
updated for GA
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Book_Info.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Book_Info.xml 2011-07-18 02:48:03 UTC (rev 32986)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Book_Info.xml 2011-07-18 02:52:04 UTC (rev 32987)
@@ -5,9 +5,9 @@
<title>Struts Tools Tutorial</title>
<subtitle>Guides the reader through a tutorial on the Struts Tools set.</subtitle>
<productname>JBoss Developer Studio</productname>
- <productnumber>4.0</productnumber>
- <edition>4.0.0</edition>
- <pubsnumber>4</pubsnumber>
+ <productnumber>4.1</productnumber>
+ <edition>4.1.0</edition>
+ <pubsnumber>1</pubsnumber>
<abstract>
<para>The Struts Tools Tutorial guide explains how to use the Struts Tools set and guides the reader through a tutorial.</para>
</abstract>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Feedback.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Feedback.xml 2011-07-18 02:48:03 UTC (rev 32986)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Feedback.xml 2011-07-18 02:52:04 UTC (rev 32987)
@@ -1,20 +1,92 @@
<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Document_Conventions.ent">
+%BOOK_ENTITIES;
+]>
+<appendix id="sect_JBoss-Getting_Help_and_Giving_Feedback" lang="en-US">
+ <title>Getting Help and Giving Feedback</title>
+ <section id="sect_JBoss-Do_You_Need_Help">
+ <title>Do You Need Help?</title>
+ <indexterm>
+ <primary>help</primary>
+ <secondary>getting help</secondary>
-<section id="sect-Beginners_Guide-We_Need_Feedback" lang="en-US">
- <title>We Need Feedback!</title>
- <indexterm>
- <primary>feedback</primary>
- <secondary>contact information for this manual</secondary>
- </indexterm>
- <para>
- If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA against JBoss Developer Studio: <ulink url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...">https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...</ulink>
- </para>
- <para>
- When submitting a bug report, be sure to mention the manual's name and to select the "documentation" component.
- </para>
- <para>
- If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.
- </para>
-</section>
+ </indexterm>
+ <para>
+ If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at <ulink url="http://access.redhat.com" />. Through the customer portal, you can:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ search or browse through a knowledgebase of technical support articles about Red Hat products.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ submit a support case to Red Hat Global Support Services (GSS).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ access other product documentation.
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+ <para>
+ Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. You can find a list of publicly available mailing lists at <ulink url="https://www.redhat.com/mailman/listinfo" />. Click on the name of any mailing list to subscribe to that list or to access the list archives.
+ </para>
+
+ </section>
+
+ <section id="jboss-feedback">
+ <title>Give us Feedback</title>
+ <!-- NOTE: You will need the following entities defined in your .ent file.
+ You will need to replace _YOUR_PRODUCT_HERE_, _YOUR_COMPONENT_
+ and _YOUR_SUMMARY_ - entities are not replaced in URLs.
+ <!ENTITY PRODUCT "JBoss Product Name">
+ <!ENTITY BZCOMPONENT "doc-triage">
+ <!ENTITY BZURL "<ulink url='https://bugzilla.example.com/enter_bug.cgi?product=_YOUR_PRODUCT_HERE_&am...'>http://bugzilla.redhat.com/</ulink>">
+
+ These entities should not affect translated documents, since Bugzilla is not localised.
+ --> <indexterm>
+ <primary>feedback</primary>
+ <secondary>contact information for this manual</secondary>
+
+ </indexterm>
+ <para>
+ If you find a typographical error, or know how this guide can be improved, we would love to hear from you. Submit a report in Bugzilla against the product <literal>&BZPRODUCT;</literal> and the component <literal>&BZCOMPONENT;</literal>. The following link will take you to a pre-filled bug report for this product: &BZURL;.
+ </para>
+ <para>
+ Fill out the following template in Bugzilla's <literal>Description</literal> field. Be as specific as possible when describing the issue; this will help ensure that we can fix it quickly.
+ </para>
+
+<screen>Document URL:
+
+
+Section Number and Name:
+
+
+Describe the issue:
+
+
+Suggestions for improvement:
+
+
+Additional information:
+
+
+</screen>
+ <para>
+ Be sure to give us your name so that you can receive full credit for reporting the issue.
+ </para>
+
+ </section>
+
+
+</appendix>
+
+
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Preface.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Preface.xml 2011-07-18 02:48:03 UTC (rev 32986)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Preface.xml 2011-07-18 02:52:04 UTC (rev 32987)
@@ -8,9 +8,5 @@
<para>
This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. To get more information on these conventions please refer to the <guilabel>Document Conventions</guilabel> manual, which can be found on the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index.html">Red Hat Documentation</ulink> website under the <guilabel>JBoss Developer Studio</guilabel> section.
</para>
- <!--<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- </xi:fallback>
- </xi:include>-->
</preface>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Struts_Tools_Tutorial.ent
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Struts_Tools_Tutorial.ent 2011-07-18 02:48:03 UTC (rev 32986)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Struts_Tools_Tutorial.ent 2011-07-18 02:52:04 UTC (rev 32987)
@@ -1,4 +1,7 @@
<!ENTITY PRODUCT "JBoss">
<!ENTITY BOOKID "Struts_Tools_Tutorial">
-<!ENTITY YEAR "2010">
+<!ENTITY YEAR "2011">
<!ENTITY HOLDER "Red Hat">
+<!ENTITY BZPRODUCT "JBoss Developer Studio">
+<!ENTITY BZCOMPONENT "Struts Tools Tutorial">
+<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss%20Develope...'>http://bugzilla.redhat.com/</ulink>">
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Struts_Tools_Tutorial.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Struts_Tools_Tutorial.xml 2011-07-18 02:48:03 UTC (rev 32986)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/Struts_Tools_Tutorial.xml 2011-07-18 02:52:04 UTC (rev 32987)
@@ -11,5 +11,6 @@
<xi:include href="compiling_and_running.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="struts_validation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="relevant_resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
+<xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
</book>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/coding_files.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/coding_files.xml 2011-07-18 02:48:03 UTC (rev 32986)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/coding_files.xml 2011-07-18 02:52:04 UTC (rev 32987)
@@ -1,433 +1,514 @@
-<?xml version='1.0' encoding='UTF-8'?>
-<chapter id="coding_files">
- <?dbhtml filename="coding_files.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Struts</keyword>
- <keyword>Struts Application</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Coding the Various Files</title>
- <para>We will now code both the Java stub classes just generated, the JSP files left in as
- placeholders from previous steps, and a new start JSP page we will have to create.</para>
- <section id="JavaStubClasses">
- <title>Java Stub Classes</title>
- <itemizedlist>
- <listitem>
- <para>To finish the two Java classes, switch to the <emphasis>
- <property>Package Explorer</property>
- </emphasis> view and expand the <emphasis>
- <property>JavaSource > sample</property>
- </emphasis> folder</para>
- </listitem>
- </itemizedlist>
- <section id="GetNameForm.java">
- <title>GetNameForm.java</title>
- <itemizedlist>
- <listitem>
- <para>Double-click <emphasis>
- <property>GetNameForm.java</property>
- </emphasis> for editing</para>
- </listitem>
-
- <listitem>
- <para>You are looking at a Java stub class that was generated by JBoss
- Tools. Now we are going to edit the file</para>
- </listitem>
-
- <listitem>
- <para>Add the following attributes at the beginning of the class:</para>
- </listitem>
- </itemizedlist>
- <programlisting role="JAVA"><![CDATA[private String name = "";
-]]></programlisting>
-
- <itemizedlist>
- <listitem>
- <para>Inside the reset method, delete the TO DO and throw lines and
- add:</para>
- </listitem>
- </itemizedlist>
- <programlisting role="JAVA"><![CDATA[this.name = "";
-]]></programlisting>
-
- <itemizedlist>
- <listitem>
- <para>Inside the validate method, delete the TO DO and throw lines and
- add:</para>
- </listitem>
- </itemizedlist>
- <programlisting role="JAVA"><![CDATA[ActionErrors errors = new ActionErrors();
- return errors;
-]]></programlisting>
-
- <itemizedlist>
- <listitem>
- <para>Right-click and select <emphasis>
- <property>Source > Generate Getters and Setters</property>
- </emphasis>from the context menu</para>
- </listitem>
- <listitem>
- <para>In the dialog box, check the check box for <emphasis>
- <property>name</property>,</emphasis>
- select First method for Insertion point, and click on the <emphasis>
- <property>OK</property>
- </emphasis> button</para>
- </listitem>
- </itemizedlist>
- <para>The final <emphasis>
- <property>GetNameForm.java</property></emphasis> file should look like this:</para>
- <programlisting role="JAVA"><![CDATA[package sample;
-import javax.servlet.http.HttpServletRequest;
-import org.apache.struts.action.ActionErrors;
-import org.apache.struts.action.ActionMapping;
-
-public class GetNameForm extends org.apache.struts.action.ActionForm
-{
-
- private String name = "";
-
- public String getName()
- {
- return name;
- }
- public void setName(String name)
- {
- this.name = name;
- }
-
- public GetNameForm()
- {
- }
-
- public void reset(ActionMapping actionMapping, HttpServletRequest request)
- {
- this.name = "";
- }
-
- public ActionErrors validate(ActionMapping actionMapping,
- HttpServletRequest request)
- {
- ActionErrors errors = new ActionErrors();
- return errors;
- }
-}
-]]></programlisting>
-
- <itemizedlist>
- <listitem>
- <para>Save the file</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="GreetingAction.java">
- <title>GreetingAction.java</title>
- <itemizedlist>
- <listitem>
- <para>Open <emphasis>
- <property>GreetingAction.java</property></emphasis> for editing</para>
- </listitem>
- <listitem>
- <para>Inside the execute method, delete the TO DO lines and add the
- following:</para>
- </listitem>
- </itemizedlist>
-
- <programlisting role="JAVA"><![CDATA[String name = ((GetNameForm)form).getName();
-String greeting = "Hello, "+name+"!";
-((GetNameForm)form).setName(greeting);
-return mapping.findForward(FORWARD_sayHello);
-]]></programlisting>
-
- <para>The final version of <emphasis>
- <property>GreetingAction.java</property></emphasis> should look like this:</para>
-
- <programlisting role="JAVA"><![CDATA[package sample;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-import org.apache.struts.action.ActionForm;
-import org.apache.struts.action.ActionForward;
-import org.apache.struts.action.ActionMapping;
-
-public class GreetingAction extends org.apache.struts.action.Action
-{
-
- // Global Forwards
- public static final String GLOBAL_FORWARD_getName = "getName";
-
- // Local Forwards
- public static final String FORWARD_sayHello = "sayHello";
-
- public GreetingAction()
- {
- }
- public ActionForward execute(ActionMapping mapping, ActionForm form,
- HttpServletRequest request, HttpServletResponse response) throws Exception
- {
- String name = ((GetNameForm)form).getName();
- String greeting = "Hello, "+name+"!";
- ((GetNameForm)form).setName(greeting);
- return mapping.findForward(FORWARD_sayHello);
- }
-}
-]]></programlisting>
- <itemizedlist>
- <listitem>
- <para>Save the file</para>
- </listitem>
- <listitem>
- <para>Close the editors for the two Java files</para>
- </listitem>
- </itemizedlist>
- <para>The last thing left to do is to code the JSP files whose editors should still
- be open from having been created as placeholders.</para>
- </section>
- </section>
- <section id="JSPPages">
- <title>JSP Pages</title>
- <section id="inputname.jsp">
- <title>inputname.jsp</title>
- <para>In this page, the user will enter any name and click the <emphasis>
- <property>submit</property>
- </emphasis> button. Then, the greeting action will be called through the form.</para>
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis>
- <property>inputname.jsp</property>
- </emphasis> tab in the Editing area to bring its editor forward</para>
- </listitem>
- <listitem>
- <para>In the Web Projects view, expand <emphasis>
- <property>StrutsHello > Configuration > default
- > struts-config.xml > action-mappings</property>
- </emphasis> and select <emphasis>
- <property>/greeting</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>Drag it and drop it between the quotes for the <emphasis role="italic">
- <property>"action"</property>
- </emphasis> attribute to the
- <code><html:form></code>
- element in the Source pane of the editor</para>
- </listitem>
- <listitem>
- <para>Then type this text on a new line just below this line:</para>
- <programlisting role="XML"><![CDATA[Input name:
- ]]></programlisting>
- </listitem>
-
- <listitem>
- <para>Select the <emphasis>
- <property>Visual</property>
- </emphasis> pane of the editor</para>
- </listitem>
- <listitem>
- <para>Then, in the JBoss Tools Palette, expand the <emphasis>
- <property>Struts Form</property>
- </emphasis> library, select <emphasis>
- <property>text</property>
- </emphasis>, and drag it onto the box
- <note>
- <title>Note:</title>
- <para>By default there are only four groups on the JBoss Tools
- Palette. If you wish to make some group visible click the <emphasis>
- <property>Show/Hide</property>
- </emphasis> button on the top of palette and in the prompted
- dialog check the group (or groups) you want to be shown.</para>
- </note>
- </para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>JBoss Tools Palette</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts_application/struts_application_3.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>In the Insert Tag dialog box, type in name for property and select <emphasis>
- <property>Finish</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>In the StrutsForm library in the <property>JBoss Tools Palette</property>, select <emphasis>
- <property>submit</property>
- </emphasis>, and drag it to right after the text box in the Visual pane
- of the editor</para>
- </listitem>
- <listitem>
- <para>Right-click the <emphasis>
- <property>submit</property>
- </emphasis> button and select
- <code><html:submit></code>
- Attributes from the context menu</para>
- </listitem>
- <listitem>
- <para>In the Attributes dialog box, select the <emphasis>
- <property>value</property>
- </emphasis> field and type in "Say Hello!" for its
- value</para>
- </listitem>
- </itemizedlist>
- <para>After tidying the page source, the Editor window for the file should look
- something like this:</para>
- <figure>
- <title>Editor Window</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts_application/struts_application_4.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section id="greeting.jsp">
- <title>greeting.jsp</title>
- <para>Next, we will fill in the result page.</para>
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis>
- <property>greeting.jsp</property>
- </emphasis> tab in the Editing area to bring its editor forward</para>
- </listitem>
- <listitem>
- <para>Type in the following code:</para>
- </listitem>
- </itemizedlist>
- <programlisting role="XML"><![CDATA[<html>
-<head>
- <title>Greeting</title>
-</head>
- <body>
- <p>
- </p>
- </body>
-</html>
-]]></programlisting>
-
- <para>To complete editing of this file, we will use macros from the <property>JBoss Tools
- Palette</property>. This palette is a view that should be available to the right of the
- editing area.</para>
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis>
- <property>Struts Common</property>
- </emphasis> folder in the <property>JBoss Tools Palette</property> to open it</para>
- </listitem>
- <listitem>
- <para>Position the cursor at the beginning of the <emphasis>
- <property>greeting.jsp</property></emphasis> file in the
- Source pane and then click on <emphasis>
- <property>bean taglib</property></emphasis> in the <property>JBoss Tools
- Palette</property></para>
- </listitem>
- </itemizedlist>
- <para>This will insert the following line at the top of the file:</para>
- <programlisting role="JAVA"><![CDATA[
-<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean" %>
-]]></programlisting>
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis>
- <property>Struts Bean</property>
- </emphasis> folder in the <property>JBoss Tools Palette</property> to open it</para>
- </listitem>
- <listitem>
- <para>Position the cursor inside the
- <code><p></code>
- element</para>
- </listitem>
- <listitem>
- <para>Click on <emphasis>
- <property>write</property></emphasis> in the <property>JBoss Tools Palette</property></para>
- </listitem>
- <listitem>
- <para>Type in "GetNameForm" for the <emphasis
- role="italic">
- <property>name</property>
- </emphasis> attribute and add a <emphasis role="italic">
- <property>property</property>
- </emphasis> attribute with "name" as its
- value</para>
- </listitem>
- </itemizedlist>
- <para>The editor should now look like this:</para>
- <figure>
- <title>Editor Window</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts_application/struts_application_5.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section id="index.jsp">
- <title>index.jsp</title>
- <para>Finally, we will need to create and edit an <emphasis>
- <property>index.jsp</property></emphasis> page. This page will use
- a Struts forward to simply redirect us to the getName global forward.</para>
- <itemizedlist>
- <listitem>
- <para>In the Web Projects view, right-click on <emphasis>
- <property>StrutsHello > WEB-ROOT(WebContent)</property>
- </emphasis> node and select <emphasis>
- <property>New > File > JSP</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>Type <emphasis>
- <property>index</property></emphasis> for Name and click on the <emphasis>
- <property>Finish</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>On the <property>JBoss Tools Palette</property>, select the <emphasis>
- <property>Struts Common</property>
- </emphasis> folder of macros by clicking on it in the palette</para>
- </listitem>
- <listitem>
- <para>Click on the <emphasis>
- <property>logic taglib</property></emphasis> icon</para>
- </listitem>
- <listitem>
- <para>Press the <emphasis>
- <property>Enter</property>
- </emphasis> key in the editor to go to the next line</para>
- </listitem>
- <listitem>
- <para>Back on the palette, select the <emphasis>
- <property>Struts Logic</property>
- </emphasis> folder of macros</para>
- </listitem>
- <listitem>
- <para>Click on <emphasis>
- <property>redirect</property></emphasis></para>
- </listitem>
- <listitem>
- <para>Delete the ending tag, put a forward slash in front of the closing
- angle bracket, and type "forward=getName" in front of
- the slash</para>
- </listitem>
- </itemizedlist>
- <para>The finished code for the page is shown below:</para>
- <programlisting role="JAVA"><![CDATA[<%@ taglib uri="/WEB-INF/struts-logic.tld" prefix="logic" %>
-<logic:redirect forward="getName"/>
-]]></programlisting>
- <itemizedlist>
- <listitem>
- <para>To save all the edits to files, select <emphasis>
- <property>File>Save All</property>
- </emphasis> from the menu bar</para>
- </listitem>
- </itemizedlist>
- </section>
- </section>
- </chapter>
\ No newline at end of file
+<?xml version='1.0' encoding='UTF-8'?>
+<chapter id="coding_files">
+<?dbhtml filename="coding_files.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+
+ <keyword>Struts</keyword>
+
+ <keyword>Struts Application</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Coding the Various Files</title>
+ <para>
+ We will now code both the Java stub classes just generated, the JSP files left in as placeholders from previous steps, and a new start JSP page we will have to create.
+ </para>
+
+ <section id="JavaStubClasses">
+ <title>Java Stub Classes</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ To finish the two Java classes, switch to the <emphasis> <property>Package Explorer</property> </emphasis> view and expand the <menuchoice><guimenuitem>JavaSource</guimenuitem><guimenuitem>sample</guimenuitem></menuchoice> folder
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <section id="GetNameForm.java">
+ <title>GetNameForm.java</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Double-click <emphasis> <property>GetNameForm.java</property> </emphasis> for editing
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ You are looking at a Java stub class that was generated by JBoss Tools. Now we are going to edit the file
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Add the following attributes at the beginning of the class:
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <programlisting role="JAVA">
+<![CDATA[private String name = "";
+]]>
+ </programlisting>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Inside the reset method, delete the TO DO and throw lines and add:
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <programlisting role="JAVA">
+<![CDATA[this.name = "";
+]]>
+ </programlisting>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Inside the validate method, delete the TO DO and throw lines and add:
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <programlisting role="JAVA">
+<![CDATA[ActionErrors errors = new ActionErrors();
+ return errors;
+]]>
+ </programlisting>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Right-click and select <menuchoice><guimenuitem>Source</guimenuitem><guimenuitem>Generate Getters and Setters</guimenuitem></menuchoice>from the context menu
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the dialog box, check the check box for <emphasis> <property>name</property>,</emphasis> select First method for Insertion point, and click on the <emphasis> <property>OK</property> </emphasis> button
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ The final <emphasis> <property>GetNameForm.java</property></emphasis> file should look like this:
+ </para>
+
+ <programlisting role="JAVA">
+<![CDATA[package sample;
+import javax.servlet.http.HttpServletRequest;
+import org.apache.struts.action.ActionErrors;
+import org.apache.struts.action.ActionMapping;
+
+public class GetNameForm extends org.apache.struts.action.ActionForm
+{
+
+ private String name = "";
+
+ public String getName()
+ {
+ return name;
+ }
+ public void setName(String name)
+ {
+ this.name = name;
+ }
+
+ public GetNameForm()
+ {
+ }
+
+ public void reset(ActionMapping actionMapping, HttpServletRequest request)
+ {
+ this.name = "";
+ }
+
+ public ActionErrors validate(ActionMapping actionMapping,
+ HttpServletRequest request)
+ {
+ ActionErrors errors = new ActionErrors();
+ return errors;
+ }
+}
+]]>
+ </programlisting>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Save the file
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="GreetingAction.java">
+ <title>GreetingAction.java</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Open <emphasis> <property>GreetingAction.java</property></emphasis> for editing
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Inside the execute method, delete the TO DO lines and add the following:
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <programlisting role="JAVA">
+<![CDATA[String name = ((GetNameForm)form).getName();
+String greeting = "Hello, "+name+"!";
+((GetNameForm)form).setName(greeting);
+return mapping.findForward(FORWARD_sayHello);
+]]>
+ </programlisting>
+
+ <para>
+ The final version of <emphasis> <property>GreetingAction.java</property></emphasis> should look like this:
+ </para>
+
+ <programlisting role="JAVA">
+<![CDATA[package sample;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import org.apache.struts.action.ActionForm;
+import org.apache.struts.action.ActionForward;
+import org.apache.struts.action.ActionMapping;
+
+public class GreetingAction extends org.apache.struts.action.Action
+{
+
+ // Global Forwards
+ public static final String GLOBAL_FORWARD_getName = "getName";
+
+ // Local Forwards
+ public static final String FORWARD_sayHello = "sayHello";
+
+ public GreetingAction()
+ {
+ }
+ public ActionForward execute(ActionMapping mapping, ActionForm form,
+ HttpServletRequest request, HttpServletResponse response) throws Exception
+ {
+ String name = ((GetNameForm)form).getName();
+ String greeting = "Hello, "+name+"!";
+ ((GetNameForm)form).setName(greeting);
+ return mapping.findForward(FORWARD_sayHello);
+ }
+}
+]]>
+ </programlisting>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Save the file
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Close the editors for the two Java files
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ The last thing left to do is to code the JSP files whose editors should still be open from having been created as placeholders.
+ </para>
+ </section>
+ </section>
+
+ <section id="JSPPages">
+ <title>JSP Pages</title>
+ <section id="inputname.jsp">
+ <title>inputname.jsp</title>
+ <para>
+ In this page, the user will enter any name and click the <emphasis> <property>submit</property> </emphasis> button. Then, the greeting action will be called through the form.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Click on the <emphasis> <property>inputname.jsp</property> </emphasis> tab in the Editing area to bring its editor forward
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the Web Projects view, expand <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>Configuration</guimenuitem><guimenuitem>default</guimenuitem><guimenuitem>struts-config.xml</guimenuitem><guimenuitem>action-mappings</guimenuitem></menuchoice> and select <emphasis> <property>/greeting</property> </emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Drag it and drop it between the quotes for the <emphasis role="italic"> <property>"action"</property> </emphasis> attribute to the <code><html:form></code> element in the Source pane of the editor
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Then type this text on a new line just below this line:
+ </para>
+
+ <programlisting role="XML">
+<![CDATA[Input name:
+ ]]>
+ </programlisting>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select the <emphasis> <property>Visual</property> </emphasis> pane of the editor
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Then, in the JBoss Tools Palette, expand the <emphasis> <property>Struts Form</property> </emphasis> library, select <emphasis> <property>text</property> </emphasis>, and drag it onto the box
+ <note>
+ <title>Note:</title>
+ <para>
+ By default there are only four groups on the JBoss Tools Palette. If you wish to make some group visible click the <emphasis> <property>Show/Hide</property> </emphasis> button on the top of palette and in the prompted dialog check the group (or groups) you want to be shown.
+ </para>
+ </note>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>JBoss Tools Palette</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_application/struts_application_3.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ In the Insert Tag dialog box, type in name for property and select <emphasis> <property>Finish</property> </emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the StrutsForm library in the <property>JBoss Tools Palette</property>, select <emphasis> <property>submit</property> </emphasis>, and drag it to right after the text box in the Visual pane of the editor
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Right-click the <emphasis> <property>submit</property> </emphasis> button and select <code><html:submit></code> Attributes from the context menu
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the Attributes dialog box, select the <emphasis> <property>value</property> </emphasis> field and type in "Say Hello!" for its value
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ After tidying the page source, the Editor window for the file should look something like this:
+ </para>
+
+ <figure>
+ <title>Editor Window</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_application/struts_application_4.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="greeting.jsp">
+ <title>greeting.jsp</title>
+ <para>
+ Next, we will fill in the result page.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Click on the <emphasis> <property>greeting.jsp</property> </emphasis> tab in the Editing area to bring its editor forward
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Type in the following code:
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <programlisting role="XML">
+<![CDATA[<html>
+<head>
+ <title>Greeting</title>
+</head>
+ <body>
+ <p>
+ </p>
+ </body>
+</html>
+]]>
+ </programlisting>
+
+ <para>
+ To complete editing of this file, we will use macros from the <property>JBoss Tools Palette</property>. This palette is a view that should be available to the right of the editing area.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Click on the <emphasis> <property>Struts Common</property> </emphasis> folder in the <property>JBoss Tools Palette</property> to open it
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Position the cursor at the beginning of the <emphasis> <property>greeting.jsp</property></emphasis> file in the Source pane and then click on <emphasis> <property>bean taglib</property></emphasis> in the <property>JBoss Tools Palette</property>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ This will insert the following line at the top of the file:
+ </para>
+
+ <programlisting role="JAVA">
+<![CDATA[
+<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean" %>
+]]>
+ </programlisting>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Click on the <emphasis> <property>Struts Bean</property> </emphasis> folder in the <property>JBoss Tools Palette</property> to open it
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Position the cursor inside the <code><p></code> element
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click on <emphasis> <property>write</property></emphasis> in the <property>JBoss Tools Palette</property>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Type in "GetNameForm" for the <emphasis
+ role="italic"> <property>name</property> </emphasis> attribute and add a <emphasis role="italic"> <property>property</property> </emphasis> attribute with "name" as its value
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ The editor should now look like this:
+ </para>
+
+ <figure>
+ <title>Editor Window</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_application/struts_application_5.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="index.jsp">
+ <title>index.jsp</title>
+ <para>
+ Finally, we will need to create and edit an <emphasis> <property>index.jsp</property></emphasis> page. This page will use a Struts forward to simply redirect us to the getName global forward.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ In the Web Projects view, right-click on <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>WEB-ROOT(WebContent)</guimenuitem></menuchoice> node and select <emphasis> <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>File</guimenuitem><guimenuitem>JSP</guimenuitem></menuchoice> </emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Type <emphasis> <property>index</property></emphasis> for Name and click on the <emphasis> <property>Finish</property> </emphasis> button
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ On the <property>JBoss Tools Palette</property>, select the <emphasis> <property>Struts Common</property> </emphasis> folder of macros by clicking on it in the palette
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click on the <emphasis> <property>logic taglib</property></emphasis> icon
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Press the <emphasis> <property>Enter</property> </emphasis> key in the editor to go to the next line
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Back on the palette, select the <emphasis> <property>Struts Logic</property> </emphasis> folder of macros
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click on <emphasis> <property>redirect</property></emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Delete the ending tag, put a forward slash in front of the closing angle bracket, and type "forward=getName" in front of the slash
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ The finished code for the page is shown below:
+ </para>
+
+ <programlisting role="JAVA">
+<![CDATA[<%@ taglib uri="/WEB-INF/struts-logic.tld" prefix="logic" %>
+<logic:redirect forward="getName"/>
+]]>
+ </programlisting>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ To save all the edits to files, select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save All</guimenuitem></menuchoice> from the menu bar
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ </section>
+</chapter>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/generating_stub.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/generating_stub.xml 2011-07-18 02:48:03 UTC (rev 32986)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/generating_stub.xml 2011-07-18 02:52:04 UTC (rev 32987)
@@ -1,51 +1,65 @@
-<?xml version='1.0' encoding='UTF-8'?>
-<chapter id="generating_stub">
- <?dbhtml filename="generating_stub.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Struts</keyword>
- <keyword>Struts Application</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Generating Stub Coding</title>
- <para>We are done with designing the application through the diagram. Now we need to write
- code for the action component. We also need to write an action class for the <emphasis>
- <property>/greeting</property>
- </emphasis> mapping along with a FormBean. To aid in the coding phase, JBoss Developer
- Studio can generate Java class stubs for all of the components shown in the diagram.</para>
- <itemizedlist>
- <listitem>
- <para>Switch back to the diagram, by selecting the <emphasis>
- <property>Diagram</property>
- </emphasis> tab at the bottom of the editor window</para>
- </listitem>
- <listitem>
- <para>Right-click a blank space in the diagram and select <emphasis>
- <property>Generate Java Code</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>Leave everything as is in the dialog box and click <emphasis>
- <property>Generate</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
- <para>You should see a screen that says:</para>
- <para>Generated classes: 2</para>
- <para>Actions: 1</para>
- <para>Form beans: 1</para>
- <itemizedlist>
- <listitem>
- <para>Click <emphasis>
- <property>Finish</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
- <para>The Java files will be generated in a <emphasis>
- <property>JavaSource > sample</property>
- </emphasis> folder that you can see in the <property>Package Explorer view</property> under the
- "StrutsHello" node. One Action stub and one FormBean stub will have
- been generated.</para>
- </chapter>
\ No newline at end of file
+<?xml version='1.0' encoding='UTF-8'?>
+<chapter id="generating_stub">
+<?dbhtml filename="generating_stub.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+
+ <keyword>Struts</keyword>
+
+ <keyword>Struts Application</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Generating Stub Coding</title>
+ <para>
+ We are done with designing the application through the diagram. Now we need to write code for the action component. We also need to write an action class for the <emphasis> <property>/greeting</property> </emphasis> mapping along with a FormBean. To aid in the coding phase, JBoss Developer Studio can generate Java class stubs for all of the components shown in the diagram.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Switch back to the diagram, by selecting the <emphasis> <property>Diagram</property> </emphasis> tab at the bottom of the editor window
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Right-click a blank space in the diagram and select <emphasis> <property>Generate Java Code</property> </emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Leave everything as is in the dialog box and click <emphasis> <property>Generate</property> </emphasis>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ You should see a screen that says:
+ </para>
+
+ <para>
+ Generated classes: 2
+ </para>
+
+ <para>
+ Actions: 1
+ </para>
+
+ <para>
+ Form beans: 1
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Click <emphasis> <property>Finish</property> </emphasis>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ The Java files will be generated in a <menuchoice><guimenuitem>JavaSource</guimenuitem><guimenuitem>sample</guimenuitem></menuchoice> folder that you can see in the <property>Package Explorer view</property> under the "StrutsHello" node. One Action stub and one FormBean stub will have been generated.
+ </para>
+</chapter>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/introduction.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/introduction.xml 2011-07-18 02:48:03 UTC (rev 32986)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/introduction.xml 2011-07-18 02:52:04 UTC (rev 32987)
@@ -1,100 +1,124 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="introduction">
- <?dbhtml filename="introduction.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
- <title>Introduction</title>
- <para>The following chapters describe how to deal with classic/old style of Struts development. We
- recommend users to use JBoss Seam to
- simplify development, but until then you can read about classical Struts usage here.</para>
-
- <para>We are going to show you how to create a simple <emphasis>
- <property>Struts application</property>
- </emphasis> using the JBoss Tools. The completed application will ask a user to enter
- a name and click a button. The resulting new page will display the familiar message,
- "Hello <name>!"</para>
- <para>This document will show you how to create such an application from the beginning, along the
- way demonstrating some of the powerful features of JBoss Tools. With the help of our tutorial you will design the
- application, generate stub code for the application, fill in the stub coding, compile the
- application, and finally run it all from inside the Eclipse.</para>
-
- <section>
- <title>Key Features Struts Tools</title>
-
- <para>For a start, we propose you to look through the table of main features of Struts
- Tools:</para>
- <table>
-
- <title>Key Functionality of Struts Tools</title>
- <tgroup cols="2">
-
- <colspec colnum="1" align="left" colwidth="2*"/>
- <colspec colnum="2" colwidth="4*"/>
-
-
- <thead>
- <row>
- <entry>Feature</entry>
- <entry>Benefit</entry>
-
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>Struts Support</para></entry>
- <entry><para>Step-by-step wizards for creating a new struts project with a number
- of predefined templates, importing existing ones and adding struts
- capabilities to non-struts web projects.</para></entry>
-
- </row>
-
- <row>
- <entry><para>Support for Struts Configuration File</para></entry>
- <entry><para>Working on file using three modes: diagram, tree and source.
- Synchronization between the modes and full control over the code. Easy
- moving around the diagram using the Diagram Navigator. Working with
- struts projects that have multiple modules. Possibility to use Struts
- configuration file debugger allowing to set break points on struts
- diagram and then launch the server in debug mode.</para></entry>
-
- </row>
-
- <row>
- <entry><para>Support for Struts modules</para></entry>
- <entry><para>A Struts module (struts-config.xml) is automatically created while
- creating a new project. There is also possibility to add new ones or edit
- already existing modules in your existing project or while importing Struts project.</para></entry>
-
- </row>
-
- <row>
- <entry><para>Verification and Validation</para></entry>
- <entry><para>All occurring errors will be immediately reported by verification
- feature, no matter in what view you are working. Constant validation and
- errors checking allows to catch many of the errors during development
- process that significantly reduces development time.</para></entry>
-
-
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
-
-
-
- <section>
- <title>Other relevant resources on the topic</title>
-
- <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para>
- <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para>
-
- </section>
-
-</chapter>
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="introduction">
+<?dbhtml filename="introduction.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+
+ <keyword>Eclipse</keyword>
+
+ <keyword>Java</keyword>
+
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Introduction</title>
+ <para>
+ The following chapters describe how to deal with classic/old style of Struts development. We recommend users to use JBoss Seam to simplify development, but until then you can read about classical Struts usage here.
+ </para>
+
+ <para>
+ We are going to show you how to create a simple <emphasis> <property>Struts application</property> </emphasis> using the JBoss Tools. The completed application will ask a user to enter a name and click a button. The resulting new page will display the familiar message, "Hello <name>!"
+ </para>
+
+ <para>
+ This document will show you how to create such an application from the beginning, along the way demonstrating some of the powerful features of JBoss Tools. With the help of our tutorial you will design the application, generate stub code for the application, fill in the stub coding, compile the application, and finally run it all from inside the Eclipse.
+ </para>
+
+ <section>
+ <title>Key Features Struts Tools</title>
+ <para>
+ For a start, we propose you to look through the table of main features of Struts Tools:
+ </para>
+
+ <table>
+ <title>Key Functionality of Struts Tools</title>
+ <tgroup cols="2">
+ <colspec colnum="1" align="left" colwidth="2*"/>
+
+ <colspec colnum="2" colwidth="4*"/>
+
+ <thead>
+ <row>
+ <entry>
+ Feature
+ </entry>
+
+ <entry>
+ Benefit
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ Struts Support
+ </para>
+ </entry>
+
+ <entry>
+ <para>
+ Step-by-step wizards for creating a new struts project with a number of predefined templates, importing existing ones and adding struts capabilities to non-struts web projects.
+ </para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>
+ Support for Struts Configuration File
+ </para>
+ </entry>
+
+ <entry>
+ <para>
+ Working on file using three modes: diagram, tree and source. Synchronization between the modes and full control over the code. Easy moving around the diagram using the Diagram Navigator. Working with struts projects that have multiple modules. Possibility to use Struts configuration file debugger allowing to set break points on struts diagram and then launch the server in debug mode.
+ </para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>
+ Support for Struts modules
+ </para>
+ </entry>
+
+ <entry>
+ <para>
+ A Struts module (struts-config.xml) is automatically created while creating a new project. There is also possibility to add new ones or edit already existing modules in your existing project or while importing Struts project.
+ </para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>
+ Verification and Validation
+ </para>
+ </entry>
+
+ <entry>
+ <para>
+ All occurring errors will be immediately reported by verification feature, no matter in what view you are working. Constant validation and errors checking allows to catch many of the errors during development process that significantly reduces development time.
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section>
+ <title>Other relevant resources on the topic</title>
+ <para>
+ All JBoss Developer Studio/JBoss Tools release documentation you can find at <ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.
+ </para>
+
+ <para>
+ The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.
+ </para>
+ </section>
+</chapter>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/master.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/master.xml 2011-07-18 02:48:03 UTC (rev 32986)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/master.xml 2011-07-18 02:52:04 UTC (rev 32987)
@@ -53,12 +53,12 @@
Version: 3.1.1.GA
</releaseinfo>
-<abstract>
+<!--<abstract>
<title/>
<para>
<ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/struts_tools_tutoria...">PDF version</ulink>
</para>
-</abstract>
+</abstract>-->
</bookinfo>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/struts_application.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/struts_application.xml 2011-07-18 02:48:03 UTC (rev 32986)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/struts_application.xml 2011-07-18 02:52:04 UTC (rev 32987)
@@ -1,453 +1,527 @@
-<?xml version='1.0' encoding='UTF-8'?>
-<chapter id="struts_application">
- <?dbhtml filename="struts_application.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Struts</keyword>
- <keyword>Struts Application</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Creating a Simple Struts Application</title>
-
- <para>Firstly, we assume that you have already launched Eclipse with <property>JBoss Tools</property> installed and
- also that the <property>Web Development perspective</property> is the current perspective. (If not, make it
- active by selecting <emphasis>
- <property>Window > Open Perspective > Other > Web
- Development</property>
- </emphasis> from the menu bar.)</para>
-
- <section id="StartingUp">
- <title>Starting Up</title>
- <para>We are first going to create a new project for the application.</para>
- <itemizedlist>
- <listitem>
- <para>Go to the menu bar and select <emphasis>
- <property>File > New > Struts Project</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>Next enter "StrutsHello" as the project name</para>
- </listitem>
- <listitem>
- <para>Leave everything else as it is, and click <emphasis>
- <property>Next</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>If you have server runtime already defined, just pass to next point. Otherwise in the <emphasis>
- <property>Runtime</property></emphasis> section click the <emphasis>
- <property>New</property></emphasis> button and target at needed server runtime environment. Click <emphasis>
- <property>Finish</property>.</emphasis></para>
- </listitem>
- <listitem>
- <para>Click <emphasis>
- <property>Next</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>Make sure that <emphasis>
- <property>struts-bean.tld</property>
- </emphasis>, <emphasis>
- <property>struts-html.tld</property>
- </emphasis>, and <emphasis>
- <property>struts-logic.tld</property>
- </emphasis> are checked in the list of included tag libraries and then hit <emphasis>
- <property>Finish</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
- <para>A "StrutsHello" node should appear in the <property>Package
- Explorer view</property>.</para>
- <itemizedlist>
- <listitem>
- <para>Click the plus sign next to <emphasis>
- <property>StrutsHello</property>
- </emphasis> to reveal the child nodes</para>
- </listitem>
- <listitem>
- <para>Click the plus sign next to <emphasis>
- <property>WebContent</property>
- </emphasis> under <emphasis>
- <property>StrutsHello</property></emphasis></para>
- </listitem>
- <listitem>
- <para>Click the plus sign next to <emphasis>
- <property>WEB-INF</property>
- </emphasis> under <emphasis>
- <property>WebContent</property></emphasis></para>
- </listitem>
- <listitem>
- <para>Then, double-click on the <emphasis>
- <property>struts-config.xml</property>
- </emphasis> node to display a diagram of the Struts application configuration
- file in the editing area</para>
- </listitem>
- </itemizedlist>
- <para>At this point, its empty except for the background grid lines.</para>
- </section>
-
- <section id="CreatingtheApplicationComponents">
- <?dbhtml filename="CreatingtheApplicationComponents.html"?>
- <title>Creating the Application Components</title>
- <para>Now, we will design the application by creating the individual components as
- placeholders first. (We don't have to complete all of the details inside the components
- until afterwards.)</para>
- <section id="CreatingJSPPagePlaceholders">
- <title>Creating JSP Page Placeholders</title>
- <para>Next, let's create and place two JSP pages. We will not write anything more than basic template code
- for the files; they will serve only as placeholders so that we can create links to
- them in the diagram. We will write some custom code a little bit later.</para>
- <section id="CreatingthePagePlaceholders">
- <title>Creating the Page Placeholders</title>
- <itemizedlist>
- <listitem>
- <para>Bring the <property moreinfo="none">Web Projects view</property> to the front of the <property moreinfo="none">Package Explorer view</property>
- by selecting the <emphasis>
- <property moreinfo="none">Web Projects</property>
- </emphasis> tab next to that tab.</para>
- </listitem>
- <listitem>
- <para>Right-click the <emphasis>
- <property moreinfo="none">StrutsHello > WEB-ROOT (WebContent)</property>
- </emphasis> folder in the <property moreinfo="none">Web Projects view</property> and select <emphasis>
- <property moreinfo="none">New > Folder...</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>Enter <emphasis>
- <property moreinfo="none">pages</property>
- </emphasis> for a folder name and click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis></para>
- </listitem>
-
- <listitem>
- <para>We will keep our presentation files in this folder</para>
- </listitem>
-
- <listitem>
- <para>Right-click the <emphasis>
- <property moreinfo="none">pages</property></emphasis> folder and select <emphasis>
- <property moreinfo="none">New > File > JSP...</property>
- </emphasis>
- </para>
- </listitem>
- <listitem>
- <para>For Name type in <emphasis>
- <property moreinfo="none">inputname</property>
- </emphasis> (the JSP extension will be automatically added to the file), and then click on the <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>
- Untick the <emphasis><property moreinfo="none">use JSP Template</property></emphasis> checkbox, and then click on the
- <emphasis><property moreinfo="none">Finish</property></emphasis> button
- </para>
- </listitem>
- <listitem>
- <para>Right-click the <emphasis>
- <property moreinfo="none">pages</property></emphasis> folder again and select <emphasis>
- <property moreinfo="none">New > File > JSP...</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>For Name type in <emphasis>
- <property moreinfo="none">greeting</property>
- </emphasis>, and then click on the <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>
- Untick the <emphasis><property moreinfo="none">use JSP Template</property></emphasis> checkbox, and then click on the
- <emphasis><property moreinfo="none">Finish</property></emphasis> button
- </para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="UpdatingInputnameJSP">
- <title>Adding Template Code to the inputname.jsp File</title>
- <para>
- The <emphasis><property moreinfo="none">inputname.jsp</property></emphasis> file needs to be populated with some template code. Click on the <emphasis>
- <property moreinfo="none">inputname.jsp</property>
- </emphasis> page in the <property moreinfo="none">Web Projects view</property>, and then modify the file so it looks like this:
- <programlisting><![CDATA[<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %>
-<html:html>
-<head>
- <title></title>
-</head>
-<body>
- <html:form action="">
- </html:form>
-</body>
-</html:html>]]></programlisting>
- </para>
- </section>
- <section id="PlacingthePagePlaceholders">
- <title>Placing the Page Placeholders</title>
- <para>Lets now place the two pages just created on the diagram.</para>
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis>
- <property>struts-config.xml</property>
- </emphasis> tab in the editing area to bring the diagram to the
- front</para>
- </listitem>
- <listitem>
- <para>Click on the <emphasis>
- <property>inputname.jsp</property>
- </emphasis> page in the <property>Web Projects view</property>, drag it onto the diagram, and
- drop it</para>
- </listitem>
- <listitem><para>Click on the <emphasis>
- <property>greeting.jsp</property>
- </emphasis> page in the <property>Web Projects view</property>, drag it onto the diagram, and
- drop it to the right of the <emphasis>
- <property>/pages/inputname.jsp</property>
- </emphasis> icon with some extra space</para></listitem>
- </itemizedlist>
- <para>You should now have two JSP pages in the diagram.</para>
- </section>
- </section>
- <section id="CreatinganActionMappings">
- <title>Creating an Action Mappings</title>
- <para>Using a context menu on the diagram, we are next going to create an Action
- mapping.</para>
- <itemizedlist>
- <listitem>
- <para>Right-click between the two icons and select <emphasis>
- <property>New > Action</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>Enter the following values:</para>
- </listitem>
- </itemizedlist>
- <table>
- <title>Action values</title>
- <tgroup cols="2">
- <tbody>
- <row>
- <entry>path</entry>
- <entry>/greeting</entry>
- </row>
- <row>
- <entry>name</entry>
- <entry>GetNameForm</entry>
- </row>
- <row>
- <entry>scope</entry>
- <entry>request</entry>
- </row>
- <row>
- <entry>type</entry>
- <entry>sample.GreetingAction</entry>
- </row>
- <row>
- <entry>validate</entry>
- <entry><leave blank></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>("GetNameForm" is the name for a form bean that we will create
- later.)</para>
- <itemizedlist>
- <listitem>
- <para>Click <emphasis>
- <property>Finish</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
-
- <para>The <emphasis>
- <property>/greeting</property>
- </emphasis> action should appear in four places, in the diagram, under the
- <emphasis>
- <property>action-mappings</property></emphasis> node, under the <emphasis>
- <property>struts-config.xml</property></emphasis> node in Tree view, in <property>Web Projects
- view</property> and in the <property>Outline view</property>. Also, note the asterisk to the right of the name,
- <emphasis>
- <property>struts-config.xml</property>,</emphasis> in the <property>Outline view</property> showing that the file has been changed, but
- not saved to disk.</para>
- </section>
- <section id="CreatingaLink">
- <title>Creating a Link</title>
- <para>Let's now create a link from the <emphasis>
- <property>inputname.jsp</property></emphasis> page to the action.</para>
- <itemizedlist>
- <listitem>
- <para>On the left-hand side of the diagram in the column of icons, click on the Create New Connection
- icon( <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/struts_application/struts_application_1.png"/>
- </imageobject>
- </inlinemediaobject>).</para>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <listitem>
- <para>In the connect-the-components mode you are in now, click on the <emphasis>
- <property>/pages/inputname.jsp</property>
- </emphasis> icon in the diagram and then click on the <emphasis>
- <property>/greeting</property>
- </emphasis> action</para>
- </listitem>
- </itemizedlist>
- <para>A link will be created from the page to the action.</para>
- </section>
- <section id="CreatingaForward">
- <title>Creating a Forward</title>
- <para>Next, we are going to create a forward for the action.</para>
- <itemizedlist>
- <listitem>
- <para>On the left-hand side of the diagram in the column of icons, click on
- the Create New Connection
- icon( <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/struts_application/struts_application_1.png"/>
- </imageobject>
- </inlinemediaobject>), again.</para>
- </listitem>
- </itemizedlist>
-
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis>
- <property>/greeting</property>
- </emphasis> action icon in the diagram and then click on the <emphasis>
- <property>pages/greeting.jsp</property>
- </emphasis> icon</para>
- </listitem>
- <listitem>
- <para>That's it. A link will be drawn from the actions new greeting
- forward to the <emphasis>
- <property>greeting.jsp</property></emphasis> JSP page. Note that the forwards name will be
- set based on the name of the target JSP file name. If you don't
- like it, you can easily change it</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis>
- <property>Tree</property>
- </emphasis> tab at the bottom of the editor window (between Diagram and
- Source)</para>
- </listitem>
- <listitem>
- <para>Expand the <emphasis>
- <property>struts-config.xml/action-mappings/ /greeting</property>
- </emphasis> node and then select the greeting forward</para>
- </listitem>
- <listitem>
- <para>In the Properties Editor to the right, change the text to
- "sayHello" in the <emphasis>
- <property>Name</property></emphasis> field</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis>
- <property>Diagram</property>
- </emphasis> tab at the bottom of the editor window and see how the diagram
- is also updated to reflect the change</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="CreatingaGlobalForward">
- <title>Creating a Global Forward</title>
- <para>One last component that we need to create in the diagram is a global forward.</para>
- <itemizedlist>
- <listitem>
- <para>Somewhere in the top-left corner of diagram, right-click and select <emphasis>
- <property>New > Global Forward</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>Enter <emphasis>
- <property>getName</property>
- </emphasis> in the <emphasis>
- <property>Name</property></emphasis> field</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis>
- <property>Change...</property>
- </emphasis>button for Path</para>
- </listitem>
- <listitem>
- <para>In the Edit Path window, switch to the <emphasis>
- <property>Pages</property>
- </emphasis> tab</para>
- </listitem>
- <listitem>
- <para>Expand the <emphasis>
- <property>StrutsHello > WEB-ROOT (WebContent) > pages</property>
- </emphasis> node and then select the inputname.jsp page</para>
- </listitem>
- <listitem>
- <para>Click <emphasis>
- <property>Ok</property>
- </emphasis>.</para>
- </listitem>
- <listitem>
- <para>Leave the rest of the fields blank and click <emphasis>
- <property>OK</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
- <para>A forward object now appears on the diagram and also in the global-forwards folder
- in the Outline view.</para>
- <itemizedlist>
- <listitem>
- <para>Tidy up the diagram, by clicking and dragging around each icon, so that
- the diagram looks something like this:</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Diagram View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts_application/struts_application_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section id="CreatingaFormBean">
- <title>Creating a Form Bean</title>
- <para>One last thing that we need to do is to create a form bean.</para>
- <itemizedlist>
- <listitem>
- <para>Switch to the Tree viewer in the editor for the <emphasis>
- <property>struts-config.xml</property></emphasis> file, by
- selecting the <emphasis>
- <property>Tree</property>
- </emphasis> tab at the bottom of the editor window</para>
- </listitem>
- <listitem>
- <para>Right-click <emphasis>
- <property>struts-config.xml > form-beans</property>
- </emphasis> and select Create Form Bean</para>
- </listitem>
- <listitem>
- <para>Enter <emphasis>
- <property>GetNameForm</property>
- </emphasis> in the name field and <emphasis>
- <property>sample.GetNameForm</property>
- </emphasis> for type</para>
- </listitem>
- <listitem>
- <para>Click <emphasis>
- <property>Finish</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>To save your changes to struts-config.xml, select <emphasis>
- <property>File > Save</property>
- </emphasis> from the menu bar</para>
- </listitem>
- </itemizedlist>
- <para>Note the disappearance of the asterisk next to the name, <emphasis>
- <property>struts-config.xml</property>.</emphasis></para>
- </section>
- </section>
-</chapter>
+<?xml version='1.0' encoding='UTF-8'?>
+<chapter id="struts_application">
+<?dbhtml filename="struts_application.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+
+ <keyword>Struts</keyword>
+
+ <keyword>Struts Application</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Creating a Simple Struts Application</title>
+ <para>
+ Firstly, we assume that you have already launched Eclipse with <property>JBoss Tools</property> installed and also that the <property>Web Development perspective</property> is the current perspective. (If not, make it active by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Web Development</guimenuitem></menuchoice> from the menu bar.)
+ </para>
+
+ <section id="StartingUp">
+ <title>Starting Up</title>
+ <para>
+ We are first going to create a new project for the application.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Go to the menu bar and select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Struts Project</guimenuitem></menuchoice>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Next enter "StrutsHello" as the project name
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Leave everything else as it is, and click <emphasis> <property>Next</property> </emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ If you have server runtime already defined, just pass to next point. Otherwise in the <emphasis> <property>Runtime</property></emphasis> section click the <emphasis> <property>New</property></emphasis> button and target at needed server runtime environment. Click <emphasis> <property>Finish</property>.</emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click <emphasis> <property>Next</property> </emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Make sure that <emphasis> <property>struts-bean.tld</property> </emphasis>, <emphasis> <property>struts-html.tld</property> </emphasis>, and <emphasis> <property>struts-logic.tld</property> </emphasis> are checked in the list of included tag libraries and then hit <emphasis> <property>Finish</property> </emphasis>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ A "StrutsHello" node should appear in the <property>Package Explorer view</property>.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Click the plus sign next to <emphasis> <property>StrutsHello</property> </emphasis> to reveal the child nodes
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click the plus sign next to <emphasis> <property>WebContent</property> </emphasis> under <emphasis> <property>StrutsHello</property></emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click the plus sign next to <emphasis> <property>WEB-INF</property> </emphasis> under <emphasis> <property>WebContent</property></emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Then, double-click on the <emphasis> <property>struts-config.xml</property> </emphasis> node to display a diagram of the Struts application configuration file in the editing area
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ At this point, its empty except for the background grid lines.
+ </para>
+ </section>
+
+ <section id="CreatingtheApplicationComponents">
+<?dbhtml filename="CreatingtheApplicationComponents.html"?>
+ <title>Creating the Application Components</title>
+ <para>
+ Now, we will design the application by creating the individual components as placeholders first. (We don't have to complete all of the details inside the components until afterwards.)
+ </para>
+
+ <section id="CreatingJSPPagePlaceholders">
+ <title>Creating JSP Page Placeholders</title>
+ <para>
+ Next, let's create and place two JSP pages. We will not write anything more than basic template code for the files; they will serve only as placeholders so that we can create links to them in the diagram. We will write some custom code a little bit later.
+ </para>
+
+ <section id="CreatingthePagePlaceholders">
+ <title>Creating the Page Placeholders</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Bring the <property moreinfo="none">Web Projects view</property> to the front of the <property moreinfo="none">Package Explorer view</property> by selecting the <emphasis> <property moreinfo="none">Web Projects</property> </emphasis> tab next to that tab.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Right-click the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>WEB-ROOT (WebContent)</guimenuitem></menuchoice> folder in the <property moreinfo="none">Web Projects view</property> and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Folder...</guimenuitem></menuchoice>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Enter <emphasis> <property moreinfo="none">pages</property> </emphasis> for a folder name and click <emphasis> <property moreinfo="none">Finish</property> </emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ We will keep our presentation files in this folder
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Right-click the <emphasis> <property moreinfo="none">pages</property></emphasis> folder and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>File</guimenuitem><guimenuitem>JSP...</guimenuitem></menuchoice>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ For Name type in <emphasis> <property moreinfo="none">inputname</property> </emphasis> (the JSP extension will be automatically added to the file), and then click on the <emphasis> <property moreinfo="none">Next</property> </emphasis> button
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Untick the <emphasis><property moreinfo="none">use JSP Template</property></emphasis> checkbox, and then click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Right-click the <emphasis> <property moreinfo="none">pages</property></emphasis> folder again and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>File</guimenuitem><guimenuitem>JSP...</guimenuitem></menuchoice>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ For Name type in <emphasis> <property moreinfo="none">greeting</property> </emphasis>, and then click on the <emphasis> <property moreinfo="none">Next</property> </emphasis> button
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Untick the <emphasis><property moreinfo="none">use JSP Template</property></emphasis> checkbox, and then click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="UpdatingInputnameJSP">
+ <title>Adding Template Code to the inputname.jsp File</title>
+ <para>
+ The <emphasis><property moreinfo="none">inputname.jsp</property></emphasis> file needs to be populated with some template code. Click on the <emphasis> <property moreinfo="none">inputname.jsp</property> </emphasis> page in the <property moreinfo="none">Web Projects view</property>, and then modify the file so it looks like this:
+ <programlisting>
+<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %>
+<html:html>
+<head>
+ <title></title>
+</head>
+<body>
+ <html:form action="">
+ </html:form>
+</body>
+</html:html>
+ </programlisting>
+ </para>
+ </section>
+
+ <section id="PlacingthePagePlaceholders">
+ <title>Placing the Page Placeholders</title>
+ <para>
+ Lets now place the two pages just created on the diagram.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Click on the <emphasis> <property>struts-config.xml</property> </emphasis> tab in the editing area to bring the diagram to the front
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click on the <emphasis> <property>inputname.jsp</property> </emphasis> page in the <property>Web Projects view</property>, drag it onto the diagram, and drop it
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click on the <emphasis> <property>greeting.jsp</property> </emphasis> page in the <property>Web Projects view</property>, drag it onto the diagram, and drop it to the right of the <emphasis> <property>/pages/inputname.jsp</property> </emphasis> icon with some extra space
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ You should now have two JSP pages in the diagram.
+ </para>
+ </section>
+ </section>
+
+ <section id="CreatinganActionMappings">
+ <title>Creating an Action Mappings</title>
+ <para>
+ Using a context menu on the diagram, we are next going to create an Action mapping.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Right-click between the two icons and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Action</guimenuitem></menuchoice>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Enter the following values:
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <table>
+ <title>Action values</title>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>
+ path
+ </entry>
+
+ <entry>
+ /greeting
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ name
+ </entry>
+
+ <entry>
+ GetNameForm
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ scope
+ </entry>
+
+ <entry>
+ request
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ type
+ </entry>
+
+ <entry>
+ sample.GreetingAction
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ validate
+ </entry>
+
+ <entry>
+ <leave blank>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ ("GetNameForm" is the name for a form bean that we will create later.)
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Click <emphasis> <property>Finish</property> </emphasis>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ The <emphasis> <property>/greeting</property> </emphasis> action should appear in four places, in the diagram, under the <emphasis> <property>action-mappings</property></emphasis> node, under the <emphasis> <property>struts-config.xml</property></emphasis> node in Tree view, in <property>Web Projects view</property> and in the <property>Outline view</property>. Also, note the asterisk to the right of the name, <emphasis> <property>struts-config.xml</property>,</emphasis> in the <property>Outline view</property> showing that the file has been changed, but not saved to disk.
+ </para>
+ </section>
+
+ <section id="CreatingaLink">
+ <title>Creating a Link</title>
+ <para>
+ Let's now create a link from the <emphasis> <property>inputname.jsp</property></emphasis> page to the action.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ On the left-hand side of the diagram in the column of icons, click on the Create New Connection icon(
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_application/struts_application_1.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ ).
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ In the connect-the-components mode you are in now, click on the <emphasis> <property>/pages/inputname.jsp</property> </emphasis> icon in the diagram and then click on the <emphasis> <property>/greeting</property> </emphasis> action
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ A link will be created from the page to the action.
+ </para>
+ </section>
+
+ <section id="CreatingaForward">
+ <title>Creating a Forward</title>
+ <para>
+ Next, we are going to create a forward for the action.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ On the left-hand side of the diagram in the column of icons, click on the Create New Connection icon(
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_application/struts_application_1.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ ), again.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Click on the <emphasis> <property>/greeting</property> </emphasis> action icon in the diagram and then click on the <emphasis> <property>pages/greeting.jsp</property> </emphasis> icon
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ That's it. A link will be drawn from the actions new greeting forward to the <emphasis> <property>greeting.jsp</property></emphasis> JSP page. Note that the forwards name will be set based on the name of the target JSP file name. If you don't like it, you can easily change it
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select the <emphasis> <property>Tree</property> </emphasis> tab at the bottom of the editor window (between Diagram and Source)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Expand the <emphasis> <property>struts-config.xml/action-mappings/ /greeting</property> </emphasis> node and then select the greeting forward
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the Properties Editor to the right, change the text to "sayHello" in the <emphasis> <property>Name</property></emphasis> field
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select the <emphasis> <property>Diagram</property> </emphasis> tab at the bottom of the editor window and see how the diagram is also updated to reflect the change
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="CreatingaGlobalForward">
+ <title>Creating a Global Forward</title>
+ <para>
+ One last component that we need to create in the diagram is a global forward.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Somewhere in the top-left corner of diagram, right-click and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Global Forward</guimenuitem></menuchoice>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Enter <emphasis> <property>getName</property> </emphasis> in the <emphasis> <property>Name</property></emphasis> field
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select the <emphasis> <property>Change...</property> </emphasis>button for Path
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the Edit Path window, switch to the <emphasis> <property>Pages</property> </emphasis> tab
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Expand the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>WEB-ROOT (WebContent)</guimenuitem><guimenuitem>pages</guimenuitem></menuchoice> node and then select the inputname.jsp page
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click <emphasis> <property>Ok</property> </emphasis>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Leave the rest of the fields blank and click <emphasis> <property>OK</property> </emphasis>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ A forward object now appears on the diagram and also in the global-forwards folder in the Outline view.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Tidy up the diagram, by clicking and dragging around each icon, so that the diagram looks something like this:
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Diagram View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_application/struts_application_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="CreatingaFormBean">
+ <title>Creating a Form Bean</title>
+ <para>
+ One last thing that we need to do is to create a form bean.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Switch to the Tree viewer in the editor for the <emphasis> <property>struts-config.xml</property></emphasis> file, by selecting the <emphasis> <property>Tree</property> </emphasis> tab at the bottom of the editor window
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Right-click <menuchoice><guimenuitem>struts-config.xml</guimenuitem><guimenuitem>form-beans</guimenuitem></menuchoice> and select Create Form Bean
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Enter <emphasis> <property>GetNameForm</property> </emphasis> in the name field and <emphasis> <property>sample.GetNameForm</property> </emphasis> for type
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click <emphasis> <property>Finish</property> </emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ To save your changes to struts-config.xml, select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save</guimenuitem></menuchoice> from the menu bar
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ Note the disappearance of the asterisk next to the name, <emphasis> <property>struts-config.xml</property>.</emphasis>
+ </para>
+ </section>
+ </section>
+</chapter>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/struts_validation.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/struts_validation.xml 2011-07-18 02:48:03 UTC (rev 32986)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/en-US/struts_validation.xml 2011-07-18 02:52:04 UTC (rev 32987)
@@ -1,239 +1,499 @@
-<?xml version='1.0' encoding='UTF-8'?>
-<chapter id="struts_validation">
- <?dbhtml filename="struts_validation.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Struts</keyword>
- <keyword>Struts Validation</keyword>
- </keywordset>
- </chapterinfo>
-<title>Struts Validation Examples</title>
-
-<para><property>Validation</property> of input is an important part of any Web application. All Apache Jakarta frameworks,
-including Struts, can use a common Jakarta Validation Framework for streamlining this aspect of Web
-application development. The Validation Framework allows you to define validation rules and then apply these rules on the client-side or the server-side.</para>
-
- <para>JBoss Developer Studio makes using the <property>Validation Framework</property> in Struts even easier with the help of a specialized editor for the XML files that controls validation in a project. In this document, we'll show you how this all works by creating some simple client-side validation and server-side validation examples.</para>
-
-<section id="StartingPoint">
-<?dbhtml filename="StartingPoint.html"?>
-<title>Starting Point</title>
-<para>The example assumes that you have already created our sample "StrutsHello" application from the
-Getting Started Guide for Creating a Struts Application. You should have the JBoss Developer Studio perspective
- open on this StrutsHello project.</para>
-</section>
-
-<section id="DefiningTheValidationRule">
-<?dbhtml filename="DefiningTheValidationRule.html"?>
-<title>Defining the Validation Rule</title>
-<para>In these steps you will set up the validation that can be used for either client-side or
-server side validation. You need to enable validation as a part of the project, define an error message, and tie it into an appropriate part of the application.</para>
-
-<itemizedlist>
-<listitem><para>Right-click on a "plug-ins" node under the <emphasis><property>StrutsHello > Configuration > default > struts-config.xml</property></emphasis> node in the Web Projects view and select <emphasis><property>Create Special Plugin > Validators</property></emphasis> from the context menu</para></listitem>
-<listitem><para>Further down in the Web Projects view, right-click on the
-<emphasis><property>StrutsHello > ResourceBundles</property></emphasis> node and select <emphasis><property> New > Properties File...</property></emphasis>from the context menu</para></listitem>
-<listitem><para>In the dialog box, click on the <emphasis><property>Browse...</property></emphasis>button next to the Folder field, expand the
- JavaSource folder in this next dialog box, select the sample subfolder, and click on the <emphasis><property>OK</property></emphasis> button</para></listitem>
- <listitem><para>Back in the first dialog box, type in "applResources" for the Name field and click on the <emphasis><property>Finish</property></emphasis> button</para></listitem>
-<listitem><para>Right-click on a newly created file and select <emphasis><property>New > Default Error Messages</property></emphasis>
- from the context menu</para></listitem>
-
-<listitem><para>Drag up the sample.applResources icon until you can drop it on the resources folder under struts-config.xml</para></listitem>
-<listitem><para>Select<emphasis><property> File > Save </property></emphasis>All from the menu bar</para></listitem>
-<listitem><para>Select validation.xml under the <emphasis><property>StrutsHello > Validation</property></emphasis> node and double-click it to open it with the JBoss Tools XML Editor</para></listitem>
-<listitem><para>Here you must create a Formset.</para></listitem>
-<listitem><para>In the validation.xml file editor click the button <emphasis><property>Create Formset</property></emphasis> on the panel <emphasis><property>Formsets</property></emphasis></para></listitem>
-<listitem><para>In the dialog <emphasis><property>Add Formset</property></emphasis> fill the fields <emphasis><property>Language</property></emphasis> and <emphasis><property>Country</property></emphasis> or just leave them empty to create a default formset. Click <emphasis><property>OK</property></emphasis></para></listitem>
-</itemizedlist>
-<figure>
- <title>Create Formset</title>
-<mediaobject>
- <imageobject>
- <imagedata fileref="images/struts_validation/struts_validation.png"/>
- </imageobject>
-</mediaobject>
-</figure>
-<itemizedlist>
-<listitem><para>Expand the "form-beans" node under the <emphasis><property>StrutsHello > Configuration > default > struts-config.xml node.</property></emphasis> Then, drag the form bean "GetNameForm" and drop it onto a formset in the <property>XML</property> Editor</para></listitem>
-<listitem><para>In the Validation Editor, expand the formset node, right-click GetNameForm, and select <emphasis><property>Create Field...</property></emphasis> from the context menu</para></listitem>
-<listitem><para>Enter a name for Property in the dialog box. A new property will be created:</para></listitem>
-</itemizedlist>
-<figure>
- <title>New Property Is Added</title>
-<mediaobject>
- <imageobject>
- <imagedata fileref="images/struts_validation/struts_validation_2.png"/>
- </imageobject>
-</mediaobject>
-</figure>
-<itemizedlist>
-<listitem><para>In the Properties view for the name field to the right of the "tree" for the validation.xml file, click on the <emphasis><property>Change...</property></emphasis>button next to the Depends entry field</para></listitem>
-<listitem><para>In the displayed double list, select <emphasis><property>required</property></emphasis> from the left list and then click <emphasis><property>Add</property></emphasis></para></listitem>
- <listitem><para>Click <emphasis><property>Ok</property></emphasis></para></listitem>
-<listitem><para>Right-click name and select <emphasis><property>Add Arg...</property></emphasis> from the context menu</para></listitem>
-<listitem><para>In the Add Arg dialog box, click on the <emphasis><property>Change...</property></emphasis>button next to the <emphasis><property>Key</property></emphasis> field</para></listitem>
- <listitem><para>In the Key dialog box that appears now, click on the <emphasis><property>Add</property></emphasis> button</para></listitem>
- <listitem><para>Enter "name.required" in the Name field, and enter a person's name in the Value field</para></listitem>
- <listitem><para>Click <emphasis><property>Finish</property></emphasis>, then <emphasis><property>Ok</property></emphasis>, and then <emphasis><property>Ok</property></emphasis> again</para></listitem>
-<listitem><para>Select <emphasis><property>File > Save All</property></emphasis> from the menu bar</para></listitem>
-</itemizedlist>
-</section>
-
-<section id="Client-SideValidation">
-<?dbhtml filename="Client-SideValidation.html"?>
-<title>Client-Side Validation</title>
-<para>Client-side <property>validation</property> uses a scripting language (like JavaScript) running in the client browser to actually do the <property>validation</property>. In a Struts application using the <property>Validation</property> Framework, however, you don't actually have to do any of the script coding. The <property>Validation</property> Framework handles this.</para>
-<para>To see how this works in our application, you'll just need to make a couple of modifications to one of the JSP files.</para>
-<itemizedlist>
-<listitem><para>Double-click inputname.jsp under <emphasis><property>StrutsHello > WEB-ROOT(WebContent) > pages</property></emphasis> to open it for editing</para></listitem>
-<listitem><para>Find the tag near the top and hit Return to make a new line under it</para></listitem>
- <listitem><para>In the JBoss Tools Palette view to the right, open the Struts HTML folder and click on the javascript tag</para></listitem>
-<listitem><para>Back in the editor, just in front of the closing slash for this inserted tag, hit Ctrl+Space and select "formName" from the prompting menu</para></listitem>
-<listitem><para>Over in the Web Projects view, select GetNameForm under the <emphasis><property>StrutsHello > Configuration > default > struts-config.xml > form-beans</property></emphasis> node, drag it, and drop it between the quotes in the editor</para></listitem>
-<listitem><para>Modify the <code><html:form></code> tag by inserting this attribute:</para></listitem>
-</itemizedlist>
-<programlisting role="XML"><![CDATA[onsubmit="return validateGetNameForm(this)"
-]]></programlisting>
-<para></para>
-<para>The file should now look like this:</para>
-<programlisting role="XML"><![CDATA[
-<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %>
-
-<html:html >
- <head>
- <html:javascript formName="GetNameForm"/>
- <title></title>
- </head>
- <body>
- <html:form action="/greeting.do" onsubmit="return validateGetNameForm(this)">
- Input name:<html:text property="name"/><html:submit value="Say Hello!"/>
- </html:form>
- </body>
-</html:html>
-]]></programlisting>
-<itemizedlist>
-<listitem><para>Select<emphasis><property> File > Save </property></emphasis>from the menu bar</para></listitem>
-<listitem><para>Start JBoss Application Server by clicking on its icon (a right-pointing arrow) in the toolbar</para></listitem>
- <listitem><para>Click the Run icon(<inlinemediaobject> <imageobject>
- <imagedata fileref="images/struts_validation/struts_validation_1.png"/>
- </imageobject></inlinemediaobject>) or right click your project folder and select <emphasis><property>Run As > Run on Server</property></emphasis></para></listitem>
-</itemizedlist>
-
-<itemizedlist><listitem><para>In the browser window, click on the "Say Hello!" button without having entered any name in the form</para></listitem></itemizedlist>
-<para>A JavaScript error message should be displayed in an alert box.</para>
-</section>
-<section id="Server-SideValidation">
-<?dbhtml filename="Server-SideValidation.html"?>
-<title>Server Side Validation</title>
-<para>Server side validation does the validation inside the application on the server. In a Struts application using the Validation Framework, you still don't have to do any of the actual validation coding. The Validation Framework handles this. You will though have to make a few changes to the JSP file you modified for client-side validation along with a change to an action and a few changes to the form bean class.</para>
-</section>
-
-<section id="EditingTheJSPFile">
-<?dbhtml filename="EditingTheJSPFile.html"?>
-<title>Editing the JSP File</title>
-<itemizedlist>
-<listitem><para>Reopen inputname.jsp for editing</para></listitem>
-<listitem><para>Delete the <emphasis role="italic"><property>"onsubmit"</property></emphasis> attribute in the <code><html:form></code> element that you put in for client-side validation</para></listitem>
-
-<listitem><para>Add an <code><html:errors/></code> tag after the
- <code><html:form></code>
- tag</para></listitem>
-</itemizedlist>
-<para>The JSP file should now look like this:</para>
-
- <programlisting role="XML"><![CDATA[<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %>
-<html:html >
-<head>
- <html:javascript formName="GetNameForm"/>
- <title></title>
- </head>
- <body>
- <html:form action="/greeting.do" >Input name:<html:text property="name"/>
- <html:submit value="Say Hello!"/>
- </html:form>
- <html:errors/>
- </body>
-</html:html>
-]]></programlisting>
-
-</section>
-
-<section id="EditingTheAction">
-<?dbhtml filename="EditingTheAction.html"?>
-<title>Editing the Action</title>
-<itemizedlist>
-<listitem><para>In the Web Projects view, expand the node under the <emphasis><property>StrutsHello > Configuration > default > struts-config.xml > action-mappings</property></emphasis> node, right-click the <emphasis><property>/greeting</property></emphasis> action, and then select <emphasis><property>Properties...</property></emphasis>from the context menu</para></listitem>
-
- <listitem><para>In the Edit Properties window, insert the cursor into the value column for the input property and click on the <property>...</property> button</para></listitem>
-
- <listitem><para>In the dialog box, make sure the Pages tab is selected, select <emphasis><property>StrutsHello > WEB-ROOT(WebContent) > pages > inputname.jsp</property></emphasis>, click the <emphasis><property>Ok</property></emphasis> button, and then click on the <emphasis><property>Close</property></emphasis> button</para></listitem>
-</itemizedlist>
-</section>
-<section id="EditingTheFormBean">
-<?dbhtml filename="EditingTheFormBean.html"?>
-
-<title>Editing the Form Bean</title>
-<itemizedlist>
-<listitem><para>Right-click the <emphasis><property>/greeting</property></emphasis> action again and select Open Form-bean Source to open the GetNameForm.java file for editing</para></listitem>
-<listitem><para>Change the class that it extends from: <emphasis><property>org.apache.struts.action.ActionForm</property></emphasis> to <emphasis><property>org.apache.struts.validator.ValidatorForm</property></emphasis></para></listitem>
-<listitem><para>Comment out a validate method</para></listitem>
-</itemizedlist>
-<para>The file should now look like this:</para>
-<programlisting role="JAVA"><![CDATA[package sample;
-import javax.servlet.http.HttpServletRequest;
-import org.apache.struts.action.ActionErrors;
-import org.apache.struts.action.ActionMapping;
-public class GetNameForm extends
-
-org.apache.struts.validator.ValidatorForm
-{
-
- private String name = "";
-
- /**
- * @return Returns the name.
- */
- public String getName()
- {
- return name;
- }
-
- /**
- * @param name The name to set.
- */
- public void setName(String name)
- {
- this.name = name;
- }
-
- public GetNameForm ()
- {
- }
-
- public void reset(ActionMapping actionMapping,
- HttpServletRequest request)
- {
- this.name = "";
- }
-
- // public ActionErrors validate(ActionMapping actionMapping,
- // HttpServletRequest request)
- //{
- // ActionErrors errors = new ActionErrors();
- // return errors;
- // }
- }
-]]></programlisting>
-
-<itemizedlist>
-<listitem><para>Select <emphasis><property>File > Save All </property></emphasis>from the menu bar</para></listitem>
-<listitem><para>Reload the application into JBoss AS by clicking on the "Change Time Stamp" icon (a finger pointing with a little star) in the toolbar</para></listitem>
-<listitem><para>Run the application</para></listitem>
-<listitem><para>In the browser window, click on the "Say Hello!" button without having entered any name in the form</para></listitem>
-</itemizedlist>
-<para>The error message should appear in a refreshed version of the form.</para>
-</section>
-
-</chapter>
\ No newline at end of file
+<?xml version='1.0' encoding='UTF-8'?>
+<chapter id="struts_validation">
+<?dbhtml filename="struts_validation.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+
+ <keyword>Struts</keyword>
+
+ <keyword>Struts Validation</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Struts Validation Examples</title>
+ <para>
+ <property>Validation</property> of input is an important part of any Web application. All Apache Jakarta frameworks, including Struts, can use a common Jakarta Validation Framework for streamlining this aspect of Web application development. The Validation Framework allows you to define validation rules and then apply these rules on the client-side or the server-side.
+ </para>
+
+ <para>
+ JBoss Developer Studio makes using the <property>Validation Framework</property> in Struts even easier with the help of a specialized editor for the XML files that controls validation in a project. In this document, we'll show you how this all works by creating some simple client-side validation and server-side validation examples.
+ </para>
+
+ <section id="StartingPoint">
+<?dbhtml filename="StartingPoint.html"?>
+ <title>Starting Point</title>
+ <para>
+ The example assumes that you have already created our sample "StrutsHello" application from the Getting Started Guide for Creating a Struts Application. You should have the JBoss Developer Studio perspective open on this StrutsHello project.
+ </para>
+ </section>
+
+ <section id="DefiningTheValidationRule">
+<?dbhtml filename="DefiningTheValidationRule.html"?>
+ <title>Defining the Validation Rule</title>
+ <para>
+ In these steps you will set up the validation that can be used for either client-side or server side validation. You need to enable validation as a part of the project, define an error message, and tie it into an appropriate part of the application.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Right-click on a "plug-ins" node under the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>Configuration</guimenuitem><guimenuitem>default</guimenuitem><guimenuitem>struts-config.xml</guimenuitem></menuchoice> node in the Web Projects view and select <menuchoice><guimenuitem>Create Special Plugin</guimenuitem><guimenuitem>Validators</guimenuitem></menuchoice> from the context menu
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Further down in the Web Projects view, right-click on the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>ResourceBundles</guimenuitem></menuchoice> node and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Properties File...</guimenuitem></menuchoice> from the context menu
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the dialog box, click on the <emphasis><property>Browse...</property></emphasis>button next to the Folder field, expand the JavaSource folder in this next dialog box, select the sample subfolder, and click on the <emphasis><property>OK</property></emphasis> button
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Back in the first dialog box, type in "applResources" for the Name field and click on the <emphasis><property>Finish</property></emphasis> button
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Right-click on a newly created file and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Default Error Messages</guimenuitem></menuchoice> from the context menu
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Drag up the sample.applResources icon until you can drop it on the resources folder under struts-config.xml
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save All</guimenuitem></menuchoice> from the menu bar
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select validation.xml under the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>Validation</guimenuitem></menuchoice> node and double-click it to open it with the JBoss Tools XML Editor
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Here you must create a Formset.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the validation.xml file editor click the button <emphasis><property>Create Formset</property></emphasis> on the panel <emphasis><property>Formsets</property></emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the dialog <emphasis><property>Add Formset</property></emphasis> fill the fields <emphasis><property>Language</property></emphasis> and <emphasis><property>Country</property></emphasis> or just leave them empty to create a default formset. Click <emphasis><property>OK</property></emphasis>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Create Formset</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_validation/struts_validation.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Expand the "form-beans" node under the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>Configuration</guimenuitem><guimenuitem>default</guimenuitem><guimenuitem>struts-config.xml node.</guimenuitem></menuchoice> Then, drag the form bean "GetNameForm" and drop it onto a formset in the <property>XML</property> Editor
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the Validation Editor, expand the formset node, right-click GetNameForm, and select <emphasis><property>Create Field...</property></emphasis> from the context menu
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Enter a name for Property in the dialog box. A new property will be created:
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>New Property Is Added</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_validation/struts_validation_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ In the Properties view for the name field to the right of the "tree" for the validation.xml file, click on the <emphasis><property>Change...</property></emphasis>button next to the Depends entry field
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the displayed double list, select <emphasis><property>required</property></emphasis> from the left list and then click <emphasis><property>Add</property></emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click <emphasis><property>Ok</property></emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Right-click name and select <emphasis><property>Add Arg...</property></emphasis> from the context menu
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the Add Arg dialog box, click on the <emphasis><property>Change...</property></emphasis>button next to the <emphasis><property>Key</property></emphasis> field
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the Key dialog box that appears now, click on the <emphasis><property>Add</property></emphasis> button
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Enter "name.required" in the Name field, and enter a person's name in the Value field
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click <emphasis><property>Finish</property></emphasis>, then <emphasis><property>Ok</property></emphasis>, and then <emphasis><property>Ok</property></emphasis> again
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save All</guimenuitem></menuchoice> from the menu bar
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="Client-SideValidation">
+<?dbhtml filename="Client-SideValidation.html"?>
+ <title>Client-Side Validation</title>
+ <para>
+ Client-side <property>validation</property> uses a scripting language (like JavaScript) running in the client browser to actually do the <property>validation</property>. In a Struts application using the <property>Validation</property> Framework, however, you don't actually have to do any of the script coding. The <property>Validation</property> Framework handles this.
+ </para>
+
+ <para>
+ To see how this works in our application, you'll just need to make a couple of modifications to one of the JSP files.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Double-click inputname.jsp under <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>WEB-ROOT(WebContent)</guimenuitem><guimenuitem>pages</guimenuitem></menuchoice> to open it for editing
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Find the tag near the top and hit Return to make a new line under it
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the JBoss Tools Palette view to the right, open the Struts HTML folder and click on the javascript tag
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Back in the editor, just in front of the closing slash for this inserted tag, hit Ctrl+Space and select "formName" from the prompting menu
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Over in the Web Projects view, select GetNameForm under the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>Configuration</guimenuitem><guimenuitem>default</guimenuitem><guimenuitem>struts-config.xml</guimenuitem><guimenuitem>form-beans</guimenuitem></menuchoice> node, drag it, and drop it between the quotes in the editor
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Modify the <code><html:form></code> tag by inserting this attribute:
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <programlisting role="XML">
+<![CDATA[onsubmit="return validateGetNameForm(this)"
+]]>
+ </programlisting>
+
+ <para></para>
+
+ <para>
+ The file should now look like this:
+ </para>
+
+ <programlisting role="XML">
+<![CDATA[
+<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %>
+
+<html:html >
+ <head>
+ <html:javascript formName="GetNameForm"/>
+ <title></title>
+ </head>
+ <body>
+ <html:form action="/greeting.do" onsubmit="return validateGetNameForm(this)">
+ Input name:<html:text property="name"/><html:submit value="Say Hello!"/>
+ </html:form>
+ </body>
+</html:html>
+]]>
+ </programlisting>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save</guimenuitem></menuchoice> from the menu bar
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Start JBoss Application Server by clicking on its icon (a right-pointing arrow) in the toolbar
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click the Run icon(
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_validation/struts_validation_1.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ ) or right click your project folder and select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run on Server</guimenuitem></menuchoice>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ In the browser window, click on the "Say Hello!" button without having entered any name in the form
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ A JavaScript error message should be displayed in an alert box.
+ </para>
+ </section>
+
+ <section id="Server-SideValidation">
+<?dbhtml filename="Server-SideValidation.html"?>
+ <title>Server Side Validation</title>
+ <para>
+ Server side validation does the validation inside the application on the server. In a Struts application using the Validation Framework, you still don't have to do any of the actual validation coding. The Validation Framework handles this. You will though have to make a few changes to the JSP file you modified for client-side validation along with a change to an action and a few changes to the form bean class.
+ </para>
+ </section>
+
+ <section id="EditingTheJSPFile">
+<?dbhtml filename="EditingTheJSPFile.html"?>
+ <title>Editing the JSP File</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Reopen inputname.jsp for editing
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Delete the <emphasis role="italic"><property>"onsubmit"</property></emphasis> attribute in the <code><html:form></code> element that you put in for client-side validation
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Add an <code><html:errors/></code> tag after the <code><html:form></code> tag
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ The JSP file should now look like this:
+ </para>
+
+ <programlisting role="XML">
+<![CDATA[<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %>
+<html:html >
+<head>
+ <html:javascript formName="GetNameForm"/>
+ <title></title>
+ </head>
+ <body>
+ <html:form action="/greeting.do" >Input name:<html:text property="name"/>
+ <html:submit value="Say Hello!"/>
+ </html:form>
+ <html:errors/>
+ </body>
+</html:html>
+]]>
+ </programlisting>
+ </section>
+
+ <section id="EditingTheAction">
+<?dbhtml filename="EditingTheAction.html"?>
+ <title>Editing the Action</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ In the Web Projects view, expand the node under the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>Configuration</guimenuitem><guimenuitem>default</guimenuitem><guimenuitem>struts-config.xml</guimenuitem><guimenuitem>action-mappings</guimenuitem></menuchoice> node, right-click the <emphasis><property>/greeting</property></emphasis> action, and then select <emphasis><property>Properties...</property></emphasis>from the context menu
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the Edit Properties window, insert the cursor into the value column for the input property and click on the <property>...</property> button
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the dialog box, make sure the Pages tab is selected, select <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>WEB-ROOT(WebContent)</guimenuitem><guimenuitem>pages</guimenuitem><guimenuitem>inputname.jsp</guimenuitem></menuchoice>, click the <emphasis><property>Ok</property></emphasis> button, and then click on the <emphasis><property>Close</property></emphasis> button
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="EditingTheFormBean">
+<?dbhtml filename="EditingTheFormBean.html"?>
+ <title>Editing the Form Bean</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Right-click the <emphasis><property>/greeting</property></emphasis> action again and select Open Form-bean Source to open the GetNameForm.java file for editing
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Change the class that it extends from: <emphasis><property>org.apache.struts.action.ActionForm</property></emphasis> to <emphasis><property>org.apache.struts.validator.ValidatorForm</property></emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Comment out a validate method
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ The file should now look like this:
+ </para>
+
+ <programlisting role="JAVA">
+<![CDATA[package sample;
+import javax.servlet.http.HttpServletRequest;
+import org.apache.struts.action.ActionErrors;
+import org.apache.struts.action.ActionMapping;
+public class GetNameForm extends
+
+org.apache.struts.validator.ValidatorForm
+{
+
+ private String name = "";
+
+ /**
+ * @return Returns the name.
+ */
+ public String getName()
+ {
+ return name;
+ }
+
+ /**
+ * @param name The name to set.
+ */
+ public void setName(String name)
+ {
+ this.name = name;
+ }
+
+ public GetNameForm ()
+ {
+ }
+
+ public void reset(ActionMapping actionMapping,
+ HttpServletRequest request)
+ {
+ this.name = "";
+ }
+
+ // public ActionErrors validate(ActionMapping actionMapping,
+ // HttpServletRequest request)
+ //{
+ // ActionErrors errors = new ActionErrors();
+ // return errors;
+ // }
+ }
+]]>
+ </programlisting>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save All</guimenuitem></menuchoice> from the menu bar
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Reload the application into JBoss AS by clicking on the "Change Time Stamp" icon (a finger pointing with a little star) in the toolbar
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Run the application
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the browser window, click on the "Say Hello!" button without having entered any name in the form
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ The error message should appear in a refreshed version of the form.
+ </para>
+ </section>
+</chapter>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/pom.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/pom.xml 2011-07-18 02:48:03 UTC (rev 32986)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_tutorial/pom.xml 2011-07-18 02:52:04 UTC (rev 32987)
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.jboss.tools</groupId>
@@ -10,229 +8,232 @@
<packaging>jdocbook</packaging>
<name>${bookname}-(${translation})</name>
- <properties>
- <translation>en-US</translation>
- <docname>Struts_Tools_Tutorial</docname>
- <bookname>Struts Tools Tutorial</bookname>
- </properties>
-
- <profiles>
+ <properties>
+ <translation>en-US</translation>
+ <docname>Struts_Tools_Tutorial</docname>
+ <bookname>Struts Tools Tutorial</bookname>
+ </properties>
+ <profiles>
+
<!-- mvn compile -->
- <profile>
- <id>all</id>
- <activation>
- <activeByDefault>true</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${docname}.pdf</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>all</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.4</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${docname}.pdf</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <useRelativeImageUris>true</useRelativeImageUris>
+ </options>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Phtml -->
- <profile>
- <id>html</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>html</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Phtml-single -->
- <profile>
- <id>html-single</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- </plugin>
+ <profile>
+ <id>html-single</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Ppdf -->
- <profile>
- <id>pdf</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${docname}.pdf</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>pdf</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${docname}.pdf</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Peclipse -->
- <profile>
- <id>eclipse</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
- </plugins>
- </build>
- </profile>
+ <profile>
+ <id>eclipse</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
- </profiles>
- <build>
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <dependencies>
- <dependency>
- <groupId>org.jboss.pressgang</groupId>
- <artifactId>pressgang-xslt</artifactId>
- <version>1.2.0</version>
- </dependency>
- <dependency>
- <groupId>org.jboss</groupId>
- <artifactId>jbossorg-jdocbook-style</artifactId>
- <version>1.1.1</version>
- <type>jdocbook-style</type>
- </dependency>
- </dependencies>
- <configuration>
- <sourceDirectory>${project.basedir}</sourceDirectory>
+ </profiles>
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <dependencies>
+ <dependency>
+ <groupId>org.jboss.pressgang</groupId>
+ <artifactId>pressgang-xslt</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss</groupId>
+ <artifactId>jbossorg-jdocbook-style</artifactId>
+ <version>1.1.1</version>
+ <type>jdocbook-style</type>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <sourceDirectory>${project.basedir}</sourceDirectory>
<!-- <sourceDocumentName>${docname}.xml</sourceDocumentName> -->
- <sourceDocumentName>master.xml</sourceDocumentName>
- <masterTranslation>en-US</masterTranslation>
- <imageResource>
- <directory>${project.basedir}/en-US</directory>
- <includes>
- <include>images/**/*</include>
- </includes>
- </imageResource>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${pdf.name}</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- <options>
- <xincludeSupported>true</xincludeSupported>
- <xmlTransformerType>saxon</xmlTransformerType>
- <docbookVersion>1.72.0</docbookVersion>
- <localeSeparator>-</localeSeparator>
- <transformerParameters>
- <property>
- <name>javax.xml.parsers.DocumentBuilderFactory</name>
- <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
- </property>
- <property>
- <name>javax.xml.parsers.SAXParserFactory</name>
- <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
- </property>
- </transformerParameters>
- </options>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
+ <sourceDocumentName>master.xml</sourceDocumentName>
+ <masterTranslation>en-US</masterTranslation>
+ <imageResource>
+ <directory>${project.basedir}/en-US</directory>
+ <includes>
+ <include>images/**/*</include>
+ </includes>
+ </imageResource>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${pdf.name}</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <xincludeSupported>true</xincludeSupported>
+ <xmlTransformerType>saxon</xmlTransformerType>
+ <docbookVersion>1.72.0</docbookVersion>
+ <localeSeparator>-</localeSeparator>
+ <transformerParameters>
+ <property>
+ <name>javax.xml.parsers.DocumentBuilderFactory</name>
+ <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
+ </property>
+ <property>
+ <name>javax.xml.parsers.SAXParserFactory</name>
+ <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
+ </property>
+ </transformerParameters>
+ </options>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
</project>
14 years, 9 months
- 1
- 0
JBoss Tools SVN: r32986 - in branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide: en-US and 1 other directory.
by jbosstools-commits＠lists.jboss.org
Author: irooskov(a)redhat.com
Date: 2011-07-17 22:48:03 -0400 (Sun, 17 Jul 2011)
New Revision: 32986
Modified:
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Book_Info.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Feedback.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Preface.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Revision_History.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Struts_Tools_Reference_Guide.ent
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Struts_Tools_Reference_Guide.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/code_generation.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/config_file_debugger.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/editors.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/introduction.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/master.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/modules.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/page_links_recognizer.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/project_verification.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/projects.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/rel_resources_links.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/struts_project_verification.xml
branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/pom.xml
Log:
updated for GA
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Book_Info.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Book_Info.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Book_Info.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -5,9 +5,9 @@
<title>Struts Tools Reference Guide</title>
<subtitle>Provides information relating to the Struts Tools module.</subtitle>
<productname>JBoss Developer Studio</productname>
- <productnumber>4.0</productnumber>
- <edition>4.0.0</edition>
- <pubsnumber>4</pubsnumber>
+ <productnumber>4.1</productnumber>
+ <edition>4.1.0</edition>
+ <pubsnumber>1</pubsnumber>
<abstract>
<para>The Struts Tools Reference Guide explains how to use the Struts Tools to create high-quality web applications.</para>
</abstract>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Feedback.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Feedback.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Feedback.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -1,20 +1,92 @@
<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Document_Conventions.ent">
+%BOOK_ENTITIES;
+]>
+<appendix id="sect_JBoss-Getting_Help_and_Giving_Feedback" lang="en-US">
+ <title>Getting Help and Giving Feedback</title>
+ <section id="sect_JBoss-Do_You_Need_Help">
+ <title>Do You Need Help?</title>
+ <indexterm>
+ <primary>help</primary>
+ <secondary>getting help</secondary>
-<section id="sect-Beginners_Guide-We_Need_Feedback" lang="en-US">
- <title>We Need Feedback!</title>
- <indexterm>
- <primary>feedback</primary>
- <secondary>contact information for this manual</secondary>
- </indexterm>
- <para>
- If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA against JBoss Developer Studio: <ulink url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...">https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...</ulink>
- </para>
- <para>
- When submitting a bug report, be sure to mention the manual's name and to select the "documentation" component.
- </para>
- <para>
- If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.
- </para>
-</section>
+ </indexterm>
+ <para>
+ If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at <ulink url="http://access.redhat.com" />. Through the customer portal, you can:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ search or browse through a knowledgebase of technical support articles about Red Hat products.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ submit a support case to Red Hat Global Support Services (GSS).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ access other product documentation.
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+ <para>
+ Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. You can find a list of publicly available mailing lists at <ulink url="https://www.redhat.com/mailman/listinfo" />. Click on the name of any mailing list to subscribe to that list or to access the list archives.
+ </para>
+
+ </section>
+
+ <section id="jboss-feedback">
+ <title>Give us Feedback</title>
+ <!-- NOTE: You will need the following entities defined in your .ent file.
+ You will need to replace _YOUR_PRODUCT_HERE_, _YOUR_COMPONENT_
+ and _YOUR_SUMMARY_ - entities are not replaced in URLs.
+ <!ENTITY PRODUCT "JBoss Product Name">
+ <!ENTITY BZCOMPONENT "doc-triage">
+ <!ENTITY BZURL "<ulink url='https://bugzilla.example.com/enter_bug.cgi?product=_YOUR_PRODUCT_HERE_&am...'>http://bugzilla.redhat.com/</ulink>">
+
+ These entities should not affect translated documents, since Bugzilla is not localised.
+ --> <indexterm>
+ <primary>feedback</primary>
+ <secondary>contact information for this manual</secondary>
+
+ </indexterm>
+ <para>
+ If you find a typographical error, or know how this guide can be improved, we would love to hear from you. Submit a report in Bugzilla against the product <literal>&BZPRODUCT;</literal> and the component <literal>&BZCOMPONENT;</literal>. The following link will take you to a pre-filled bug report for this product: &BZURL;.
+ </para>
+ <para>
+ Fill out the following template in Bugzilla's <literal>Description</literal> field. Be as specific as possible when describing the issue; this will help ensure that we can fix it quickly.
+ </para>
+
+<screen>Document URL:
+
+
+Section Number and Name:
+
+
+Describe the issue:
+
+
+Suggestions for improvement:
+
+
+Additional information:
+
+
+</screen>
+ <para>
+ Be sure to give us your name so that you can receive full credit for reporting the issue.
+ </para>
+
+ </section>
+
+
+</appendix>
+
+
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Preface.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Preface.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Preface.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -8,9 +8,5 @@
<para>
This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. To get more information on these conventions please refer to the <guilabel>Document Conventions</guilabel> manual, which can be found on the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index.html">Red Hat Documentation</ulink> website under the <guilabel>JBoss Developer Studio</guilabel> section.
</para>
- <!--<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- </xi:fallback>
- </xi:include>-->
</preface>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Revision_History.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Revision_History.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Revision_History.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -2,31 +2,51 @@
<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
]>
<appendix>
- <title>Revision History</title>
- <simpara>
- <revhistory>
- <revision>
- <revnumber>1</revnumber><date>Wed Jun 09 2010</date>
- <author>
- <firstname>JBoss Tools</firstname><surname>Documentation Team</surname><email>irooskov(a)redhat.com</email>
- </author>
- <revdescription>
- <simplelist>
- <member>General updates</member>
- </simplelist>
- </revdescription>
- </revision>
- <revision>
- <revnumber>0</revnumber><date>Fri Nov 20 2009</date>
- <author>
- <firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email>
- </author>
- <revdescription>
- <simplelist>
- <member>Initial creation of book by publican</member>
- </simplelist>
- </revdescription>
- </revision>
- </revhistory>
- </simpara>
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>2</revnumber>
+ <date>Wed Jan 19 2011</date>
+ <author>
+ <firstname>JBoss Tools</firstname>
+ <surname>Documentation Team</surname>
+ <email>mcaspers(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>General updates</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>1</revnumber>
+ <date>Wed Jun 09 2010</date>
+ <author>
+ <firstname>JBoss Tools</firstname>
+ <surname>Documentation Team</surname>
+ <email>irooskov(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>General updates</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>0</revnumber>
+ <date>Fri Nov 20 2009</date>
+ <author>
+ <firstname>Isaac</firstname>
+ <surname>Rooskov</surname>
+ <email>irooskov(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial creation of book by publican</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
</appendix>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Struts_Tools_Reference_Guide.ent
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Struts_Tools_Reference_Guide.ent 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Struts_Tools_Reference_Guide.ent 2011-07-18 02:48:03 UTC (rev 32986)
@@ -1,4 +1,7 @@
<!ENTITY PRODUCT "JBoss">
<!ENTITY BOOKID "Struts_Tools_Reference_Guide">
-<!ENTITY YEAR "2010">
+<!ENTITY YEAR "2011">
<!ENTITY HOLDER "Red Hat">
+<!ENTITY BZPRODUCT "JBoss Developer Studio">
+<!ENTITY BZCOMPONENT "Struts Tools Reference Guide">
+<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss%20Develope...'>http://bugzilla.redhat.com/</ulink>">
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Struts_Tools_Reference_Guide.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Struts_Tools_Reference_Guide.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/Struts_Tools_Reference_Guide.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -13,6 +13,7 @@
<xi:include href="page_links_recognizer.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="project_verification.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="rel_resources_links.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
+<xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<index></index>
</book>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/code_generation.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/code_generation.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/code_generation.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -1,97 +1,91 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="code_generation">
- <?dbhtml filename="code_generation.html"?>
-
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Struts Tools</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Code Generation</title>
-
- <para>JBoss Tools comes with a <property>code generation</property>
- feature. You can generate stub code for Struts Actions, FormBeans, Forwards
- and Exceptions.</para>
-
- <para>The code generation that JBoss tooling provides is based on Velocity templates
- which can be modified for your use. The templates are located at <emphasis>
- <property> {JBossStudioHome} > templates >
- codegeneration</property>. </emphasis></para>
-
- <para>There are a number of ways to invoke code generation. One is simply
- right-clicking the Struts diagram and selecting <emphasis>
- <property>Generate Java Code....</property>
- </emphasis></para>
-
- <figure>
- <title>Selecting Generate Java Code</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_45.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On this screen you can select for which elements to generate code. If you
- select Next you will be able to specify more options for each of the
- categories you selected.</para>
-
- <figure>
- <title>Generate - Step 1</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_46.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Tip:</title>
- <para>Please be careful not to override your existing files.</para>
- </note>
-
- <para>When generation is complete, a result window will appear letting you know how
+ <?dbhtml filename="code_generation.html"?>
+
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Code Generation</title>
+
+ <para>
+ JBoss Tools comes with a <property>code generation</property> feature which can be used to generate stub code for Struts Actions, FormBeans, Forwards and Exceptions.
+ </para>
+
+ <para>
+ The code generation that JBoss tooling provides is based on Velocity templates which can be modified for your use. The templates are located at <menuchoice><guimenuitem>{JBossStudioHome}</guimenuitem><guimenuitem>templates</guimenuitem><guimenuitem>codegeneration</guimenuitem></menuchoice>.
+ </para>
+
+ <para>
+ There are a number of ways to invoke code generation. One way is to simply right-click the Struts diagram and select <guimenuitem>Generate Java Code....</guimenuitem>
+ </para>
+
+ <figure>
+ <title>Selecting Generate Java Code</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_45.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ On this screen you can select for which elements to generate code. If you click the <guibutton>Next</guibutton> button you will be able to specify more options for each of the categories you selected.
+ </para>
+
+ <figure>
+ <title>Generate - Step 1</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_46.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Tip:</title>
+ <para>Please be careful not to override your existing files.</para>
+ </note>
+
+ <para>When generation is complete, a result window will appear letting you know how
many classes were generated:</para>
-
- <figure>
- <title>Generation Finished</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_47.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You don't always have to generate code for all elements at once. You
- can invoke generation for just an individual Struts artifact as well.
- Right-click an element on the diagram of the Struts configuration file and
- select <emphasis>
- <property>Generate Java Code...</property>
- </emphasis> from the context menu.</para>
-
- <figure>
- <title>Generation For Individual Struts Artifact</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_48.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The same can be done from within the Tree viewer for the editor of the Struts
- configuration file.</para>
-
- <figure>
- <title>Generation in Struts Config Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_49.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+
+ <figure>
+ <title>Generation Finished</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_47.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ You don't always have to generate code for all elements at once. You can generate code for an individual Struts artifact as well. Right-click an element on the diagram of the Struts configuration file and select <guimenuitem>Generate Java Code...</guimenuitem> from the context menu.
+ </para>
+
+ <figure>
+ <title>Generation For Individual Struts Artifact</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_48.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The same can be done from within the Tree viewer for the editor of the Struts configuration file.</para>
+
+ <figure>
+ <title>Generation in Struts Config Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_49.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
</chapter>
\ No newline at end of file
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/config_file_debugger.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/config_file_debugger.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/config_file_debugger.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -13,12 +13,11 @@
<title>Struts Configuration File Debugger</title>
- <para>JBoss Tools come with <property>Struts configuration file
- debugger</property>. It allows you to set break points on Struts diagram and
- then simply launch the server in debug mode.</para>
+ <para>
+ JBoss Tools come with <property>Struts configuration file debugger</property>. It allows you to set break points on Struts diagram and then simply launch the server in debug mode.
+ </para>
- <para>Simply right click an Action or a page and select Add <emphasis>
- <property>Breakpoint</property>. </emphasis></para>
+ <para>Simply right click an Action or a page and select Add <guimenuitem>Breakpoint</guimenuitem>.</para>
<figure>
<title>Adding Breakpoint</title>
<mediaobject>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/editors.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/editors.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/editors.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -1,479 +1,469 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="editors">
- <?dbhtml filename="editors.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Struts Tools</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
+ <?dbhtml filename="editors.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
- <title>Editors</title>
- <para>In this chapter we'll introduce you to featured graphical editors for specific
- Struts files such as Struts Configuration files, Tiles files, Struts Validation files and web.xml.</para>
+ <title>Editors</title>
+ <para>
+ This chapter will cover the graphical editors provided for editing specific Struts files such as Struts Configuration files, Tiles files, Struts Validation files and web.xml.
+ </para>
<section id="webxml_editor">
<title>Web.xml Editor</title>
- <para>The <emphasis>
- <property>web.xml</property></emphasis> file inside the <emphasis>
- <property>WEB-INF</property></emphasis> folder is a deployment descriptor file for a Web Application. It
- describes the servlets and other components and deployment properties that make up your application.</para>
+ <para>
+ The <filename>web.xml</filename> file inside the <filename>WEB-INF</filename> folder is a deployment descriptor file for a Web Application. It describes the servlets, other components and deployment properties that make up your application.
+ </para>
- <para><property>JBoss Tools</property> add the <emphasis>
- <property>web.xml</property></emphasis> file to created Struts project automatically and provides a special editor for its editing.
- See the Visual Web Tools guide that gives a descriptive information on the <filename>web.xml</filename> editor.</para>
+ <para>
+ <property>JBoss Tools</property> adds the <filename>web.xml</filename> file to a Struts project automatically and provides a special editor through which the file can be edited. See the Visual Web Tools guide that gives a descriptive information on the <filename>web.xml</filename> editor.
+ </para>
</section>
-
- <section id="struts_config_editor">
- <title>Graphical Editor for Struts Configuration Files</title>
- <para>First, let's dwell on the Struts Configuration file editor.</para>
- <para>This editor has three views with different representation of <emphasis>
- <property>struts-config.xml</property>: </emphasis>Diagram, Tree and Source. The
- views can be selected via the tabs at the bottom of the editor. Any changes made in one
- view are immediately visible when you switch to any other view.</para>
+ <section id="struts_config_editor">
- <para>Now, we'll consider every view in more detail.</para>
- <section id="StrutsDiagramMode453">
+ <title>Graphical Editor for Struts Configuration Files</title>
+ <para>First, let's dwell on the Struts Configuration file editor.</para>
+ <para>
+ This editor provides three views of the <filename>struts-config.xml</filename> file: Diagram, Tree and Source. The views can be selected using the tabs at the bottom of the editor. Any changes made in one view are immediately visible when you switch to any other view.
+ </para>
- <title>Diagram View</title>
+ <para>Now, we'll consider each of these three views in more detail.</para>
+ <section id="StrutsDiagramMode453">
- <para>The Diagram view graphically displays the Web flow of the application defined in
- the Struts configuration file.</para>
+ <title>Diagram View</title>
- <figure>
- <title>Diagram View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_14.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>The Diagram view graphically displays the Web flow of the application defined in the Struts configuration file.</para>
- <para>The Diagram view allows to edit navigation in your Struts application. Just by
- right-clicking anywhere on the diagram, you can use a context menu to create the
- building blocks of a Struts application:</para>
- <itemizedlist>
- <listitem>
- <para>Actions</para>
- </listitem>
- <listitem>
- <para>Global forwards</para>
- </listitem>
- <listitem>
- <para>Global exceptions</para>
- </listitem>
- <listitem>
- <para>JSP Pages</para>
- </listitem>
- </itemizedlist>
+ <figure>
+ <title>Diagram View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_14.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Diagram Context Menu</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_15.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>
+ The Diagram view provides a way to edit the navigation in your Struts application. By right-clicking anywhere on the diagram, you can use a context menu to create the building blocks of a Struts application:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>Actions</para>
+ </listitem>
+ <listitem>
+ <para>Global forwards</para>
+ </listitem>
+ <listitem>
+ <para>Global exceptions</para>
+ </listitem>
+ <listitem>
+ <para>JSP Pages</para>
+ </listitem>
+ </itemizedlist>
- <para>Along the upper-left side of the editor is a stack of seven icons for changing the
- behavior of the cursor in the diagram. </para>
+ <figure>
+ <title>Diagram Context Menu</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_15.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Editor Icons</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_16.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>Along the upper-left side of the editor is a stack of seven icons for changing the behavior of the cursor in the diagram. </para>
- <para>The first icon switches to the default regular selection cursor, the second to the
- marquee selection cursor and the third to the new connection cursor. The last four
- icons switch the cursor to an insert cursor for each type of Struts build block
- listed above (and in the order listed).</para>
+ <figure>
+ <title>Editor Icons</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_16.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>For instance, clicking on the first of these four icons (the one with the gears)
- will switch the cursor to insert actions. Clicking anywhere in the diagram with this
- cursor has the same effect as right-click and selecting <emphasis>
- <property>Add > Action...</property>
- </emphasis> from the context menu with the regular cursor active. It's just
- more efficient to use this cursor if you're adding more than one action at
- once.</para>
+ <para>
+ The first icon switches to the default regular selection cursor, the second to the marquee selection cursor and the third to the new connection cursor. The last four icons switch the cursor to an insert cursor for each type of Struts build block listed above (and in the order listed).
+ </para>
+ <para>
+ For instance, clicking on the first of these four icons (the one with the gears) will switch the cursor to insert actions. Clicking anywhere in the diagram with this cursor has the same effect as right-click and selecting <menuchoice><guimenuitem>Add</guimenuitem><guimenuitem>Action...</guimenuitem></menuchoice> from the context menu with the regular cursor active. It's just more efficient to use this cursor if you're adding more than one action at once.
+ </para>
- </section>
- <section id="StrutsTreeMode42">
- <title>Tree View</title>
+ </section>
+ <section id="StrutsTreeMode42">
- <para>The Tree view represents the different elements of the Struts application that are organized into functional categories
- on the left-hand side and a form for editing the properties of currently selected items on the right-hand side.</para>
+ <title>Tree View</title>
+
+ <para>
+ The Tree view represents the different elements of the Struts application that are organized into functional categories on the left-hand side and a form for editing the properties of currently selected items on the right-hand side.
+ </para>
- <figure>
- <title>Tree View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_17.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You can right-click on any node in the category tree and perform appropriate
- operations through a context menu. For instance, by right-clicking on the
- action-mappings category node, you can add new actions to the application.</para>
+ <figure>
+ <title>Tree View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_17.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Tree Context Menu</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_18.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>
+ You can right-click on any node in the category tree to perform a number of operations through a context menu. For instance, by right-clicking on the action-mappings category node, you can add new actions to the application.
+ </para>
+
+ <figure>
+ <title>Tree Context Menu</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_18.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>Let's consider the tree on the left more closely.</para>
+ <para>Let's consider the tree on the left more closely.</para>
- <itemizedlist>
- <listitem><para>Under the <emphasis>
- <property>data-sources</property></emphasis> node you can create a Data Source object that will be configured
- and made available as a servlet context attribute.</para></listitem>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Under the <emphasis><property>data-sources</property></emphasis> node you can create a Data Source object that will be configured and made available as a servlet context attribute.
+ </para>
+ </listitem>
- <listitem><para>The <emphasis>
- <property>form-beans</property></emphasis> node is meant for creating a set of form bean descriptors for this module.
- Every created element under this node is a JavaBean that implements the org.apache.struts.action.ActionForm class.
- Use the Properties editor on the right to adjust properties specific to every created form-bean.</para></listitem>
+ <listitem>
+ <para>
+ The <emphasis><property>form-beans</property></emphasis> node is meant for creating a set of form bean descriptors for this module. Every element under this node is a JavaBean that implements the <code>org.apache.struts.action.ActionForm</code> class. Use the Properties editor on the right to adjust the properties specific to each form-bean.
+ </para>
+ </listitem>
- <listitem><para>The <emphasis>
- <property>global-exceptions</property></emphasis> node is intended for registering the handlers for the exceptions
- that might be thrown by an Action object.</para></listitem>
+ <listitem>
+ <para>
+ The <emphasis><property>global-exceptions</property></emphasis> node is intended for registering handlers for the exceptions that might be thrown by an Action object.
+ </para>
+ </listitem>
- <listitem><para>Use the <emphasis>
- <property>global-forwards</property></emphasis> node to add, edit or delete a global forwards that represent
- ActionForward objects available to all Action objects as a return value.</para></listitem>
+ <listitem>
+ <para>
+ Use the <emphasis><property>global-forwards</property></emphasis> node to add, edit or delete a global forwards that represent ActionForward objects available to all Action objects as a return value.
+ </para>
+ </listitem>
- <listitem><para>The <emphasis>
- <property>controller</property></emphasis> node allows you to configure the controller properties.</para></listitem>
+ <listitem>
+ <para>The <emphasis><property>controller</property></emphasis> node allows you to configure the controller properties.</para>
+ </listitem>
- <listitem><para>Under the <emphasis>
- <property>resources</property></emphasis> node you can add, delete, or edit message resources.</para></listitem>
+ <listitem>
+ <para>Under the <emphasis><property>resources</property></emphasis> node you can add, delete, or edit message resources.</para>
+ </listitem>
- <listitem><para>Under the <emphasis>
- <property>plug-ins</property></emphasis> node you can define a Struts plug-in. Right-click the node, select <emphasis>
- <property>Create Plug-in</property></emphasis>
- and specify the plug-in <emphasis>
- <property>Id</property></emphasis> and <emphasis>
- <property>ClassName</property></emphasis> by pointing to the Java class which implements the org.apache.struts.action.PlugIn interface. </para></listitem>
-
- </itemizedlist>
- </section>
- <section id="StrutsSourceMode9655">
+ <listitem>
+ <para>
+ Under the <emphasis><property>plug-ins</property></emphasis> node you can define a Struts plug-in. Right-click the node, select <guimenuitem>Create Plug-in</guimenuitem> and specify the plug-in <emphasis><property>Id</property></emphasis> and <emphasis><property>ClassName</property></emphasis> by pointing to the Java class which implements the <code>org.apache.struts.action.PlugIn</code> interface.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </section>
+ <section id="StrutsSourceMode9655">
- <title>Source View</title>
+ <title>Source View</title>
- <para>In the Source view, you have complete editing control of the underlying XML
- coding.</para>
+ <para>In the Source view, you have complete editing control of the underlying XML coding.</para>
- <figure>
- <title>Source View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_19.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>When working in Source view, you always have all the following features available:</para>
- <itemizedlist>
- <listitem>
- <para>Content Assist</para>
- </listitem>
- <listitem>
- <para>Open On Selection</para>
- </listitem>
- <listitem>
- <para>File Folding</para>
- </listitem>
- </itemizedlist>
- <para>You can take advantage of code assist.</para>
- <figure>
- <title>Code Assist</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_20.png" scale="85"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Source View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_19.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>The editor will also immediately flag any errors.</para>
+ <para>When working in Source view, you always have all the following features available:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Content Assist</para>
+ </listitem>
+ <listitem>
+ <para>Open On Selection</para>
+ </listitem>
+ <listitem>
+ <para>File Folding</para>
+ </listitem>
+ </itemizedlist>
+ <para>You can take advantage of code assist.</para>
+ <figure>
+ <title>Code Assist</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_20.png" scale="85"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Errors in Source View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_21.png" scale="85"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>The editor will also immediately flag any errors.</para>
- <para>Finally, you can use the Outline view with the editor to easily navigate through
- the file.</para>
+ <figure>
+ <title>Errors in Source View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_21.png" scale="85"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Outline View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_22.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Find more information about editor features in the editor features chapter.</para>
- </section>
- </section>
+ <para>Finally, you can use the Outline view with the editor to easily navigate through the file.</para>
- <section id="GraphicalEditorForTilesFiles132">
+ <figure>
+ <title>Outline View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_22.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <title>Graphical Editor for Tiles Files</title>
- <para>Here, you'll know how to make use of the special graphical editor for Tiles configuration files.</para>
- <para>The editor has three main views: Tree, Diagram and Source.
- The views can be selected via the tabs at the bottom of the editor. Any changes made in
- one view are immediately visible when you switch to any other view.</para>
+ <para>Find more information about editor features in the editor features chapter.</para>
+ </section>
+ </section>
- <para>Before we consider each view of the editor, let's look at the way of creating new Tiles files.</para>
- <section id="CreateNewTilesFile1422">
+ <section id="GraphicalEditorForTilesFiles132">
- <title>Create New Tiles File</title>
+ <title>Graphical Editor for Tiles Files</title>
+ <para>Here, you'll know how to make use of the special graphical editor for Tiles configuration files.</para>
+ <para>
+ The editor has three main views: Tree, Diagram and Source. The views can be selected via the tabs at the bottom of the editor. Any changes made in one view are immediately visible when you switch to any other view.
+ </para>
- <para>To create new Tiles files, right click any folder and select <emphasis>
- <property>New > Tiles File</property>. </emphasis></para>
- <figure>
- <title>Creating a New Tiles File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_23.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section id="StrutsTreeView896">
+ <para>Before we consider each view of the editor, let's look at the way of creating new Tiles files.</para>
+ <section id="CreateNewTilesFile1422">
- <title>Tree View</title>
+ <title>Create New Tiles File</title>
- <para>The Tree view represents the different elements of the Tiles file that are
- organized into functional categories on the left-hand side and a form for editing
- the properties of currently selected items on the right-hand side.</para>
- <figure>
- <title>Tree View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_24.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>
+ To create new Tiles files, right click any folder and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Tiles File</guimenuitem></menuchoice>.
+ </para>
+ <figure>
+ <title>Creating a New Tiles File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_23.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="StrutsTreeView896">
- <para>To edit the file, simply right click any node and select among the available
- actions.</para>
- <figure>
- <title>Editing in Tiles Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_25.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section id="StrutsDiagramView4643">
+ <title>Tree View</title>
- <title>Diagram View</title>
+ <para>
+ The Tree view represents the different elements of the Tiles file organized into functional categories on the left-hand side and a form for editing the properties of currently selected items on the right-hand side.
+ </para>
+ <figure>
+ <title>Tree View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_24.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>The Diagram view allows you to create complex Tiles files in the form of a
- diagram.</para>
- <figure>
- <title>Diagram Mode</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_26.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>To edit the file, simply right click any node and select from the available actions.</para>
+ <figure>
+ <title>Editing in Tiles Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_25.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="StrutsDiagramView4643">
- <para>To create new definitions, simply right click anywhere in the diagram.</para>
- <figure>
- <title>Creating New Definition</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_27.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <title>Diagram View</title>
- <para>You can also use the Diagram toolbar to make editing easier.</para>
- <figure>
- <title>Diagram Toolbar</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_28.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>The Diagram view allows you to create complex Tiles files in the form of a diagram.</para>
+ <figure>
+ <title>Diagram Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_26.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para> It contains four icons for changing the cursor state. The first one is the
- default cursor state for selecting existing nodes. The second icon is marquee
- selector. The third is used for creating new connections and the last one is for
- adding definition template to the content.</para>
- </section>
- <section id="StrutsSource75">
+ <para>To create new definitions, simply right click anywhere in the diagram.</para>
+ <figure>
+ <title>Creating New Definition</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_27.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <title>Source</title>
+ <para>You can also use the Diagram toolbar to make editing easier.</para>
+ <figure>
+ <title>Diagram Toolbar</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_28.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>The other view of the <property>Tiles editor</property> is the Source view that
- gives you full control over the source. Any changes here will immediately appear in
- other modes when you switch to them.</para>
-
- <para>When working in Source view, you always have all following features available:</para>
- <itemizedlist>
- <listitem>
- <para>Content Assist</para>
- </listitem>
- <listitem>
- <para>Open On Selection</para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>Source View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_29.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Code
- assist is available in the Source mode.</para>
- <figure>
- <title>Code Assist</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_30.png" scale="85"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Any errors are immediately reported as shown below:</para>
- <figure>
- <title>Errors Reporting</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_31.png" scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>
+ It contains four icons for changing the cursor state. The first one is the default cursor state for selecting existing nodes. The second icon is marquee selector. The third is used for creating new connections and the last one is for adding definition template to the content.
+ </para>
+ </section>
+ <section id="StrutsSource75">
- <para>You can also use the Outline view together with the editor's Source mode.
- It provides an easier navigation through the file.</para>
- <figure>
- <title>Outline View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_32.png" scale="85"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- </section>
+ <title>Source</title>
- <section id="GraphicalEditorForStrutsValidationFiles86">
+ <para>
+ The other view of the <property>Tiles editor</property> is the Source view that gives you full control over the source. Any changes here will immediately appear in other modes when you switch to them.
+ </para>
- <title>Graphical Editor for Struts Validation Files</title>
+ <para>When working in Source view, you always have all following features available:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Content Assist</para>
+ </listitem>
+ <listitem>
+ <para>Open On Selection</para>
+ </listitem>
+ </itemizedlist>
- <para>Providing full support for development Struts applications JBoss Tools comes with a
- visual validation editor. To open the editor double-click on the validation file or if you don't have it create a new one.</para>
-
- <para>To create a new validation file, right click any folder in
- Project Explorer and select <emphasis>
- <property>File > New > Other...</property>
- </emphasis>from the context menu and then <emphasis>
- <property>JBoss Tools Web > Struts > Validation File</property>. </emphasis></para>
- <figure>
- <title>Creating New Validation File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_33.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Source View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_29.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Code assist is available in the Source mode.</para>
+ <figure>
+ <title>Code Assist</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_30.png" scale="85"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Any errors are immediately reported as shown below:</para>
+ <figure>
+ <title>Errors Reporting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_31.png" scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>The validation editor works with five modes: Formsets, Validators, Constants and
- standard Tree and Source that you can easily switch over using tabs at the bottom of the
- editor.</para>
- <para>The Formsets view shows forms and their elements on the left side and the dialogue for
- defining their validation rules on the right side.</para>
- <figure>
- <title>Formsets View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_34.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>You can also use the Outline view together with the editor's Source mode. It provides a way to more easily navigate through the file.</para>
+ <figure>
+ <title>Outline View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_32.png" scale="85"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ </section>
- <para>The Constants view let you set constant values for your validation rules.</para>
- <figure>
- <title>Constansts View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_35.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <section id="GraphicalEditorForStrutsValidationFiles86">
- <para>The validation file can also be viewed in a Tree view.</para>
- <figure>
- <title>Tree View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_36.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <title>Graphical Editor for Struts Validation Files</title>
- <para>At any point you have full control over the source by switching to the Source view.
- Any editing in this view will immediately be available in other views of the editor.</para>
- <figure>
- <title>Source View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_37.png" scale="85"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>
+ JBoss Tools comes with a visual validation editor that provides full support for the development of Struts applications. To open the editor double-click on the validation file, or create a new one if it doesn't exist.
+ </para>
- <para>You can also open your own custom or Struts-standard <emphasis>
- <property>validation-rules.xml</property>
- </emphasis> file.</para>
- <para>The Validators view shows the validation rules for a selected validator. You can of
- course add your own rules.</para>
- <figure>
- <title>Validators View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_38.png" scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Here are the validation rules shown in the Source mode.</para>
- <figure>
- <title>Validation Rules</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_39.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
+ <para>To create a new validation file, right click any folder in Project Explorer and select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other...</guimenuitem></menuchoice> from the context menu and then select <menuchoice><guimenuitem>JBoss Tools Web</guimenuitem><guimenuitem>Struts</guimenuitem><guimenuitem>Validation File</guimenuitem></menuchoice>.
+ </para>
+ <figure>
+ <title>Creating New Validation File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_33.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The validation editor works with five modes: Formsets, Validators, Constants and standard Tree and Source that you can easily switch between using tabs at the bottom of the editor.
+ </para>
+ <para>The Formsets view shows forms and their elements on the left side and the dialogue for defining their validation rules on the right side.</para>
+ <figure>
+ <title>Formsets View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_34.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The Constants view let you set constant values for your validation rules.</para>
+ <figure>
+ <title>Constants View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_35.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The validation file can also be viewed in a Tree view.</para>
+ <figure>
+ <title>Tree View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_36.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ At any point you have full control over the source by switching to the Source view. Any editing in this view will immediately be available in other views of the editor.
+ </para>
+ <figure>
+ <title>Source View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_37.png" scale="85"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can also open your own custom or Struts-standard <filename>validation-rules.xml</filename> file.</para>
+ <para>The Validators view shows the validation rules for a selected validator. You can of course add your own rules.</para>
+ <figure>
+ <title>Validators View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_38.png" scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Here are the validation rules shown in the Source mode.</para>
+ <figure>
+ <title>Validation Rules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_39.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
</chapter>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/introduction.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/introduction.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/introduction.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -13,23 +13,20 @@
<title>Introduction</title>
- <para>If you prefer to develop web applications using Struts technology JBoss Tools also meet
- your needs. The professional developer toolset provides all necessary editors and wizards
- for creating Struts resources that enhances the process of building high-quality web
- applications.</para>
+ <para>
+ JBoss Developer Studio provides a number of editors and wizards that allow Struts developers to quickly and efficiently build high quality web applications.
+ </para>
<note>
<title>Note:</title>
<para>Note that JBoss Tools support the Struts 1.1, 1.2.x versions.</para>
</note>
- <para>In this guide you will learn how to take advantage of Struts support that <property>JBoss Tools</property>
- provide.</para>
+ <para>In this guide you will learn how to take advantage of Struts support that is provided by <property>JBoss Developer Studio</property>.</para>
<section id="struts_key_features">
<title>Key Features of Struts Tools</title>
- <para>For a start, we propose you to look through the table of main features of Struts
- Tools:</para>
+ <para>The table below lists the main features provided by Struts Tools:</para>
<table>
@@ -50,23 +47,24 @@
<tbody>
<row>
<entry><para>Struts Support</para></entry>
- <entry><para>Step-by-step wizards for creating a new struts project with a number
- of predefined templates, importing existing ones and adding struts
- capabilities to non-struts web projects.</para></entry>
<entry>
+ <para>
+ Step-by-step wizards for creating a new Struts project with a number of predefined templates, importing existing ones and adding struts capabilities to non-Struts web projects.
+ </para>
+ </entry>
+ <entry>
<xref linkend="projects"/>
</entry>
</row>
<row>
<entry><para>Support for Struts Configuration File</para></entry>
- <entry><para>Working on file using three modes: diagram, tree and source.
- Synchronization between the modes and full control over the code. Easy
- moving around the diagram using the Diagram Navigator. Working with
- struts projects that have multiple modules. Possibility to use Struts
- configuration file debugger allowing to set break points on struts
- diagram and then launch the server in debug mode.</para></entry>
<entry>
+ <para>
+ Working on files using three modes: diagram, tree and source. Synchronization between the modes and full control over the code. Easily move around the diagram using the Diagram Navigator. Working with struts projects that have multiple modules. The option to use thee Struts configuration file debugger, which allows break points to be set on a Struts diagram and then launch the server in debug mode.
+ </para>
+ </entry>
+ <entry>
<xref linkend="struts_config_editor"/>
<xref linkend="config_file_debugger"/>
</entry>
@@ -74,21 +72,24 @@
<row>
<entry><para>Support for Struts modules</para></entry>
- <entry><para>A Struts module (struts-config.xml) is automatically created while
- creating a new project. There is also possibility to add new ones or edit
- already existing modules in your existing project or while importing Struts project.</para></entry>
<entry>
+ <para>
+ A Struts module (<filename>struts-config.xml</filename>) is automatically created when creating a new project. There is also the option to add new or edit already existing modules in your existing project or while importing Struts project.
+ </para>
+ </entry>
+ <entry>
<xref linkend="modules"/>
</entry>
</row>
<row>
<entry><para>Verification and Validation</para></entry>
- <entry><para>All occurring errors will be immediately reported by verification
- feature, no matter in what view you are working. Constant validation and
- errors checking allows to catch many of the errors during development
- process that significantly reduces development time.</para></entry>
<entry>
+ <para>
+ All errors will be immediately reported by verification feature, no matter which view you are working in. Constant validation and errors checking allows developers to catch many of the errors during development process, which significantly reduces development time.
+ </para>
+ </entry>
+ <entry>
<xref linkend="project_verification"/>
</entry>
@@ -102,7 +103,9 @@
<section>
<title>Other relevant resources on the topic</title>
- <para>All JBoss Developer Studio/JBoss Tools documentation you can find on<ulink url="http://docs.jboss.org/tools/">JBoss Tools project page </ulink>.</para>
+ <para>
+ All JBoss Developer Studio/JBoss Tools documentation you can find on<ulink url="http://docs.jboss.org/tools/">JBoss Tools project page </ulink>.
+ </para>
<para>The latest documentation builds are available on<ulink url="http://download.jboss.org/jbosstools/nightly-docs/">nightly docs page</ulink>.</para>
</section>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/master.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/master.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/master.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -56,12 +56,12 @@
Version: 3.1.1.GA
</releaseinfo>
-<abstract>
+<!--<abstract>
<title/>
<para>
<ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/struts_tools_ref_gui...">PDF version</ulink>
</para>
-</abstract>
+</abstract> -->
</bookinfo>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/modules.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/modules.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/modules.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -13,15 +13,13 @@
<title>Modules</title>
- <para>JBoss Tools support working with Struts projects that have
- multiple modules. You can easily do the following:</para>
+ <para>JBoss Tools supports working with Struts projects that have multiple modules. You can easily do the following:</para>
<itemizedlist>
<listitem>
<para>Add new modules</para>
</listitem>
<listitem>
- <para>Edit modules for an existing project or during Struts project
- import</para>
+ <para>Edit modules for an existing project or during Struts project import</para>
</listitem>
</itemizedlist>
<para>Now, let's discuss this functionality in more detail.</para>
@@ -29,9 +27,9 @@
<title>When Importing a Struts Project</title>
- <para>During Struts project import, if the project has multiple modules, you
- will see a screen with all existing modules. You can select each
- module and edit its details.</para>
+ <para>
+ During Struts project import, if the project has multiple modules, you will see a screen with all existing modules. You can select each module and edit its details.
+ </para>
<figure>
<title>Configuring Project Modules</title>
@@ -45,14 +43,7 @@
<section id="EditingModulesInAnExistingProject1">
<title>Editing Modules in an Existing Project</title>
- <para>To edit modules in an existing project, right click the project in Web Project view
- and select <emphasis>
- <property>JBoss Tools Struts > Modules Configuration</property>
- </emphasis>
- (or right click the project in Package Explorer view
- and select <emphasis>
- <property>Configure > Modules Configuration</property>
- </emphasis>).
+ <para>To edit modules in an existing project, right click the project in Web Project view and select <menuchoice><guimenuitem>JBoss Tools Struts</guimenuitem><guimenuitem>Modules Configuration</guimenuitem></menuchoice> (or right click the project in Package Explorer view and select <menuchoice><guimenuitem>Configure</guimenuitem><guimenuitem>Modules Configuration</guimenuitem></menuchoice>).
</para>
<figure>
<title>Choosing Modules Configuration</title>
@@ -62,8 +53,7 @@
</imageobject>
</mediaobject>
</figure>
- <para>You will see the same screen as above where you will be able to select
- a module and edit its details.</para>
+ <para>You will see the same screen as above where you will be able to select a module and edit its details.</para>
<figure>
<title>Modules Configuration</title>
<mediaobject>
@@ -77,11 +67,9 @@
<title>Adding New Modules</title>
- <para>Adding a new module is very simple. First switch to Web Project view.
- Expand your project to the Configuration folder. Under that folder
- you should see the current modules. Right click on Configuration and
- select <emphasis>
- <property>New > Struts Config</property>. </emphasis></para>
+ <para>
+ Adding a new module is very simple. First switch to Web Project view. Expand your project to the Configuration folder. Under that folder you should see the current modules. Right click on Configuration and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Struts Config</guimenuitem></menuchoice>.
+ </para>
<figure>
<title>Adding New Modules</title>
<mediaobject>
@@ -90,8 +78,9 @@
</imageobject>
</mediaobject>
</figure>
- <para>You will see the screen below. You can specify a new module name and
- also add the new Struts configuration file to web.xml file.</para>
+ <para>
+ You will see the screen below. You can specify a new module name and also add the new Struts configuration file to the <filename>web.xml</filename> file.
+ </para>
<figure>
<title>Adding New Modules</title>
<mediaobject>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/page_links_recognizer.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/page_links_recognizer.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/page_links_recognizer.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -13,13 +13,8 @@
<title>Customizable Page Links Recognizer</title>
- <para><property>Custom page links</property> allow you to define custom Struts page
- links that will be recognizable in the Struts application diagram. You can
- define these links by selecting <emphasis>
- <property>Window > Preferences</property>
- </emphasis> from the menu bar and then selecting <emphasis>
- <property>JBoss Tools > Web > Struts > Customization</property>
- </emphasis> from the Preferences dialog box.</para>
+ <para>
+ <property>Custom page links</property> allow you to define custom Struts page links that will be recognizable in the Struts application diagram. You can define these links by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem></menuchoice> from the menu bar and then selecting <menuchoice><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Struts</guimenuitem><guimenuitem>Customization</guimenuitem></menuchoice> from the Preferences dialog box.</para>
<figure>
<title>Customization Panel</title>
<mediaobject>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/project_verification.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/project_verification.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/project_verification.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -1,117 +1,89 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="project_verification">
- <?dbhtml filename="project_verification.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Struts Tools</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Struts Project Verification</title>
-
- <para>In this section we'll consider one more functionality that JBoss Tools provide for Struts
- projects, namely adjusting projects verification.</para>
-
- <para>To configure Struts project verification select <emphasis>
- <property>Window > Preferences</property>
- </emphasis> from the menu bar, select <emphasis>
- <property>JBoss Tools > Web > Verification</property>
- </emphasis> from the Preferences dialog box and then expand the
- Struts Rules node.</para>
- <figure>
- <title>Struts Rules</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/verif_valid/verif_valid_8.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- <para>Suppose you are working in the Source viewer for a Struts
- configuration file as shown below:</para>
- <figure>
- <title>Struts Configuration File</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/verif_valid/verif_valid_9.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- <para>While typing a class name or entering it from the graphical editor,
- you might make a minor typo (like <emphasis role="italic">
- <property>"sample.GreetingAction1"</property>
- </emphasis> instead of <emphasis role="italic">
- <property>"sample.GreetingAction"</property>
- </emphasis>). After saving the file,
- <property>verification</property> checks to make sure everything is
- correct and finds the error below:</para>
- <figure>
- <title>Error Reporting</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/verif_valid/verif_valid_10.png"
- scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Notice that the Package Explorer View shows a marked folder and a
- marked file where the error is.</para>
- <para>You can place the cursor over the line with the error to view a
- detailed error message:</para>
- <figure>
- <title>Error Message</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/verif_valid/verif_valid_11.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- <para>The verification also checks to make sure you have specified the
- correct JSP page for the forward:</para>
- <figure>
- <title>JSP Page Verification</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/verif_valid/verif_valid_12.png"
- scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Once you place the cursor over the line, you can see the error
- message:</para>
- <figure>
- <title>Error Message</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/verif_valid/verif_valid_13.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- <para>You can always invoke the verification by switching to the Diagram
- viewer, right-clicking and selecting <emphasis>
- <property>Verify</property>
- </emphasis> from the context menu:</para>
- <figure>
- <title>Verify Command</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/verif_valid/verif_valid_14.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
+ <?dbhtml filename="project_verification.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Struts Project Verification</title>
+
+ <para>
+ This section covers the Struts project verification functionality provided by JBoss Tools.
+ </para>
+ <para>
+ To configure Struts project verification select <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem></menuchoice> from the menu bar, select <menuchoice><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Verification</guimenuitem></menuchoice> from the Preferences dialog box, and then expand the Struts Rules node.
+ </para>
+ <figure>
+ <title>Struts Rules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_8.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Suppose you are working in the Source viewer for a Struts configuration file as shown below:</para>
+ <figure>
+ <title>Struts Configuration File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_9.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ While typing a class name or entering it from the graphical editor, you might make a minor typo (like <emphasis role="italic"><property>"sample.GreetingAction1"</property></emphasis> instead of <emphasis role="italic"><property>"sample.GreetingAction"</property></emphasis>). After saving the file, it is verified to make sure everything is correct and finds the error shown below:
+ </para>
+ <figure>
+ <title>Error Reporting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_10.png" scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Notice that the Package Explorer View shows a marked folder and a marked file to indicate where the error is.</para>
+ <para>You can place the cursor over the line with the error to view a detailed error message:</para>
+ <figure>
+ <title>Error Message</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_11.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The verification process also checks to make sure you have specified the correct JSP page for the forward:</para>
+ <figure>
+ <title>JSP Page Verification</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_12.png" scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Once you place the cursor over the line, you can see the error message:</para>
+ <figure>
+ <title>Error Message</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_13.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ You can always invoke the verification process by switching to the Diagram viewer, right-clicking and selecting <guimenuitem>Verify</guimenuitem> from the context menu:
+ </para>
+ <figure>
+ <title>Verify Command</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_14.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
</chapter>
\ No newline at end of file
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/projects.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/projects.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/projects.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -1,275 +1,238 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="projects">
- <?dbhtml filename="projects.html"?>
+ <?dbhtml filename="projects.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
- <title>Projects</title>
+ <title>Projects</title>
- <para>JBoss Tools provide the following functionality when working with Struts:</para>
+ <para>JBoss Tools provides the following functionality when working with Struts:</para>
- <itemizedlist>
- <listitem>
- <para>Create new <property>Struts projects</property></para>
- </listitem>
- <listitem>
- <para>Import (open) existing Struts projects. You can import any project
- structure</para>
- </listitem>
- <listitem>
- <para>Add <property>Struts capabilities</property> to any existing Eclipse
- project</para>
- </listitem>
- <listitem>
- <para>Import and add Struts capabilities to any existing project created outside
- Eclipse.</para>
- </listitem>
- </itemizedlist>
- <para>Now, we'll focus on all these points more fully.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Create new <property>Struts projects</property></para>
+ </listitem>
+ <listitem>
+ <para>Import (open) existing Struts projects. You can import any project structure</para>
+ </listitem>
+ <listitem>
+ <para>Add <property>Struts capabilities</property> to any existing Eclipse project</para>
+ </listitem>
+ <listitem>
+ <para>Import and add Struts capabilities to any existing project created outside Eclipse.</para>
+ </listitem>
+ </itemizedlist>
+ <para>Now, we'll focus on all these points more fully.</para>
- <section id="CreatingANewStrutsProjec745t">
+ <section id="CreatingANewStrutsProjec745t">
- <title>Creating a New Struts Project</title>
+ <title>Creating a New Struts Project</title>
- <para>JBoss Tools provides a New Struts Project Wizard that radically simplifies the process
- for getting started with a new Struts project. You just need to follow these steps:</para>
- <itemizedlist>
- <listitem>
- <para>Select<emphasis>
- <property>File > New > Project...</property>
- </emphasis> from the menu bar. Then, select <emphasis>
- <property>JBoss Tools Web > Struts > Struts Project</property>
- </emphasis> in this dialog box. Click <emphasis>
- <property>Next</property>: </emphasis></para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Selecting Struts Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>On this form, provide the <property>Project Name</property>. You can also
- select where to create the project or use the default path.</para>
- <para>Next to <property>Struts Environment</property> set which Struts version to
- use.</para>
- </listitem>
- </itemizedlist>
+ <para>
+ JBoss Tools provides a <guilabel>New Struts Project</guilabel> Wizard that significantly simplifies the process of creating a new Struts project. You just need to follow these steps:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Project...</guimenuitem></menuchoice> from the menu bar. Then, select <menuchoice><guimenuitem>JBoss Tools Web</guimenuitem><guimenuitem>Struts</guimenuitem><guimenuitem>Struts Project</guimenuitem></menuchoice> from the dialog box. Click the <guibutton>Next</guibutton> button:
+ </para>
+ </listitem>
+ </itemizedlist>
+ <figure>
+ <title>Selecting Struts Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>On this form, provide the <property>Project Name</property>. You can also select where to create the project, or use the default path.</para>
+ <para>The <property>Struts Environment</property> sets the Struts version that will be used.</para>
+ </listitem>
+ </itemizedlist>
- <figure>
- <title>Creating Struts Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Creating Struts Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <note>
- <title>Tip:</title>
- <para>Don't put spaces in project names since some OS could experience problems
- with their processing and searching these files.</para>
- </note>
+ <note>
+ <title>Tip:</title>
+ <para>Don't put spaces in project names since some operating systems may experience problems processing and searching for these files.</para>
+ </note>
- <para>You can select the KickStart template, then the project created will include a simple
- Hello World type application that is ready to run.</para>
+ <para>You can select the KickStart template, which results in a project that includes a simple Hello World type application that is ready to run.</para>
- <figure>
- <title>Choosing Struts Template </title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_3_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Choosing Struts Template </title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_3_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <itemizedlist>
- <listitem>
- <para>Next, you register this application with the current servlet container defined
- for your workspace (JBoss AS, by default) in order to allow you to test your
- application more easily while still developing it. A new entry will be added in
- the servlet container configuration file to enable running the application
- in-place (called null deployment or link deployment). Uncheck the <emphasis
- role="italic">
- <property>"Target Server"</property>
- </emphasis> check box if for some reason you don't want to register
- your application at this point.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Registering The Project at Server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>On the next form, you can select the TLD files to include in this
- project:</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Selecting Tag Libraries</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Next, you register this application with the current servlet container defined for your workspace (JBoss AS, by default) in order to allow you to easily test your application while still developing it. A new entry will be added in the servlet container configuration file to enable the application to be run in-place (called null deployment or link deployment). Uncheck the <emphasis role="italic"> <property>"Target Server"</property></emphasis> check box if you prefer not to register your application at this point.</para>
+ </listitem>
+ </itemizedlist>
+ <figure>
+ <title>Registering The Project at Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>On the next form, you can select the TLD files to include in this project:</para>
+ </listitem>
+ </itemizedlist>
+ <figure>
+ <title>Selecting Tag Libraries</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>After the project is created, you should have the following project structure (if you
- used the KickStart template):</para>
+ <para>After the project is created, you should have the following project structure (if you used the KickStart template):</para>
- <figure>
- <title>Project Structure</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Project Structure</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <note>
- <title>Tip:</title>
- <para>If you want to hide the jar files from Web App Libraries in view, select the
- down-pointing arrow in the upper right corner, select
- <emphasis>Filters...</emphasis>, check the box next to Name filter patterns
- (matching names will be hidden), and type *.jar into the field. Then, click OK.
- </para>
- </note>
- </section>
- <section id="ImportingAnExistingStrutsProjectWithAnyStructure9653">
+ <note>
+ <title>Tip:</title>
+ <para>
+ If you want to hide the JAR files from Web App Libraries in view, select the down-pointing arrow in the upper right corner, select <guimenuitem>Filters...</guimenuitem>, check the box next to Name filter patterns (matching names will be hidden), and type *.jar into the field. Then, click the <guibutton>OK</guibutton> button.
+ </para>
+ </note>
+ </section>
+ <section id="ImportingAnExistingStrutsProjectWithAnyStructure9653">
- <title>Importing an Existing Struts Project with Any Structure</title>
+ <title>Importing an Existing Struts Project with Any Structure</title>
- <para>For detailed information on migration projects to JBoss Developer Studio see the Migration Guide.</para>
+ <para>For detailed information on migration projects to JBoss Developer Studio see the Migration Guide.</para>
- </section>
- <section id="AddingStrutsCapabilityToAnExistingWebApplication532">
+ </section>
+ <section id="AddingStrutsCapabilityToAnExistingWebApplication532">
- <title>Adding Struts Capability to an Existing Web Application</title>
+ <title>Adding Struts Capability to an Existing Web Application</title>
- <para>Here, we'll consider how to add Struts functionality (Struts libraries, tag
- libraries and a Struts configuration file) to any existing Web application project in
- your Eclipse workspace.</para>
+ <para>
+ This section will describe how to add Struts functionality (Struts libraries, tag libraries and a Struts configuration file) to any existing Web application project in your Eclipse workspace.
+ </para>
- <para>By adding a Struts Nature to your project, you can now edit files using JBoss Tools
- editors, such as the <link linkend="struts_config_editor">Struts configuration
- editor</link> and the JBoss Tools JSP editor. To take advantage of this just right-click
- the project and select <emphasis>
- <property>JBoss Tools > Add Struts Capabilities</property>
- </emphasis> from the context menu. This will start the process of adding all necessary
- libraries and files to make a Web Struts project from your one.</para>
+ <para>By adding a Struts Nature to your project, you can now edit files using JBoss Tools editors, such as the <link linkend="struts_config_editor">Struts configuration editor</link> and the JBoss Tools JSP editor. To take advantage of this just right-click the project and select <menuchoice><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Add Struts Capabilities</guimenuitem></menuchoice> from the context menu. This will start the process of adding all the necessary Struts libraries and files to your existing project.</para>
- <figure>
- <title>Adding Struts Capabilities</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Adding Struts Capabilities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>In the wizard you should point to location of your deployment descriptor file web.xml
- and name of the project.</para>
+ <para>In the wizard you should point to the location of your deployment descriptor file <filename>web.xml</filename> and name of the project.</para>
- <figure>
- <title>Choosing Project Location</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_8.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>After hitting <emphasis>
- <property>Next</property>, </emphasis> you will see the following screen. This
- screen simply means that you need to add at least one Struts module to your project to
- make this project a Struts project. Adding a Struts module means that a new
- struts-config.xml will be added to your project and registered in the web.xml file. In
- addition, all required Struts libraries will be added. To add a Struts module, select
- the <emphasis>
- <property>Add Struts Support</property>
- </emphasis> button.</para>
- <figure>
- <title>Project Modules</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_9.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Choosing Project Location</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ After clicking the <guibutton>Next</guibutton> button you will see the following screen. This screen simply indicates that you need to add at least one Struts module to your project to make this project a Struts project. Adding a Struts module means that a new <filename>struts-config.xml</filename> will be added to your project and registered in the <filename>web.xml</filename> file. In addition, all required Struts libraries will be added. To add a Struts module, click the <guibutton>Add Struts Support</guibutton> button.
+ </para>
+ <figure>
+ <title>Project Modules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_9.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>Here you can select what Struts <property>Version</property>, <property>Servlet
- Class</property>, <property>URL Pattern</property> and <property>TLD</property>s to add
- to this project.</para>
+ <para>
+ Here you can select which Struts <property>Version</property>, <property>Servlet Class</property>, <property>URL Pattern</property> and <property>TLD</property>s to add to this project.
+ </para>
- <figure>
- <title>Selecting Struts Support Options</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_10.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Selecting Struts Support Options</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_10.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>When done, you will see the default Struts module configuration information. See how
- to Edit <link linkend="modules">Struts modules</link>.</para>
+ <para>When done, you will see the default Struts module configuration information. See how to Edit <link linkend="modules">Struts modules</link>.</para>
- <figure>
- <title>Project Configuration Information</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_11.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Project Configuration Information</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_11.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>On the last screen you can set the different folders for your project as well as
- register this application with a servlet container. If you want the libraries (.jar
- files) will be automatically added to your project, click on the checkbox <emphasis>
- <property>Add Libraries</property>.</emphasis></para>
+ <para>
+ On the last screen you can set the different folders for your project as well as register this application with a servlet container. If you want the libraries (.jar files) to be automatically added to your project, tick the <guilabel>Add Libraries</guilabel> checkbox.
+ </para>
- <figure>
- <title>Registering the Project at Server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_12.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Registering the Project at Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_12.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>When done, you can open and edit the struts-config.xml file using useful Struts
- configuration file editor provided by JBDS. (The Struts configuration is shown below in
- the Tree viewer).</para>
+ <para>When done, you can open and edit the <filename>struts-config.xml</filename> file using useful Struts configuration file editor provided by JBDS. (The Struts configuration is shown below in the Tree viewer).</para>
- <figure>
- <title>Struts-config.xml File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/struts/struts_13.png" scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
+ <figure>
+ <title>Struts-config.xml File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_13.png" scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
- <section>
- <title>Relevant Resources Links</title>
-
- <para>You can find more in-depth explanation on how to work with special wizards, editors and views that can
- be used in various scenarios while developing Struts applications in our Visual Web Tools Guide.</para>
- </section>
+ <section>
+ <title>Relevant Resources Links</title>
+
+ <para>
+ You can find more in-depth explanation on how to work with special wizards, editors and views that can be used in various scenarios while developing Struts applications in our Visual Web Tools Guide.
+ </para>
+ </section>
</chapter>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/rel_resources_links.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/rel_resources_links.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/rel_resources_links.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -1,33 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="rel_resources_links">
- <?dbhtml filename="rel_resources_links.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Struts Tools</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
+ <?dbhtml filename="rel_resources_links.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
- <title>Relevant Resources Links</title>
+ <title>Relevant Resources Links</title>
- <para>Find out necessary information on <ulink url="http://struts.apache.org/">Struts
- technology</ulink> if you don't know enough.</para>
+ <para>More information on Struts can be found on the <ulink url="http://struts.apache.org/">Struts website</ulink>.</para>
- <para>In summary, this reference should help you to get familiar with those parts of
- <property>JBoss Tools</property> which are meant for development with Struts
- technology. If you've carefully gone through the document, you should know
- now how to create/import Struts project or enable Struts capabilities for an
- existing web project as well as organize and edit all necessary staff for your
- Struts application using a set of views and editors provided by <property>JBoss
- Tools</property>.</para>
+ <para>
+ This reference has been designed to help you become familiar with those parts of <property>JBoss Tools</property> which assist in developing using Struts technology. It covers how to create and import Struts projects, enable Struts capabilities for an existing web project, as well as organize and edit all necessary the necessary files in your Struts application using the views and editors provided by <property>JBoss Tools</property>.
+ </para>
- <para>If you'd like to contribute your feedback is always appreciated. You can
- leave your questions and suggestions on our <ulink
- url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201"
- >Forum</ulink>.</para>
- <para>We hope, this guide helped you to get started with the JBoss Struts Tools. Besides, for additional information you are welcome on <ulink
- url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para>
+ <para>
+ Feedback is always appreciated. You can leave your questions and suggestions on our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">Forum</ulink>.
+ </para>
</chapter>
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/struts_project_verification.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/struts_project_verification.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/en-US/struts_project_verification.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -1,115 +1,86 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="struts_project_verification">
- <?dbhtml filename="struts_project_verification.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Struts Tools</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Struts Project Verification</title>
-
- <para>JBoss Developer Studio provides the same functionality for Struts
- projects. To configure Struts project verification select <emphasis>
- <property>Window > Preferences</property>
- </emphasis> from the menu bar, select <emphasis>
- <property>JBoss Tools > Web > Verification</property>
- </emphasis> from the Preferences dialog box and then expand the
- Struts Rules node.</para>
- <figure>
- <title>Struts Rules</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/verif_valid/verif_valid_8.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- <para>Suppose you are working in the Source viewer for a Struts
- configuration file as shown below:</para>
- <figure>
- <title>Struts Configuration File</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/verif_valid/verif_valid_9.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- <para>While typing a class name or entering it from the graphical editor,
- you might make a minor typo (like <emphasis role="italic">
- <property>"sample.GreetingAction1"</property>
- </emphasis> instead of <emphasis role="italic">
- <property>"sample.GreetingAction"</property>
- </emphasis>). After saving the file,
- <property>verification</property> checks to make sure everything is
- correct and finds the error below:</para>
- <figure>
- <title>Error Reporting</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/verif_valid/verif_valid_10.png"
- scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Notice that the Package Explorer View shows a marked folder and a
- marked file where the error is.</para>
- <para>You can place the cursor over the line with the error to view a
- detailed error message:</para>
- <figure>
- <title>Error Message</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/verif_valid/verif_valid_11.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- <para>The verification also checks to make sure you have specified the
- correct JSP page for the forward:</para>
- <figure>
- <title>JSP Page Verification</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/verif_valid/verif_valid_12.png"
- scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Once you place the cursor over the line, you can see the error
- message:</para>
- <figure>
- <title>Error Message</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/verif_valid/verif_valid_13.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- <para>You can always invoke the verification by switching to the Diagram
- viewer, right-clicking and selecting <emphasis>
- <property>Verify</property>
- </emphasis> from the context menu:</para>
- <figure>
- <title>Verify Command</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/verif_valid/verif_valid_14.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
+ <?dbhtml filename="struts_project_verification.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Struts Project Verification</title>
+
+ <para>
+ JBoss Developer Studio provides the same functionality for Struts projects. To configure Struts project verification select <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem></menuchoice> from the menu bar, select <menuchoice><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Verification</guimenuitem></menuchoice> from the Preferences dialog box and then expand the Struts Rules node.
+ </para>
+ <figure>
+ <title>Struts Rules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_8.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Suppose you are working in the Source viewer for a Struts configuration file as shown below:</para>
+ <figure>
+ <title>Struts Configuration File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_9.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ While typing a class name or entering it from the graphical editor, you might make a minor typo (like <emphasis role="italic"><property>"sample.GreetingAction1"</property></emphasis> instead of <emphasis role="italic"><property>"sample.GreetingAction"</property></emphasis>). After saving the file, <property>verification</property> checks to make sure everything is correct and finds the error below:
+ </para>
+ <figure>
+ <title>Error Reporting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_10.png" scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Notice that the Package Explorer View shows a marked folder and a marked file where the error is.</para>
+ <para>You can place the cursor over the line with the error to view a detailed error message:</para>
+ <figure>
+ <title>Error Message</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_11.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The verification also checks to make sure you have specified the correct JSP page for the forward:</para>
+ <figure>
+ <title>JSP Page Verification</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_12.png" scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Once you place the cursor over the line, you can see the error message:</para>
+ <figure>
+ <title>Error Message</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_13.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ You can always invoke the verification by switching to the Diagram viewer, right-clicking and selecting <guimenuitem>Verify</guimenuitem> from the context menu:
+ </para>
+ <figure>
+ <title>Verify Command</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_14.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
</chapter>
\ No newline at end of file
Modified: branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/pom.xml
===================================================================
--- branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/pom.xml 2011-07-18 02:45:08 UTC (rev 32985)
+++ branches/jbosstools-3.2.x/struts/docs/struts_tools_ref_guide/pom.xml 2011-07-18 02:48:03 UTC (rev 32986)
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.jboss.tools</groupId>
@@ -10,229 +8,232 @@
<packaging>jdocbook</packaging>
<name>${bookname}-(${translation})</name>
- <properties>
- <translation>en-US</translation>
- <docname>Struts_Tools_Reference_Guide</docname>
- <bookname>Struts Tools Reference Guide</bookname>
- </properties>
-
- <profiles>
+ <properties>
+ <translation>en-US</translation>
+ <docname>Struts_Tools_Reference_Guide</docname>
+ <bookname>Struts Tools Reference Guide</bookname>
+ </properties>
+ <profiles>
+
<!-- mvn compile -->
- <profile>
- <id>all</id>
- <activation>
- <activeByDefault>true</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${docname}.pdf</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>all</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.4</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${docname}.pdf</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <useRelativeImageUris>true</useRelativeImageUris>
+ </options>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Phtml -->
- <profile>
- <id>html</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>html</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Phtml-single -->
- <profile>
- <id>html-single</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- </plugin>
+ <profile>
+ <id>html-single</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Ppdf -->
- <profile>
- <id>pdf</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${docname}.pdf</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>pdf</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${docname}.pdf</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Peclipse -->
- <profile>
- <id>eclipse</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
- </plugins>
- </build>
- </profile>
+ <profile>
+ <id>eclipse</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
- </profiles>
- <build>
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <dependencies>
- <dependency>
- <groupId>org.jboss.pressgang</groupId>
- <artifactId>pressgang-xslt</artifactId>
- <version>1.2.0</version>
- </dependency>
- <dependency>
- <groupId>org.jboss</groupId>
- <artifactId>jbossorg-jdocbook-style</artifactId>
- <version>1.1.1</version>
- <type>jdocbook-style</type>
- </dependency>
- </dependencies>
- <configuration>
- <sourceDirectory>${project.basedir}</sourceDirectory>
+ </profiles>
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <dependencies>
+ <dependency>
+ <groupId>org.jboss.pressgang</groupId>
+ <artifactId>pressgang-xslt</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss</groupId>
+ <artifactId>jbossorg-jdocbook-style</artifactId>
+ <version>1.1.1</version>
+ <type>jdocbook-style</type>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <sourceDirectory>${project.basedir}</sourceDirectory>
<!-- <sourceDocumentName>${docname}.xml</sourceDocumentName> -->
- <sourceDocumentName>master.xml</sourceDocumentName>
- <masterTranslation>en-US</masterTranslation>
- <imageResource>
- <directory>${project.basedir}/en-US</directory>
- <includes>
- <include>images/**/*</include>
- </includes>
- </imageResource>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${pdf.name}</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- <options>
- <xincludeSupported>true</xincludeSupported>
- <xmlTransformerType>saxon</xmlTransformerType>
- <docbookVersion>1.72.0</docbookVersion>
- <localeSeparator>-</localeSeparator>
- <transformerParameters>
- <property>
- <name>javax.xml.parsers.DocumentBuilderFactory</name>
- <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
- </property>
- <property>
- <name>javax.xml.parsers.SAXParserFactory</name>
- <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
- </property>
- </transformerParameters>
- </options>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
+ <sourceDocumentName>master.xml</sourceDocumentName>
+ <masterTranslation>en-US</masterTranslation>
+ <imageResource>
+ <directory>${project.basedir}/en-US</directory>
+ <includes>
+ <include>images/**/*</include>
+ </includes>
+ </imageResource>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${pdf.name}</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <xincludeSupported>true</xincludeSupported>
+ <xmlTransformerType>saxon</xmlTransformerType>
+ <docbookVersion>1.72.0</docbookVersion>
+ <localeSeparator>-</localeSeparator>
+ <transformerParameters>
+ <property>
+ <name>javax.xml.parsers.DocumentBuilderFactory</name>
+ <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
+ </property>
+ <property>
+ <name>javax.xml.parsers.SAXParserFactory</name>
+ <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
+ </property>
+ </transformerParameters>
+ </options>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
</project>
14 years, 9 months
- 1
- 0
JBoss Tools SVN: r32985 - in branches/jbosstools-3.2.x/smooks/docs/reference: en-US and 1 other directories.
by jbosstools-commits＠lists.jboss.org
Author: irooskov(a)redhat.com
Date: 2011-07-17 22:45:08 -0400 (Sun, 17 Jul 2011)
New Revision: 32985
Added:
branches/jbosstools-3.2.x/smooks/docs/reference/en-US/images/process_page/direct_source_to_target_mapping_1.png
Modified:
branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Book_Info.xml
branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Feedback.xml
branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Preface.xml
branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent
branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml
branches/jbosstools-3.2.x/smooks/docs/reference/en-US/introduction.xml
branches/jbosstools-3.2.x/smooks/docs/reference/en-US/master.xml
branches/jbosstools-3.2.x/smooks/docs/reference/en-US/references.xml
branches/jbosstools-3.2.x/smooks/docs/reference/en-US/summary.xml
branches/jbosstools-3.2.x/smooks/docs/reference/en-US/tasks.xml
branches/jbosstools-3.2.x/smooks/docs/reference/pom.xml
Log:
updated for GA
Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Book_Info.xml
===================================================================
--- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Book_Info.xml 2011-07-18 02:42:15 UTC (rev 32984)
+++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Book_Info.xml 2011-07-18 02:45:08 UTC (rev 32985)
@@ -5,9 +5,9 @@
<title>Smooks Developer Tools Reference Guide</title>
<subtitle>Provides information relating to the Smooks Tools module.</subtitle>
<productname>JBoss Developer Studio</productname>
- <productnumber>4.0</productnumber>
- <edition>4.0.0</edition>
- <pubsnumber>4</pubsnumber>
+ <productnumber>4.1</productnumber>
+ <edition>4.1.0</edition>
+ <pubsnumber>1</pubsnumber>
<abstract>
<para>The Smooks Developer Tools Reference Guide explains how to use Smooks Tools to graphically edit Smooks configuration files.</para>
</abstract>
Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Feedback.xml
===================================================================
--- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Feedback.xml 2011-07-18 02:42:15 UTC (rev 32984)
+++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Feedback.xml 2011-07-18 02:45:08 UTC (rev 32985)
@@ -1,20 +1,92 @@
<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Document_Conventions.ent">
+%BOOK_ENTITIES;
+]>
+<appendix id="sect_JBoss-Getting_Help_and_Giving_Feedback" lang="en-US">
+ <title>Getting Help and Giving Feedback</title>
+ <section id="sect_JBoss-Do_You_Need_Help">
+ <title>Do You Need Help?</title>
+ <indexterm>
+ <primary>help</primary>
+ <secondary>getting help</secondary>
-<section id="sect-Beginners_Guide-We_Need_Feedback" lang="en-US">
- <title>We Need Feedback!</title>
- <indexterm>
- <primary>feedback</primary>
- <secondary>contact information for this manual</secondary>
- </indexterm>
- <para>
- If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA against JBoss Developer Studio: <ulink url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...">https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...</ulink>
- </para>
- <para>
- When submitting a bug report, be sure to mention the manual's name and to select the "documentation" component.
- </para>
- <para>
- If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.
- </para>
-</section>
+ </indexterm>
+ <para>
+ If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at <ulink url="http://access.redhat.com" />. Through the customer portal, you can:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ search or browse through a knowledgebase of technical support articles about Red Hat products.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ submit a support case to Red Hat Global Support Services (GSS).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ access other product documentation.
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+ <para>
+ Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. You can find a list of publicly available mailing lists at <ulink url="https://www.redhat.com/mailman/listinfo" />. Click on the name of any mailing list to subscribe to that list or to access the list archives.
+ </para>
+
+ </section>
+
+ <section id="jboss-feedback">
+ <title>Give us Feedback</title>
+ <!-- NOTE: You will need the following entities defined in your .ent file.
+ You will need to replace _YOUR_PRODUCT_HERE_, _YOUR_COMPONENT_
+ and _YOUR_SUMMARY_ - entities are not replaced in URLs.
+ <!ENTITY PRODUCT "JBoss Product Name">
+ <!ENTITY BZCOMPONENT "doc-triage">
+ <!ENTITY BZURL "<ulink url='https://bugzilla.example.com/enter_bug.cgi?product=_YOUR_PRODUCT_HERE_&am...'>http://bugzilla.redhat.com/</ulink>">
+
+ These entities should not affect translated documents, since Bugzilla is not localised.
+ --> <indexterm>
+ <primary>feedback</primary>
+ <secondary>contact information for this manual</secondary>
+
+ </indexterm>
+ <para>
+ If you find a typographical error, or know how this guide can be improved, we would love to hear from you. Submit a report in Bugzilla against the product <literal>&BZPRODUCT;</literal> and the component <literal>&BZCOMPONENT;</literal>. The following link will take you to a pre-filled bug report for this product: &BZURL;.
+ </para>
+ <para>
+ Fill out the following template in Bugzilla's <literal>Description</literal> field. Be as specific as possible when describing the issue; this will help ensure that we can fix it quickly.
+ </para>
+
+<screen>Document URL:
+
+
+Section Number and Name:
+
+
+Describe the issue:
+
+
+Suggestions for improvement:
+
+
+Additional information:
+
+
+</screen>
+ <para>
+ Be sure to give us your name so that you can receive full credit for reporting the issue.
+ </para>
+
+ </section>
+
+
+</appendix>
+
+
Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Preface.xml
===================================================================
--- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Preface.xml 2011-07-18 02:42:15 UTC (rev 32984)
+++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Preface.xml 2011-07-18 02:45:08 UTC (rev 32985)
@@ -8,9 +8,5 @@
<para>
This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. To get more information on these conventions please refer to the <guilabel>Document Conventions</guilabel> manual, which can be found on the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index.html">Red Hat Documentation</ulink> website under the <guilabel>JBoss Developer Studio</guilabel> section.
</para>
- <!--<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- </xi:fallback>
- </xi:include>-->
</preface>
Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent
===================================================================
--- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent 2011-07-18 02:42:15 UTC (rev 32984)
+++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent 2011-07-18 02:45:08 UTC (rev 32985)
@@ -1,4 +1,7 @@
<!ENTITY PRODUCT "JBoss">
<!ENTITY BOOKID "Smooks_Developer_Tools_Reference_Guide">
-<!ENTITY YEAR "2010">
+<!ENTITY YEAR "2011">
<!ENTITY HOLDER "Red Hat">
+<!ENTITY BZPRODUCT "JBoss Developer Studio">
+<!ENTITY BZCOMPONENT "Smooks Developer Tools Reference Guide">
+<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss%20Develope...'>http://bugzilla.redhat.com/</ulink>">
Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml
===================================================================
--- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml 2011-07-18 02:42:15 UTC (rev 32984)
+++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml 2011-07-18 02:45:08 UTC (rev 32985)
@@ -8,5 +8,6 @@
<xi:include href="tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="references.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="summary.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
+<xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
</book>
Added: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/images/process_page/direct_source_to_target_mapping_1.png
===================================================================
(Binary files differ)
Property changes on: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/images/process_page/direct_source_to_target_mapping_1.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/introduction.xml
===================================================================
--- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/introduction.xml 2011-07-18 02:42:15 UTC (rev 32984)
+++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/introduction.xml 2011-07-18 02:45:08 UTC (rev 32985)
@@ -13,7 +13,7 @@
<para>First, have a look at the key features of Smooks tools:</para>
<section>
<title>Key Features of Smooks Tools</title>
- <para>Here, we provide you with a key functionality which is integrated in Smooks tools.</para>
+ <para>The table below provides you with a list of the key features integrated in Smooks tools.</para>
<table>
<title>Key Functionality for Smooks Tools</title>
@@ -34,64 +34,78 @@
<tbody>
<row>
- <entry><para>Smooks Configuration File Wizard</para></entry>
- <entry><para>Smooks tools allows to create/edit the Smooks configuration file for Java2Java data transformation.</para></entry>
<entry>
+ <para>Smooks Configuration File Wizard</para>
+ </entry>
+ <entry>
+ <para>Smooks tools allows you to create and edit the Smooks configuration file for Java2Java data transformation.</para>
+ </entry>
+ <entry>
<xref linkend="config_file_wizzard"/>
</entry>
</row>
<row>
- <entry><para>Smooks Editor</para></entry>
- <entry><para>Smooks Editor helps configure the created Smooks configuration file.</para></entry>
<entry>
+ <para>Smooks Editor</para>
+ </entry>
+ <entry>
+ <para>Smooks Editor helps configure the created Smooks configuration file.</para>
+ </entry>
+ <entry>
<xref linkend="process_tab"/>
</entry>
</row>
-
+
</tbody>
-
+
</tgroup>
</table>
-
+
</section>
<section>
<title>What is Smooks?</title>
-
- <para><property>Smooks</property> is a Java Framework/Engine for processing XML and non XML
- data (CSV, EDI, Java, JSON etc).It provides: </para>
+
+ <para>
+ <property>Smooks</property> is a Java Framework/Engine for processing XML and non XML
+ data (CSV, EDI, Java, JSON etc). It provides: </para>
<para/>
<para>
<orderedlist numeration="upperroman" inheritnum="inherit">
<listitem>
- <para><emphasis role="bold">Transformation</emphasis>: Perform a wide range of
+ <para>
+ <emphasis role="bold">Transformation</emphasis>: Perform a wide range of
Data Transforms. Supports many different Source and Result types
-XML/CSV/EDI/Java/JSON to XML/CSV/EDI/Java/JSON.</para>
</listitem>
<listitem>
- <para><emphasis role="bold">Java Binding</emphasis>: Bind into a Java Object
+ <para>
+ <emphasis role="bold">Java Binding</emphasis>: Bind into a Java Object
Model from any data source (CSV, EDI, XML, Java, JSON etc). </para>
</listitem>
-
+
<listitem>
- <para><emphasis role="bold">Huge Message Processing</emphasis>: Process huge
+ <para>
+ <emphasis role="bold">Huge Message Processing</emphasis>: Process huge
messages (GBs) - Split, Transform and Route message fragments to JMS, File,
Database etc destinations. Route multiple message formats to multiple
destinations in a single pass over a message. </para>
</listitem>
-
+
<listitem>
- <para><emphasis role="bold">Message Enrichment</emphasis>: Enrich a message with
+ <para>
+ <emphasis role="bold">Message Enrichment</emphasis>: Enrich a message with
data from a Database, or other Datasources. </para>
</listitem>
-
+
<listitem>
- <para><emphasis role="bold">Combine</emphasis>: Combine the above features in
+ <para>
+ <emphasis role="bold">Combine</emphasis>: Combine the above features in
different ways e.g. add Message Enrichment as part of a Splitting and
Routing process. </para>
</listitem>
@@ -105,14 +119,12 @@
</imageobject>
</mediaobject>
</figure>
- <para> For more informations about <property>Smooks</property>, please visit <ulink
- url="http://www.smooks.org">Smooks official site</ulink>.</para>
+ <para> For more informations about <property>Smooks</property>, please visit the <ulink url="http://www.smooks.org">Smooks official site</ulink>.</para>
</section>
<section>
<title>What is Smooks Tools?</title>
-
- <para>Smooks tools is a set of graphical tools for editing Smooks configuration file
- based on Eclipse.</para>
+
+ <para>Smooks tools is a set of graphical tools, based on Eclipse, for editing Smooks configuration files.</para>
<figure>
<title>Smooks Form editor</title>
<mediaobject>
@@ -130,30 +142,30 @@
<section>
<title>Adding Smooks jars</title>
- <para>During your development, you probably will be faced with the
- necessity to include some additional Smooks jars to your project.
- This problem can be solved in such a way:</para>
+ <para>During your development, you probably will be required to include additional Smooks jars to your project. This can be achieved with the following steps:</para>
<itemizedlist>
- <listitem><para>Create the folder named "lib" inside your project,if it doesn't exist yet.
- Copy all the Smooks jars you need to include into the <emphasis><property>lib</property></emphasis> directory.
- </para></listitem>
- <listitem><para>Right-click on the project and select Properties.</para></listitem>
- <listitem><para>Select the "Java Build Path" item in the Properties list, then the Libraries tab, and click "Add JARs".
- </para></listitem>
- <listitem><para>In the Jar Selection dialog, select all the jars in the "lib" directory you want to include and click OK.</para></listitem>
- <listitem><para>
- Now you should see all the jars
- included to your project hierarchy. </para></listitem>
+ <listitem>
+ <para>If it doesn't yet exist, create the folder named "lib" inside your project.
+ Copy all the Smooks jars you need to include into the <emphasis><property>lib</property>
+ </emphasis> directory.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Right-click (or Control-click on Mac OS) on the project and select <guilabel>Properties.</guilabel></para>
+ </listitem>
+ <listitem>
+ <para>Select the <guilabel>Java Build Path</guilabel> item in the Properties list, then the <guilabel>Libraries tab</guilabel>, and click the <guibutton>Add JARs</guibutton> button.
+ </para>
+ </listitem>
+ <listitem>
+ <para>In the Jar Selection dialog, select all the jars in the "lib" directory you want to include and click the <guibutton>OK</guibutton> button.</para>
+ </listitem>
+ <listitem>
+ <para>
+ Now you should see all the jars included to your project hierarchy. </para>
+ </listitem>
</itemizedlist>
- <figure>
- <title>Smooks Form editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/introduction/introduction2.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
<!-- <para>The easiest way to use the Smooks Configuration Editor is to create a project
(Java project, an ESB project, etc.), right-click on it and select <property>New -> Other</property>
to open the New wizard. Drill into <property>Smooks -> Smooks Configuration File</property>
Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/master.xml
===================================================================
--- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/master.xml 2011-07-18 02:42:15 UTC (rev 32984)
+++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/master.xml 2011-07-18 02:45:08 UTC (rev 32985)
@@ -35,13 +35,13 @@
Version: 1.1.1.GA
</releaseinfo>
- <abstract>
+<!-- <abstract>
<title/>
<para>
<ulink
url="http://download.jboss.org/jbosstools/nightly-docs/en/smooks/pdf/Smooks_Re...">PDF version</ulink>
</para>
- </abstract>
+ </abstract> -->
</bookinfo>
Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/references.xml
===================================================================
--- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/references.xml 2011-07-18 02:42:15 UTC (rev 32984)
+++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/references.xml 2011-07-18 02:45:08 UTC (rev 32985)
@@ -1,879 +1,1740 @@
<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="reference">
- <?dbhtml filename="reference.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Smooks</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
- <title>Reference</title>
- <para>This chapter includes detailed reference information about all tabs of the Smooks Configuration Editor.</para>
- <section id="process_tab">
- <title>Process tab</title>
- <para>The Process tab of the Smooks Configuration Editor helps to configure different types of transformations.
- By default smooks configuration file is opened in this editor.If you have another default settings for editor opening
- you should left click smooks configuration file and select:<emphasis>Open With->Smooks Configuration Editor</emphasis>.</para>
- <para>The Process tab has two sections:</para>
- <itemizedlist>
- <listitem><para><xref linkend="processing_task_section"/></para></listitem>
- <listitem><para><xref linkend="selected_task_details"/></para></listitem>
- </itemizedlist>
- <para>You can see them on the picture below.</para>
- <figure>
- <title>Two Sections of the Process tab.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_1.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <section id="processing_task_section">
- <title>Processing Task section</title>
- <para>Using the popup menu in the Processing Task section you
- can select which types of technologies(templating or mapping ones) you will use for transofmation: </para>
- <para>The descriptions of the popup menu options are in the following table.</para>
- <table>
- <title>Process Tab. Processing Task section.</title>
- <tgroup cols="3">
- <colspec colnum="1" align="left" colwidth="1*"/>
- <colspec colnum="2" align="left" colwidth="3*"/>
- <colspec colnum="3" align="left" colwidth="1*"/>
-
- <thead>
- <row>
- <entry>Option</entry>
- <entry>Description</entry>
- <entry>Default</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Add Task</entry>
- <entry>Select one of the following tasks according to the necessary type of Source and Result types of the files:
- <itemizedlist>
- <listitem><para><emphasis>Input</emphasis> - this task is required and
- appears automatically when Smooks config file is created.
- You should just configure it properly.</para></listitem>
- <listitem><para><emphasis>Java Mapping</emphasis></para></listitem>
- <listitem><para><emphasis>Apply Template</emphasis></para></listitem>
- </itemizedlist>
- </entry>
- <entry></entry>
- </row>
-
- <row>
- <entry>Delete</entry>
- <entry>Click this option if you want to delete some task from the section.
- Note:you can't delete input task because it's required.</entry>
- <entry></entry>
-
- </row>
-
- <row>
- <entry>Input Methods</entry>
- <entry>Choose one of the following methods:
- <itemizedlist>
- <listitem><para>System</para></listitem>
- <listitem><para>Simple</para></listitem>
- <listitem><para>Amharic(EZ+)</para></listitem>
- <listitem><para>Cedilla</para></listitem>
- <listitem><para>Cyrillic</para></listitem>
- <listitem><para>Inuktitut</para></listitem>
- <listitem><para>IPA</para></listitem>
- <listitem><para>Multipress</para></listitem>
- <listitem><para>SCIM Bridge Input Method</para></listitem>
- <listitem><para>SCIM Input Method</para></listitem>
- <listitem><para>Thai-Lio</para></listitem>
- <listitem><para>Tigrigna-Eritrean(EZ+)</para></listitem>
- <listitem><para>Tigrigna-Ethiopian(EZ+)</para></listitem>
- <listitem><para>Vietnamese</para></listitem>
- <listitem><para>X input Method</para></listitem>
- </itemizedlist>
- </entry>
- <entry>System</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
- <section id="selected_task_details">
- <title>Selected Task Details Section</title>
- <para>The options of this section depends on the selected task in the Processing Task section.
- Because there are 3 types of tasks there are 3 different sets of its options in the Selected Task Details Section.
- They will be described one by one. </para>
- <section>
- <title>Selected Task Details Section for Input Task.</title>
- <para>On the picture below you can find an example of Selected Task Details Section view
- if XML is selected as input type.</para>
-
- <figure>
- <title>Selected Task Details Section for Input XML Task.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_2.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>As you can see on the picture above Input Configuration section is empty for XML input file.
- But this section has special configuration options for CSV,EDI,JSON,Custom input files.</para>
-
- <para>Here are the screens of these configuration options:</para>
+<chapter id="references">
+<?dbhtml filename="reference.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+
+ <keyword>Smooks</keyword>
+
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Reference</title>
+ <para>
+ This chapter includes detailed reference information on all tabs in the Smooks Configuration Editor.
+ </para>
+
+ <section id="process_tab">
+ <title>Process tab</title>
+ <para>
+ The Process tab of the Smooks Configuration Editor provides a way to configure different types of transformations. By default the smooks configuration file is opened in this editor. If you have set another editor to open the file by default, you should right click on the smooks configuration file and select <menuchoice><guimenuitem>Open With</guimenuitem><guimenuitem>Smooks Configuration Editor</guimenuitem></menuchoice>.
+ </para>
+
+ <para>
+ The Process tab has two sections:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <xref linkend="processing_task_section"/>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <xref linkend="selected_task_details"/>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ You can see them on the picture below.
+ </para>
+
+ <figure>
+ <title>Two Sections of the Process tab.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_1.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <section id="processing_task_section">
+ <title>Processing Task section</title>
+ <para>
+ Using the popup menu in the Processing Task section you can select which types of technologies (templating or mapping ones) you will use for transformation:
+ </para>
+
+ <para>
+ The descriptions of the popup menu options are in the following table.
+ </para>
+
+ <table>
+ <title>Process Tab. Processing Task section.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+
+ <colspec colnum="2" align="left" colwidth="3*"/>
+
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>
+ Option
+ </entry>
+
+ <entry>
+ Description
+ </entry>
+
+ <entry>
+ Default
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>
+ Add Task
+ </entry>
+
+ <entry>
+ Select one of the following tasks according to the required Source and Result file types:
<itemizedlist>
- <listitem><para>CSV:</para>
- <figure>
- <title>Selected Task Details Section for Input CSV Task.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_3.png" />
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem><para>EDI:</para>
- <figure>
- <title>Selected Task Details Section for Input EDI Task.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem><para>JSON:</para>
- <figure>
- <title>Selected Task Details Section for Input JSON Task.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem><para>Custom:</para>
- <figure>
- <title>Selected Task Details Section for Input Custom Task.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
+ <listitem>
+ <para>
+ <emphasis>Input</emphasis> - this task is required and appears automatically when Smooks config file is created. You should just configure it properly.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Java Mapping</emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Apply Template</emphasis>
+ </para>
+ </listitem>
</itemizedlist>
- <para>All the input task configuration positions can be found in the table below:</para>
- <table>
- <title>Selected Task Details Section. Options for Input Task.</title>
- <tgroup cols="3">
- <colspec colnum="1" align="left" colwidth="1*"/>
- <colspec colnum="2" align="left" colwidth="3*"/>
- <colspec colnum="3" align="left" colwidth="1*"/>
- <thead>
- <row>
- <entry>Option</entry>
- <entry>Description</entry>
- <entry>Default</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Input type</entry>
- <entry>Select your type of input file.
- If don't find your type in the list,you should use Custom type:
- <itemizedlist>
- <listitem><para>No Input</para></listitem>
- <listitem><para>XML</para></listitem>
- <listitem><para>Java</para></listitem>
- <listitem><para>XSD/WSDL</para></listitem>
- <listitem><para>CSV</para></listitem>
- <listitem><para>EDI</para></listitem>
- <listitem><para>JSON</para></listitem>
- <listitem><para>Custom</para></listitem>
- </itemizedlist>
- </entry>
- <entry>XML</entry>
- </row>
-
- <row>
- <entry>Input configuration
-
- </entry>
- <entry>
- <itemizedlist>
- <listitem><para><emphasis>No Input</emphasis> - no info required</para></listitem>
- <listitem><para><emphasis>XML</emphasis> - no info required</para></listitem>
- <listitem><para><emphasis>Java</emphasis> - no info required</para></listitem>
- <listitem><para><emphasis>XSD/WSDL</emphasis> - no info required</para></listitem>
- <listitem><para><emphasis>CSV</emphasis></para><itemizedlist>
- <listitem><para><emphasis>Fields</emphasis> - Comma separated list of CSV record field names
- </para></listitem>
- <listitem><para><emphasis>Separator Character</emphasis> - Field separator character.
- </para></listitem>
- <listitem><para><emphasis>Quote Character</emphasis> - Quote character.
- </para></listitem>
- <listitem><para><emphasis>Record Name</emphasis> - Name of csv record element.</para></listitem>
- <listitem><para><emphasis>Root Name</emphasis> - Name of csv root element.</para></listitem>
- <listitem><para><emphasis>indent</emphasis> - Add indentation character data to
- the generated event stream. This simply makes
- the generated event stream easier to read in its serialized form. Useful for
- testing etc.
- </para></listitem>
- <listitem><para><emphasis>Skip Lines</emphasis> - Number of lines to skip before processing starts.
- </para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para><emphasis>EDI</emphasis></para>
- <itemizedlist>
- <listitem><para><emphasis>Target Profile</emphasis> - Defines the output
- transformation profile
- </para></listitem>
- <listitem><para><emphasis>Encoding</emphasis> - The character encoding.</para></listitem>
- <listitem><para><emphasis>Mapping Model</emphasis> - Defines the EDI Mapping Model
- configuration for processing the
- EDI message stream to a stream of SAX events that can be processed by Smooks.</para></listitem>
- <listitem><para><emphasis>Validate</emphasis> - This attribute turns on/off datatype validation in the EDI Parser.
- Validation is on by default.
- It makes sense to turn datatype validation off on the EDI Reader
- if the EDI data is being bound into a Java Object model.
- </para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para><emphasis>JSON</emphasis></para>
- <itemizedlist>
- <listitem><para><emphasis>Target Profile</emphasis> - Defines the output transformation profile</para></listitem>
- <listitem><para><emphasis>Array Element Name</emphasis> - The element name of an array element.
- </para></listitem>
- <listitem><para><emphasis>Encoding</emphasis> - encoding: The default encoding of any JSON message
- InputStream processed by this Reader.</para></listitem>
- <listitem><para><emphasis>Illegal Element Name Char Replacement</emphasis> - If illegal characters are encountered in a JSON element name then they are replaced with this value.
- By default this is not defined, so that the reader doesn't doesn't search for illegal characters.
- </para></listitem>
- <listitem><para><emphasis>Indent</emphasis> - Add indentation character data to the generated event stream. This simply makes
- the generated event stream easier to read in its serialized form. Useful for
- testing etc.
- </para></listitem>
- <listitem><para><emphasis>Key Prefix on Numeric</emphasis> - The prefix character to add if the JSON node name starts with a number.
- By default this is not defined, so that the reader doesn't search for element names that start with a number.
- </para></listitem>
- <listitem><para><emphasis>Key Whitespace Replacement</emphasis> - The replacement character for whitespaces in a JSON map key.
- By default this not defined, so that the reader doesn't search for whitespaces.
- </para></listitem>
- <listitem><para><emphasis>Null Value Replacement</emphasis> - The replacement string for JSON NULL values.</para></listitem>
- <listitem><para><emphasis>Root Name</emphasis> - The element name of the document root.
- </para></listitem>
- <listitem><para><emphasis>Key Maps</emphasis> - Defines a JSON element name mapping
- The "from" key will be replaced with the "to" key or the contents of the element.
- </para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para><emphasis>Custom</emphasis></para>
- <itemizedlist>
- <listitem><para><emphasis>Target Profile</emphasis> - Defines the output transformation profile</para></listitem>
- <listitem><para><emphasis>Class</emphasis> - Custom reader class.</para></listitem>
- <listitem><para><emphasis>Handlers</emphasis> - Set a handler on the reader instance e.g. an EntityResolver, ErrorHandler etc.
- </para></listitem>
- <listitem><para><emphasis>Features</emphasis> - Reader Features List</para></listitem>
- <listitem><para><emphasis>Parametres</emphasis> - Resource Parameters</para></listitem>
-
- </itemizedlist>
- </listitem>
- </itemizedlist></entry>
- <entry><itemizedlist>
- <listitem><para><emphasis>CSV</emphasis></para><itemizedlist>
- <listitem><para>not defined</para></listitem>
- <listitem><para>','</para></listitem>
- <listitem><para>'"'</para></listitem>
- <listitem><para>csv-record</para></listitem>
- <listitem><para>csv-set</para></listitem>
- <listitem><para>true</para></listitem>
- <listitem><para>0</para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para><emphasis>EDI</emphasis></para>
- <itemizedlist>
- <listitem><para>not defined</para></listitem>
- <listitem><para>UTF-8</para></listitem>
- <listitem><para>not defined</para></listitem>
- <listitem><para>true</para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para><emphasis>JSON</emphasis></para>
- <itemizedlist>
- <listitem><para>not defined</para></listitem>
- <listitem><para>element</para></listitem>
- <listitem><para>UTF-8</para></listitem>
- <listitem><para>not defined</para></listitem>
- <listitem><para>false</para></listitem>
- <listitem><para>not defined</para></listitem>
- <listitem><para>not defined</para></listitem>
- <listitem><para>""(an empty string)</para></listitem>
- <listitem><para>'json'</para></listitem>
- <listitem><para>not defined</para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para><emphasis>Custom</emphasis></para>
- <itemizedlist>
- <listitem><para>no defaults</para></listitem>
-
- </itemizedlist>
- </listitem>
- </itemizedlist></entry>
- </row>
- <row>
- <entry>Input Data</entry>
- <entry>You should select a data file using <emphasis>Add</emphasis> and <emphasis>Delete</emphasis> buttons</entry>
- <entry></entry>
- </row>
- <row>
- <entry>Input Model View</entry>
- <entry>Using this view you can see the structure of your input file.If the file has been changed, to see the changes
- click <emphasis>Refresh</emphasis>link.</entry>
- <entry></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
- <section id="mapping_task"><title>Selected Task Details section for Java Mapping Task.</title>
- <para>Selected Task Details section for this task is presented by the graf,
- that lighten the process of java mapping. </para>
- <figure>
- <title>Selected Task Details Section for Mapping Task.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_7.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>This graphical editor allows you to perform drag&drop operation with the nodes of transformed data to map the source data to target data.
- When you save the changes in the graphical editor the correct Smooks configuration file content will be generated. </para>
- <para>Using the popup menu in the <emphasis>Selected Task Details</emphasis> section you
- can manage the diagram elements on the canvas. </para>
- <para>The descriptions of the popup menu options are in the following table.</para>
- <table id="popup">
- <title>Popup menu. Selected Task Details section.</title>
- <tgroup cols="3">
- <colspec colnum="1" align="left" colwidth="1*"/>
- <colspec colnum="2" align="left" colwidth="3*"/>
- <colspec colnum="3" align="left" colwidth="1*"/>
-
- <thead>
- <row>
- <entry>Option</entry>
- <entry>Description</entry>
- <entry>Default</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Add</entry>
- <entry>Select one of the following tasks:
- <itemizedlist>
- <listitem><para><emphasis>Java Class</emphasis> - adds bean context item to the config file.
- This option is available when no elements are selected and a user right click the canvas.
- </para></listitem>
- <listitem><para><emphasis>Expession Binding</emphasis> - adds expression based
- binding to selected java binding element.</para></listitem>
- <listitem><para><emphasis>Value Binding</emphasis> - adds Value binding (<jb:value>)
- to the selected java binding element.</para></listitem>
- <listitem><para><emphasis>Bean Binding</emphasis> - adds Wiring binding (<jb:wiring>)
- to the selected java binding element.</para></listitem>
- </itemizedlist>
- </entry>
- <entry></entry>
- </row>
- <row>
- <entry>Undo</entry>
- <entry>By this option you can revert the changes made at the previous step.
- </entry>
- <entry></entry>
-
- </row>
- <row>
- <entry>Redo</entry>
- <entry>By this option you can redo the changes made at the previous step.
- </entry>
- <entry></entry>
-
- </row>
- <row>
- <entry>Delete</entry>
- <entry>This option is available only if you select some element on the canvas.
- Click this option if you want to delete the element from it.
- </entry>
- <entry></entry>
-
- </row>
- <row>
- <entry>Auto Layout</entry>
- <entry>Sets the default layout of the elements on the canvas.</entry>
- <entry></entry>
-
- </row>
- <row>
- <entry>Properties</entry>
- <entry>Click this option if you want to add <emphasis>Properties view</emphasis>
- to the current perspective.
- The just opened <emphasis>Properties view</emphasis>
- will automatically reflect the properties of the selected
- diagram element.
- </entry>
- <entry></entry>
- </row>
-
- <row>
- <entry>Input Methods</entry>
- <entry>Choose one of the following methods:
- <itemizedlist>
- <listitem><para>System</para></listitem>
- <listitem><para>Simple</para></listitem>
- <listitem><para>Amharic(EZ+)</para></listitem>
- <listitem><para>Cedilla</para></listitem>
- <listitem><para>Cyrillic</para></listitem>
- <listitem><para>Inuktitut</para></listitem>
- <listitem><para>IPA</para></listitem>
- <listitem><para>Multipress</para></listitem>
- <listitem><para>SCIM Bridge Input Method</para></listitem>
- <listitem><para>SCIM Input Method</para></listitem>
- <listitem><para>Thai-Lio</para></listitem>
- <listitem><para>Tigrigna-Eritrean(EZ+)</para></listitem>
- <listitem><para>Tigrigna-Ethiopian(EZ+)</para></listitem>
- <listitem><para>Vietnamese</para></listitem>
- <listitem><para>X input Method</para></listitem>
- </itemizedlist>
- </entry>
- <entry>System</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
- <section><title>Selected Task Details section for Template Task.</title>
- <para>Selected Task Details section for this task is presented by the graf,
- that is similar to the <xref linkend="mapping_task"/>.
- </para>
- <figure>
- <title>Selected Task Details Section for Template Task.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_7a.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Popup menu similar to <xref linkend="popup"/>.</para>
- </section>
- </section>
-
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Delete
+ </entry>
+
+ <entry>
+ Click this option if you want to delete some task from the section. Note:you can't delete input task because it's required.
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Input Methods
+ </entry>
+
+ <entry>
+ Choose one of the following methods:
+ <itemizedlist>
+ <listitem>
+ <para>
+ System
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Simple
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ IBus (Inteligent Input Bus)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Amharic(EZ+)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Cedilla
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Cyrillic
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Inuktitut
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ IPA
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Multipress
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ SCIM Bridge Input Method
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ SCIM Input Method
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Thai-Lio
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Tigrigna-Eritrean(EZ+)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Tigrigna-Ethiopian(EZ+)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Vietnamese
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ X input Method
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ None
+ </para>
+ </listitem>
+ </itemizedlist>
+ </entry>
+
+ <entry>
+ System
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
</section>
- <section id="options_tab">
- <title>Options Tab</title>
- <para>This section describes Options tab of the Smooks Configuration File editor, gives short recommendations how this tab can be used during the project configuring.</para>
+
+ <section id="selected_task_details">
+ <title>Selected Task Details Section</title>
+ <para>
+ The options available in this section depends on the selected task in the Processing Task section. Because there are 3 types of tasks there are 3 different sets of its options in the Selected Task Details Section. They will be described one by one.
+ </para>
+
+ <section>
+ <title>Selected Task Details Section for Input Task.</title>
+ <para>
+ On the picture below you can find an example of the Selected Task Details Section view if XML is selected as input type.
+ </para>
+
<figure>
- <title> Options tab of the Smooks Configuration File editor</title>
- <mediaobject>
+ <title>Selected Task Details Section for Input XML Task.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_2.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ As you can see on the picture above the Input Configuration section is empty for XML input file. However, this section has special configuration options for CSV,EDI,JSON,Custom input files.
+ </para>
+
+ <para>
+ Here are the screens of these configuration options:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ CSV:
+ </para>
+
+ <figure>
+ <title>Selected Task Details Section for Input CSV Task.</title>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/reference/reference_8.png" scale="90"/>
+ <imagedata fileref="images/reference/reference_3.png" />
</imageobject>
- </mediaobject>
- </figure>
- <section>
- <title>Smooks Configuration section</title>
- <para>
- In the <property>Smooks Configuration</property> section of <property>Options Tab</property>
- only one element is availible:Smooks Platform Version
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>
+ EDI:
</para>
+
<figure>
- <title>Smooks Configuration section of Options tab</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_9.png" scale="90"/>
- </imageobject>
- </mediaobject>
+ <title>Selected Task Details Section for Input EDI Task.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_4.png"/>
+ </imageobject>
+ </mediaobject>
</figure>
- <para>This parameter is not rechangable,
- and is set according to the vesion of the Smooks libraries that are added to the project.
+ </listitem>
+
+ <listitem>
+ <para>
+ JSON:
</para>
- </section>
-
- <section>
- <title>Filter Settings Filter section</title>
- <para>
- In Filter Settings section you can set
- the following global options responsible for Smooks filtering configuring:</para>
+
<figure>
- <title>Filter Settings section of Options tab</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_10.png" scale="90"/>
- </imageobject>
- </mediaobject>
+ <title>Selected Task Details Section for Input JSON Task.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_5.png"/>
+ </imageobject>
+ </mediaobject>
</figure>
- <para>This behavior can be turned off using this global configuration parameter and can be overriden on a per fragment basis by targetting a Visitor implementation at that fragment that takes ownership of the Result writer (in the case of SAX filtering), or simply modifies the DOM (in the case of DOM filtering). As an example of this, see the FreeMarkerTemplateProcessor.
+ </listitem>
+
+ <listitem>
+ <para>
+ Custom:
</para>
- <table>
- <title>Options Tab. Filter Settings section.</title>
- <tgroup cols="3">
- <colspec colnum="1" align="left" colwidth="1*"/>
- <colspec colnum="2" align="left" colwidth="3*"/>
- <colspec colnum="3" align="left" colwidth="1*"/>
-
- <thead>
- <row>
- <entry>Option</entry>
- <entry>Description</entry>
- <entry>Default</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Stream Filter Type</entry>
- <entry>Determines the type of processing model that will be used.
- Please refer to <ulink url="http://www.smooks.org/mediawiki/index.php?title=V1.2:Smooks_v1.2_User_Gui...">
- Filtering Process Selection section</ulink>
- of the official Smooks User Guide for more information about these models:
- <itemizedlist>
- <listitem><para><emphasis>SAX</emphasis></para></listitem>
- <listitem><para><emphasis>DOM</emphasis></para></listitem>
- </itemizedlist>
- </entry>
- <entry>SAX</entry>
- </row>
-
- <row>
- <entry>Default Serialization is On</entry>
- <entry>Defines whether default serialization should be switched on.
- Default serialization being turned on leads to locating StreamResult/DOMResult
- to the Result objects provided to the Smooks.filterSource method and to
- serialization all the events to that Result.</entry>
- <entry>false</entry>
-
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
- </section>
- <section id="smooksformeditor_sourcetab">
-
- <title>Source Tab</title>
- <para>This section provides information about Smooks Source Editor Page.</para>
- <section>
- <title>XML Source Editor</title>
- <para>You can use this editor to edit the Smooks Configuration file directly. </para>
+
<figure>
- <title>Graphical Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/source_editor/source_editor1.png" scale="90"/>
- </imageobject>
- </mediaobject>
+ <title>Selected Task Details Section for Input Custom Task.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_6.png"/>
+ </imageobject>
+ </mediaobject>
</figure>
- </section>
- <section>
- <title>Error underlining in Graphical Editor</title>
- <para>If the <property>Smooks tools</property> can't understand the configuration
- file or the configuration file is illegal (XML structure isn't right for Smooks
- Configuration file, etc.), the error is underlined.</para>
- <figure>
- <title>Graphical Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_11.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
- <section>
- <title>Smooks Configuration File Validator</title>
- <para>Smooks configuration file validator will validate your Smooks configuration file. Just right-click on the file and then click on the <property>Validate</property> button. The validator can be enabled/disabled in <emphasis><property>Window -> Preferences -> Validation</property></emphasis>:</para>
-
- <figure>
- <title>Validation: Smooks Configuration File Validator</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/source_editor/smooks_conf_validator.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You can set up your Smooks validator to include, exclude groups to validate and specify rules for validation. Just click on the <property>Settings</property> button and use the options provided:</para>
-
- <figure>
- <title>Smooks Configuration File Validator Settings</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/source_editor/smooks_conf_validator_settings.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>For more details about Smooks editor, also see the movie, <ulink url="">"Overview of the Smooks Editor"</ulink>.</para>
- </section>
- </section>
- <section>
- <title>Properties View</title>
- <para><emphasis><property>Properties View</property></emphasis> is available for some
- elements on the canvas of Java Mapping and Apply Template Tasks,like:</para>
- <itemizedlist>
- <listitem><para><emphasis><property>Java mapping</property></emphasis>:java class members,its fields,
- links between input values and the class members;</para></listitem>
- <listitem><para><emphasis><property>Apply Template</property></emphasis>:output template.</para></listitem>
+ </listitem>
</itemizedlist>
- <para>To add <emphasis><property>Properties View</property></emphasis>
- to the opened perspective the user can either open <property>Window->Show View->Preferences</property>
- in the toolbar or right click the element which properties he wants to inspect and select <property>Properties</property>
- in the popup menu.On the picture below you can see how this view looks like when some csv template is selected.
+
+ <para>
+ All the input task configuration positions can be found in the table below:
</para>
+
+ <table>
+ <title>Selected Task Details Section. Options for Input Task.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+
+ <colspec colnum="2" align="left" colwidth="3*"/>
+
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>
+ Option
+ </entry>
+
+ <entry>
+ Description
+ </entry>
+
+ <entry>
+ Default
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>
+ Input type
+ </entry>
+
+ <entry>
+ Select your type of input file. If you don't find your type in the list, you should use Custom type:
+ <itemizedlist>
+ <listitem>
+ <para>
+ No Input
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ XML
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Java
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ XSD/WSDL
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ CSV
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ EDI
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ JSON
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Custom
+ </para>
+ </listitem>
+ </itemizedlist>
+ </entry>
+
+ <entry>
+ XML
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ Input configuration
+ </entry>
+
+ <entry>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>No Input</emphasis> - no info required
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>XML</emphasis> - no info required
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Java</emphasis> - no info required
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>XSD/WSDL</emphasis> - no info required
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>CSV</emphasis>
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>Fields</emphasis> - Comma separated list of CSV record field names
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Separator Character</emphasis> - Field separator character.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Quote Character</emphasis> - Quote character.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Record Name</emphasis> - Name of csv record element.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Root Name</emphasis> - Name of csv root element.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>indent</emphasis> - Add indentation character data to the generated event stream. This simply makes the generated event stream easier to read in its serialized form. Useful for testing etc.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Skip Lines</emphasis> - Number of lines to skip before processing starts.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>EDI</emphasis>
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>Target Profile</emphasis> - Defines the output transformation profile
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Encoding</emphasis> - The character encoding.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Mapping Model</emphasis> - Defines the EDI Mapping Model configuration for processing the EDI message stream to a stream of SAX events that can be processed by Smooks.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Validate</emphasis> - This attribute turns on/off datatype validation in the EDI Parser. Validation is on by default. It makes sense to turn datatype validation off on the EDI Reader if the EDI data is being bound into a Java Object model.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>JSON</emphasis>
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>Target Profile</emphasis> - Defines the output transformation profile
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Array Element Name</emphasis> - The element name of an array element.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Encoding</emphasis> - encoding: The default encoding of any JSON message InputStream processed by this Reader.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Illegal Element Name Char Replacement</emphasis> - If illegal characters are encountered in a JSON element name then they are replaced with this value. By default this is not defined, so that the reader doesn't doesn't search for illegal characters.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Indent</emphasis> - Add indentation character data to the generated event stream. This simply makes the generated event stream easier to read in its serialized form. Useful for testing etc.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Key Prefix on Numeric</emphasis> - The prefix character to add if the JSON node name starts with a number. By default this is not defined, so that the reader doesn't search for element names that start with a number.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Key Whitespace Replacement</emphasis> - The replacement character for whitespaces in a JSON map key. By default this not defined, so that the reader doesn't search for whitespaces.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Null Value Replacement</emphasis> - The replacement string for JSON NULL values.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Root Name</emphasis> - The element name of the document root.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Key Maps</emphasis> - Defines a JSON element name mapping The "from" key will be replaced with the "to" key or the contents of the element.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Custom</emphasis>
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>Target Profile</emphasis> - Defines the output transformation profile
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Class</emphasis> - Custom reader class.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Handlers</emphasis> - Set a handler on the reader instance e.g. an EntityResolver, ErrorHandler etc.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Features</emphasis> - Reader Features List
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Parameters</emphasis> - Resource Parameters
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ </entry>
+
+ <entry>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>CSV</emphasis>
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ not defined
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ ','
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ '"'
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ csv-record
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ csv-set
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ true
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ 0
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>EDI</emphasis>
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ not defined
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ UTF-8
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ not defined
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ true
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>JSON</emphasis>
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ not defined
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ element
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ UTF-8
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ not defined
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ false
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ not defined
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ not defined
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ ""(an empty string)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ 'json'
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ not defined
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Custom</emphasis>
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ no defaults
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ Input Data
+ </entry>
+
+ <entry>
+ You should select a data file using the
+ <guibutton>
+ Add
+ </guibutton>
+ and
+ <guibutton>
+ Delete
+ </guibutton>
+ buttons
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Input Model View
+ </entry>
+
+ <entry>
+ Using this view you can see the structure of your input file.If the file has been changed, to see the changes click the <emphasis>Refresh</emphasis>link.
+ </entry>
+
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section id="mapping_task">
+ <title>Selected Task Details section for Java Mapping Task.</title>
+ <para>
+ Selected Task Details section for this task is presented by the graph, which eases the process of java mapping.
+ </para>
+
<figure>
- <title>Properties View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_12.png" scale="90"/>
- </imageobject>
- </mediaobject>
+ <title>Selected Task Details Section for Mapping Task.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_7.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
</figure>
+
<para>
- This view is fully syncronized with the canvas of <emphasis><property>Smooks Configuration Editor</property></emphasis>.
- This means that when you change selected element by click,the properties of a new element are immediatly displayed in it.
- Using <emphasis><property>Properties View</property></emphasis> you can edit all the properties of the selected item.
+ This graphical editor allows you to perform drag&drop operations with the nodes of transformed data to map the source data to target data. When you save the changes in the graphical editor the correct Smooks configuration file content will be generated.
</para>
+
+ <para>
+ Using the popup menu in the <emphasis>Selected Task Details</emphasis> section you can manage the diagram elements on the canvas.
+ </para>
+
+ <para>
+ The descriptions of the popup menu options are in the following table.
+ </para>
+
+ <table id="popup">
+ <title>Popup menu. Selected Task Details section.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+
+ <colspec colnum="2" align="left" colwidth="3*"/>
+
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>
+ Option
+ </entry>
+
+ <entry>
+ Description
+ </entry>
+
+ <entry>
+ Default
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>
+ Add
+ </entry>
+
+ <entry>
+ Select one of the following tasks:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>Java Class</emphasis> - adds a bean context item to the config file. This option is available when no elements are selected and a user right clicks on the canvas.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Expression Binding</emphasis> - adds expression based binding to selected java binding element.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Value Binding</emphasis> - adds Value binding (<jb:value>) to the selected java binding element.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Bean Binding</emphasis> - adds Wiring binding (<jb:wiring>) to the selected java binding element.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Undo
+ </entry>
+
+ <entry>
+ This option allows you to revert any changes made in the previous step.
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Redo
+ </entry>
+
+ <entry>
+ This option allows you to redo the changes made at the previous step.
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Delete
+ </entry>
+
+ <entry>
+ This option is available only if you select an element on the canvas. Click this option if you want to delete the element from it.
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Auto Layout
+ </entry>
+
+ <entry>
+ Sets the default layout of the elements on the canvas.
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Properties
+ </entry>
+
+ <entry>
+ Click this option if you want to add the <emphasis>Properties view</emphasis> to the current perspective. The <emphasis>Properties view</emphasis> will automatically display the properties of the selected diagram element.
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Input Methods
+ </entry>
+
+ <entry>
+ Choose one of the following methods:
+ <itemizedlist>
+ <listitem>
+ <para>
+ System
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Simple
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Amharic(EZ+)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Cedilla
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Cyrillic
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Inuktitut
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ IPA
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Multipress
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ SCIM Bridge Input Method
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ SCIM Input Method
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Thai-Lio
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Tigrigna-Eritrean(EZ+)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Tigrigna-Ethiopian(EZ+)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Vietnamese
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ X input Method
+ </para>
+ </listitem>
+ </itemizedlist>
+ </entry>
+
+ <entry>
+ System
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section>
+ <title>Selected Task Details section for Template Task.</title>
+ <para>
+ Selected Task Details section for this task is presented by the graph, which is similar to what is described in the section <xref linkend="mapping_task"/>.
+ </para>
+
<figure>
- <title>Synchronization between Properties View and the canvas</title>
+ <title>Selected Task Details Section for Template Task.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_7a.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Popup menu similar to <xref linkend="popup"/>.
+ </para>
+ </section>
+ </section>
+ </section>
+
+ <section id="options_tab">
+ <title>Options Tab</title>
+ <para>
+ This section describes Options tab of the Smooks Configuration File editor, and gives short recommendations how this tab can be used during the project configuring.
+ </para>
+
+ <figure>
+ <title> Options tab of the Smooks Configuration File editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_8.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <section>
+ <title>Smooks Configuration section</title>
+ <para>
+ The <property>Smooks Configuration</property> section in the <property>Options Tab</property> displays only the Smooks Platform Version value.
+ </para>
+
+ <figure>
+ <title>Smooks Configuration section of Options tab</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_9.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ This value can not be modified, and is set according to the version of the Smooks libraries that are added to the project.
+ </para>
+ </section>
+
+ <section>
+ <title>Filter Settings Filter section</title>
+ <para>
+ In Filter Settings section you can set the following global options responsible for the Smooks filtering configuration:
+ </para>
+
+ <figure>
+ <title>Filter Settings section of Options tab</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_10.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ This behavior can be turned off using this global configuration parameter and can be overridden on a per fragment basis by targeting a Visitor implementation at that fragment that takes ownership of the Result writer (in the case of SAX filtering), or simply modifies the DOM (in the case of DOM filtering). As an example of this, see the FreeMarkerTemplateProcessor.
+ </para>
+
+ <table>
+ <title>Options Tab. Filter Settings section.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+
+ <colspec colnum="2" align="left" colwidth="3*"/>
+
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>
+ Option
+ </entry>
+
+ <entry>
+ Description
+ </entry>
+
+ <entry>
+ Default
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>
+ Stream Filter Type
+ </entry>
+
+ <entry>
+ Determines the type of processing model that will be used. Please refer to the <ulink url="http://www.smooks.org/mediawiki/index.php?title=V1.2:Smooks_v1.2_User_Gui..."> Filtering Process Selection section</ulink> of the official Smooks User Guide for more information about these models:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>SAX</emphasis>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>DOM</emphasis>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </entry>
+
+ <entry>
+ SAX
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ Default Serialization is On
+ </entry>
+
+ <entry>
+ Defines whether the default serialization should be switched on. Default serialization being enabled leads to locating StreamResult/DOMResult to the Result objects provided to the Smooks.filterSource method and to serialization all the events to that Result.
+ </entry>
+
+ <entry>
+ false
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ </section>
+
+ <section id="smooksformeditor_sourcetab">
+ <title>Source Tab</title>
+ <para>
+ This section provides information about the Smooks Source Editor Page.
+ </para>
+
+ <section>
+ <title>XML Source Editor</title>
+ <para>
+ You can use this editor to edit the Smooks Configuration file directly.
+ </para>
+
+ <figure>
+ <title>Graphical Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/source_editor/source_editor1.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section>
+ <title>Error underlining in Graphical Editor</title>
+ <para>
+ If the <property>Smooks tools</property> can't understand the configuration file or the configuration file is illegal (e.g. XML structure isn't valid for a Smooks Configuration file), the error is underlined.
+ </para>
+
+ <figure>
+ <title>Graphical Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_11.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section>
+ <title>Smooks Configuration File Validator</title>
+ <para>
+ The Smooks configuration file validator will validate your Smooks configuration file. Just right-click on the file and then click on the
+ <guibutton>
+ Validate
+ </guibutton>
+ button. The validator can be enabled/disabled by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>Validation</guimenuitem></menuchoice>, as you can see in the image below:
+ </para>
+
+ <figure>
+ <title>Validation: Smooks Configuration File Validator</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/source_editor/smooks_conf_validator.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ You can set up your Smooks validator to include and exclude groups to validate, and specify rules for validation. Just click on the
+ <guibutton>
+ Settings
+ </guibutton>
+ button and use the options provided, which you can see in the image below:
+ </para>
+
+ <figure>
+ <title>Smooks Configuration File Validator Settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/source_editor/smooks_conf_validator_settings.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ </section>
+
+ <section>
+ <title>Properties View</title>
+ <para>
+ <emphasis><property>Properties View</property></emphasis> is available for some elements on the canvas of Java Mapping and Apply Template Tasks, like:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis><property>Java mapping</property></emphasis>:java class members,its fields, links between input values and the class members;
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis><property>Apply Template</property></emphasis>:output template.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ To add <emphasis><property>Properties View</property></emphasis> to the opened perspective the user can either open <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Preferences</guimenuitem></menuchoice> in the toolbar or right click the element which properties he wants to inspect and select <property>Properties</property> in the popup menu. On the picture below you can see how this view looks like when some csv template is selected.
+ </para>
+
+ <figure>
+ <title>Properties View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_12.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ This view is fully synchronized with the canvas of the <emphasis><property>Smooks Configuration Editor</property></emphasis>. This means that when you change the selected element by clicking on it, the properties of a new element are immediately displayed in it. Using <emphasis><property>Properties View</property></emphasis> you can then edit all the properties of the selected item.
+ </para>
+
+ <figure>
+ <title>Synchronization between Properties View and the canvas</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_13.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <section>
+ <title>Decode Configuration</title>
+ <para>
+ Smooks tools support decode parameter configuration through the Decode tab in <emphasis> <property>Properties View</property></emphasis> activated by clicking the connection between input model and bean items.
+ </para>
+
+ <para>
+ On the picture below you can see an example of decode configurations for mapping an <property>Input Model</property> Item to a <property>Date</property> format:
+ </para>
+
+ <figure>
+ <title>Decode Configuration tab in Properties View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_14.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The descriptions of the <property>Decode Configuration</property> tab options are listed in the following table:
+ </para>
+
+ <table>
+ <title>Decode Configuration tab in Properties View</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+
+ <colspec colnum="2" align="left" colwidth="3*"/>
+
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>
+ Option
+ </entry>
+
+ <entry>
+ Description
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>
+ Decoder
+ </entry>
+
+ <entry>
+ Select from the dropdown list the type of decoder you need.
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ Decoder Parameters
+ </entry>
+
+ <entry>
+ For most of decoders the <emphasis><property>Decoder Parameters table</property></emphasis> is empty. But some of the decoders require additional configuration (like Date decoder on the picture above), so you should configure them by editing the corresponding line in the <property>Value</property> row. For example, for the Date Decoder:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <property>format</property> - Date format string.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <property>locale country</property> - ISO Country Code. Upper case two-letter code defined by ISO-3166.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <property>locale language</property> - ISO Language Code. Lower case two-letter code defined by ISO-639.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ The <property>Decoder Parameters</property> section for <property>EnumDecoder</property> quite differs from other types of decoders. See the picture below:
+ </para>
+
+ <figure>
+ <title>EnumDecoder in Properties View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_15.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The Decoder Parameters section for EnumDecoder in Properties View consists of 2 rows:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <property>From Data Value</property> - The lines in this row are editable. You can change them according to the names of enum types you used in input file.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <property>To Enum Value</property> - The lines in this row are not editable. Here a set of all constants declared in mapped Enum type is listed. The user is responsible for correspondence between the values in these two rows.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ For more information about different decoder parameters read the <ulink url="http://www.smooks.org/mediawiki/index.php?title=Main_Page">Smooks Technology Documentation</ulink>.
+ </para>
+ </section>
+
+ <section>
+ <title>Apply Template Wizard</title>
+ <para>
+ The <property>Apply Template Wizard</property> helps you to add a new <property>Apply Template Task</property> to the Smooks configuration file. You can call it from the popup menu when the <property>Java Mapping</property> item in the Processing Task section is selected by following <menuchoice><guimenuitem>Add Task</guimenuitem><guimenuitem>Apply Template</guimenuitem></menuchoice> (see <xref linkend="apply_templ"/> picture).
+ </para>
+
+ <para>
+ The wizard consists of several pages:
+ </para>
+
+ <orderedlist>
+ <listitem>
+ <para>
+ The first one includes only one option to adjust.The user should select in which of the two formats(<property>XML</property> or <property>CSV</property>) he prefers to create an output message:
+ </para>
+
+ <figure>
+ <title>The first page of Apply Template Wizard</title>
<mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_13.png" scale="90"/>
- </imageobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_24.png"/>
+ </imageobject>
</mediaobject>
- </figure>
- <section>
- <title>Decode Configuration</title>
- <para>Smooks tools support decode parameter configuration through the Decode tab in <emphasis>
- <property>Properties View</property></emphasis>
- activated by clicking the connection between input model and bean items. </para>
- <para>On the picture below you can see an example of decode configurations
- for mapping some <property>Input Model</property> Item to <property>Date</property> format:</para>
- <figure>
- <title>Decode Configuration tab in Properties View</title>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>
+ The second page is specific for each of the output message formats:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ If the <property>CSV</property> output message type was selected in the previous step the second wizard page will be the following :
+ </para>
+
+ <figure>
+ <title>CSV:The second page of Apply Template Wizard</title>
<mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_14.png" scale="90"/>
- </imageobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_25.png"/>
+ </imageobject>
</mediaobject>
- </figure>
- <para>The descriptions of the <property>Decode Configuration</property> tab options are listed in the following table:</para>
- <table>
- <title>Decode Configuration tab in Properties View</title>
+ </figure>
+
+ <para>
+ The wizard page includes the next options to adjust:
+ </para>
+
+ <table>
+ <title>Apply Template Wizard. Second Page Options if CSV output format is selected.</title>
<tgroup cols="3">
- <colspec colnum="1" align="left" colwidth="1*"/>
- <colspec colnum="2" align="left" colwidth="3*"/>
- <colspec colnum="3" align="left" colwidth="1*"/>
-
- <thead>
- <row>
- <entry>Option</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Decoder</entry>
- <entry>Select from the dropdown list the type of decoder you need.
- </entry>
- </row>
-
- <row>
- <entry>Decoder Parameters</entry>
- <entry>For most of decoders <emphasis><property>Decoder Parametres table</property></emphasis> is empty.
- But some of the decoders require additional configuration
- (like Date decoder on the picture above),so you should configure them
- by editing the corresponding line in the <property>Value</property> row.
- For example for Date Decoder:
- <itemizedlist>
- <listitem><para><property>format</property> - Date format string.</para></listitem>
- <listitem><para><property>locale country</property> - ISO Country Code.
- Upper case two-letter code defined by ISO-3166. </para></listitem>
- <listitem><para><property>locale language</property> - ISO Language Code.
- Lower case two-letter code defined by ISO-639. </para></listitem>
- </itemizedlist>
- </entry>
- </row>
- </tbody>
+ <colspec colnum="1" align="left" colwidth="1*"/>
+
+ <colspec colnum="2" colwidth="3*"/>
+
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>
+ Option
+ </entry>
+
+ <entry>
+ Description
+ </entry>
+
+ <entry>
+ Default
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>
+ Fields
+ </entry>
+
+ <entry>
+ Comma separated list of CSV record field names.
+ </entry>
+
+ <entry>
+ Empty
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ Separator Character
+ </entry>
+
+ <entry>
+ Field separator character in the output message.
+ </entry>
+
+ <entry>
+ ,
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ Quote Character
+ </entry>
+
+ <entry>
+ Quote character in the output message.
+ </entry>
+
+ <entry>
+ "
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ Output Field name
+ </entry>
+
+ <entry>
+ Click the checkbox if you want the output CSV message to also include field names.
+ </entry>
+
+ <entry></entry>
+ </row>
+ </tbody>
</tgroup>
- </table>
- <para>The <property>Decoder Parameters</property> section for <property>EnumDecoder</property>
- quite differs from other types of decoders.
- See the picture below:</para>
- <figure>
- <title>EnumDecoder in Properties View</title>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>
+ The following second wizard page will appear if the <property>XML</property> output message type was selected in the previous step:
+ </para>
+
+ <figure>
+ <title>Apply Template Wizard. Second Page Options if XML output format is selected.</title>
<mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_15.png" scale="90"/>
- </imageobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_22.png"/>
+ </imageobject>
</mediaobject>
- </figure>
- <para>The Decoder Parameters section for EnumDecoder in Properties View consists of 2 rows:</para>
- <itemizedlist>
- <listitem><para><property>From Data Value</property> - The lines in this row are editable.
- You can change them according to the names of enum types you used in input file.
- </para></listitem>
- <listitem><para><property>To Enum Value</property> - The lines in this row are not editable.
- Here a set of all constants declared in mapped Enum type is listed.
- The user is responsible for correspondence between the values in these two rows. </para></listitem>
- </itemizedlist>
-
- <para>For more information about different decoder parametres read <ulink url="http://www.smooks.org/mediawiki/index.php?title=Main_Page">
- Smooks Technology Documentation</ulink>.</para>
- </section>
- <section>
- <title>Apply Template Wizard</title>
- <para>The <property>Apply Template Wizard</property>
- helps you to add a new <property>Apply Template Task</property> to
- Smooks configuration file.
- You can call it from the popup menu when <property>Java Mapping</property> item in Processing
- Task section is selected by following <emphasis>Add Task > Apply Template</emphasis>
- (see <xref linkend="apply_templ"/> picture).</para>
- <para>The wizard consists of several pages:</para>
-
- <orderedlist>
- <listitem>
- <para>The first one includes only one option to adjust.The user should select in
- which of the two formats(<property>XML</property> or <property>CSV</property>)
- he prefers to create an output message:</para>
- <figure>
- <title>The first page of Apply Template Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_24.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- </listitem>
- <listitem><para>The second page is specific for each of the output message formats:</para>
- <itemizedlist>
- <listitem><para>If the <property>CSV</property> output message type was selected at
- the previous step the second wizard page will be the following :</para>
- <figure>
- <title>CSV:The second page of Apply Template Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_25.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The wizard page includes the next options to adjust:</para>
-
- <table>
- <title>Apply Template Wizard. Second Page Options if CSV output format is selected.</title>
- <tgroup cols="3">
- <colspec colnum="1" align="left" colwidth="1*"/>
- <colspec colnum="2" colwidth="3*"/>
- <colspec colnum="3" align="left" colwidth="1*"/>
- <thead>
- <row>
- <entry>Option</entry>
- <entry>Description</entry>
- <entry>Default</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Fields</entry>
- <entry>Comma separated list of CSV record field names.</entry>
- <entry>Empty</entry>
- </row>
-
- <row>
- <entry>Separator Character</entry>
- <entry>Field separator character in the output message.</entry>
- <entry>,</entry>
- </row>
-
- <row>
- <entry>Quote Character</entry>
- <entry>Quote character in the output message.</entry>
- <entry>"</entry>
- </row>
-
- <row>
- <entry>Output Field name</entry>
- <entry>Click the checkbox if you want the output csv message also include field names.</entry>
- <entry></entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
- </listitem>
- <listitem>
- <para>The following second wizard page will appear
- if <property>XML</property> output message type was selected at
- the previous step:</para>
- <figure>
- <title>Apply Template Wizard. Second Page Options if XML output format is selected.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_22.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Here you should firstly select XSD or Sample XML format of output template and then
- click <property>Browse File System</property>
- or <property>Browse Workspace</property> button depending on what
- browse type you want to use.For example, if you click <property>Browse Workspace</property>
- the following view will appear:
- </para>
- <figure>
- <title>Browse Workspace</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_18.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>In the workspace you should select the template you
- want to use and click <property>Ok</property>.
- </para>
- <para>If you selected XSD format after adjusting the template path you should click Load button:
- </para>
- <figure>
- <title>Load Button</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_19.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>After that it is necessary to select in the <property>Select Root Element
- </property> the root node for the template and click <property>Finish</property>.</para>
- <figure>
- <title>Load Button</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_20.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>If you have chosen Sample XML option after selecting
- the template xml file destination you should only
- click <property>Finish</property>:
- </para>
- <figure>
- <title>Load Button</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_23.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
- </listitem>
- </orderedlist>
- </section>
-
+ </figure>
+
+ <para>
+ Here you should first select the XSD or Sample XML output template format and then click the <property>Browse File System</property> or the <property>Browse Workspace</property> button depending on what browse type you want to use. For example, if you click <property>Browse Workspace</property> the following view will appear:
+ </para>
+
+ <figure>
+ <title>Browse Workspace</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_18.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ In the workspace you should select the template you want to use and click the
+ <guibutton>
+ OK
+ </guibutton>
+ button.
+ </para>
+
+ <para>
+ If you selected XSD format after adjusting the template path you should click the
+ <guibutton>
+ Load
+ </guibutton>
+ button:
+ </para>
+
+ <figure>
+ <title>Load Button</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_19.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ After that it is necessary to select the root node for the template in the <property>Select Root Element</property>. Then click the
+ <guibutton>
+ Finish
+ </guibutton>
+ button.
+ </para>
+
+ <figure>
+ <title>Load Button</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_20.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ If you have chosen Sample XML option after selecting the template XML file destination you should only click the
+ <guibutton>
+ Finish
+ </guibutton>
+ button:
+ </para>
+
+ <figure>
+ <title>Load Button</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_23.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </orderedlist>
</section>
-
+ </section>
</chapter>
Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/summary.xml
===================================================================
--- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/summary.xml 2011-07-18 02:42:15 UTC (rev 32984)
+++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/summary.xml 2011-07-18 02:45:08 UTC (rev 32985)
@@ -1,24 +1,17 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter>
- <?dbhtml filename="summary.html"?>
- <title>Summary</title>
- <para>In conclusion, with this document you know all the capabilities of Smooks Tools and could easily start with them.
- The chapters above walked you through the steps on how to create and configure some XML to JAVA mapping project.
- If you have questions or suggestions concerned both the documentation and tools behavior,
- you are welcome to JBoss Tools Users forum.
- Please, use Jira to report bugs and requests on documentation.</para>
-
- <section>
- <title>Other relevant resources on the topic</title>
- <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at
- <ulink url="http://docs.jboss.org/tools">http://docs.jboss.org/tools</ulink> in the corresponding release directory.
- </para>
- <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs">http://download.jboss.org/jbosstools/nightly-docs</ulink>. </para>
-<para>
- For more information about Smooks technology please visit
- <ulink url="http://www.smooks.org/mediawiki/index.php?title=Main_Page">
- Smooks Technology Home Page</ulink>
-</para>
- <para>You can find a set of screencasts on Smooks tools technology <ulink url="http://community.jboss.org/wiki/JBossTools-SmooksEditor">here</ulink>.</para>
- </section>
+ <?dbhtml filename="summary.html"?>
+ <title>Summary</title>
+ <para>The document summarizes the capabilities of Smooks Tools, and provides some instructions on how to use them. The chapters above also walked you through the steps on creating and configuring a XML to JAVA mapping project. If you have questions or suggestions concerned both the documentation and tools behavior, you are welcome to JBoss Tools Users forum. Please, use Jira to report bugs and requests on documentation.</para>
+
+ <section>
+ <title>Other relevant resources on the topic</title>
+ <para>All JBoss Developer Studio/JBoss Tools release documentation can be found at <ulink url="http://docs.jboss.org/tools">http://docs.jboss.org/tools</ulink> in the corresponding release directory.
+ </para>
+ <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs">http://download.jboss.org/jbosstools/nightly-docs</ulink>. </para>
+ <para>
+ For more information about Smooks technology please visit the <ulink url="http://www.smooks.org/mediawiki/index.php?title=Main_Page">Smooks Technology Home Page</ulink>
+ </para>
+ <para>You can find a collection of screencasts covering the Smooks tools technology <ulink url="http://community.jboss.org/wiki/JBossTools-SmooksEditor">here</ulink>.</para>
+ </section>
</chapter>
Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/tasks.xml
===================================================================
--- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/tasks.xml 2011-07-18 02:42:15 UTC (rev 32984)
+++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/tasks.xml 2011-07-18 02:45:08 UTC (rev 32985)
@@ -9,18 +9,15 @@
</keywordset>
</chapterinfo>
<title>Tasks</title>
- <para>This chapter describes the main tasks a user can be faced during Smooks tools usage.
+ <para>This chapter describes the main tasks that can be performed with Smooks tools.
In this chapter we use the example that can be downloaded from
<ulink url="http://anonsvn.jboss.org/repos/jbosstools/trunk/smooks/docs/reference/xml...">
here</ulink>. </para>
<section id="config_file_wizzard">
<title>New Smooks Configuration File Creation</title>
- <para>Select the project where you want to create new Smooks Configuration File and right-click on it,
- select in the menu <emphasis><property>New > Other</property>,</emphasis> then find
- <emphasis><property>Smooks > Smooks Configuration File</property>.</emphasis>
- Click the <emphasis>
- <property>Next</property>
- </emphasis> button. </para>
+ <para>
+ Select the project where you want to create the new Smooks Configuration File and right-click on it. Select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Smooks</guimenuitem><guimenuitem>Smooks Configuration File</guimenuitem></menuchoice>. Then click the <guibutton>Next</guibutton> button.
+ </para>
<figure>
<title>Selecting Smooks Configuration File Wizard</title>
<mediaobject>
@@ -29,11 +26,9 @@
</imageobject>
</mediaobject>
</figure>
- <para>The wizard page is a file path creation page. Select the <emphasis>
- <property>src</property>
- </emphasis> folder to be the files container, and input the name
- <emphasis><property>smooks-config.xml</property>.</emphasis> Click
- <emphasis><property>Next</property>.</emphasis></para>
+ <para>
+ Select the <emphasis><property>src</property></emphasis> folder to be the files container, and type the name <filename>smooks-config.xml</filename>. Click the <guibutton>Next</guibutton> button.
+ </para>
<figure>
<title>Choosing the configuration file container and the file name</title>
<mediaobject>
@@ -47,8 +42,7 @@
<section>
<title>Input Task Configuring</title>
<para>
- <property>Input task configuring</property> is an obligatory step for your smooks project creation.
- You can configure it on the Process page of the editor: look for the "Input Task" in the Process Map at the top of the page.
+ Configuring an <property>Input task</property> is mandatory step when creating a smooks project. You can configure it on the Process page of the editor: look for the "Input Task" in the Process Map at the top of the page.
</para>
<figure>
<title>Input Task Configuring</title>
@@ -64,12 +58,12 @@
Each reader type has slightly different configuration details that must be set in the "Input configuration" area.
For instance, the CSV reader requires you to specify details such as the encoding, quote character, separator character, and the list of incoming fields.
The EDI reader requires the encoding and the path to the Mapping Model describing the incoming data.
- In the <emphasis>Input data</emphasis> section, you specify some sample data that conforms to your reader configuration.
+ In the <emphasis>Input data</emphasis> section, you can specify some sample data that conforms to your reader configuration.
</para>
<para>
Once you've specified your reader configuration and sample data, you can see the input model rendered in a tree form in the <emphasis>Input model</emphasis> section.
- On the picture below you can see the correct configuration of some XML input task where <emphasis><property>input-message.xml</property></emphasis> is set as an input data file.
+ In the picture below you can see the correct configuration of an XML input task where <emphasis><property>input-message.xml</property></emphasis> is set as an input data file.
</para>
<figure>
<title>Input Task Configuring</title>
@@ -81,31 +75,39 @@
</figure>
</section>
<section>
- <title>"Java Mapping" or "Apply Template"?</title>
-
- <para>Though there are many options in Smooks as far as what you can do with input
- data such as transformation, routing, and persistence, this version
- of the Smooks Configuration Editor focuses only on these areas:
- mapping to java and applying templates to create different output formats.
- If you have a set of Java classes you want to use the incoming data for,
- you can use the "Java Mapping" task to specify those classes and use drag and
- drop to map between the input model generated by the reader and elements in the output model.
- Or if you simply want to transform your output to one or more formats, you can use the "Apply Template"
- task to map it to a CSV file, XML or XSD file (and other formats in the future).
- <note><title>Note</title>
- <para>Now you can't transform your output directly,
- using only Input and Template tasks.
- You should use Mapping as an interagent between these tasks.</para>
- </note>
- </para>
- </section>
+ <title>Mapping processes</title>
+ <para>
+ In previous versions of the Smooks tooling you were required to manually create a java mapping task before applying a transformation template to the data. A new method is now available called <emphasis>Direct source to target mapping</emphasis>. This allows you to skip the manual creation of Java mapping and apply a template directly to your data.
+ </para>
+ <!-- <para>
+ Though there are many options in Smooks regarding what you can do with input data, such as transformation, routing, and persistence, this version of the Smooks Configuration Editor focuses only on mapping to java and applying templates to create different output formats. If you have a set of Java classes you want to use the incoming data for, you can use the "Java Mapping" task to specify those classes and use drag and drop to map between the input model generated by the reader and elements in the output model. Or if you simply want to transform your output to one or more formats, you can use the <guilabel>Apply Template</guilabel> task to map it to a CSV file, XML or XSD file (with other formats being provided in the future).
+ <note>
+ <title>Note</title>
+ <para>You can't transform your output directly using only Input and Template tasks. You should use Mapping as an interagent between these tasks.</para>
+ </note>
+ </para> -->
+ <section>
+ <title>Direct source to target mapping</title>
+ <para>
+ A new simplified mapping process is supported within the Smooks Editor called <emphasis>Direct source to target mapping</emphasis>. This allows for you to skip the intermediate Java mapping step when applying a template to your data.
+ </para>
+ <para>
+ An example of the new editor performing a transformation (EDI to XML):
+ </para>
+ <figure>
+ <title>Java Mapping configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/process_page/direct_source_to_target_mapping_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
<section id="mapping">
<title>Java Mapping Task</title>
-
<para>
- If you decide to do Java Mapping, you need to make sure that your Input reader has been set up and you have some sample data specified.
- Then you should select <emphasis>Input Task</emphasis> in the Process tab and click the plus (+) sign to the right of the icon.
- Select <emphasis>Java Mapping</emphasis> from the popup menu and it will appear to the right, connected to <emphasis>Input Task</emphasis>. Then select <emphasis>Java Mapping</emphasis> task.
+ If you decide to do Java Mapping, you need to make sure that your Input reader has been set up and you have some sample data specified. Then you should select <emphasis>Input Task</emphasis> in the Process tab and click the plus (+) sign to the right of the icon. Select <emphasis>Java Mapping</emphasis> from the popup menu and it will appear to the right, connected to <emphasis>Input Task</emphasis>. Then select <emphasis>Java Mapping</emphasis> task.
</para>
<figure>
<title>Java Mapping configuration</title>
@@ -115,9 +117,7 @@
</imageobject>
</mediaobject>
</figure>
- <para>Another method of adding <emphasis>Java Mapping</emphasis> element
- to the canvas in the Processing Tasks section is to right click Input Task
- element and select <emphasis>Java Mapping</emphasis> in the popup menu. </para>
+ <para>Another method of adding a <emphasis>Java Mapping</emphasis> element to the canvas in the Processing Tasks section is to right click on the Input Task element and select <emphasis>Java Mapping</emphasis> in the popup menu. </para>
<figure>
<title>Java Mapping configuration</title>
<mediaobject>
@@ -127,7 +127,7 @@
</mediaobject>
</figure>
<para>
- Right-click on the canvas in an empty space and select "Add ->Java Class".
+ Right-click on the canvas in an empty space and select <menuchoice><guimenuitem>Add</guimenuitem><guimenuitem>Java Class</guimenuitem></menuchoice>.
</para>
<figure>
<title>Java Mapping configuration</title>
@@ -138,14 +138,7 @@
</mediaobject>
</figure>
<para>
- <emphasis>Java Bean Creation</emphasis> wizard appears.
- Specify a unique identifier for the new class, the class path.
- If the Java class is specified, you'll see a list of the properties in the box below.
- Click <emphasis>Finish</emphasis> when you're done.
- Now with the input and output models on the canvas, you can click and drag
- from the various input elements to corresponding output elements.
- Make sure to connect collection elements to corresponding collection elements.
- Finally your mapping should look nearly like the one on the picture below.
+ This will display the <emphasis>Java Bean Creation</emphasis> wizard. Specify a unique identifier for the new class and the class path. If the Java class is specified, you'll see a list of the properties in the box below. Click the <guibutton>Finish</guibutton> button when you're done. Now, with the input and output models on the canvas, you can click and drag from the various input elements to corresponding output elements. Make sure to connect collection elements to corresponding collection elements. Finally your mapping should look something like the one on the picture below.
</para>
<figure>
<title>Final Mapping schema</title>
@@ -155,17 +148,14 @@
</imageobject>
</mediaobject>
</figure>
- <para>For details, also see the movie,
- <ulink url="http://www.screencast.com/users/tfennelly/folders/Camtasia/media/a6648ba3...">"XML to Java"</ulink>.
+ <para>The movie <ulink url="http://www.screencast.com/users/tfennelly/folders/Camtasia/media/a6648ba3...">"XML to Java"</ulink> has more information on this process.
</para>
- <para>If you are interested in transforming EDI to Java, please, follow the
- <ulink url="http://www.screencast.com/users/tfennelly/folders/Camtasia/media/a72704fb...">link</ulink>.</para>
+ <para>If you are interested in transforming EDI to Java you can find more information <ulink url="http://www.screencast.com/users/tfennelly/folders/Camtasia/media/a72704fb...">here</ulink>.</para>
</section>
<section>
<title>Apply Template Task</title>
- <para>The "Apply Template" task works very similarly to the <xref linkend="mapping"/>, where you map between an input model and an output model.
- Select the <emphasis>Java Mapping</emphasis> task you want to use as the input model in the Process Map pane and click the plus (+) sign to the right of the icon.
+ <para>The "Apply Template" task works very similarly to the section <xref linkend="mapping"/>, where you define a mapping between an input model and an output model. Select the <emphasis>Java Mapping</emphasis> task you want to use as the input model in the Process Map pane and click the plus (+) sign to the right of the icon.
</para>
<figure id="apply_templ">
<title>Apply Template configuration</title>
@@ -176,8 +166,7 @@
</mediaobject>
</figure>
<para>
- The <property>Message Type Selection</property> wizard will appear.
- In our example we will transfer our data to csv output format,so you should select <emphasis><property>CSV</property></emphasis> and click <property>Next</property>.</para>
+ This will display the <property>Message Type Selection</property> wizard. In our example we will transfer our data to csv output format, so you should select <emphasis><property>CSV</property></emphasis> and click the <guibutton>Next</guibutton> button.</para>
<figure>
<title>Message Type Selection</title>
<mediaobject>
@@ -187,7 +176,7 @@
</mediaobject>
</figure>
<para>
- On the next wizard page put the following string into the Fields,select <property>Output Fields Names</property> and click <property>Finish</property>.</para>
+ On the next wizard page put the following string into the Fields, select <property>Output Fields Names</property> and click the <property>Finish</property> button.</para>
<figure>
<title>CSV output message configuration</title>
<mediaobject>
@@ -197,15 +186,9 @@
</mediaobject>
</figure>
<para>
- After these steps <property>"Apply Template"</property>
- task will appear to the right, connected to the task you created it from.
- To continue the process of configuration you should click on it and find <emphasis>CSV Template</emphasis>
- item with entered fields on the canvas.Now you can click and drag from various
- input elements to corresponding output elements
- in the template. Make sure to connect collection elements to the c
- orresponding <emphasis>csv-record</emphasis>.
- In our example we transfer into CSV output only the elements
- of <property>orderItems</property> collection (see the picture below):
+ After these steps the <property>"Apply Template"</property> task will appear to the right, connected to the task you created it from. To continue the configuration processyou should click on it and find the <emphasis>CSV Template</emphasis> item with entered fields on the canvas. Now you can click and drag from various input elements to corresponding output elements
+ in the template. Make sure to connect collection elements to the corresponding <emphasis>csv-record</emphasis>. In our example output only the elements
+ of <property>orderItems</property> collection to the CSV format (see the picture below):
</para>
<figure>
<title>Relations between input and output models</title>
@@ -216,14 +199,11 @@
</mediaobject>
</figure>
</section>
+</section>
<section>
<title>Smooks Configuration testing using Smooks Run Configuration</title>
- <para>This option is intended to view the results of Smooks transforming procedure.
- To do the testing you should select your <emphasis>Smooks Configuration file</emphasis> you want to transfer in the Project Navigator or open it in
- the Smooks Configuration Editor and then select "Run As..." from the <emphasis><property>Run</property></emphasis>
- toolbar button
- or <emphasis><property>Run->Smooks Run Configuration</property></emphasis> option in the top menu bar. And Smooks Configuration file will be run automatically.
+ <para>This option is used to view the results of Smooks transforming procedure. To do the testing you should select your <emphasis>Smooks Configuration file</emphasis> you want to transfer in the Project Navigator or open it in the Smooks Configuration Editor and then select "Run As..." from the <emphasis><property>Run</property></emphasis> toolbar button or select the <emphasis><property>Run->Smooks Run Configuration</property></emphasis> option in the top menu bar. The Smooks Configuration file will then be run automatically.
</para>
<figure>
<title>Smooks Configuration testing</title>
@@ -233,9 +213,7 @@
</imageobject>
</mediaobject>
</figure>
- <para>If any errors or warnings appear, they will pop up in a dialog.
- The output of the test will appear in the Console view.
- In our case the following streaming output will appear:</para>
+ <para>Any errors or warnings will appear in a pop up dialog. The output of the test will appear in the Console view. In our case the following streaming output will appear:</para>
<programlisting role="JAVA"><![CDATA[[Stream Templating Result ...]
|--
|"productId","quantity","price"
Modified: branches/jbosstools-3.2.x/smooks/docs/reference/pom.xml
===================================================================
--- branches/jbosstools-3.2.x/smooks/docs/reference/pom.xml 2011-07-18 02:42:15 UTC (rev 32984)
+++ branches/jbosstools-3.2.x/smooks/docs/reference/pom.xml 2011-07-18 02:45:08 UTC (rev 32985)
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.jboss.tools</groupId>
@@ -10,229 +8,232 @@
<packaging>jdocbook</packaging>
<name>${bookname}-(${translation})</name>
- <properties>
- <translation>en-US</translation>
- <docname>Smooks_Reference_Guide</docname>
- <bookname>Smooks Reference Guide</bookname>
- </properties>
-
- <profiles>
+ <properties>
+ <translation>en-US</translation>
+ <docname>Smooks_Reference_Guide</docname>
+ <bookname>Smooks Reference Guide</bookname>
+ </properties>
+ <profiles>
+
<!-- mvn compile -->
- <profile>
- <id>all</id>
- <activation>
- <activeByDefault>true</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${docname}.pdf</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>all</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.4</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${docname}.pdf</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <useRelativeImageUris>true</useRelativeImageUris>
+ </options>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Phtml -->
- <profile>
- <id>html</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>html</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Phtml-single -->
- <profile>
- <id>html-single</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- </plugin>
+ <profile>
+ <id>html-single</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Ppdf -->
- <profile>
- <id>pdf</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${docname}.pdf</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>pdf</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${docname}.pdf</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Peclipse -->
- <profile>
- <id>eclipse</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
- </plugins>
- </build>
- </profile>
+ <profile>
+ <id>eclipse</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
- </profiles>
- <build>
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <dependencies>
- <dependency>
- <groupId>org.jboss.pressgang</groupId>
- <artifactId>pressgang-xslt</artifactId>
- <version>1.2.0</version>
- </dependency>
- <dependency>
- <groupId>org.jboss</groupId>
- <artifactId>jbossorg-jdocbook-style</artifactId>
- <version>1.1.1</version>
- <type>jdocbook-style</type>
- </dependency>
- </dependencies>
- <configuration>
- <sourceDirectory>${project.basedir}</sourceDirectory>
+ </profiles>
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <dependencies>
+ <dependency>
+ <groupId>org.jboss.pressgang</groupId>
+ <artifactId>pressgang-xslt</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss</groupId>
+ <artifactId>jbossorg-jdocbook-style</artifactId>
+ <version>1.1.1</version>
+ <type>jdocbook-style</type>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <sourceDirectory>${project.basedir}</sourceDirectory>
<!-- <sourceDocumentName>${docname}.xml</sourceDocumentName> -->
- <sourceDocumentName>master.xml</sourceDocumentName>
- <masterTranslation>en-US</masterTranslation>
- <imageResource>
- <directory>${project.basedir}/en-US</directory>
- <includes>
- <include>images/**/*</include>
- </includes>
- </imageResource>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${pdf.name}</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- <options>
- <xincludeSupported>true</xincludeSupported>
- <xmlTransformerType>saxon</xmlTransformerType>
- <docbookVersion>1.72.0</docbookVersion>
- <localeSeparator>-</localeSeparator>
- <transformerParameters>
- <property>
- <name>javax.xml.parsers.DocumentBuilderFactory</name>
- <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
- </property>
- <property>
- <name>javax.xml.parsers.SAXParserFactory</name>
- <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
- </property>
- </transformerParameters>
- </options>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
+ <sourceDocumentName>master.xml</sourceDocumentName>
+ <masterTranslation>en-US</masterTranslation>
+ <imageResource>
+ <directory>${project.basedir}/en-US</directory>
+ <includes>
+ <include>images/**/*</include>
+ </includes>
+ </imageResource>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${pdf.name}</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <xincludeSupported>true</xincludeSupported>
+ <xmlTransformerType>saxon</xmlTransformerType>
+ <docbookVersion>1.72.0</docbookVersion>
+ <localeSeparator>-</localeSeparator>
+ <transformerParameters>
+ <property>
+ <name>javax.xml.parsers.DocumentBuilderFactory</name>
+ <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
+ </property>
+ <property>
+ <name>javax.xml.parsers.SAXParserFactory</name>
+ <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
+ </property>
+ </transformerParameters>
+ </options>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
</project>
14 years, 9 months
- 1
- 0
JBoss Tools SVN: r32984 - in branches/jbosstools-3.2.x/seam/docs/reference: en-US and 1 other directory.
by jbosstools-commits＠lists.jboss.org
Author: irooskov(a)redhat.com
Date: 2011-07-17 22:42:15 -0400 (Sun, 17 Jul 2011)
New Revision: 32984
Modified:
branches/jbosstools-3.2.x/seam/docs/reference/en-US/Book_Info.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/Feedback.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/Preface.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.ent
branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/adding_seam_support_to_ear_project.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_mavenized_seam.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_new_seam.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_application_walkthrough.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_database_application.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/directory_structure.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/generate_entities.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/intro.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/master.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_editors.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_faq.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_menus_and_actions.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_preferences.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_refactoring.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_view.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_wizards.xml
branches/jbosstools-3.2.x/seam/docs/reference/en-US/testng.xml
branches/jbosstools-3.2.x/seam/docs/reference/pom.xml
branches/jbosstools-3.2.x/seam/docs/reference/publican.cfg
Log:
updated for GA
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/Book_Info.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/Book_Info.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/Book_Info.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -5,9 +5,9 @@
<title>Seam Developer Tools Reference Guide</title>
<subtitle>Provides information relating to the Seam Developer Tools module.</subtitle>
<productname>JBoss Developer Studio</productname>
- <productnumber>4.0</productnumber>
- <edition>4.0.0</edition>
- <pubsnumber>4</pubsnumber>
+ <productnumber>4.1</productnumber>
+ <edition>4.1.0</edition>
+ <pubsnumber>1</pubsnumber>
<abstract>
<para>The Seam Developer Tools Reference Guide explains how to use the Seam Developer Tools module to create Seam projects for deployment.</para>
</abstract>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/Feedback.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/Feedback.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/Feedback.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,20 +1,92 @@
<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Document_Conventions.ent">
+%BOOK_ENTITIES;
+]>
+<appendix id="sect_JBoss-Getting_Help_and_Giving_Feedback" lang="en-US">
+ <title>Getting Help and Giving Feedback</title>
+ <section id="sect_JBoss-Do_You_Need_Help">
+ <title>Do You Need Help?</title>
+ <indexterm>
+ <primary>help</primary>
+ <secondary>getting help</secondary>
-<section id="sect-Beginners_Guide-We_Need_Feedback" lang="en-US">
- <title>We Need Feedback!</title>
- <indexterm>
- <primary>feedback</primary>
- <secondary>contact information for this manual</secondary>
- </indexterm>
- <para>
- If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA against JBoss Developer Studio: <ulink url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...">https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...</ulink>
- </para>
- <para>
- When submitting a bug report, be sure to mention the manual's name and to select the "documentation" component.
- </para>
- <para>
- If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.
- </para>
-</section>
+ </indexterm>
+ <para>
+ If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at <ulink url="http://access.redhat.com" />. Through the customer portal, you can:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ search or browse through a knowledgebase of technical support articles about Red Hat products.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ submit a support case to Red Hat Global Support Services (GSS).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ access other product documentation.
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+ <para>
+ Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. You can find a list of publicly available mailing lists at <ulink url="https://www.redhat.com/mailman/listinfo" />. Click on the name of any mailing list to subscribe to that list or to access the list archives.
+ </para>
+
+ </section>
+
+ <section id="jboss-feedback">
+ <title>Give us Feedback</title>
+ <!-- NOTE: You will need the following entities defined in your .ent file.
+ You will need to replace _YOUR_PRODUCT_HERE_, _YOUR_COMPONENT_
+ and _YOUR_SUMMARY_ - entities are not replaced in URLs.
+ <!ENTITY PRODUCT "JBoss Product Name">
+ <!ENTITY BZCOMPONENT "doc-triage">
+ <!ENTITY BZURL "<ulink url='https://bugzilla.example.com/enter_bug.cgi?product=_YOUR_PRODUCT_HERE_&am...'>http://bugzilla.redhat.com/</ulink>">
+
+ These entities should not affect translated documents, since Bugzilla is not localised.
+ --> <indexterm>
+ <primary>feedback</primary>
+ <secondary>contact information for this manual</secondary>
+
+ </indexterm>
+ <para>
+ If you find a typographical error, or know how this guide can be improved, we would love to hear from you. Submit a report in Bugzilla against the product <literal>&BZPRODUCT;</literal> and the component <literal>&BZCOMPONENT;</literal>. The following link will take you to a pre-filled bug report for this product: &BZURL;.
+ </para>
+ <para>
+ Fill out the following template in Bugzilla's <literal>Description</literal> field. Be as specific as possible when describing the issue; this will help ensure that we can fix it quickly.
+ </para>
+
+<screen>Document URL:
+
+
+Section Number and Name:
+
+
+Describe the issue:
+
+
+Suggestions for improvement:
+
+
+Additional information:
+
+
+</screen>
+ <para>
+ Be sure to give us your name so that you can receive full credit for reporting the issue.
+ </para>
+
+ </section>
+
+
+</appendix>
+
+
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/Preface.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/Preface.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/Preface.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -8,9 +8,5 @@
<para>
This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. To get more information on these conventions please refer to the <guilabel>Document Conventions</guilabel> manual, which can be found on the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index.html">Red Hat Documentation</ulink> website under the <guilabel>JBoss Developer Studio</guilabel> section.
</para>
- <!--<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- </xi:fallback>
- </xi:include>-->
</preface>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.ent
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.ent 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.ent 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,4 +1,7 @@
<!ENTITY PRODUCT "JBoss">
<!ENTITY BOOKID "Seam_Developer_Tools_Reference_Guide">
-<!ENTITY YEAR "2010">
+<!ENTITY YEAR "2011">
<!ENTITY HOLDER "Red Hat">
+<!ENTITY BZPRODUCT "JBoss Developer Studio">
+<!ENTITY BZCOMPONENT "Seam Developer Tools Reference Guide">
+<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss%20Develope...'>http://bugzilla.redhat.com/</ulink>">
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -21,5 +21,6 @@
<xi:include href="testng.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="seam_faq.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<!--<xi:include href="business_application.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>-->
+<xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
</book>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/adding_seam_support_to_ear_project.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/adding_seam_support_to_ear_project.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/adding_seam_support_to_ear_project.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -15,9 +15,9 @@
<para>For example you have several WTP projects:</para>
<itemizedlist>
- <listitem><para> seamproject-ear (You can create WTP EAR project using New -> Project -> Java EE -> Enterprise Application Project wizard)</para></listitem>
- <listitem><para> seamproject-ejb (You can create WTP EJB project using New -> Project -> EJB -> EJB Project wizard)</para></listitem>
- <listitem><para> seamproject-war (You can create WTP WEB project using New -> Project -> Web -> Dynamic Web Project wizard)</para></listitem>
+ <listitem><para> seamproject-ear (You can create WTP EAR project using <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Project</guimenuitem><guimenuitem>Java EE</guimenuitem><guimenuitem>Enterprise Application Project wizard</guimenuitem></menuchoice>)</para></listitem>
+ <listitem><para> seamproject-ejb (You can create WTP EJB project using <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Project</guimenuitem><guimenuitem>EJB</guimenuitem><guimenuitem>EJB Project wizard</guimenuitem></menuchoice>)</para></listitem>
+ <listitem><para> seamproject-war (You can create WTP WEB project using <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Project</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Dynamic Web Project wizard</guimenuitem></menuchoice>)</para></listitem>
</itemizedlist>
<note><title>Tip</title>
@@ -32,7 +32,7 @@
</mediaobject>
</figure>
- <para>Make sure EJB and WAR are included in EAR as modules (Properties for seamproject-ear -> Java EE Module Dependencies)</para>
+ <para>Make sure EJB and WAR are included in EAR as modules (Properties for <menuchoice><guimenuitem>seamproject-ear</guimenuitem><guimenuitem>Java EE Module Dependencies</guimenuitem></menuchoice>)</para>
<figure>
<title>Java EE Module Dependencies</title>
@@ -55,7 +55,7 @@
</figure>
- <para>Then include libs from EAR to EJB Manifest Class-Path (Properties for seamproject-ejb -> Java EE Module Dependencies)</para>
+ <para>Then include libs from EAR to EJB Manifest Class-Path (Properties for <menuchoice><guimenuitem>seamproject-ejb</guimenuitem><guimenuitem>Java EE Module Dependencies</guimenuitem></menuchoice>)</para>
<figure>
<title>Including Libs from EAR to EJB Manifest Class-Path</title>
@@ -66,7 +66,7 @@
</mediaobject>
</figure>
- <para>Include libs from EAR and seamproject-ejb.jar to WAR Manifest Class-Path (Properties for seamproject-war -> Java EE Module Dependencies)</para>
+ <para>Include libs from EAR and seamproject-ejb.jar to WAR Manifest Class-Path (Properties for <menuchoice><guimenuitem>seamproject-war</guimenuitem><guimenuitem>Java EE Module Dependencies</guimenuitem></menuchoice>)</para>
<figure>
<title>Including Libs from EAR and seamproject-ejb.jar to WAR Manifest Class-Path</title>
@@ -79,7 +79,7 @@
<para>Thus we have set our WTP EAR/EJB/WAR projects and now we are ready to add Seam support to them:</para>
- <para>First you have to add Seam support to WAR project: Properties for seamproject-war -> Seam Settings</para>
+ <para>First you have to add Seam support to WAR project: Properties for <menuchoice><guimenuitem>seamproject-war</guimenuitem><guimenuitem>Seam Settings</guimenuitem></menuchoice></para>
<figure>
@@ -94,7 +94,7 @@
<para>Set seamproject-war as Main Seam project. All other settings mostly are used by New Seam Entity/Action/Form/Conversation/... Wizards. Thus you can set them as you wish.</para>
- <para>Then you can add Seam support to EJB project: Properties for seamproject-war -> Seam Settings</para>
+ <para>Then you can add Seam support to EJB project: Properties for <menuchoice><guimenuitem>seamproject-war</guimenuitem><guimenuitem>Seam Settings</guimenuitem></menuchoice></para>
<figure>
<title>Adding Seam Support to EJB Project</title>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_mavenized_seam.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_mavenized_seam.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_mavenized_seam.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,181 +1,201 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="mavenized_seam">
- <?dbhtml filename="create_mavenized_seam.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Seam</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
- <title>Maven Integration for Seam Projects</title>
- <para>Starting from 3.1 M2 version <property>JBoss Tools</property> includes new Jboss Maven
- Integration plug-in which for now allows to create mavenized Seam projects and enable Seam
- tools support for imported Maven projects.</para>
- <para>The Jboss Maven Integration requires <ulink url="http://m2eclipse.sonatype.org/"
- >m2eclipse</ulink> to be installed.</para>
- <note>
- <title>Note:</title>
- <para>For M2 release of <property>Jboss Tools</property> it is important to use m2eclipse
- <ulink url="http://m2eclipse.sonatype.org/update/">stable updatesite</ulink> or the
- <ulink url="http://m2eclipse.sonatype.org/releases/0.9.9.200906081351">latest
- integration build</ulink> that M2 was developed against. If you want to use the
- latest development release of m2eclipse you need to use the <ulink
- url="http://download.jboss.org/jbosstools/updates/nightly/trunk/">nightly
- builds</ulink> of <property>JBoss Tools</property>.</para>
- </note>
- <section id="create_mavenized_project">
- <title>Creating Maven ready Seam project</title>
- <para>Maven Integration makes the Seam Wizard capable of creating Maven ready projects to
- let Maven get the libraries instead of using the Seam runtime.</para>
- <para>To create a mavenized Seam project you should perform the following steps:</para>
- <itemizedlist>
- <listitem>
- <para>Navigate to <emphasis>
- <property>File > New Seam Project</property>.</emphasis> Give the project
- a meaningful name, specify a target runtime and server and select the proper
- configuration for your Seam project:</para>
- <figure>
- <title>Starting the Mavenized Seam Project</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/create_mavenized_seam/createMavenizedSeamProject.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Click the <emphasis>
- <property>Modify</property></emphasis> button to enable the <emphasis>
- <property>Jboss Maven Integration</property></emphasis> facet:</para>
- <figure>
- <title>Enabling the Jboss Maven Integration Facet</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/create_mavenized_seam/jbossMavenIntegrationFacet.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>On the <property>JBoss M2 capabilities</property> page you'll be prompted
- to add the following maven properties: groupId, artifactId, version, packaging,
- name and description. Here it's possible to set a maven version of Seam and
- also decide whether to remove WTP classpath containers (where the path starts
- with org.eclipse.jst). </para>
- <figure>
- <title>Adjusting JBoss M2 Capabilities</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/create_mavenized_seam/jbossM2capabilities.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para> On the <property>JSF Capabilities</property> page you can choose Maven as
- libraries provider. This is possible when you use Maven JSF 1.2 Libraries as
- type of JSF Implementing Library. Also it gives you capability to edit
- Dependencies and Exclusions for the mavenized Seam project directly from the
- wizard. </para>
- <figure>
- <title>Using JSF Implementation libraries provided by Maven</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/create_mavenized_seam/seamJSFImplementation.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>On the <property>Seam Facet</property> page configure the Seam Facet settings
- and click <emphasis>
- <property>Finish</property>:</emphasis></para>
- <figure>
- <title>Seam Facet Settings</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_mavenized_seam/seamFacetPage.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
- <para>The organized Seam project contains five projects with the Maven nature, builder,
- Maven classpath and the <emphasis>
- <property>pom.xml</property></emphasis> files added: projectname, projectname-ear,
- projectname-ejb, projectname-parent and projectname-test.</para>
- <figure>
- <title>Mavenized Seam Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_mavenized_seam/mavenizedProjectStructure.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section id="import_maven_project">
- <title>Existing Maven Projects Import</title>
- <para>Maven Integration includes the Seam Maven configurator which is called when importing
- a project, changing <emphasis>
- <property>pom.xml</property></emphasis> and/or calling <emphasis>
- <property>Maven > Update Project Configuration</property>.</emphasis> When
- importing a Maven Seam project, the Seam Maven configurator picks up the settings set up
- in <emphasis>
- <property>pom.xml</property></emphasis> and adds to the project the
- following:</para>
- <itemizedlist>
- <listitem>
- <para>Seam nature</para>
- </listitem>
- <listitem>
- <para>Seam facet and dependent facets to the EJB, EAR and WAR projects</para>
- </listitem>
- <listitem>
- <para>JBoss Maven Integration facet if the Maven project contains a dependency with
- the org.jboss.seam groupId and an artifactId starting with 'jboss-seam'</para>
- </listitem>
- <listitem>
- <para>other required facets (Web Module, Java, JSF, etc.)</para>
- </listitem>
- </itemizedlist>
- <para>If the Seam version from <emphasis>
- <property>pom.xml</property></emphasis> matches a version of a Seam runtime
- configured in the workspace, Seam configurator will set that runtime, otherwise no Seam
- runtime will be set and you'll have to set it manually under <xref
- linkend="project_pref"/>.</para>
- <para>Seam configurator recognizes the Seam artifacts in the following way: the view folder
- is a web content folder from the WAR project, the source folder is the first Eclipse
- source folder. If there is a folder containing "hot" in the name, it will be
- chosen as the action source folder. Package is the first package that has children or
- doesn't have any subpackage. </para>
- <para>Configuring the Seam when importing a Maven project as well as a Seam Runtime, Seam
- artifacts and some facets could be suspended in the JBoss Maven Integration preferences
- (<emphasis>
- <property>Window > Preferences > JBoss Tools > JBoss Maven
- Integration</property></emphasis>).</para>
- <figure>
- <title>JBoss Maven Integration Preferences</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/create_mavenized_seam/configure_maven_integration.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section>
- <title>Relevant Resources Links</title>
- <para>In the <ulink url="http://in.relation.to/Bloggers/UsingMavenWithJBossTools">Using
- Maven with JBoss Tools</ulink> article written by Max Andersen you'll find
- references to the screencasts on how to use the examples of mavenized Seam projects
- provided by <property>JBoss Tools</property>.</para>
- </section>
-</chapter>
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="mavenized_seam">
+<?dbhtml filename="create_mavenized_seam.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+
+ <keyword>Seam</keyword>
+
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Maven Integration for Seam Projects</title>
+ <para>
+ Starting from 3.1 M2 version <property>JBoss Tools</property> includes new Jboss Maven Integration plug-in which for now allows to create mavenized Seam projects and enable Seam tools support for imported Maven projects.
+ </para>
+
+ <para>
+ The Jboss Maven Integration requires <ulink url="http://m2eclipse.sonatype.org/"
+ >m2eclipse</ulink> to be installed.
+ </para>
+
+ <note>
+ <title>Note:</title>
+ <para>
+ For M2 release of <property>Jboss Tools</property> it is important to use m2eclipse <ulink url="http://m2eclipse.sonatype.org/update/">stable updatesite</ulink> or the <ulink url="http://m2eclipse.sonatype.org/releases/0.9.9.200906081351">latest integration build</ulink> that M2 was developed against. If you want to use the latest development release of m2eclipse you need to use the <ulink
+ url="http://download.jboss.org/jbosstools/updates/nightly/trunk/">nightly builds</ulink> of <property>JBoss Tools</property>.
+ </para>
+ </note>
+
+ <section id="create_mavenized_project">
+ <title>Creating Maven ready Seam project</title>
+ <para>
+ Maven Integration makes the Seam Wizard capable of creating Maven ready projects to let Maven get the libraries instead of using the Seam runtime.
+ </para>
+
+ <para>
+ To create a mavenized Seam project you should perform the following steps:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Navigate to <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New Seam Project.</guimenuitem></menuchoice> Give the project a meaningful name, specify a target runtime and server and select the proper configuration for your Seam project:
+ </para>
+
+ <figure>
+ <title>Starting the Mavenized Seam Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/create_mavenized_seam/createMavenizedSeamProject.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click the <emphasis> <property>Modify</property></emphasis> button to enable the <emphasis> <property>Jboss Maven Integration</property></emphasis> facet:
+ </para>
+
+ <figure>
+ <title>Enabling the Jboss Maven Integration Facet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/create_mavenized_seam/jbossMavenIntegrationFacet.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>
+ On the <property>JBoss M2 capabilities</property> page you'll be prompted to add the following maven properties: groupId, artifactId, version, packaging, name and description. Here it's possible to set a maven version of Seam and also decide whether to remove WTP classpath containers (where the path starts with org.eclipse.jst).
+ </para>
+
+ <figure>
+ <title>Adjusting JBoss M2 Capabilities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/create_mavenized_seam/jbossM2capabilities.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>
+ On the <property>JSF Capabilities</property> page you can choose Maven as libraries provider. This is possible when you use Maven JSF 1.2 Libraries as type of JSF Implementing Library. Also it gives you capability to edit Dependencies and Exclusions for the mavenized Seam project directly from the wizard.
+ </para>
+
+ <figure>
+ <title>Using JSF Implementation libraries provided by Maven</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/create_mavenized_seam/seamJSFImplementation.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>
+ On the <property>Seam Facet</property> page configure the Seam Facet settings and click <emphasis> <property>Finish</property>:</emphasis>
+ </para>
+
+ <figure>
+ <title>Seam Facet Settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_mavenized_seam/seamFacetPage.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ The organized Seam project contains five projects with the Maven nature, builder, Maven classpath and the <emphasis> <property>pom.xml</property></emphasis> files added: projectname, projectname-ear, projectname-ejb, projectname-parent and projectname-test.
+ </para>
+
+ <figure>
+ <title>Mavenized Seam Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_mavenized_seam/mavenizedProjectStructure.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="import_maven_project">
+ <title>Existing Maven Projects Import</title>
+ <para>
+ Maven Integration includes the Seam Maven configurator which is called when importing a project, changing <emphasis> <property>pom.xml</property></emphasis> and/or calling <menuchoice><guimenuitem>Maven</guimenuitem><guimenuitem>Update Project Configuration.</guimenuitem></menuchoice> When importing a Maven Seam project, the Seam Maven configurator picks up the settings set up in <emphasis> <property>pom.xml</property></emphasis> and adds to the project the following:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Seam nature
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Seam facet and dependent facets to the EJB, EAR and WAR projects
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ JBoss Maven Integration facet if the Maven project contains a dependency with the org.jboss.seam groupId and an artifactId starting with 'jboss-seam'
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ other required facets (Web Module, Java, JSF, etc.)
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ If the Seam version from <emphasis> <property>pom.xml</property></emphasis> matches a version of a Seam runtime configured in the workspace, Seam configurator will set that runtime, otherwise no Seam runtime will be set and you'll have to set it manually under <xref
+ linkend="project_pref"/>.
+ </para>
+
+ <para>
+ Seam configurator recognizes the Seam artifacts in the following way: the view folder is a web content folder from the WAR project, the source folder is the first Eclipse source folder. If there is a folder containing "hot" in the name, it will be chosen as the action source folder. Package is the first package that has children or doesn't have any subpackage.
+ </para>
+
+ <para>
+ Configuring the Seam when importing a Maven project as well as a Seam Runtime, Seam artifacts and some facets could be suspended in the JBoss Maven Integration preferences (<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>JBoss Maven Integration</guimenuitem></menuchoice>).
+ </para>
+
+ <figure>
+ <title>JBoss Maven Integration Preferences</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/create_mavenized_seam/configure_maven_integration.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section>
+ <title>Relevant Resources Links</title>
+ <para>
+ In the <ulink url="http://in.relation.to/Bloggers/UsingMavenWithJBossTools">Using Maven with JBoss Tools</ulink> article written by Max Andersen you'll find references to the screencasts on how to use the examples of mavenized Seam projects provided by <property>JBoss Tools</property>.
+ </para>
+ </section>
+</chapter>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_new_seam.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_new_seam.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_new_seam.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,477 +1,556 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="create_seam" role="updated">
- <?dbhtml filename="create_new_seam.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Seam</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
- <title>Creating a New Seam Project via the New Seam Project wizard</title>
- <para>In this chapter we provide you with the necessary steps to start working with Seam
- Framework.</para>
- <para>At first, we suggest to set the specific Seam perspective that combines a number of
- different views and editors needed for work with resources concerned. For that select
- <emphasis>
- <property>Window > Open Perspective > Other > Seam</property>
- </emphasis> or you can also access it through the button in the right top corner.</para>
+<?dbhtml filename="create_new_seam.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+
+ <keyword>Seam</keyword>
+
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Creating a New Seam Project via the New Seam Project wizard</title>
+ <para>
+ In this chapter we provide you with the necessary steps to start working with Seam Framework.
+ </para>
+
+ <para>
+ At first, we suggest to set the specific Seam perspective that combines a number of different views and editors needed for work with resources concerned. For that select <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Seam</guimenuitem></menuchoice> or you can also access it through the button in the right top corner.
+ </para>
+
+ <figure>
+ <title>Seam Perspective Icon</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_0.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Also the <emphasis> <property>Open Web Browser</property></emphasis> action is directly available in the <property>Seam perspective</property>.
+ </para>
+
+ <figure>
+ <title>Embedded Web Browser Button</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_01.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <section id="standaloneSeam" role="updated">
+ <title>Create standalone Seam Web Project</title>
+ <para>
+ The best way to get started with Seam is to create a simple Seam Project and experiment with it.
+ </para>
+
+ <para>
+ Thus, you should select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Web Project</guimenuitem></menuchoice> to run the <property>New Seam Project</property> wizard. The wizard form allows you to create runtime and server instances in order to get started creating, running, and debugging J2EE (only) applications.
+ </para>
+
+ <para>
+ Seam Web Project wizard has an option for selecting the actual Server (not just WTP runtime) that will be used for the project. This allows the wizard to identify correctly where the required datasource and driver libraries need to go.
+ </para>
+
+ <para>
+ Let's get through the wizard step-by-step. First, you should enter a name and a location directory for your new project.
+ </para>
+
+ <figure id="figure_create_seam1">
+ <title>New Seam Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ On the figure above you can see the runtime and the server already created.
+ </para>
+
+ <para>
+ If you need to create a new runtime, click on the <emphasis> <property>New...</property> </emphasis> button in the <property>Target Runtime</property> section. It brings up the wizard where you can specify a new JBoss Server Runtime environment or the other type of runtime appropriate for your project configuration. Let's create one more JBoss 4.2 Runtime. Hence, after choosing it click on <emphasis> <property>Next</property> </emphasis> button.
+ </para>
+
<figure>
- <title>Seam Perspective Icon</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_0.png"/>
- </imageobject>
- </mediaobject>
+ <title>Specifying Target Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_2.png"/>
+ </imageobject>
+ </mediaobject>
</figure>
- <para>Also the <emphasis>
- <property>Open Web Browser</property></emphasis> action is directly available in the
- <property>Seam perspective</property>.</para>
+
+ <para>
+ All what you need here is to name runtime, type the path to its install directory or locate it by using <emphasis> <property>Browse</property> </emphasis> button, select a Java Runtime Environment, and select which configuration you want.
+ </para>
+
<figure>
- <title>Embedded Web Browser Button</title>
+ <title>Specifying Target Runtime Configurations</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Clicking on <emphasis> <property>Finish</property> </emphasis> returns you to the <xref linkend="figure_create_seam1"/>.
+ </para>
+
+ <para>
+ The next step is to define a Server by clicking on <emphasis> <property>New...</property> </emphasis> button in the <property>Target Server</property> section. In appeared <property>New Server dialog</property> the last server which matches the runtime will be selected.
+ </para>
+
+ <para>
+ All declared runtimes are listed in the combobox under the servers view. Here, you can indicate a server runtime that you need. Click <emphasis> <property>Add</property> </emphasis> if you want to add a new Server Runtime.
+ </para>
+
+ <figure>
+ <title>Specifying Target Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Next page allows you to verify the information for a chosen server. Leave everything as it is and click on <emphasis> <property>Next</property> </emphasis>.
+ </para>
+
+ <figure>
+ <title>JBoss Runtime Summary</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ On the last wizard step you can modify your projects to configure them on the Server.
+ </para>
+
+ <figure>
+ <title>Project Modification for Configuring on the Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Once you have the Target Server defined click on <emphasis> <property>Finish</property> </emphasis> button to return to the first page of the <property>New Seam Project wizard</property>.
+ </para>
+
+ <note>
+ <title>Tip:</title>
+ <para>
+ We suggest that you look through the Application Server Manager Guide to find out more about runtimes and servers.
+ </para>
+ </note>
+
+ <figure>
+ <title>Completion of Runtime and Server Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The last section on this wizard step is <property>Configuration</property>. Here, you can select one of the predefined project configurations either associated with Seam 1.2, Seam 2.0 or with Seam 2.1. Furthermore, you can create your own configuration by pressing the <guibutton>Modify...</guibutton> button. It will open the dialog which allows to configure your own set of facets for adding extra functionality to your project.
+ </para>
+
+ <para>
+ Pass to the next section to find out more details on this dialog.
+ </para>
+ </section>
+
+ <section id="projectFacets">
+ <title>Selecting the Project Facets</title>
+ <para>
+ The <property>Project Facets wizard</property> allows you to enable or disable specific facets which define necessary features for the project. When you switch to this wizard form, all critical facets are already checked for the chosen Configuration.
+ </para>
+
+ <para>
+ Notice that this page of the wizard also allows you to set the necessary version for any facet.
+ </para>
+
+ <figure>
+ <title>Project Facets Selection</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Moreover, here you can specify your own preset of selected facets by checking needed ones in project facets window and clicking on <emphasis> <property>Save</property> </emphasis> button.
+ </para>
+
+ <figure>
+ <title>Specifying Custom Facet Preset</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_15.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ To see all available Server runtimes click on <property>Runtimes</property> tab on the left. You can create a new one using the <emphasis> <property>New</property> </emphasis> button. If more than one runtime is checked here, the <emphasis> <property>Make Primary</property> </emphasis> button won't be dimmed yet. Thus, you can make use of it to mark primary runtime.
+ </para>
+
+ <figure>
+ <title>Setting Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_16.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Clicking the <guibutton>OT</guibutton> button will bring you to the <property>Web Module</property> wizard form again.
+ </para>
+
+ <section id="seamWithJPA">
+ <title>Seam project with JPA facets</title>
+ <para>
+ For creating Seam project with JPA support you need to select<property> Java Persistent</property> facet on <property>Project Facets</property> page and click <property>OK</property>.
+ </para>
+
+ <para>
+ Then you should press <property>Next</property> and may leave the default value on <property>Java application building</property> page and <property>Web Module Settings</property> page.
+ </para>
+
+ <para>
+ After that you will see <property>JPA facet</property> page.
+ </para>
+
+ <figure>
+ <title>JPA Facet page</title>
<mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_01.png"/>
- </imageobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_16b.png"/>
+ </imageobject>
</mediaobject>
- </figure>
- <section id="standaloneSeam" role="updated">
- <title>Create standalone Seam Web Project</title>
- <para>The best way to get started with Seam is to create a simple Seam Project and
- experiment with it.</para>
- <para>Thus, you should select <emphasis>
- <property>File > New > Seam Web Project</property>
- </emphasis> to run the <property>New Seam Project</property> wizard. The wizard form
- allows you to create runtime and server instances in order to get started creating,
- running, and debugging J2EE (only) applications.</para>
- <para>Seam Web Project wizard has an option for selecting the actual Server (not just WTP
- runtime) that will be used for the project. This allows the wizard to identify correctly
- where the required datasource and driver libraries need to go.</para>
- <para>Let's get through the wizard step-by-step. First, you should enter a name and a
- location directory for your new project.</para>
- <figure id="figure_create_seam1">
- <title>New Seam Project Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On the figure above you can see the runtime and the server already created.</para>
- <para>If you need to create a new runtime, click on the <emphasis>
- <property>New...</property>
- </emphasis> button in the <property>Target Runtime</property> section. It brings up the
- wizard where you can specify a new JBoss Server Runtime environment or the other type of
- runtime appropriate for your project configuration. Let's create one more JBoss 4.2
- Runtime. Hence, after choosing it click on <emphasis>
- <property>Next</property>
- </emphasis> button.</para>
- <figure>
- <title>Specifying Target Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>All what you need here is to name runtime, type the path to its install directory or
- locate it by using <emphasis>
- <property>Browse</property>
- </emphasis> button, select a Java Runtime Environment, and select which configuration
- you want.</para>
- <figure>
- <title>Specifying Target Runtime Configurations</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para> Clicking on <emphasis>
- <property>Finish</property>
- </emphasis> returns you to the <xref linkend="figure_create_seam1"/>.</para>
- <para>The next step is to define a Server by clicking on <emphasis>
- <property>New...</property>
- </emphasis> button in the <property>Target Server</property> section. In appeared
- <property>New Server dialog</property> the last server which matches the runtime
- will be selected.</para>
- <para>All declared runtimes are listed in the combo-box under the servers view. Here, you
- can indicate a server runtime that you need. Click <emphasis>
- <property>Add</property>
- </emphasis> if you want to add a new Server Runtime.</para>
- <figure>
- <title>Specifying Target Server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Next page allows you to verify the information for a chosen server. Leave everything
- as it is and click on <emphasis>
- <property>Next</property>
- </emphasis>.</para>
- <figure>
- <title>JBoss Runtime Summary</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On the last wizard step you can modify your projects to configure them on the
- Server.</para>
- <figure>
- <title>Project Modification for Configuring on the Server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Once you have the Target Server defined click on <emphasis>
- <property>Finish</property>
- </emphasis> button to return to the first page of the <property>New Seam Project
- wizard</property>.</para>
- <note>
- <title>Tip:</title>
- <para>We suggest that you look through the Application Server Manager Guide to
- find out more about runtimes and servers.</para>
- </note>
- <figure>
- <title>Completion of Runtime and Server Configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The last section on this wizard step is <property>Configuration</property>. Here, you
- can select one of the pre-defined project configurations either associated with Seam
- 1.2, Seam 2.0 or with Seam 2.1. Furthermore, you can create your own configuration by
- pressing the <emphasis>
- <property>Modify...</property>
- </emphasis> button. It will open the dialog which allows to configure your own set of
- facets for adding extra functionality to your project.</para>
- <para>Pass to the next section to find out more details on this dialog.</para>
- </section>
- <section id="projectFacets">
- <title>Selecting the Project Facets</title>
- <para>The <property>Project Facets wizard</property> allows you to enable or disable
- specific facets which define necessary features for the project. When you switch to this
- wizard form, all critical facets are already checked for the chosen
- Configuration.</para>
- <para>Notice that this page of the wizard also allows you to set the necessary version for
- any facet. </para>
- <figure>
- <title>Project Facets Selection</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_8.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Moreover, here you can specify your own preset of selected facets by checking needed
- ones in project facets window and clicking on <emphasis>
- <property>Save</property>
- </emphasis> button.</para>
- <figure>
- <title>Specifying Custom Facet Preset</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_15.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>To see all available Server runtimes click on <property>Runtimes</property> tab on the
- left. You can create a new one using the <emphasis>
- <property>New</property>
- </emphasis> button. If more than one runtime is checked here, the <emphasis>
- <property>Make Primary</property>
- </emphasis> button won't be dimmed yet. Thus, you can make use of it to mark
- primary runtime.</para>
- <figure>
- <title>Setting Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_16.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para><emphasis>
- <property>Ok</property>
- </emphasis> button will bring you to the <property>Web Module</property> wizard form
- again.</para>
- <section id="seamWithJPA">
- <title>Seam project with JPA facets</title>
- <para>For creating Seam project with JPA support you need to select<property> Java
- Persistent</property> facet on <property>Project Facets</property> page and
- click <property>OK</property>.</para>
- <para>Then you should press <property>Next</property> and may leave the default value on
- <property>Java application building</property> page and <property>Web Module
- Settings</property> page.</para>
- <para>After that you will see <property>JPA facet</property> page.</para>
- <figure>
- <title>JPA Facet page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_16b.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On this page you can choose <property>Platform</property> (vendor-specific JPA
- implementation) for your project, type of JPA Implementation, and configure the
- <property>Connection</property> to database in the <property
- >Connection</property> area.</para>
- <para>More about <property>JPA facet</property> page you can read in <ulink
+ </figure>
+
+ <para>
+ On this page you can choose <property>Platform</property> (vendor-specific JPA implementation) for your project, type of JPA Implementation, and configure the <property>Connection</property> to database in the <property
+ >Connection</property> area.
+ </para>
+
+ <para>
+ More about <property>JPA facet</property> page you can read in <ulink
url="http://help.eclipse.org/galileo/index.jsp?topic=/org.eclipse.jpt.doc.user..."
- >Eclipse documentation</ulink>. </para>
- <para>On the next step you will see <property>JSF Capabilities</property> and <property>Seam
- facet</property> pages, which are mostly the same as in general Seam
- project.</para>
- </section>
+ >Eclipse documentation</ulink>.
+ </para>
+
+ <para>
+ On the next step you will see <property>JSF Capabilities</property> and <property>Seam facet</property> pages, which are mostly the same as in general Seam project.
+ </para>
</section>
- <section id="configureJava">
- <title>Java application building configuration</title>
- <para>With this wizard you can define Java source directories which will be generated on
- build path. Also you can specify a default output folder. If you are agree with default
- values, press <property>Next</property></para>
- <figure>
- <title>Java application building Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_16a.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section id="configureWebModule">
- <title>How to Configure Web Module Settings</title>
- <para> As we deal with a Dynamic Web Application, we should at first specify the top level
- directory of our application for deploying it to a server afterwards. You know, this
- kind of application contains Web resources. Thus, it's important to indicate the content
- directory. The wizard will put all those values itself, so you can leave everything as
- is.</para>
- <figure>
- <title>Web Module Settings</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_9.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Choose <emphasis>
- <property>Next</property>
- </emphasis> to switch to the next wizard form.</para>
- </section>
- <section id="addJSFCapab">
- <title>Adding JSF Capabilities</title>
- <para>This wizard helps you to add JSF capabilities to your project. </para>
- <para>Choose <emphasis>
- <property>Library provided by Target Runtime</property>
- </emphasis> from Library Type list if you'd like to use a default JSF implementation
- given by the present runtime.</para>
- <figure>
- <title>Adding JSF Capabilities to Web Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_10.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>In case if you prefer to use your custom JSF implementation, choose <property>User
- Library</property> Item from Library Type list. In User Library list you can check
- required library.</para>
- <figure>
- <title>Using Custom JSF implementation Library </title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_17.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para> If a new library is required, click <property>Manage libraries...</property> (
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_17a.png"/>
- </imageobject>
- </inlinemediaobject>) button. Then you should click <property>New</property>.</para>
- <figure>
- <title>Using Custom JSF implementation Library </title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_18.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para> Here, it's necessary to type a <property>Library Name</property>. </para>
- <figure>
- <title>Entering New User Library Name</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_23.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>To add proper <property>Library JARs</property>, click <property>Add
- JARs...</property> button and select the JARs on your hard drive. </para>
- <figure>
- <title>Selection Library JARs</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_25.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>You can download necessary JSF implementation libraries provided by Sun and Apache
- Foundation as well. Click <property>Download...</property> (<inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_23a.png"/>
- </imageobject>
- </inlinemediaobject>) button and choose one of proposed libraries.</para>
- <figure>
- <title>Download JSF Implementation Library</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_24.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The last wizard options allows to edit a path for <property>JSF Configuration
- File</property>, a name for <property>JSF Servlet</property>, <property>JSF Servlet
- Classname</property> and change <property>URL Mapping Patterns</property>.</para>
- <figure>
- <title>JSF Capabilities Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_19.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Since we are arranging the Seam Web project, the last step we should do is to adjust
- project configurations associated with the Seam.</para>
- </section>
- <section id="seamFacet">
- <title>Configure Seam Facet Settings</title>
- <para>The last wizard step is related to Seam facet and allows you to do the
- following:</para>
- <figure>
- <title>Seam Facet Settings</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_11.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Create Seam runtime and define Seam home folder.</para>
- </listitem>
- </itemizedlist>
- <para>For that click on <emphasis>
- <property>Add</property>
- </emphasis> button in the <property>General</property> section. Note, in the wizard
- shown below you can create a Seam runtime only for the version that was selected in the
- <xref linkend="projectFacets"/> wizard (version 1.2 in our
- case).</para>
- <figure>
- <title>Seam Runtime Creation</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_12.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Select EAR or WAR deployment by checking a necessary radio button.</para>
- </listitem>
- <listitem>
- <para>Enter EJB project name and EAR project name in case of EAR radio button is checked.</para>
- </listitem>
- </itemizedlist>
-
- <note>
- <title>Tip:</title>
- <para>If you want to name your web project "MyProject-war" note that the EJB project should not be "MyProject-war-ejb",
- it should be "MyProject-ejb". The same for EAR and Test projects' names. They should be respectively "MyProject-ear"
- and "MyProject-test".</para>
- </note>
-
- <itemizedlist>
- <listitem>
- <para>Select a <emphasis>
- <property>Database Type</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Database Type Selecting</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_20.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>and then specify a <emphasis>
- <property>Connection profile</property>
- </emphasis> appropriate for your database.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Connection Profile Options</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_21.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>You can edit chosen profile by using <emphasis>
- <property>Edit</property>
- </emphasis> button or organise a new one by clicking on <emphasis>
- <property>New</property>
- </emphasis> button and selecting necessary for you type of connection profile.</para>
- <figure>
- <title>Connection Profile Selecting</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_13.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On the dialog you'll be asked to enter its name and description. And then you
- should select a proper driver and adjust connection details. Press <emphasis>
- <property>Next</property>
- </emphasis> to preview all the adjusted settings and complete the creation of the new
- profile.</para>
- <figure>
- <title>Connection Details</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_22.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The next block of settings in the Seam Facet wizard are describing a Database and a
- connection to it.</para>
- <para>In the <property>Code Generation</property> section the wizard has already provided
- the names for your <property>Session Bean</property>, <property>Entity Bean</property>
- and <property>Test</property> packages generation (optional). Of course, you can change
- them on others of your choice.</para>
- <figure>
- <title>Code Generation Section</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_14.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on <emphasis>
- <property>Finish</property>
- </emphasis> to generate a project.</para>
- <para/>
- </section>
-</chapter>
\ No newline at end of file
+ </section>
+
+ <section id="configureJava">
+ <title>Java application building configuration</title>
+ <para>
+ With this wizard you can define Java source directories which will be generated on build path. Also you can specify a default output folder. If you are agree with default values, press <property>Next</property>
+ </para>
+
+ <figure>
+ <title>Java application building Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_16a.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="configureWebModule">
+ <title>How to Configure Web Module Settings</title>
+ <para>
+ As we deal with a Dynamic Web Application, we should at first specify the top level directory of our application for deploying it to a server afterwards. You know, this kind of application contains Web resources. Thus, it's important to indicate the content directory. The wizard will put all those values itself, so you can leave everything as is.
+ </para>
+
+ <figure>
+ <title>Web Module Settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_9.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Choose <emphasis> <property>Next</property> </emphasis> to switch to the next wizard form.
+ </para>
+ </section>
+
+ <section id="addJSFCapab">
+ <title>Adding JSF Capabilities</title>
+ <para>
+ This wizard helps you to add JSF capabilities to your project.
+ </para>
+
+ <para>
+ Choose <emphasis> <property>Library provided by Target Runtime</property> </emphasis> from Library Type list if you'd like to use a default JSF implementation given by the present runtime.
+ </para>
+
+ <figure>
+ <title>Adding JSF Capabilities to Web Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_10.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ In case if you prefer to use your custom JSF implementation, choose <property>User Library</property> Item from Library Type list. In User Library list you can check required library.
+ </para>
+
+ <figure>
+ <title>Using Custom JSF implementation Library </title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_17.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ If a new library is required, click <property>Manage libraries...</property> (
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_17a.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ ) button. Then you should click <property>New</property>.
+ </para>
+
+ <figure>
+ <title>Using Custom JSF implementation Library </title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_18.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Here, it's necessary to type a <property>Library Name</property>.
+ </para>
+
+ <figure>
+ <title>Entering New User Library Name</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_23.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ To add proper <property>Library JARs</property>, click <property>Add JARs...</property> button and select the JARs on your hard drive.
+ </para>
+
+ <figure>
+ <title>Selection Library JARs</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_25.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ You can download necessary JSF implementation libraries provided by Sun and Apache Foundation as well. Click <property>Download...</property> (
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_23a.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ ) button and choose one of proposed libraries.
+ </para>
+
+ <figure>
+ <title>Download JSF Implementation Library</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_24.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The last wizard options allows to edit a path for <property>JSF Configuration File</property>, a name for <property>JSF Servlet</property>, <property>JSF Servlet Classname</property> and change <property>URL Mapping Patterns</property>.
+ </para>
+
+ <figure>
+ <title>JSF Capabilities Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_19.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Since we are arranging the Seam Web project, the last step we should do is to adjust project configurations associated with the Seam.
+ </para>
+ </section>
+
+ <section id="seamFacet">
+ <title>Configure Seam Facet Settings</title>
+ <para>
+ The last wizard step is related to Seam facet and allows you to do the following:
+ </para>
+
+ <figure>
+ <title>Seam Facet Settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_11.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Create Seam runtime and define Seam home folder.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ For that click on <emphasis> <property>Add</property> </emphasis> button in the <property>General</property> section. Note, in the wizard shown below you can create a Seam runtime only for the version that was selected in the <xref linkend="projectFacets"/> wizard (version 1.2 in our case).
+ </para>
+
+ <figure>
+ <title>Seam Runtime Creation</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_12.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Select EAR or WAR deployment by checking a necessary radio button.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Enter EJB project name and EAR project name in case of EAR radio button is checked.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <note>
+ <title>Tip:</title>
+ <para>
+ If you want to name your web project "MyProject-war" note that the EJB project should not be "MyProject-war-ejb", it should be "MyProject-ejb". The same for EAR and Test projects' names. They should be respectively "MyProject-ear" and "MyProject-test".
+ </para>
+ </note>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Select a <emphasis> <property>Database Type</property> </emphasis>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Database Type Selecting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_20.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ and then specify a <emphasis> <property>Connection profile</property> </emphasis> appropriate for your database.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Connection Profile Options</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_21.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ You can edit chosen profile by using <emphasis> <property>Edit</property> </emphasis> button or organize a new one by clicking on <emphasis> <property>New</property> </emphasis> button and selecting necessary for you type of connection profile.
+ </para>
+
+ <figure>
+ <title>Connection Profile Selecting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_13.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ On the dialog you'll be asked to enter its name and description. And then you should select a proper driver and adjust connection details. Press <emphasis> <property>Next</property> </emphasis> to preview all the adjusted settings and complete the creation of the new profile.
+ </para>
+
+ <figure>
+ <title>Connection Details</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_22.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The next block of settings in the Seam Facet wizard are describing a Database and a connection to it.
+ </para>
+
+ <para>
+ In the <property>Code Generation</property> section the wizard has already provided the names for your <property>Session Bean</property>, <property>Entity Bean</property> and <property>Test</property> packages generation (optional). Of course, you can change them on others of your choice.
+ </para>
+
+ <figure>
+ <title>Code Generation Section</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_14.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Click on <emphasis> <property>Finish</property> </emphasis> to generate a project.
+ </para>
+
+ <para/>
+ </section>
+</chapter>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_application_walkthrough.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_application_walkthrough.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_application_walkthrough.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,145 +1,162 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="crud_application_walkthrough">
- <?dbhtml filename="crud_application_walkthrough.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Java</keyword>
- <keyword>CRUD</keyword>
- <keyword>JBoss AS</keyword>
- </keywordset>
- </chapterinfo>
- <title>The CRUD Application Walkthrough</title>
- <para>After you familiarized oneself with example of creating the CRUD Database Application with
- Seam, you can read this charter.</para>
- <section>
- <title>Using CRUD Application</title>
- <para>To run your CRUD Application you should do the following steps:</para>
-
- <itemizedlist>
- <listitem>
- <para>Run a project on the Server. </para>
- </listitem>
- </itemizedlist>
-
- <para>On <emphasis>
- <property>Package Explorer View </property>
- </emphasis> right click on the <emphasis>
- <property>crudapp</property>
- </emphasis> project, select <emphasis><property> Run As > Run on
- Server</property>.</emphasis></para>
-
- <figure>
- <title>Run Project on Server</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/crud_application_walkthrough/crud_application_walkthrough_1.png"
- scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Select a Server and click <property>Finish</property></para>
-
- <figure>
- <title>Select a Server</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/crud_application_walkthrough/crud_application_walkthrough_3.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Home page of the <emphasis>
- <property>crudapp</property>
- </emphasis> project should appear in <emphasis>
- <property>Web Browser</property>
- </emphasis>.</para>
- <figure>
- <title>Home page</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/crud_application_walkthrough/crud_application_walkthrough_4.png"
- scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After that you can use CRUD application with
- <property>"employee"</property> database.</para>
-
- <para>You can use internal JBDS Web Browser or your external Web Browser with the same link
- (<ulink url="http://localhost:8080/crudapp/home.seam"
- >http://localhost:8080/crudapp/home.seam</ulink>). </para>
- <para>Click on the <emphasis>
- <property>Employees List</property>
- </emphasis> link and observe that data from <emphasis>
- <property>employee</property>
- </emphasis> database is displayed.</para>
- <figure>
- <title>Employees List Page</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/crud_application_walkthrough/crud_application_walkthrough_5.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Use <property>Employees search parameters</property> fields to filter the selected
- list.</para>
-
- <para> Press <property>Select</property> opposite one of employees.</para>
- <figure>
- <title>Employee details Page</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/crud_application_walkthrough/crud_application_walkthrough_6.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para> Press <property>Edit</property> to edit employee fields.</para>
- <para> Enter <emphasis>
- <property>Login</property>
- </emphasis> and <emphasis>
- <property>Password</property>
- </emphasis> to login. (Use
- <emphasis>"crudapp-user"/"secret"</emphasis> for
- example)</para>
-
- <figure>
- <title>Login page</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/crud_application_walkthrough/crud_application_walkthrough_7.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- <figure>
- <title>Edit Employee</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/crud_application_walkthrough/crud_application_walkthrough_8.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
- <para> Fill in <emphasis>
- <property>firstname</property>
- </emphasis> and press <property>Save</property>.</para>
- <para> Database will be updated.</para>
- </section>
-</chapter>
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="crud_application_walkthrough">
+<?dbhtml filename="crud_application_walkthrough.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+
+ <keyword>Eclipse</keyword>
+
+ <keyword>Java</keyword>
+
+ <keyword>CRUD</keyword>
+
+ <keyword>JBoss AS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>The CRUD Application Walkthrough</title>
+ <para>
+ After you familiarized oneself with example of creating the CRUD Database Application with Seam, you can read this charter.
+ </para>
+
+ <section>
+ <title>Using CRUD Application</title>
+ <para>
+ To run your CRUD Application you should do the following steps:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Run a project on the Server.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ On <emphasis> <property>Package Explorer View </property> </emphasis> right click on the <emphasis> <property>crudapp</property> </emphasis> project, select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run on Server.</guimenuitem></menuchoice>
+ </para>
+
+ <figure>
+ <title>Run Project on Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/crud_application_walkthrough/crud_application_walkthrough_1.png"
+ scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Select a Server and click <property>Finish</property>
+ </para>
+
+ <figure>
+ <title>Select a Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/crud_application_walkthrough/crud_application_walkthrough_3.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Home page of the <emphasis> <property>crudapp</property> </emphasis> project should appear in <emphasis> <property>Web Browser</property> </emphasis>.
+ </para>
+
+ <figure>
+ <title>Home page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/crud_application_walkthrough/crud_application_walkthrough_4.png"
+ scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ After that you can use CRUD application with <property>"employee"</property> database.
+ </para>
+
+ <para>
+ You can use internal JBDS Web Browser or your external Web Browser with the same link (<ulink url="http://localhost:8080/crudapp/home.seam"
+ >http://localhost:8080/crudapp/home.seam</ulink>).
+ </para>
+
+ <para>
+ Click on the <emphasis> <property>Employees List</property> </emphasis> link and observe that data from <emphasis> <property>employee</property> </emphasis> database is displayed.
+ </para>
+
+ <figure>
+ <title>Employees List Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/crud_application_walkthrough/crud_application_walkthrough_5.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Use <property>Employees search parameters</property> fields to filter the selected list.
+ </para>
+
+ <para>
+ Press <property>Select</property> opposite one of employees.
+ </para>
+
+ <figure>
+ <title>Employee details Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/crud_application_walkthrough/crud_application_walkthrough_6.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Press <property>Edit</property> to edit employee fields.
+ </para>
+
+ <para>
+ Enter <emphasis> <property>Login</property> </emphasis> and <emphasis> <property>Password</property> </emphasis> to login. (Use <emphasis>"crudapp-user"/"secret"</emphasis> for example)
+ </para>
+
+ <figure>
+ <title>Login page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/crud_application_walkthrough/crud_application_walkthrough_7.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <figure>
+ <title>Edit Employee</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/crud_application_walkthrough/crud_application_walkthrough_8.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Fill in <emphasis> <property>firstname</property> </emphasis> and press <property>Save</property>.
+ </para>
+
+ <para>
+ Database will be updated.
+ </para>
+ </section>
+</chapter>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_database_application.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_database_application.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_database_application.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,530 +1,486 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="crud_database_application">
- <?dbhtml filename="crud_database_application.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Java</keyword>
- <keyword>CRUD</keyword>
- <keyword>Database Application</keyword>
- </keywordset>
- </chapterinfo>
- <title>Generate a CRUD Database Application</title>
- <section>
- <title>What is CRUD?</title>
+<?dbhtml filename="crud_database_application.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+
+ <keyword>Eclipse</keyword>
+
+ <keyword>Java</keyword>
+
+ <keyword>CRUD</keyword>
+
+ <keyword>Database Application</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Generate a CRUD Database Application</title>
+ <section>
+ <title>What is CRUD?</title>
+ <para>
+ <property>CRUD</property> is an acronym for the four basic types of SQL commands: <emphasis> <property>Create</property> </emphasis>, <emphasis> <property>Read</property> </emphasis>, <emphasis> <property>Update</property> </emphasis>, <emphasis> <property>Delete</property> </emphasis>. Most applications have some kind of <property>CRUD</property> functionality, and we can assume that every programmer had to deal with <property>CRUD</property> at some point. A <property>CRUD</property> application is one that uses forms to get data into and out of a database.
+ </para>
+
+ <para>
+ In the next section we will create a Seam Web application, connect it to the <ulink url="http://www.hsqldb.org/">HSQL</ulink> database and add <property>CRUD</property> support.
+ </para>
+ </section>
+
+ <section>
+ <title>How to create the CRUD Database Application with Seam</title>
+ <itemizedlist>
+ <listitem>
<para>
- <property>CRUD</property> is an acronym for the four basic types of SQL commands: <emphasis>
- <property>Create</property>
- </emphasis>, <emphasis>
- <property>Read</property>
- </emphasis>, <emphasis>
- <property>Update</property>
- </emphasis>, <emphasis>
- <property>Delete</property>
- </emphasis>. Most applications have some kind of <property>CRUD</property>
- functionality, and we can assume that every programmer had to deal with
- <property>CRUD</property> at some point. A <property>CRUD</property> application is
- one that uses forms to get data into and out of a database. </para>
- <para> In the next section we will create <xref linkend="intro"/> Web application,
- connect it to the <ulink url="http://www.hsqldb.org/">HSQL</ulink> database and add
- <property>CRUD</property> support. </para>
- </section>
-
- <section>
- <title>How to create the CRUD Database Application with Seam</title>
-
- <itemizedlist>
- <listitem>
- <para>First, you should <ulink url="http://docs.jboss.org/tools/resources/"
- >download</ulink> a database and start it by running <emphasis>
- <property>./runDBServer.sh</property>
- </emphasis> or <emphasis>
- <property>runDBServer.bat</property>
- </emphasis> from the database directory.</para>
- </listitem>
- <listitem>
- <para>Create a new Seam Web Project using <property>New Seam Project
- wizard</property> or main menu <emphasis><property>File > New > Seam Web
- Project</property>.</emphasis></para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Seam Web Project Creation</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ First, you should <ulink url="http://docs.jboss.org/tools/resources/"
+ >download</ulink> a database and start it by running <emphasis> <property>./runDBServer.sh</property> </emphasis> or <emphasis> <property>runDBServer.bat</property> </emphasis> from the database directory.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Create a new Seam Web Project using <property>New Seam Project wizard</property> or main menu <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Web Project.</guimenuitem></menuchoice>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Seam Web Project Creation</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_01.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Name your project as <emphasis>
- <property>crudapp</property>, </emphasis> specify Target Runtime, Server and
- Seam Runtime configuration. Then press <emphasis>
- <property>Next</property>
- </emphasis> and follow the next wizard steps keeping default settings.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>New Seam Project Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Name your project as <emphasis> <property>crudapp</property>, </emphasis> specify Target Runtime, Server and Seam Runtime configuration. Then press <emphasis> <property>Next</property> </emphasis> and follow the next wizard steps keeping default settings.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>New Seam Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_02.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Tip:</title>
- <para>Please have a look at <xref linkend="create_seam"/> how to create Target
- Runtime and Seam Runtime in order to get started creating, running, and debugging
- J2EE applications.</para>
- </note>
-
- <itemizedlist>
- <listitem>
- <para>On <emphasis>
- <property>Seam Facet</property>
- </emphasis> page click <emphasis>
- <property>New...</property>
- </emphasis> next to the <property>Connection profile</property> section to
- create a new <property>Connection profile</property>.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Seam Facet page</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Tip:</title>
+ <para>
+ Please have a look at <xref linkend="create_seam"/> how to create Target Runtime and Seam Runtime in order to get started creating, running, and debugging J2EE applications.
+ </para>
+ </note>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ On <emphasis> <property>Seam Facet</property> </emphasis> page click <emphasis> <property>New...</property> </emphasis> next to the <property>Connection profile</property> section to create a new <property>Connection profile</property>.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Seam Facet page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_03.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>On <property>New Connection Profile</property> dialog select the <emphasis>
- <property>HSQLDB</property>
- </emphasis> connection profile type, name it <emphasis>
- <property>cruddb</property>
- </emphasis> and click <emphasis>
- <property>Next</property>. </emphasis></para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>New JDBC Connection Profile</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ On <property>New Connection Profile</property> dialog select the <emphasis> <property>HSQLDB</property> </emphasis> connection profile type, name it <emphasis> <property>cruddb</property> </emphasis> and click <emphasis> <property>Next</property>. </emphasis>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>New JDBC Connection Profile</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_04.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>On the next page click the round icon next to the <emphasis>
- <property>Drivers</property>
- </emphasis> field to select a database driver.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>New JDBC Connection Profile Database Driver</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ On the next page click the round icon next to the <emphasis> <property>Drivers</property> </emphasis> field to select a database driver.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>New JDBC Connection Profile Database Driver</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_06.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Now you should see the <property>New Driver Definition</property> dialog. On
- the first tab select the <emphasis>
- <property>HSQLDB JBDC Driver</property>. </emphasis> Underneath in the <emphasis>
- <property>Driver name</property>
- </emphasis> field you can change its name if you need.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Database Driver Type</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Now you should see the <property>New Driver Definition</property> dialog. On the first tab select the <emphasis> <property>HSQLDB JBDC Driver</property>. </emphasis> Underneath in the <emphasis> <property>Driver name</property> </emphasis> field you can change its name if you need.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Database Driver Type</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_07.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>You may notice the note on the previous figure. It prompts that you should
- specify the driver of the type you pointed. Set the location of the driver by
- switching to the next tab and press <emphasis>
- <property>Add JAR/Zip</property>
- </emphasis> button.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Driver Definition</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ You may notice the note on the previous figure. It prompts that you should specify the driver of the type you pointed. Set the location of the driver by switching to the next tab and press <emphasis> <property>Add JAR/Zip</property> </emphasis> button.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Driver Definition</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_09.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>On the <property>Properties</property> tab set the
- <emphasis><property>Connection URL</property>,</emphasis>
- <emphasis>
- <property>Database Name</property>
- </emphasis> and <emphasis>
- <property>User ID</property>
- </emphasis> and click <emphasis>
- <property>OK</property>. </emphasis></para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>Driver Definitions Properties</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ On the <property>Properties</property> tab set the <emphasis><property>Connection URL</property>,</emphasis> <emphasis> <property>Database Name</property> </emphasis> and <emphasis> <property>User ID</property> </emphasis> and click <emphasis> <property>OK</property>. </emphasis>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Driver Definitions Properties</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_10.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>After clicking <emphasis>
- <property>OK</property>
- </emphasis> to submit the newly created driver you can observe and if you need
- edit all specified connection details.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Driver and Connection Details</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ After clicking <emphasis> <property>OK</property> </emphasis> to submit the newly created driver you can observe and if you need edit all specified connection details.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Driver and Connection Details</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_11.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Now click <emphasis>
- <property>Test Connection</property>
- </emphasis> to be sure that connection can be established.</para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>JDBC Connection is OK</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Now click <emphasis> <property>Test Connection</property> </emphasis> to be sure that connection can be established.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>JDBC Connection is OK</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_12.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Validate <emphasis>
- <property>JDBC Connection profile</property>
- </emphasis> settings and press <emphasis>
- <property>Finish</property>
- </emphasis> or <emphasis>
- <property>Back</property>
- </emphasis> if something is wrong.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Validate JDBC Connection settings</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Validate <emphasis> <property>JDBC Connection profile</property> </emphasis> settings and press <emphasis> <property>Finish</property> </emphasis> or <emphasis> <property>Back</property> </emphasis> if something is wrong.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Validate JDBC Connection settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_13.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>After clicking <emphasis>
- <property>Finish</property>
- </emphasis> two projects <emphasis>
- <property>crudapp</property>
- </emphasis> and <emphasis>
- <property>crudapp-test</property>
- </emphasis> will be created.</para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>CRUDAPP Seam Project</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ After clicking <emphasis> <property>Finish</property> </emphasis> two projects <emphasis> <property>crudapp</property> </emphasis> and <emphasis> <property>crudapp-test</property> </emphasis> will be created.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>CRUDAPP Seam Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_14.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Have a look at the created projects. You can expand
- <property>WEB_CONTENT</property> folder and open
- <property>home.xhtml</property> or <property>login.xhtml</property> with
- <property>JBoss Visual Editor</property>.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>login.xhtml in VPE</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Have a look at the created projects. You can expand <property>WEB_CONTENT</property> folder and open <property>home.xhtml</property> or <property>login.xhtml</property> with <property>JBoss Visual Editor</property>.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>login.xhtml in VPE</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_15.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Switch to <property>Database Development</property> perspective with <emphasis>
- <property>Window->Open Perspective->Other...</property>
- </emphasis> and connect to the <emphasis>
- <property>cruddb</property>
- </emphasis> database.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Connecting to the CRUDDB database</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Switch to <property>Database Development</property> perspective with <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other...</guimenuitem></menuchoice> and connect to the <emphasis> <property>cruddb</property> </emphasis> database.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Connecting to the CRUDDB database</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_16.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Expand <emphasis>
- <property>cruddb</property>
- </emphasis> nodes to view its <emphasis>
- <property>Schemas</property>, </emphasis>
- <emphasis>
- <property>Tables</property>, </emphasis>
- <emphasis>
- <property>Columns</property>
- </emphasis> etc.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>CRUDDB Database</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Expand <emphasis> <property>cruddb</property> </emphasis> nodes to view its <emphasis> <property>Schemas</property>, </emphasis> <emphasis> <property>Tables</property>, </emphasis> <emphasis> <property>Columns</property> </emphasis> etc.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>CRUDDB Database</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_17.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Switch back to the <property>Seam</property> perspective. From the toolbar
- select <emphasis>
- <property>New->Seam Generate Entities</property>
- </emphasis> to create a set of <property>CRUD</property> Seam components and web
- pages based on existing tables in the database. On the first page of <emphasis>
- <property>Generate Seam Entities</property>
- </emphasis> wizard keep everything by default and press <emphasis>
- <property>Next</property>. </emphasis></para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>Generate Seam Entities</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Switch back to the <property>Seam</property> perspective. From the toolbar select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Seam Generate Entities</guimenuitem></menuchoice> to create a set of <property>CRUD</property> Seam components and web pages based on existing tables in the database. On the first page of <emphasis> <property>Generate Seam Entities</property> </emphasis> wizard keep everything by default and press <emphasis> <property>Next</property>. </emphasis>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Generate Seam Entities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_18.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Click <emphasis>
- <property>Refresh</property></emphasis> to display all the tables from the
- database.</para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>Dialog for Selecting Tables</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Click <emphasis> <property>Refresh</property></emphasis> to display all the tables from the database.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Dialog for Selecting Tables</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_18a.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Now you can filter the tables. Use the <emphasis>
- <property>Include</property>
- </emphasis> button to include only necessary ones.</para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>Selecting Tables</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Now you can filter the tables. Use the <emphasis> <property>Include</property> </emphasis> button to include only necessary ones.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Selecting Tables</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_18b.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Under <emphasis>
- <property>WebContent</property>
- </emphasis> folder you can find all generated <property>xhtml</property>
- files:</para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>Entities Web Pages</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Under <emphasis> <property>WebContent</property> </emphasis> folder you can find all generated <property>xhtml</property> files:
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Entities Web Pages</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_19.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>And under <emphasis>
- <property>src</property>
- </emphasis> folder java classes are created.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Entities Java Classes</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ And under <emphasis> <property>src</property> </emphasis> folder java classes are created.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Entities Java Classes</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_20.png"
/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Switch to <property>Hibernate</property> perspective with <emphasis>
- <property>Window->Open Perspective->Other...</property>.
- </emphasis> On <property>Hibernate Configurations</property> view expand the <emphasis>
- <property>crudapp</property>
- </emphasis> configuration. Right click on <property>Customers</property> and
- select <emphasis>
- <property>Open Mapping Diagram</property>
- </emphasis> from the popup menu.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Hibernate Configurations View</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Switch to <property>Hibernate</property> perspective with <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other....</guimenuitem></menuchoice> On <property>Hibernate Configurations</property> view expand the <emphasis> <property>crudapp</property> </emphasis> configuration. Right click on <property>Customers</property> and select <emphasis> <property>Open Mapping Diagram</property> </emphasis> from the popup menu.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Hibernate Configurations View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_21.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Observe the <property>Mapping Diagram</property> opened in the editor. Here
- you can see the relations between models and database tables. For better
- navigating on the diagram use the <property>Outline view</property>.</para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>Mapping Diagram</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Observe the <property>Mapping Diagram</property> opened in the editor. Here you can see the relations between models and database tables. For better navigating on the diagram use the <property>Outline view</property>.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Mapping Diagram</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_22.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>For example, select <property>Customers</property> entity, right click and
- select <emphasis>
- <property>Open Source File</property>.
- </emphasis> This will open the <property>Customers.java</property> file in the
- java editor. You can also do this by right-clicking on the same entity on the
- <property>Mapping Diagram</property>.</para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>Entity class from Mapping Diagram</title>
- <mediaobject>
- <imageobject>
- <imagedata
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ For example, select <property>Customers</property> entity, right click and select <emphasis> <property>Open Source File</property>. </emphasis> This will open the <property>Customers.java</property> file in the java editor. You can also do this by right-clicking on the same entity on the <property>Mapping Diagram</property>.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Entity class from Mapping Diagram</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/crud_database_application/crud_database_application_23.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>So far, you are ready to deploy your application to JBoss Application Server. This
- is described in the next chapter.</para>
-
- </section>
-
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ So far, you are ready to deploy your application to JBoss Application Server. This is described in the next chapter.
+ </para>
+ </section>
</chapter>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/directory_structure.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/directory_structure.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/directory_structure.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,230 +1,197 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="directory_str">
- <?dbhtml filename="directory_structure.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Seam</keyword>
- <keyword>Eclipse</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Directory Structure of the Generated Project</title>
-
- <para>In this chapter we describe where the Seam wizard puts the generated files for both EAR
- and WAR deployments.</para>
- <para>The Seam Project wizard generates projects like Eclipse WTP style in order to utilize
- Eclipse WTP features and to have a correct classpath. To be more precise it generates one
- project per artifact.</para>
-
- <section id="WAR">
- <title>WAR Deployment</title>
-
- <para>The project layout for WAR projects is:</para>
-
- <figure>
- <title>Project Layout for WAR projects</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/directory_structure/directory_structure_1.png"
+<?dbhtml filename="directory_structure.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+
+ <keyword>Seam</keyword>
+
+ <keyword>Eclipse</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Directory Structure of the Generated Project</title>
+ <para>
+ In this chapter we describe where the Seam wizard puts the generated files for both EAR and WAR deployments.
+ </para>
+
+ <para>
+ The Seam Project wizard generates projects like Eclipse WTP style in order to utilize Eclipse WTP features and to have a correct classpath. To be more precise it generates one project per artifact.
+ </para>
+
+ <section id="WAR">
+ <title>WAR Deployment</title>
+ <para>
+ The project layout for WAR projects is:
+ </para>
+
+ <figure>
+ <title>Project Layout for WAR projects</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_1.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>A WAR project can only use Seam JavaBean and JPA Entity bean components; it cannot use
- EJB3 Session beans etc.</para>
- <para>WAR projects are generated to enable Seam war hotdeploy feature. Classes put
- into <emphasis>
- <property>src/action</property>
- </emphasis> will be deployed to <emphasis>
- <property>WEB-INF/dev</property>
- </emphasis> from which Seam automatically will perform hotdeploy of new
- components.</para>
- <note>
- <title>Note:</title>
- <para>Because of Eclipse WTP limits the hot deployed classes also existed in <emphasis>
- <property>WEB-INF/classes</property>, </emphasis> but since Seam gives <emphasis>
- <property>WEB-INF/dev</property>
- </emphasis> precedence it will work.</para>
- </note>
-
- <para>Furthermore the Seam Project wizard generates a test project that is setup to run
- <xref linkend="testNG"/> directly against the proper libraries and
- server runtime libraries. When the TestNG plugin is installed you can just run your
- tests via <emphasis><property>Run As > TestNG Test</property>.</emphasis></para>
- <para>In order to deploy WAR project on server, right-click on the project and select <emphasis>
- <property>Run As > Run on Server</property>.</emphasis> Studio will deploy
- WAR project into one web application on server to <property>deploy</property>
- folder.</para>
-
- </section>
-
- <section id="EAR">
- <title>EAR Deployment</title>
- <para>The project layout for EAR projects is:</para>
-
- <figure>
- <title>Project Layout for EAR projects</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/directory_structure/directory_structure_2.png"
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ A WAR project can only use Seam JavaBean and JPA Entity bean components; it cannot use EJB3 Session beans etc.
+ </para>
+
+ <para>
+ WAR projects are generated to enable Seam war hotdeploy feature. Classes put into <emphasis> <property>src/action</property> </emphasis> will be deployed to <emphasis> <property>WEB-INF/dev</property> </emphasis> from which Seam automatically will perform hotdeploy of new components.
+ </para>
+
+ <note>
+ <title>Note:</title>
+ <para>
+ Because of Eclipse WTP limits the hot deployed classes also existed in <emphasis> <property>WEB-INF/classes</property>, </emphasis> but since Seam gives <emphasis> <property>WEB-INF/dev</property> </emphasis> precedence it will work.
+ </para>
+ </note>
+
+ <para>
+ Furthermore the Seam Project wizard generates a test project that is setup to run <xref linkend="testNG"/> directly against the proper libraries and server runtime libraries. When the TestNG plugin is installed you can just run your tests via <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>TestNG Test.</guimenuitem></menuchoice>
+ </para>
+
+ <para>
+ In order to deploy WAR project on server, right-click on the project and select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run on Server.</guimenuitem></menuchoice> Studio will deploy WAR project into one web application on server to <property>deploy</property> folder.
+ </para>
+ </section>
+
+ <section id="EAR">
+ <title>EAR Deployment</title>
+ <para>
+ The project layout for EAR projects is:
+ </para>
+
+ <figure>
+ <title>Project Layout for EAR projects</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_2.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>An EAR project can use the whole range of Seam components, including EJB3 Session
- beans.</para>
- <para>In order to deploy EAR project on server, right-click on the project with
- <property>-ear</property> postfix and select <emphasis>
- <property>Run As > Run on Server</property>.</emphasis> Studio will take care
- about all modules and deploy EAR project into one enterprise application on server to
- <property>deploy</property> folder. EAR application keeps <property>ejb</property>
- and <property>war</property> modules of the EAR project.</para>
-
- <note><title>Note:</title>
- <para>The <property>WAR</property> generated for <property>EARs</property> is now configured to utilize Seam hot-deployment (<emphasis><property>WEB-INF/dev</property></emphasis>) similar to standalone <property>WAR</property> projects.</para>
-
- </note>
-
- </section>
-
- <section id="seam_version_changing">
-
- <title>Changing the Seam Version</title>
-
- <para>To upgrade or downgrade your projects Seam version use the facet preferences. You
- should right-click your project, open its <property>Properties</property> and choose <emphasis>
- <property>Project Facets</property>
- </emphasis> category. Next select <emphasis>
- <property>Seam</property>
- </emphasis> and change its version to needed one.</para>
-
- <figure>
- <title>Changing the Seam Facet Version</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/directory_structure/directory_structure_3.png"
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ An EAR project can use the whole range of Seam components, including EJB3 Session beans.
+ </para>
+
+ <para>
+ In order to deploy EAR project on server, right-click on the project with <property>-ear</property> postfix and select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run on Server.</guimenuitem></menuchoice> Studio will take care about all modules and deploy EAR project into one enterprise application on server to <property>deploy</property> folder. EAR application keeps <property>ejb</property> and <property>war</property> modules of the EAR project.
+ </para>
+
+ <note>
+ <title>Note:</title>
+ <para>
+ The <property>WAR</property> generated for <property>EARs</property> is now configured to utilize Seam hot-deployment (<emphasis><property>WEB-INF/dev</property></emphasis>) similar to standalone <property>WAR</property> projects.
+ </para>
+ </note>
+ </section>
+
+ <section id="seam_version_changing">
+ <title>Changing the Seam Version</title>
+ <para>
+ To upgrade or downgrade your projects Seam version use the facet preferences. You should right-click your project, open its <property>Properties</property> and choose <emphasis> <property>Project Facets</property> </emphasis> category. Next select <emphasis> <property>Seam</property> </emphasis> and change its version to needed one.
+ </para>
+
+ <figure>
+ <title>Changing the Seam Facet Version</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_3.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After pressing <emphasis>
- <property>Apply</property>
- </emphasis> the wizard for adjusting new Seam runtime settings appears.</para>
-
- <figure>
- <title>Changing the Seam Facet Version</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/directory_structure/directory_structure_4.png"
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ After pressing <emphasis> <property>Apply</property> </emphasis> the wizard for adjusting new Seam runtime settings appears.
+ </para>
+
+ <figure>
+ <title>Changing the Seam Facet Version</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_4.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>If you need to update the libraries for you project, check the <emphasis>
- <property>Update libraries</property>
- </emphasis> option. All libraries you checked will be removed and the libraries from the
- new Seam distribution will be added after clicking <emphasis>
- <property>Ok</property>.</emphasis></para>
-
- <figure>
- <title>Changing the Seam Facet Version</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/directory_structure/directory_structure_5.png"
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ If you need to update the libraries for you project, check the <emphasis> <property>Update libraries</property> </emphasis> option. All libraries you checked will be removed and the libraries from the new Seam distribution will be added after clicking <emphasis> <property>Ok</property>.</emphasis>
+ </para>
+
+ <figure>
+ <title>Changing the Seam Facet Version</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_5.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Note:</title>
-
- <para>The note "Seam configuration files and their XSDs won't be changed" is
- meant that the libraries, Seam facet and runtime version will be changed, but
- configuration files that refer to the old version will have to be manually
- updated.</para>
- </note>
- </section>
-
- <section id="changing_seam_parent_project">
- <title>Changing Seam Parent Project</title>
-
- <para>Starting from the 2.0.0.CR2 version of <property>JBoss Tools</property> it is possible
- to change the Seam parent project. In earlier versions this was only controllable at a
- project creation time, now it can be changed for existing projects too.</para>
-
- <para>Go to your project preferences and select <emphasis>
- <property>Seam Settings</property>
- </emphasis> category on the left. Press the <emphasis>
- <property>Browse</property>
- </emphasis> button next to the <emphasis>
- <property>Main Seam Project</property>
- </emphasis> section to select the other Seam parent project.</para>
-
- <figure>
- <title>Changing Seam Parent Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/directory_structure/directory_structure_6.png"
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+ <para>
+ The note "Seam configuration files and their XSDs won't be changed" is meant that the libraries, Seam facet and runtime version will be changed, but configuration files that refer to the old version will have to be manually updated.
+ </para>
+ </note>
+ </section>
+
+ <section id="changing_seam_parent_project">
+ <title>Changing Seam Parent Project</title>
+ <para>
+ Starting from the 2.0.0.CR2 version of <property>JBoss Tools</property> it is possible to change the Seam parent project. In earlier versions this was only controllable at a project creation time, now it can be changed for existing projects too.
+ </para>
+
+ <para>
+ Go to your project preferences and select <emphasis> <property>Seam Settings</property> </emphasis> category on the left. Press the <emphasis> <property>Browse</property> </emphasis> button next to the <emphasis> <property>Main Seam Project</property> </emphasis> section to select the other Seam parent project.
+ </para>
+
+ <figure>
+ <title>Changing Seam Parent Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_6.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section id="renaming_projects_folders">
- <title>Renaming the Projects and Folders</title>
-
- <para>If you need to rename one of the Seam Project artifacts
- (<emphasis><project_name></emphasis>,
- <emphasis><project_name>-ear</emphasis>,
- <emphasis><project_name>-ejb</emphasis> or
- <emphasis><project_name>-test</emphasis>) or any entire folder like
- <emphasis><project_name>/WebContent</emphasis>,
- <emphasis><project_name>/ejbModule</emphasis>,
- <emphasis><project_name>-test/test-src</emphasis>, or project name in
- packages <emphasis>org.domain.<project_name>.session</emphasis>,
- <emphasis>org.domain.<project_name>.entity</emphasis>, you can do this
- by brining the context menu and navigating <emphasis>
- <property>Refactor > Rename...</property>
- </emphasis> or just pressing <emphasis>
- <property>Shift + Alt + R</property>
- </emphasis> under the chosen resource.</para>
-
- <figure>
- <title>Renaming the folder</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/directory_structure/directory_structure_7.png"
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="renaming_projects_folders">
+ <title>Renaming the Projects and Folders</title>
+ <para>
+ If you need to rename one of the Seam Project artifacts (<emphasis><project_name></emphasis>, <emphasis><project_name>-ear</emphasis>, <emphasis><project_name>-ejb</emphasis> or <emphasis><project_name>-test</emphasis>) or any entire folder like <emphasis><project_name>/WebContent</emphasis>, <emphasis><project_name>/ejbModule</emphasis>, <emphasis><project_name>-test/test-src</emphasis>, or project name in packages <emphasis>org.domain.<project_name>.session</emphasis>, <emphasis>org.domain.<project_name>.entity</emphasis>, you can do this by brining the context menu and navigating <emphasis> <property>Refactor > Rename...</property> </emphasis> or just pressing <emphasis> <property>Shift + Alt + R</property> </emphasis> under the chosen resource.
+ </para>
+
+ <figure>
+ <title>Renaming the folder</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_7.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Use <emphasis>
- <property>Refactor > Move...</property>
- </emphasis> (or <emphasis>
- <property>Shift + Alt + V</property>
- </emphasis>), if you need to move
- <emphasis><project_name>/WebContent</emphasis> folder,
- <emphasis><project_name>/ejbModule</emphasis> folder or
- <emphasis><project_name>/test-src</emphasis> folder in the other place
- within the Project structure.</para>
-
- <figure>
- <title>Moving the folder</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/directory_structure/directory_structure_8.png"
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Use <emphasis> <property>Refactor > Move...</property> </emphasis> (or <emphasis> <property>Shift + Alt + V</property> </emphasis>), if you need to move <emphasis><project_name>/WebContent</emphasis> folder, <emphasis><project_name>/ejbModule</emphasis> folder or <emphasis><project_name>/test-src</emphasis> folder in the other place within the Project structure.
+ </para>
+
+ <figure>
+ <title>Moving the folder</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_8.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-</chapter>
\ No newline at end of file
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+</chapter>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/generate_entities.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/generate_entities.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/generate_entities.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,56 +1,79 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="generate_entities">
- <?dbhtml filename="generate_entities.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Seam</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Seam Generate Entities</title>
-
- <para>The main purpose of this chapter is to tell you about Seam Generate Entities.</para>
- <para>Generate Entities is available directly from Eclipse using Hibernate Tools plugin for the standard seam-gen generation.</para>
- <para>The wizard generates a set of CRUD Seam components and web pages based on existing tables in a database or on existing entities in your application.</para>
-
-
- <figure>
- <title>Generate Seam Entities Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/generate_entities/generate_entities1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>By default, the generation mode is set to <emphasis><property>Reverse engineer from database</property>.</emphasis>
- The reverse engineering from a database could be described in four steps:</para>
- <orderedlist>
- <listitem><para>The wizard gets in database, extracts the tables and
- their connections</para></listitem>
- <listitem><para>On basis of this metainfomation the Entity classes are generated into
- <literal>org.domain.project.entity</literal> package</para></listitem>
- <listitem><para>For the entities from step 2 the classes <property>EntityList</property> and <property>EntityHome</property> are generated
- into <literal>org.domain.project.session</literal> package</para></listitem>
- <listitem><para>The xhtml pages are generated.</para></listitem>
- </orderedlist>
-
- <note>
- <title>Note:</title>
- <para>The entities are generated from a database based on the console configuration that is created automatically during a Seam project creation.
- (Read more about the console configuration in the Hibernate guides). The created console configuration is based on the
- connection profile set on the <xref linkend="seamFacet"/> while creating a project.
- Configured connection profile settings are hold in the generated <literal>hibernate-console.properties</literal>. To change the connection
- profile, double-click the console configuration. It could be found in the <property>Hibernate Configurations</property> view
- (<emphasis><property>Window > Show view > Other > Hibernate > Hibernate Configurations</property></emphasis>
- or just switch to the <property>Hibernate</property> perspective).</para>
- </note>
- <para>
- Checking the <emphasis><property>Use existing entities</property></emphasis> mode the wizard executes only 3 and 4 steps. It generates missing classes and
- xhtml pages.
- </para>
-
- <para>Read the <xref linkend="crud_database_application"/> chapter in order to see how the <property>Generate Seam Entities</property> wizard can be used.</para>
- </chapter>
\ No newline at end of file
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="generate_entities">
+<?dbhtml filename="generate_entities.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+
+ <keyword>Seam</keyword>
+
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Seam Generate Entities</title>
+ <para>
+ The main purpose of this chapter is to tell you about Seam Generate Entities.
+ </para>
+
+ <para>
+ Generate Entities is available directly from Eclipse using Hibernate Tools plugin for the standard seam-gen generation.
+ </para>
+
+ <para>
+ The wizard generates a set of CRUD Seam components and web pages based on existing tables in a database or on existing entities in your application.
+ </para>
+
+ <figure>
+ <title>Generate Seam Entities Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/generate_entities/generate_entities1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ By default, the generation mode is set to <emphasis><property>Reverse engineer from database</property>.</emphasis> The reverse engineering from a database could be described in four steps:
+ </para>
+
+ <orderedlist>
+ <listitem>
+ <para>
+ The wizard gets in database, extracts the tables and their connections
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ On basis of this metainfomation the Entity classes are generated into <literal>org.domain.project.entity</literal> package
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ For the entities from step 2 the classes <property>EntityList</property> and <property>EntityHome</property> are generated into <literal>org.domain.project.session</literal> package
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The xhtml pages are generated.
+ </para>
+ </listitem>
+ </orderedlist>
+
+ <note>
+ <title>Note:</title>
+ <para>
+ The entities are generated from a database based on the console configuration that is created automatically during a Seam project creation. (Read more about the console configuration in the Hibernate guides). The created console configuration is based on the connection profile set on the <xref linkend="seamFacet"/> while creating a project. Configured connection profile settings are hold in the generated <literal>hibernate-console.properties</literal>. To change the connection profile, double-click the console configuration. It could be found in the <property>Hibernate Configurations</property> view (<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show view</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Hibernate</guimenuitem><guimenuitem>Hibernate Configurations</guimenuitem></menuchoice> or just switch to the <property>Hibernate</property> perspective).
+ </para>
+ </note>
+
+ <para>
+ Checking the <emphasis><property>Use existing entities</property></emphasis> mode the wizard executes only 3 and 4 steps. It generates missing classes and xhtml pages.
+ </para>
+
+ <para>
+ Read the <xref linkend="crud_database_application"/> chapter in order to see how the <property>Generate Seam Entities</property> wizard can be used.
+ </para>
+</chapter>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/intro.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/intro.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/intro.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -64,7 +64,7 @@
<row>
<entry><para>New Seam Project wizard</para></entry>
- <entry><para>An easy step-by-step wizard to create a standalone Seam Web Project with a form to create runtime and server instances in order to get started creating, running, and debugging J2EE (only) applications. You may also add JSF capabilities.</para></entry>
+ <entry><para>An easy step-by-step wizard to create a stand alone Seam Web Project with a form to create runtime and server instances in order to get started creating, running, and debugging J2EE (only) applications. You may also add JSF capabilities.</para></entry>
<entry>
<xref linkend="create_seam"/>
</entry>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/master.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/master.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/master.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -66,12 +66,12 @@
Version: 3.1.1.GA
</releaseinfo>
-<abstract>
+<!--<abstract>
<title/>
<para>
<ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/pdf/Seam_Refere...">PDF version</ulink>
</para>
-</abstract>
+</abstract>-->
</bookinfo>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_editors.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_editors.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_editors.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,697 +1,815 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="seam_editors" role="updated">
- <?dbhtml filename="seam_editors.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Seam</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Seam Editors</title>
-
-
- <para>This chapter tells about Seam Editors and their features.</para>
-
+<?dbhtml filename="seam_editors.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+
+ <keyword>Seam</keyword>
+
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Seam Editors</title>
+ <para>
+ This chapter tells about Seam Editors and their features.
+ </para>
+
+ <section>
+ <title>Visual Page Editor</title>
+ <para>
+ Visual Page Editor fits perfectly for authoring view Seam pages. The major features of VPE are listed in <xref linkend="SeamEditors"/>
+ </para>
+
+ <para>
+ You can also read more about Visual Page Editor in <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.htm...">Visual Page Editor</ulink> chapter of "Visual Web Tools Reference Guide".
+ </para>
+ </section>
+
+ <section>
+ <title>Seam Pages Editor</title>
+ <para>
+ <property>Seam Pages Editor</property> provides a handy way to edit the <property>pages.xml</property> file.
+ </para>
+
+ <para>
+ You can edit the pages.xml file in three modes: Graphical, Tree and Source.
+ </para>
+
+ <para>
+ Seam Pages Editor supports synchronization with Package Explorer.This means that while renaming files in the Package Explorer all the changes immediately affect the pages.xml file.
+ </para>
+
<section>
- <title>Visual Page Editor</title>
- <para>Visual Page Editor fits perfectly for authoring view Seam pages. The major features of VPE are listed in <xref linkend="SeamEditors"/></para>
- <para>You can also read more about Visual Page Editor in <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.htm...">Visual Page Editor</ulink> chapter of "Visual Web Tools Reference Guide".</para>
- </section>
-
-
-
-
- <section>
- <title>Seam Pages Editor</title>
-
+ <title>Graphical Mode</title>
+ <para>
+ Graphical mode provides you with a set of visual tools to organize your project pageflow, exception handling etc.
+ </para>
- <para>
- <property>Seam Pages Editor</property> provides a handy way to edit the <property>pages.xml</property> file.
-
- </para>
-
- <para>
- You can edit the pages.xml file in three modes: Graphical, Tree and Source.
-
- </para>
- <para>
- Seam Pages Editor supports synchronization with Package Explorer.This means that while renaming files in the Package Explorer all the changes immediately affect the pages.xml file.
-
- </para>
- <section>
- <title>Graphical Mode</title>
-
-
- <para>Graphical mode provides you with a set of visual tools to organize your project pageflow, exception handling etc.</para>
- <figure>
- <title>Seam Pages Editor: Graphical View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The Graphical part of the editor has some visual elements. The table below shows graphical representation of the elements and explains their meanings. </para>
-
-<table>
- <title>Pages Editor: Graphical View. Visual elements</title>
- <tgroup cols="2">
- <thead>
+ <figure>
+ <title>Seam Pages Editor: Graphical View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The Graphical part of the editor has some visual elements. The table below shows graphical representation of the elements and explains their meanings.
+ </para>
+
+ <table>
+ <title>Pages Editor: Graphical View. Visual elements</title>
+ <tgroup cols="2">
+ <thead>
<row>
- <entry>Element</entry>
-
- <entry>Description</entry>
+ <entry>
+ Element
+ </entry>
+
+ <entry>
+ Description
+ </entry>
</row>
- </thead>
- <tbody>
+ </thead>
+
+ <tbody>
<row>
- <entry>
- <mediaobject>
+ <entry>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/element_page.png"/>
+ </imageobject>
+ </mediaobject>
+ </entry>
+
+ <entry>
+ <para>
+ A yellow box with a solid border represents a <code> <page> </code> element.
+ </para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/element_param.png"/>
+ </imageobject>
+ </mediaobject>
+ </entry>
+
+ <entry>
+ <para>
+ Pressing on the plus icon (
+ <inlinemediaobject>
<imageobject>
- <imagedata fileref="images/seam_editors/element_page.png"/>
+ <imagedata fileref="images/seam_editors/icon_plus.png"/>
</imageobject>
- </mediaobject>
- </entry>
- <entry><para>A yellow box with a solid border represents a <code>
- <page>
- </code> element.
- </para></entry>
- </row>
- <row>
- <entry>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/element_param.png"/>
- </imageobject>
- </mediaobject></entry>
- <entry>
- <para>Pressing on the plus icon (<inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/icon_plus.png"/>
- </imageobject>
- </inlinemediaobject>)
-
-
- on the <code>
- <page>
- </code> element reveals a box that lists the parameters for the page.</para>
- </entry>
-
- </row>
-
- <row>
- <entry> <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/element_page2.png"/>
- </imageobject>
- </mediaobject></entry>
- <entry>
- <para>A red cross in the upper left corner of the page box indicates that the view-id is not found in the project.</para>
- </entry>
- </row>
-
- <row>
- <entry><mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/element_page1.png"/>
- </imageobject>
- </mediaobject></entry>
- <entry> <para>
- A gray box with a dashed border represents a page that has navigation
- (navigation rule) to but the page is not defined in the page.xml file.
- </para></entry>
- </row>
-
-
- <row>
- <entry> <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/element_exception.png"/>
- </imageobject>
- </mediaobject></entry>
- <entry> <para>An <code><exception></code> is represented by a blue box with a orange diamond.</para></entry>
- </row>
-
-
-
-
-
- </tbody>
- </tgroup>
-</table>
-
+ </inlinemediaobject>
+ ) on the <code> <page> </code> element reveals a box that lists the parameters for the page.
+ </para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/element_page2.png"/>
+ </imageobject>
+ </mediaobject>
+ </entry>
- <para>Pageflow relations are shown with gray arrows, when you select a relationship the arrow is changed to orange. </para>
-
-
-
- <para>On the lefthand side of the Graphical view of <property>Seam Page Editor</property> you can find a toolbar with a set of icons for the most frequently used commands. </para>
-
+ <entry>
+ <para>
+ A red cross in the upper left corner of the page box indicates that the view-id is not found in the project.
+ </para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/element_page1.png"/>
+ </imageobject>
+ </mediaobject>
+ </entry>
+
+ <entry>
+ <para>
+ A gray box with a dashed border represents a page that has navigation (navigation rule) to but the page is not defined in the page.xml file.
+ </para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/element_exception.png"/>
+ </imageobject>
+ </mediaobject>
+ </entry>
+
+ <entry>
+ <para>
+ An <code><exception></code> is represented by a blue box with a orange diamond.
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ Pageflow relations are shown with gray arrows, when you select a relationship the arrow is changed to orange.
+ </para>
+
+ <para>
+ On the left hand side of the Graphical view of <property>Seam Page Editor</property> you can find a toolbar with a set of icons for the most frequently used commands.
+ </para>
+
<table>
- <title>Pages Editor: Graphical View. Commands Icons</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Icon Image</entry>
-
- <entry>Command</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/icon_select.png"/>
- </imageobject>
- </inlinemediaobject>
-
- </entry>
- <entry>Select a page element</entry>
-
- </row>
-
- <row>
- <entry><inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/icon_marquee.png"/>
- </imageobject>
- </inlinemediaobject></entry>
- <entry>Marquee a page item</entry>
- </row>
-
-
- <row>
- <entry>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/icon_new_link.png"/>
- </imageobject>
- </inlinemediaobject>
-
- </entry>
- <entry>Add a page relationship</entry>
- </row>
-
-
- <row>
- <entry>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/icon_exception.png"/>
- </imageobject>
- </inlinemediaobject>
-
- </entry>
- <entry>Add an exception rule</entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- <para>Context menus are also available when you click either on an item or a blank space.</para>
-
-
- <para>A context menu called on a blank space of the diagram provides the following options:</para>
- <itemizedlist>
- <listitem><para><emphasis role="bold">Page</emphasis> creates a new page element on the diagram</para></listitem>
- <listitem><para><emphasis role="bold">Exception</emphasis> creates a new exception element on the diagram</para></listitem>
- <listitem><para><emphasis role="bold">Auto Layout</emphasis> formats the layout of the diagram automatically</para></listitem>
- <listitem><para><emphasis role="bold">Select Element</emphasis> calls the <property>Select Element Wizard</property> with a filter to perform a quick search through the <property>pages.xml</property> file </para></listitem>
- </itemizedlist>
- <para>Rightclicking on a selected
- <code><page></code>
- element calls a context menu where you can choose the following options if you click on the <emphasis role="bold">New</emphasis> menu item: </para>
-
-
-
+ <title>Pages Editor: Graphical View. Commands Icons</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>
+ Icon Image
+ </entry>
+
+ <entry>
+ Command
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/icon_select.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </entry>
+
+ <entry>
+ Select a page element
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/icon_marquee.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </entry>
+
+ <entry>
+ Marquee a page item
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/icon_new_link.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </entry>
+
+ <entry>
+ Add a page relationship
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/icon_exception.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </entry>
+
+ <entry>
+ Add an exception rule
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ Context menus are also available when you click either on an item or a blank space.
+ </para>
+
+ <para>
+ A context menu called on a blank space of the diagram provides the following options:
+ </para>
+
<itemizedlist>
- <listitem><para><emphasis role="bold">Rule</emphasis> opens the <property>Add Navigation Rule</property> dialog in which you can browse your project for a view page to set the view-id in the navigation rule and specify <emphasis role="bold">render</emphasis> or <emphasis role="bold">redirect</emphasis> navigation options </para></listitem>
- <listitem><para><emphasis role="bold">Param</emphasis> calls a dialog box where you can define a parameter (using the
- <code><param></code>
- tag) for the
- <code><page></code>
- element</para></listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Page</emphasis> creates a new page element on the diagram
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Exception</emphasis> creates a new exception element on the diagram
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Auto Layout</emphasis> formats the layout of the diagram automatically
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Select Element</emphasis> calls the <property>Select Element Wizard</property> with a filter to perform a quick search through the <property>pages.xml</property> file
+ </para>
+ </listitem>
</itemizedlist>
-
-
- <section>
- <title>Seam Pages Diagram Preferences</title>
-
-
-
- <para>In order to customize the layout of Diagram you can go to
- <property>Window > Preferences > JBoss Tools > Web > Seam > Editors > Seam Pages Diagram</property>.
- </para>
-
- <figure>
- <title>Preferences of Seam Pages Diagram</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_11.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- </section>
-
-
- <section>
- <title>Tree Mode</title>
-
- <para>Tree Mode provides a wider range of options and way to edit and modify the pages.xml file.</para>
-
-
-
+
+ <para>
+ Right clicking on a selected <code><page></code> element calls a context menu where you can choose the following options if you click on the <emphasis role="bold">New</emphasis> menu item:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">Rule</emphasis> opens the <property>Add Navigation Rule</property> dialog in which you can browse your project for a view page to set the view-id in the navigation rule and specify <emphasis role="bold">render</emphasis> or <emphasis role="bold">redirect</emphasis> navigation options
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Param</emphasis> calls a dialog box where you can define a parameter (using the <code><param></code> tag) for the <code><page></code> element
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <section>
+ <title>Seam Pages Diagram Preferences</title>
+ <para>
+ In order to customize the layout of Diagram you can go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Seam</guimenuitem><guimenuitem>Editors</guimenuitem><guimenuitem>Seam Pages Diagram</guimenuitem></menuchoice>.
+ </para>
+
<figure>
- <title>Seam Pages Editor: Tree View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_8.png"/>
- </imageobject>
- </mediaobject>
+ <title>Preferences of Seam Pages Diagram</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_11.png"/>
+ </imageobject>
+ </mediaobject>
</figure>
-
- <para>
- In this mode all elements and attributes of the page.xml
- file can be viewed and edited in a visual, user friendly way.
- </para>
-
- </section>
-
-
- <section>
- <title>Outline Support for Seam Pages Editor</title>
-
-
- <para>Seam Pages Editor provides <property>Outline</property> view support.
- You can explore the pages.xml using Outline view in two modes: <property>Tree</property> ( <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/outline_tree.png"/>
- </imageobject>
- </inlinemediaobject> ) and <property>Diagram Navigation</property> ( <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/outline_navigation.png"/>
- </imageobject>
- </inlinemediaobject> ).</para>
-
- <para>
- The Diagram Navigation mode of Outline view gives a birds-view of the layout to allow quick navigation for large-scale applications.
- </para>
-
- <figure>
- <title>Outline view: Diagram Navigation mode</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_9.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para>The Tree mode shows a tree for every element in the pages.xml file. You can get a quick overview of the whole file. When selecting an element in the Outline view the related element is highlighted in the Graphical, Tree or Source page of Seam Pages Editor.</para>
+ </section>
+ </section>
+ <section>
+ <title>Tree Mode</title>
+ <para>
+ Tree Mode provides a wider range of options and way to edit and modify the pages.xml file.
+ </para>
+
+ <figure>
+ <title>Seam Pages Editor: Tree View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ In this mode all elements and attributes of the page.xml file can be viewed and edited in a visual, user friendly way.
+ </para>
+ </section>
+ <section>
+ <title>Outline Support for Seam Pages Editor</title>
+ <para>
+ Seam Pages Editor provides <property>Outline</property> view support. You can explore the pages.xml using Outline view in two modes: <property>Tree</property> (
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/outline_tree.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ ) and <property>Diagram Navigation</property> (
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/outline_navigation.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ ).
+ </para>
+
+ <para>
+ The Diagram Navigation mode of Outline view gives a birds-view of the layout to allow quick navigation for large-scale applications.
+ </para>
+
+ <figure>
+ <title>Outline view: Diagram Navigation mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_9.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The Tree mode shows a tree for every element in the pages.xml file. You can get a quick overview of the whole file. When selecting an element in the Outline view the related element is highlighted in the Graphical, Tree or Source page of Seam Pages Editor.
+ </para>
+
+ <figure>
+ <title>Outline view: Tree mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_10.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ </section>
+
+ <section>
+ <title>Seam Components Editor</title>
+ <para>
+ When editing <property>components.xml</property> a structured tree editor is available in addition to pure source editing. It has a graphical view (Tree tab) and source (Source tab).
+ </para>
- <figure>
- <title>Outline view: Tree mode</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_10.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
-
-
- </section>
-
-
-
- </section>
-
-
-
-
- <section>
-
-
- <title>Seam Components Editor</title>
-
- <para>When editing <property>components.xml</property> a structured tree editor is available
- in addition to pure source editing. It has a graphical view (Tree tab) and source
- (Source tab).</para>
-
+ <figure>
+ <title>component.xml Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+ <para>
+ You can view and edit <property>components.xml</property> and other xml files directly in the Project Explorer and Properties sheet without opening the components.xml editor.
+ </para>
+ </note>
+
+ <figure>
+ <title>component.xml Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="SeamEditors">
+ <title>Main Features of Seam Editors</title>
+ <para>
+ In this chapter you will know what Seam Editors features are and how to work with them.
+ </para>
+
+ <section id="ContentAssist">
+ <title>Content Assist</title>
+ <para>
+ <property>Content Assist</property> (Ctrl + Space) is available when using EL expressions in the following file formats:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ JSP
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ XHTML
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ XML
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ JAVA
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ Notice, the code completion for the Seam components shows the proposals marked with Seam icon.
+ </para>
+
+ <figure>
+ <title>Content Assist</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_1.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Content Assist is also available for the <emphasis
+ role="italic"> <property>"jsfc "</property> </emphasis> attribute, it lets you select from a list of possible attribute values. Whereas, JSF components appear above all other components in the list.
+ </para>
+
+ <figure>
+ <title>Content Assist for the "jsfc" attribute</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_12.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+ <para>
+ To get Code Assist available for an externally generated and imported project, don't forget to enable Seam features and configure Seam Settings in <xref linkend="project_pref"/>.
+ </para>
+ </note>
+
+ <section id="components_code_assist" role="new">
+ <title>Content Assist for components.xml</title>
+ <para>
+ While you are editing a <emphasis> <property>components.xml</property> </emphasis> file you can make use of the Content Assist for inserting needed elements.
+ </para>
+
<figure>
- <title>component.xml Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_4.png"/>
- </imageobject>
- </mediaobject>
+ <title>Content Assist in the component.xml Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_1a.png"/>
+ </imageobject>
+ </mediaobject>
</figure>
-
- <note>
- <title>Note:</title>
-
- <para>You can view and edit <property>components.xml</property> and other xml files
- directly in the Project Explorer and Properties sheet without opening the
- components.xml editor.</para>
- </note>
+
+ <para>
+ The editor also makes code completion aware of methods/attributes for EntityQuery component.
+ </para>
+
<figure>
- <title>component.xml Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_5.png"/>
- </imageobject>
- </mediaobject>
+ <title>Content Assist for EntityQuery Component</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_1b.png"/>
+ </imageobject>
+ </mediaobject>
</figure>
-
+ </section>
+
+ <section id="named_beans_code_assist" role="new">
+ <title>Content assist for @Named beans</title>
+ <para>
+ To the nice code completion you can also use Content assist for all occurrences where @Named beans are used.
+ </para>
+
+ <figure>
+ <title>Content assist for @Named beans</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_1c.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
</section>
-
-
- <section id="SeamEditors">
- <title>Main Features of Seam Editors</title>
-
- <para>In this chapter you will know what Seam Editors features are and how to work with them. </para>
-
- <section id="ContentAssist">
-
- <title>Content Assist</title>
-
- <para><property>Content Assist</property> (Ctrl + Space) is available when using EL expressions in the following file formats:</para>
- <itemizedlist>
+ <section>
+ <title>Content Assist for Page Descriptors</title>
+ <para>
+ Content Assist ( CA ) is available for Page Descriptors, <property>.page.xml</property> and <property>page.xml</property> files. Content Assist lets you easily compose a Page Descriptor file by suggesting elements and attributes. The suggestions are context dependent, which means that CA provides only the elements, attributes and in some cases values for the attributes, suitable in a particular place of your Page Descriptor.
+ </para>
+
+ <para>
+ Seam Pages Editor also supports code completion in EL-expressions suggesting you possible bean properties and methods.
+ </para>
+ </section>
+
+ <section id="OpenOn">
+ <title>OpenOn</title>
+ <para>
+ <property>OpenOn</property> lets you easily navigate through your project without using the Package Explorer or Project Explorer. After pressing <emphasis> <property>Ctrl + left click</property> </emphasis> (or just F3) you will see a corresponding method or class.
+ </para>
+
+ <figure>
+ <title>OpenOn</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ OpenOn is available for the following files:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <xref linkend="xmlFiles"/>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <xref linkend="xhtmlFiles"/>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <xref linkend="javaFiles"/>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <note>
+ <title>Note:</title>
+ <para>
+ In this section were described only use cases special for Seam applications.For general information please read <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.htm...">OpenOn section in Visual Web Tools Reference Guide</ulink>.
+ </para>
+ </note>
+
+ <itemizedlist>
+ <listitem id="xhtmlFiles">
+ <para>
+ Using OpenOn in .xhtml files you can open:
+ </para>
+
+ <itemizedlist>
<listitem>
- <para>JSP</para>
+ <para>
+ components or properties resolved using an EL expression;
+ </para>
</listitem>
+
<listitem>
- <para>XHTML</para>
+ <para>
+ all actions described in pages.xml;
+ </para>
</listitem>
+
<listitem>
- <para>XML</para>
+ <para>
+ other .xhtml files that paths are specified in a current file;
+ </para>
</listitem>
+
<listitem>
- <para>JAVA</para>
+ <para>
+ image files that paths are set in the <emphasis> <property>value</property></emphasis> property.The files will be opened in the default system graphical editor.
+ </para>
</listitem>
- </itemizedlist>
-
- <para>Notice, the code completion for the Seam components shows the proposals marked with Seam icon.</para>
-
- <figure>
- <title>Content Assist</title>
+ </itemizedlist>
+ </listitem>
+
+ <listitem id="xmlFiles">
+ <para>
+ OpenOn is also supported in Page Descriptors (<property>.page.xml</property> and <property>pages.xml</property>). OpenOn allows you to navigate to Java beans as well as to view pages. You can <property>Ctrl + left click</property> on a bean or on view page file (e.g. XTML file) to navigate to the file you clicked on.
+ </para>
+
+ <figure>
+ <title>OpenOn in .page.xml file</title>
<mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_1.png" scale="70"/>
- </imageobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_2a.png"/>
+ </imageobject>
</mediaobject>
- </figure>
- <para> Content Assist is also available for the <emphasis
- role="italic">
- <property>"jsfc "</property>
- </emphasis> attribute, it lets you select from a list of possible attribute values. Whereas, JSF components appear above all other components in the list.</para>
- <figure>
- <title>Content Assist for the "jsfc" attribute</title>
+ </figure>
+
+ <para>
+ If you use Rule-based authorization with Drools in your Seam application you can apply OpenOn in <emphasis> <property>components.xml</property></emphasis> to open the files containing rule definitions in the <emphasis> <property>"rule-files"</property></emphasis> tag.
+ </para>
+
+ <figure>
+ <title>OpenOn in components.xml file</title>
<mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_12.png" scale="70"/>
- </imageobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_2c.png"/>
+ </imageobject>
</mediaobject>
- </figure>
- <note>
- <title>Note:</title>
-
- <para>To get Code Assist available for an externally generated and imported project,
- don't forget to enable Seam features and configure Seam Settings in <xref linkend="project_pref"/>.</para>
- </note>
-
- <section id="components_code_assist" role="new">
- <title>Content Assist for components.xml</title>
-
- <para>While you are editing a <emphasis>
- <property>components.xml</property>
- </emphasis> file you can make use of the Content Assist for inserting needed
- elements.</para>
-
- <figure>
- <title>Content Assist in the component.xml Editor</title>
+ </figure>
+
+ <para>
+ You can also use OpenOn to open jBPM components that are described in Seam component descriptor. Two places where it works are available:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ inside <emphasis> <property><component></property></emphasis> definition;
+ </para>
+
+ <figure>
+ <title>OpenOn in components.xml file</title>
<mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_1a.png"/>
- </imageobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_2d.png"/>
+ </imageobject>
</mediaobject>
- </figure>
-
- <para>The editor also makes code completion aware of methods/attributes for EntityQuery
- component.</para>
-
- <figure>
- <title>Content Assist for EntityQuery Component</title>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>
+ inside <emphasis> <property>jbpm</property></emphasis> tags;
+ </para>
+
+ <figure>
+ <title>OpenOn in components.xml file</title>
<mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_1b.png"/>
- </imageobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_2e.png"/>
+ </imageobject>
</mediaobject>
- </figure>
- </section>
-
- <section id="named_beans_code_assist" role="new">
- <title>Content assist for @Named beans</title>
-
- <para>To the nice code completion you can also use Content assist for all occurrences where @Named beans are used.
- </para>
-
- <figure>
- <title>Content assist for @Named beans</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_1c.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- </section>
- <section>
- <title>Content Assist for Page Descriptors</title>
-
- <para>Content Assist ( CA ) is available for Page Descriptors,
- <property>.page.xml</property> and <property>page.xml</property> files.
- Content Assist lets you easily compose a Page Descriptor file by suggesting elements and attributes. The suggestions are context dependent, which means that CA provides only the elements, attributes and in some cases values for the attributes, suitable in a particular place of your Page Descriptor.
-
- </para>
- <para>
- Seam Pages Editor also supports code completion in EL-expressions suggesting you possible bean properties and methods.
- </para>
- </section>
- <section id="OpenOn">
- <title>OpenOn</title>
-
- <para><property>OpenOn</property> lets you easily navigate through your project without
- using the Package Explorer or Project Explorer. After pressing <emphasis>
- <property>Ctrl + left click</property>
- </emphasis> (or just F3) you will see a corresponding method or class.</para>
-
- <figure>
- <title>OpenOn</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>OpenOn is available for the following files:</para>
- <itemizedlist>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem id="javaFiles">
+ <para>
+ OpenOn is also supported in seam components where <property> In annotation</property> is presented. After pressing <property>Ctrl + left click</property> on the seam component specified in <code>@In </code> you will get the possibility to open the file where the component is declarated as well as all of the seam components where it is used in the next declarations:
+ </para>
+
+ <itemizedlist>
<listitem>
- <para>
- <xref linkend="xmlFiles"/>
- </para>
+ <para>
+ @Out
+ </para>
</listitem>
+
<listitem>
- <para>
- <xref linkend="xhtmlFiles"/>
- </para>
+ <para>
+ @DataModel
+ </para>
</listitem>
+
<listitem>
- <para> <xref linkend="javaFiles"/></para>
+ <para>
+ @Role
+ </para>
</listitem>
- </itemizedlist>
- <note>
- <title>Note:</title>
-
- <para>In this section were described only use cases special for Seam applications.For general information please read
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.htm...">OpenOn section in Visual Web Tools Reference Guide</ulink>.</para>
- </note>
- <itemizedlist>
- <listitem id="xhtmlFiles"> <para>Using OpenOn in .xhtml files you can open:</para>
- <itemizedlist>
- <listitem><para>components or properties resolved using an EL expression;</para></listitem>
- <listitem><para>all actions described in pages.xml;</para></listitem>
- <listitem><para>other .xhtml files that paths are specified in a current file;</para></listitem>
- <listitem><para>image files that paths are set in the <emphasis>
- <property>value</property></emphasis> property.The files will be opened in the default system graphical editor.</para></listitem>
- </itemizedlist>
+
+ <listitem>
+ <para>
+ @Roles
+ </para>
</listitem>
- <listitem id="xmlFiles">
- <para>OpenOn is also supported in Page Descriptors (<property>.page.xml</property> and <property>pages.xml</property>). OpenOn allows you to navigate to Java beans as well as to view pages.
- You can <property>Ctrl + left click</property> on a bean or on view page file (e.g. XTML file) to navigate to the file you clicked on. </para>
-
- <figure>
- <title>OpenOn in .page.xml file</title>
+ </itemizedlist>
+
+ <figure>
+ <title>OpenOn in Seam Component</title>
<mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_2a.png"/>
- </imageobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_2b.png"/>
+ </imageobject>
</mediaobject>
- </figure>
- <para>If you use Rule-based authorization with Drools in your Seam application you can apply OpenOn
- in <emphasis>
- <property>components.xml</property></emphasis> to open the files containing rule definitions in the <emphasis>
- <property>"rule-files"</property></emphasis> tag.
+ </figure>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="SeamValidation">
+ <title>Seam Validation</title>
+ <para>
+ Validation of various possible problematic definitions is implemented for Seam applications.
+ </para>
+
+ <para>
+ If an issue is found it will be shown in the standard <property>Problems View</property>.
+ </para>
+
+ <figure>
+ <title>Seam Validation</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_6.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+ <para>
+ Please note, only files within source path and web content are validated, meaning temporary files or test files are not included.
</para>
- <figure>
- <title>OpenOn in components.xml file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_2c.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>You can also use OpenOn to open jBPM components that are described in Seam component descriptor.
- Two places where it works are available: </para>
- <itemizedlist>
- <listitem><para>inside <emphasis>
- <property><component></property></emphasis> definition;</para>
- <figure>
- <title>OpenOn in components.xml file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_2d.png"/>
- </imageobject>
- </mediaobject>
- </figure></listitem>
- <listitem><para>inside <emphasis>
- <property>jbpm</property></emphasis> tags;</para>
- <figure>
- <title>OpenOn in components.xml file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_2e.png"/>
- </imageobject>
- </mediaobject>
- </figure></listitem>
- </itemizedlist>
- </listitem>
- <listitem id="javaFiles">
- <para>
- OpenOn is also supported in seam components where <property> In annotation</property> is presented.
- After pressing <property>Ctrl + left click</property> on the seam component specified in <code>@In </code> you will get the possibility to open the file where the component is declarated as well as
- all of the seam components where it is used in the next declarations:</para>
- <itemizedlist>
- <listitem><para>@Out</para></listitem>
- <listitem><para>@DataModel</para></listitem>
- <listitem><para>@Role</para></listitem>
- <listitem><para>@Roles</para></listitem>
- </itemizedlist>
+ </note>
- <figure>
- <title>OpenOn in Seam Component</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_2b.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="SeamValidation">
- <title>Seam Validation</title>
-
- <para>Validation of various possible problematic definitions is implemented for Seam
- applications.</para>
-
- <para>If an issue is found it will be shown in the standard <property>Problems
- View</property>.</para>
-
- <figure>
- <title>Seam Validation</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_6.png" scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Note:</title>
- <para>Please note, only files within source path and web content are validated, meaning temporary files or test files are not included.</para>
- </note>
-
- <para>In the preferences page for Seam Validator you can see and modify the validator
- behavior. Go to <emphasis>
- <property>Window > Preferences > JBoss Tools > Web > Seam > Validator</property>
- </emphasis> and select the severity level for the optional Seam Validator
- problem.</para>
-
- <figure>
- <title>Seam Validator Preferences</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On WTP projects validation are enabled by default and thus executed automatically, but
- on normal Java projects you will have to go and add the Validation builder of your
- project . It is available in the properties of your project under
- <emphasis><property>Validation</property>.</emphasis></para>
-
- <figure>
- <title>Enabling the Validation Builder</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/validator1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The validations can be run manually by clicking
- <emphasis><property>Validate</property></emphasis> via the context menu on your project (folder or file inside your project) which will
- execute all the active WTP validations. Following to the project's preferences under <emphasis>
- <property>Validation</property></emphasis> it's possible to enable/disable any validator.
- </para>
-
- <para>It's also possible to turn off the validation for some resource (a file, folder) inside your project via the <emphasis>
- <property>Exclude Validation</property></emphasis> context menu option.</para>
-
- <figure>
- <title>Excluding Validation for the WebContent Folder</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/validator2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>As a result, if you've turned off the validation for a folder (or file), it is put to the excluded group of the Validation filters and be ignored during the validation.</para>
-
- <figure>
- <title>Validation Filters</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/validator3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>
+ In the preferences page for Seam Validator you can see and modify the validator behavior. Go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Seam</guimenuitem><guimenuitem>Validator</guimenuitem></menuchoice> and select the severity level for the optional Seam Validator problem.
+ </para>
+
+ <figure>
+ <title>Seam Validator Preferences</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ On WTP projects validation are enabled by default and thus executed automatically, but on normal Java projects you will have to go and add the Validation builder of your project . It is available in the properties of your project under <emphasis><property>Validation</property>.</emphasis>
+ </para>
+
+ <figure>
+ <title>Enabling the Validation Builder</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/validator1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The validations can be run manually by clicking <emphasis><property>Validate</property></emphasis> via the context menu on your project (folder or file inside your project) which will execute all the active WTP validations. Following to the project's preferences under <emphasis> <property>Validation</property></emphasis> it's possible to enable/disable any validator.
+ </para>
+
+ <para>
+ It's also possible to turn off the validation for some resource (a file, folder) inside your project via the <emphasis> <property>Exclude Validation</property></emphasis> context menu option.
+ </para>
+
+ <figure>
+ <title>Excluding Validation for the WebContent Folder</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/validator2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ As a result, if you've turned off the validation for a folder (or file), it is put to the excluded group of the Validation filters and be ignored during the validation.
+ </para>
+
+ <figure>
+ <title>Validation Filters</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/validator3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
</section>
-
-</section>
-</chapter>
\ No newline at end of file
+ </section>
+</chapter>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_faq.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_faq.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_faq.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,73 +1,60 @@
-<?xml version='1.0' encoding='UTF-8'?>
-<chapter id="seam_faq">
- <?dbhtml filename="vwt_faq.html"?>
- <title>FAQ</title>
-
- <section id="seam_question_1">
- <title>How to get Code Assist for Seam specific resources in an externally generated
- project?</title>
-
- <para>To get Code Assist for Seam specific resources in an externally generated project, you
- should enable Seam features in Project Preferences. Right click an imported project and
- navigate <emphasis>
- <property>Properties > Seam Settings</property>.</emphasis> Check <emphasis>
- <property>Seam support</property>
- </emphasis> box to enable all available <xref linkend="project_pref"/>.</para>
- </section>
-
- <section id="seam_question_2">
- <title>How to import an example Seam project from jboss-eap directory?</title>
-
- <para>To import an example Seam project from <emphasis>
- <property>jboss-eap</property>
- </emphasis> into your working directory, you should perform the following steps:</para>
-
- <itemizedlist>
- <listitem>
- <para>Go to <emphasis>
- <property>New > Other > Java Project from Existing Buildfile</property>
- </emphasis></para>
- </listitem>
-
- <listitem>
- <para>Point to the <emphasis>
- <property>build.xml</property>
- </emphasis> of any chosen project by pressing <emphasis>
- <property>Browse</property>
- </emphasis> button</para>
- </listitem>
-
- <listitem>
- <para>Hit <emphasis>
- <property>Finish</property>
- </emphasis> to open the project</para>
- </listitem>
- </itemizedlist>
-
- <para>As these seam examples are non WTP projects, next you should enable Seam support for
- them. To do that, right click the project and go to <emphasis>
- <property>Properties > Seam Settings</property>.</emphasis></para>
- </section>
-
- <section id="seam_question_3">
- <title>How to change the deploy folders for Seam source code from src/hot and src/main?</title>
-
- <para>You should right-click the project, select <emphasis>
- <property>Properties > Java Build Path</property>,</emphasis> then switch to the <emphasis>
- <property>Source tab</property>,</emphasis> select the output folder for <emphasis>
- <property>src/hot</property></emphasis> (<emphasis>
- <property>src/main</property>)</emphasis> and click <emphasis>
- <property>Edit</property></emphasis> to change their output location.</para>
-
- <para>In conclusion, the main goal of this document is to get you know with a full featureset
- that <property>JBoss Tools</property> provides to support Seam development. Thus if you have
- some questions, comments or suggestions on the topic, please fell free to ask in the <ulink
- url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss
- Tools Forum</ulink>. You can also influence on how you want to see JBoss Tools docs in
- future leaving your vote on the article <ulink
- url="http://wiki.jboss.org/wiki/JBossToolsDocsFuture"
- >Overview of the improvements required by JBossTools/JBDS Docs users</ulink>. </para>
-
- <para>A set of movies on Seam tooling is available on <ulink url="http://docs.jboss.org/tools/movies">Seam movies page</ulink>.</para>
- </section>
-</chapter>
+<?xml version='1.0' encoding='UTF-8'?>
+<chapter id="seam_faq">
+<?dbhtml filename="vwt_faq.html"?>
+ <title>FAQ</title>
+ <section id="seam_question_1">
+ <title>How to get Code Assist for Seam specific resources in an externally generated project?</title>
+ <para>
+ To get Code Assist for Seam specific resources in an externally generated project, you should enable Seam features in Project Preferences. Right click an imported project and navigate <menuchoice><guimenuitem>Properties</guimenuitem><guimenuitem>Seam Settings.</guimenuitem></menuchoice> Check <emphasis> <property>Seam support</property> </emphasis> box to enable all available <xref linkend="project_pref"/>.
+ </para>
+ </section>
+
+ <section id="seam_question_2">
+ <title>How to import an example Seam project from jboss-eap directory?</title>
+ <para>
+ To import an example Seam project from <emphasis> <property>jboss-eap</property> </emphasis> into your working directory, you should perform the following steps:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Go to <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Java Project from Existing Buildfile</guimenuitem></menuchoice>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Point to the <emphasis> <property>build.xml</property> </emphasis> of any chosen project by pressing <emphasis> <property>Browse</property> </emphasis> button
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Hit <emphasis> <property>Finish</property> </emphasis> to open the project
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ As these seam examples are non WTP projects, next you should enable Seam support for them. To do that, right click the project and go to <menuchoice><guimenuitem>Properties</guimenuitem><guimenuitem>Seam Settings.</guimenuitem></menuchoice>
+ </para>
+ </section>
+
+ <section id="seam_question_3">
+ <title>How to change the deploy folders for Seam source code from src/hot and src/main?</title>
+ <para>
+ You should right-click the project, select <menuchoice><guimenuitem>Properties</guimenuitem><guimenuitem>Java Build Path,</guimenuitem></menuchoice> then switch to the <emphasis> <property>Source tab</property>,</emphasis> select the output folder for <emphasis> <property>src/hot</property></emphasis> (<emphasis> <property>src/main</property>)</emphasis> and click <emphasis> <property>Edit</property></emphasis> to change their output location.
+ </para>
+
+ <para>
+ In conclusion, the main goal of this document is to get you know with a full feature set that <property>JBoss Tools</property> provides to support Seam development. Thus if you have some questions, comments or suggestions on the topic, please fell free to ask in the <ulink
+ url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Forum</ulink>. You can also influence on how you want to see JBoss Tools docs in future leaving your vote on the article <ulink
+ url="http://wiki.jboss.org/wiki/JBossToolsDocsFuture"
+ >Overview of the improvements required by JBossTools/JBDS Docs users</ulink>.
+ </para>
+
+ <para>
+ A set of movies on Seam tooling is available on <ulink url="http://docs.jboss.org/tools/movies">Seam movies page</ulink>.
+ </para>
+ </section>
+</chapter>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_menus_and_actions.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_menus_and_actions.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_menus_and_actions.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,361 +1,363 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="menus_and_actions">
- <?dbhtml filename="seam_menus_and_actions.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Seam</keyword>
- <keyword>JBDS</keyword>
- <keyword>menus</keyword>
- <keyword>actions</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Seam Menus and Actions</title>
-
- <para>In this chapter we provide a description of Seam actions that are available from</para>
- <itemizedlist>
- <listitem>
- <para>Menu bar</para>
- </listitem>
- <listitem>
- <para>Toolbar</para>
- </listitem>
- <listitem>
- <para>Context menus in views</para>
- </listitem>
- </itemizedlist>
-
-
- <section id="file_menu">
-
- <title>File Menu Actions</title>
-
- <para>In a Seam perspective, by default there are the following actions in <emphasis>
- <property>File > New</property>
- </emphasis> submenu</para>
-
- <table>
- <title>Seam Actions in the New Submenu</title>
- <tgroup cols="2">
- <colspec colnum="1" align="left" colwidth="1*"/>
- <colspec colnum="2" colwidth="4*"/>
-
- <thead>
- <row>
- <entry align="center">
- <para>Name</para>
- </entry>
-
- <entry align="center">
- <para>Function</para>
- </entry>
-
- </row>
- </thead>
-
- <tbody>
-
-
- <row>
- <entry>
- <para>
- <property>Seam Web Project</property>
- </para>
-
- </entry>
-
- <entry>
- <para>Runs <xref linkend="standaloneSeam"/> wizard
- for creating a new Seam project </para>
- </entry>
-
-
- </row>
-
-
- <row>
- <entry>
- <para>
- <property>Seam Action</property>
- </para>
-
- </entry>
-
- <entry>
- <para>Runs <xref linkend="seam_action"/> wizard for
- creating a new Seam action </para>
- </entry>
-
-
- </row>
-
-
-
- <row>
- <entry>
- <para>
- <property>Seam Form</property>
- </para>
-
- </entry>
-
- <entry>
- <para>Runs <xref linkend="seam_form"/> wizard for
- creating a new Seam form </para>
- </entry>
-
-
- </row>
-
-
- <row>
- <entry>
- <para>
- <property>Seam Entity</property>
- </para>
-
- </entry>
-
- <entry>
- <para>Runs <xref linkend="seam_entity"/> wizard for
- creating a new Seam entity </para>
- </entry>
-
-
- </row>
-
- <row>
- <entry>
- <para>
- <property>Seam Conversation</property>
- </para>
-
- </entry>
-
- <entry>
- <para>Runs <xref linkend="seam_conversation"/> wizard for creating a new Seam conversation
- </para>
- </entry>
-
-
-
- </row>
-
- <row>
- <entry>
- <para>
- <property>Seam Generate Entities</property>
- </para>
-
- </entry>
-
- <entry>
- <para>Runs <xref linkend="generate_entities"/> wizard</para>
- </entry>
-
-
-
- </row>
-
-
- </tbody>
- </tgroup>
- </table>
-
-
- </section>
-
- <section id="navigate_menu">
- <title>Navigate Menu Actions</title>
-
- <para>In the next sections we are going to describe Seam actions which can help you to
- easily navigate through the source code.</para>
-
- <section id="find_seam_ref_decl">
-
- <title>Find Seam References/Declarations</title>
-
- <para>To find EL expressions both in <emphasis>
- <property>.java</property>
- </emphasis> and <emphasis>
- <property>.xhtml</property>
- </emphasis> files use Find Seam References/Declarations actions. For that, in the main menu bar click on <emphasis>
- <property>Search > Find Seam References</property>
- </emphasis> or <emphasis><property>Find Seam Declarations</property>.</emphasis>
- </para>
-
- <para>Look at the description of the actions in the table below.</para>
-
- <table>
- <title>Find Seam References/Declarations actions</title>
- <tgroup cols="3">
- <colspec colnum="1" align="left" colwidth="1*"/>
- <colspec colnum="2" colwidth="4*"/>
- <colspec colnum="3" colwidth="2*"/>
-
-
- <thead>
- <row>
- <entry align="center">
- <para>Name</para>
- </entry>
-
- <entry align="center">
- <para>Function</para>
- </entry>
-
- <entry align="center">
- <para>Keyboard Shortcut</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
-
-
- <row>
- <entry>
- <para>
- <property>Find Seam References</property>
- </para>
- <para>
- <property>Find Seam Declarations</property>
- </para>
- </entry>
-
- <entry>
- <para>Find all references and declarations to the selected element.
- It's available for EL expressions in both .java and .xhtml
- files. Differs from normal Eclipse Find References/Declarations
- by showing an EL or Seam references in the Search View. </para>
- </entry>
-
- <entry>
- <para>Ctrl+G</para>
- <para>Ctrl+Shift+G</para>
- <para>also Ctrl + 1 for .java files</para>
-
- </entry>
-
- </row>
- </tbody>
- </tgroup>
- </table>
-
-
- <para>On the screenshot example below you could see that the search results are listed
- in the
- <property>Search view</property>.
- </para>
-
- <figure>
- <title>Find Seam Declaration for "Identity"</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_menus_and_actions/menus_and_actions1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You can also use Ctrl + 1 in .java files to activate the actions:</para>
-
- <figure>
- <title>Find Seam References for "Identity"</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_menus_and_actions/menus_and_actions2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
- <section id="open_seam_component">
- <title>Open Seam Component</title>
-
- <para>To open Seam Components click on <emphasis><property>Navigate > Open Seam
- Component</property></emphasis> in the main menu bar. This dialog is also available from toolbar
- icon or with hot keys combination "Ctrl+Shift+Z ".</para>
-
- <figure>
- <title>Open Seam Components icon</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3_0.png"
- />
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In the table below read a description about the dialog.</para>
-
- <table>
- <title>Open Seam Components Dialog</title>
- <tgroup cols="3">
- <colspec colnum="1" align="left" colwidth="1*"/>
- <colspec colnum="2" colwidth="4*"/>
- <colspec colnum="3" colwidth="2*"/>
-
-
- <thead>
- <row>
- <entry align="center">
- <para>Name</para>
- </entry>
-
- <entry align="center">
- <para>Function</para>
- </entry>
-
- <entry align="center">
- <para>Keyboard Shortcut</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
-
-
- <row>
- <entry>
- <para>
- <property>Open Seam Components</property>
- </para>
-
- </entry>
-
- <entry>
- <para>Brings up the Open Seam Component dialog to open a component
- in the editor. The Open Seam Component selection dialog shows
- all Seam components existing in the workspace. You can search
- the components via their short, imported or full name.</para>
- </entry>
-
- <entry>
- <para>Ctrl+Shift+Z</para>
-
- </entry>
-
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <para>Enter a name in the text field and see the results as it shown on screenshot: </para>
-
- <figure>
- <title>Open Seam Components Dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>You can also open Seam Component from the other component where the required one is declared in <code>@In </code> by using
- <xref linkend="OpenOn"/> (<property>Ctrl + left click</property> and select <property>Open Declaration of Seam Component for seam_component in Seam_class.java</property> ).</para>
- </section>
-
- </section>
-
-</chapter>
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="menus_and_actions">
+<?dbhtml filename="seam_menus_and_actions.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+
+ <keyword>Seam</keyword>
+
+ <keyword>JBDS</keyword>
+
+ <keyword>menus</keyword>
+
+ <keyword>actions</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Seam Menus and Actions</title>
+ <para>
+ In this chapter we provide a description of Seam actions that are available from
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Menu bar
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Toolbar
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Context menus in views
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <section id="file_menu">
+ <title>File Menu Actions</title>
+ <para>
+ In a Seam perspective, by default there are the following actions in <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem></menuchoice> submenu
+ </para>
+
+ <table>
+ <title>Seam Actions in the New Submenu</title>
+ <tgroup cols="2">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+
+ <colspec colnum="2" colwidth="4*"/>
+
+ <thead>
+ <row>
+ <entry align="center">
+ <para>
+ Name
+ </para>
+ </entry>
+
+ <entry align="center">
+ <para>
+ Function
+ </para>
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ <property>Seam Web Project</property>
+ </para>
+ </entry>
+
+ <entry>
+ <para>
+ Runs <xref linkend="standaloneSeam"/> wizard for creating a new Seam project
+ </para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>
+ <property>Seam Action</property>
+ </para>
+ </entry>
+
+ <entry>
+ <para>
+ Runs <xref linkend="seam_action"/> wizard for creating a new Seam action
+ </para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>
+ <property>Seam Form</property>
+ </para>
+ </entry>
+
+ <entry>
+ <para>
+ Runs <xref linkend="seam_form"/> wizard for creating a new Seam form
+ </para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>
+ <property>Seam Entity</property>
+ </para>
+ </entry>
+
+ <entry>
+ <para>
+ Runs <xref linkend="seam_entity"/> wizard for creating a new Seam entity
+ </para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>
+ <property>Seam Conversation</property>
+ </para>
+ </entry>
+
+ <entry>
+ <para>
+ Runs <xref linkend="seam_conversation"/> wizard for creating a new Seam conversation
+ </para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>
+ <property>Seam Generate Entities</property>
+ </para>
+ </entry>
+
+ <entry>
+ <para>
+ Runs <xref linkend="generate_entities"/> wizard
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section id="navigate_menu">
+ <title>Navigate Menu Actions</title>
+ <para>
+ In the next sections we are going to describe Seam actions which can help you to easily navigate through the source code.
+ </para>
+
+ <section id="find_seam_ref_decl">
+ <title>Find Seam References/Declarations</title>
+ <para>
+ To find EL expressions both in <emphasis> <property>.java</property> </emphasis> and <emphasis> <property>.xhtml</property> </emphasis> files use Find Seam References/Declarations actions. For that, in the main menu bar click on <menuchoice><guimenuitem>Search</guimenuitem><guimenuitem>Find Seam References</guimenuitem></menuchoice> or <emphasis><property>Find Seam Declarations</property>.</emphasis>
+ </para>
+
+ <para>
+ Look at the description of the actions in the table below.
+ </para>
+
+ <table>
+ <title>Find Seam References/Declarations actions</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+
+ <colspec colnum="2" colwidth="4*"/>
+
+ <colspec colnum="3" colwidth="2*"/>
+
+ <thead>
+ <row>
+ <entry align="center">
+ <para>
+ Name
+ </para>
+ </entry>
+
+ <entry align="center">
+ <para>
+ Function
+ </para>
+ </entry>
+
+ <entry align="center">
+ <para>
+ Keyboard Shortcut
+ </para>
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ <property>Find Seam References</property>
+ </para>
+
+ <para>
+ <property>Find Seam Declarations</property>
+ </para>
+ </entry>
+
+ <entry>
+ <para>
+ Find all references and declarations to the selected element. It's available for EL expressions in both .java and .xhtml files. Differs from normal Eclipse Find References/Declarations by showing an EL or Seam references in the Search View.
+ </para>
+ </entry>
+
+ <entry>
+ <para>
+ Ctrl+G
+ </para>
+
+ <para>
+ Ctrl+Shift+G
+ </para>
+
+ <para>
+ also Ctrl + 1 for .java files
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ On the screenshot example below you could see that the search results are listed in the <property>Search view</property>.
+ </para>
+
+ <figure>
+ <title>Find Seam Declaration for "Identity"</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_menus_and_actions/menus_and_actions1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ You can also use Ctrl + 1 in .java files to activate the actions:
+ </para>
+
+ <figure>
+ <title>Find Seam References for "Identity"</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_menus_and_actions/menus_and_actions2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="open_seam_component">
+ <title>Open Seam Component</title>
+ <para>
+ To open Seam Components click on <menuchoice><guimenuitem>Navigate</guimenuitem><guimenuitem>Open Seam Component</guimenuitem></menuchoice> in the main menu bar. This dialog is also available from toolbar icon or with hot keys combination "Ctrl+Shift+Z ".
+ </para>
+
+ <figure>
+ <title>Open Seam Components icon</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3_0.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ In the table below read a description about the dialog.
+ </para>
+
+ <table>
+ <title>Open Seam Components Dialog</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+
+ <colspec colnum="2" colwidth="4*"/>
+
+ <colspec colnum="3" colwidth="2*"/>
+
+ <thead>
+ <row>
+ <entry align="center">
+ <para>
+ Name
+ </para>
+ </entry>
+
+ <entry align="center">
+ <para>
+ Function
+ </para>
+ </entry>
+
+ <entry align="center">
+ <para>
+ Keyboard Shortcut
+ </para>
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ <property>Open Seam Components</property>
+ </para>
+ </entry>
+
+ <entry>
+ <para>
+ Brings up the Open Seam Component dialog to open a component in the editor. The Open Seam Component selection dialog shows all Seam components existing in the workspace. You can search the components via their short, imported or full name.
+ </para>
+ </entry>
+
+ <entry>
+ <para>
+ Ctrl+Shift+Z
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ Enter a name in the text field and see the results as it shown on screenshot:
+ </para>
+
+ <figure>
+ <title>Open Seam Components Dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ You can also open Seam Component from the other component where the required one is declared in <code>@In </code> by using <xref linkend="OpenOn"/> (<property>Ctrl + left click</property> and select <property>Open Declaration of Seam Component for seam_component in Seam_class.java</property> ).
+ </para>
+ </section>
+ </section>
+</chapter>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_preferences.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_preferences.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_preferences.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,237 +1,250 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="seam_preferences">
- <!-- mark as new -->
- <?dbhtml filename="seam_preferences.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Seam</keyword>
- <keyword>Preferences</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Seam Preferences</title>
-
- <para>In this chapter you get to know how Seam preferences can be modified during the
- development process.</para>
-
- <section id="gen_pref">
- <title>General Preferences</title>
-
- <para>Seam preferences can be set using the Seam preference page. Click on
- <emphasis><property>Window > Preferences > JBoss Tools > Web >
- Seam</property>.</emphasis></para>
-
- <para>On this page you can manage the Seam Runtime. Use the appropriate buttons to
- <property>Add</property> more runtimes or to <property>Remove</property> those that
- are not needed.</para>
-
- <figure>
- <title>Seam Preferences Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_preferences/seam_preferences1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Clicking on <property>Edit</property> button you get the form where you can change the
- path of Seam runtime home folder, modify name and version. Press
- <property>Finish</property> to apply the changes.</para>
-
- <figure>
- <title>Edit Seam Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_preferences/seam_preferences1_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <note>
- <title>Tip:</title>
- <para>If you try to delete the Seam Runtime that is already in use by some project in the current workspace, then a warning message will appear. To confirm the removal press <property>OK</property>
- </para>
- <para>Besides, when you right-click on your Seam project with deleted runtime in Project Explorer and select<property> Properties > Seam Settings</property> the error message "Runtime <runtime_name> does not exist" will appear. </para>
- </note>
- <section id="validator_pref">
-
- <title>Validator Preferences</title>
-
- <para>Seam preference page includes a subsection <property>Validator</property>. See
- <emphasis><property>Window > Preferences > JBoss Tools > Web > Seam >
- Validator</property>.</emphasis></para>
- <para>On this page you can choose a severity level for the various Seam validator
- problems. For example, if you want to ignore the case when component name is
- duplicated expand the <property>Components</property> node and select
- <property>Ignore</property> next to <property>Duplicate component
- name</property>. After that you won't see the error.</para>
-
-
- <figure>
- <title>Seam Validator Preference Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_preferences/seam_preferences1_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Notice, that in the <emphasis>
- <property>Expression language</property>
- </emphasis> section there is now a preference for setting severity of EL Syntax. You
- can select whether the Seam validator displays an error, a warning or just ignore
- the EL Syntax error.</para>
- <note><para>There are references made between each EL and variable name, so you can revalidate a particular EL if a context variable was changed. This makes parsing of each resource with referenced ELs much faster.</para></note>
-
-
- <figure>
- <title>Severity Preference for EL Syntax</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_preferences/el_syntax_error.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The <emphasis>
- <property>Revalidate unresolved ELs automatically</property></emphasis> option is enabled by default.
- If necessary, you can uncheck it. It may increase a performance for big complex projects.</para>
-
- <para>In the upper right corner of the Seam Validator preferences page there is a <emphasis><property>Configure Project
- Specific Settings</property></emphasis> link. Clicking on it you get the form where you can
- choose a project for specific setting. Project specific configuration allows you to
- have different validator settings for each project. Check the <emphasis><property>Show only
- projects with project specific settings</property></emphasis> if you want to see the
- projects that have been already set. Click on <property>Ok</property>.</para>
-
- <figure>
- <title>Project Specific Configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_preferences/seam_preferences1_4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You get the validator properties page for chosen project. Check the
- <property>Enable project specific settings</property> to be able to change the
- settings.</para>
-
- <note>
- <title>Note:</title>
- <para>You can open the same page by right clicking on the needed project in Package
- Explorer, then <emphasis><property>Properties > Seam
- Validator</property>.</emphasis></para>
- </note>
-
- <figure>
- <title>Validator Properties Page for Chosen Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_preferences/seam_preferences1_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- </section>
- </section>
-
- <section id="project_pref">
- <title>Project Preferences</title>
-
- <para>Once Seam project is created you can modify its settings. Right click on Seam project
- in Project Explorer and select <emphasis><property>Properties > Seam
- Settings</property>.</emphasis></para>
- <para>This project properties page allows you to have a flexible project layout. It means
- that you are not restricted with a specific project structure. You can use the Seam
- wizards (New Action, Form, Entity, etc.) on Maven, command line seam-gen or your own
- project structure. </para>
-
- <figure>
- <title>Properties for Seam Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_preferences/seam_preferences2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Tip:</title>
- <para>The wizard doesn't allow the renaming of the artifacts listed in the Seam
- Settings. It's possible to do in the <property>Package Explorer</property>.
- See <xref linkend="renaming_projects_folders"/>.</para>
- </note>
-
- <para>Also notice, you are not required to use the <property>New Seam Project
- wizard</property> to benefit from Seam artifact wizards. You can just enable Seam on
- your existing project by checking <property>Seam Support</property> and targeting to
- Seam Runtime, and then configure the folders as you want.</para>
-
- <figure>
- <title>Properties for Seam Project when Seam runtime is not selected</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_preferences/seam_preferences2_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Tip:</title>
- <para>On the figure above fields for configuring Seam artifacts are unavailable because Seam
- Runtime is not selected.</para>
- </note>
-
- <para>In Seam Wizards (New Action, Form, Entity, Conversation, Generate Entities) you can
- get a quick access to project settings using the <property>Settings</property> link in
- the upper right corner of each wizard.</para>
-
- <figure>
- <title>Quick Setting Link In Seam Wizards</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_preferences/seam_preferences2_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section id="add_custom_capabilities">
- <title>Adding Custom Capabilities</title>
-
- <para><property>JBoss Tools</property> provides a possibility to add custom capabilities to any Seam project,
- i.e. add a support of additional frameworks built on top of JSF, such as <itemizedlist>
- <listitem><para>ADF</para></listitem>
- <listitem><para>Facelets</para></listitem>
- <listitem><para>JBoss Rich Faces (versions 3.1, 3.2, 3.3)</para></listitem>
- </itemizedlist>
- </para>
- <para>To enable it, you should call the context menu for a Seam project and select <emphasis><property>JBoss
- Tools > Add Custom Capabilities</property>.</emphasis> Then check the needed modules and press
- <emphasis><property>Finish</property>.</emphasis></para>
-
- <figure>
- <title> Custom Capabilities be added to Seam Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_preferences/addCustomCapabilities.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The next page displays all the updates that have been made to the project.</para>
-
- <figure>
- <title>Adding Custom Capabilities to Seam Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_preferences/addCustomCapabilities2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
-</chapter>
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="seam_preferences">
+<!-- mark as new -->
+<?dbhtml filename="seam_preferences.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+
+ <keyword>Seam</keyword>
+
+ <keyword>Preferences</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Seam Preferences</title>
+ <para>
+ In this chapter you get to know how Seam preferences can be modified during the development process.
+ </para>
+
+ <section id="gen_pref">
+ <title>General Preferences</title>
+ <para>
+ Seam preferences can be set using the Seam preference page. Click on <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Seam.</guimenuitem></menuchoice>
+ </para>
+
+ <para>
+ On this page you can manage the Seam Runtime. Use the appropriate buttons to <property>Add</property> more runtimes or to <property>Remove</property> those that are not needed.
+ </para>
+
+ <figure>
+ <title>Seam Preferences Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Clicking on <property>Edit</property> button you get the form where you can change the path of Seam runtime home folder, modify name and version. Press <property>Finish</property> to apply the changes.
+ </para>
+
+ <figure>
+ <title>Edit Seam Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences1_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Tip:</title>
+ <para>
+ If you try to delete the Seam Runtime that is already in use by some project in the current workspace, then a warning message will appear. To confirm the removal press <property>OK</property>
+ </para>
+
+ <para>
+ Besides, when you right-click on your Seam project with deleted runtime in Project Explorer and select <menuchoice><guimenuitem>Properties</guimenuitem><guimenuitem>Seam Settings</guimenuitem></menuchoice> the error message "Runtime <runtime_name> does not exist" will appear.
+ </para>
+ </note>
+
+ <section id="validator_pref">
+ <title>Validator Preferences</title>
+ <para>
+ Seam preference page includes a subsection <property>Validator</property>. See <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Seam</guimenuitem><guimenuitem>Validator.</guimenuitem></menuchoice>
+ </para>
+
+ <para>
+ On this page you can choose a severity level for the various Seam validator problems. For example, if you want to ignore the case when component name is duplicated expand the <property>Components</property> node and select <property>Ignore</property> next to <property>Duplicate component name</property>. After that you won't see the error.
+ </para>
+
+ <figure>
+ <title>Seam Validator Preference Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences1_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Notice, that in the <emphasis> <property>Expression language</property> </emphasis> section there is now a preference for setting severity of EL Syntax. You can select whether the Seam validator displays an error, a warning or just ignore the EL Syntax error.
+ </para>
+
+ <note>
+ <para>
+ There are references made between each EL and variable name, so you can revalidate a particular EL if a context variable was changed. This makes parsing of each resource with referenced ELs much faster.
+ </para>
+ </note>
+
+ <figure>
+ <title>Severity Preference for EL Syntax</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/el_syntax_error.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The <emphasis> <property>Revalidate unresolved ELs automatically</property></emphasis> option is enabled by default. If necessary, you can uncheck it. It may increase a performance for big complex projects.
+ </para>
+
+ <para>
+ In the upper right corner of the Seam Validator preferences page there is a <emphasis><property>Configure Project Specific Settings</property></emphasis> link. Clicking on it you get the form where you can choose a project for specific setting. Project specific configuration allows you to have different validator settings for each project. Check the <emphasis><property>Show only projects with project specific settings</property></emphasis> if you want to see the projects that have been already set. Click on <property>Ok</property>.
+ </para>
+
+ <figure>
+ <title>Project Specific Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences1_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ You get the validator properties page for chosen project. Check the <property>Enable project specific settings</property> to be able to change the settings.
+ </para>
+
+ <note>
+ <title>Note:</title>
+ <para>
+ You can open the same page by right clicking on the needed project in Package Explorer, then <menuchoice><guimenuitem>Properties</guimenuitem><guimenuitem>Seam Validator.</guimenuitem></menuchoice>
+ </para>
+ </note>
+
+ <figure>
+ <title>Validator Properties Page for Chosen Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences1_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ </section>
+
+ <section id="project_pref">
+ <title>Project Preferences</title>
+ <para>
+ Once Seam project is created you can modify its settings. Right click on Seam project in Project Explorer and select <menuchoice><guimenuitem>Properties</guimenuitem><guimenuitem>Seam Settings.</guimenuitem></menuchoice>
+ </para>
+
+ <para>
+ This project properties page allows you to have a flexible project layout. It means that you are not restricted with a specific project structure. You can use the Seam wizards (New Action, Form, Entity, etc.) on Maven, command line seam-gen or your own project structure.
+ </para>
+
+ <figure>
+ <title>Properties for Seam Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Tip:</title>
+ <para>
+ The wizard doesn't allow the renaming of the artifacts listed in the Seam Settings. It's possible to do in the <property>Package Explorer</property>. See <xref linkend="renaming_projects_folders"/>.
+ </para>
+ </note>
+
+ <para>
+ Also notice, you are not required to use the <property>New Seam Project wizard</property> to benefit from Seam artifact wizards. You can just enable Seam on your existing project by checking <property>Seam Support</property> and targeting to Seam Runtime, and then configure the folders as you want.
+ </para>
+
+ <figure>
+ <title>Properties for Seam Project when Seam runtime is not selected</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences2_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Tip:</title>
+ <para>
+ On the figure above fields for configuring Seam artifacts are unavailable because Seam Runtime is not selected.
+ </para>
+ </note>
+
+ <para>
+ In Seam Wizards (New Action, Form, Entity, Conversation, Generate Entities) you can get a quick access to project settings using the <property>Settings</property> link in the upper right corner of each wizard.
+ </para>
+
+ <figure>
+ <title>Quick Setting Link In Seam Wizards</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences2_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="add_custom_capabilities">
+ <title>Adding Custom Capabilities</title>
+ <para>
+ <property>JBoss Tools</property> provides a possibility to add custom capabilities to any Seam project, i.e. add a support of additional frameworks built on top of JSF, such as
+ <itemizedlist>
+ <listitem>
+ <para>
+ ADF
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Facelets
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ JBoss Rich Faces (versions 3.1, 3.2, 3.3)
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ To enable it, you should call the context menu for a Seam project and select <menuchoice><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Add Custom Capabilities.</guimenuitem></menuchoice> Then check the needed modules and press <emphasis><property>Finish</property>.</emphasis>
+ </para>
+
+ <figure>
+ <title> Custom Capabilities be added to Seam Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/addCustomCapabilities.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The next page displays all the updates that have been made to the project.
+ </para>
+
+ <figure>
+ <title>Adding Custom Capabilities to Seam Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/addCustomCapabilities2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+</chapter>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_refactoring.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_refactoring.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_refactoring.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,231 +1,292 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter id="seam_refactoring">
- <?dbhtml filename="seam_refactoring.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>Seam refactoring tools
- </keyword>
- <keyword>seam</keyword>
- <keyword>rename</keyword>
- </keywordset>
- </chapterinfo>
- <title>Seam Refactoring Tools</title>
- <para>The goal of Seam components refactoring is to make system-wide code changes without affecting the behavior of the program.
- The Seam module of <property>JBoss Tools</property> provides assistance in easily code refactoring.</para>
-
- <para>Starting from Jboss Tools M4 refactoring functionality became also available for managed beans, method and properties used in ELs.
- Thus now Seam refactoring tools include the next refactoring operations:</para>
-
- <itemizedlist>
- <listitem><para><xref linkend="renaming_seam_components"/></para></listitem>
- <listitem><para><xref linkend="renaming_seam_context_vars"/></para></listitem>
- </itemizedlist>
-
- <para>Refactoring commands are available from the context menus of several views and editors and use a standard Eclipse refactoring wizard.
- For details, see <xref linkend="RefactornigWizard"/> later in this chapter.</para>
-
- <note>
- <title>Note:</title>
- <para>Seam refactoring could be only performed in the file that is not marked as <emphasis><property>Read only</property></emphasis> in its properties.</para>
- </note>
-
- <figure>
- <title>Properties View for Java File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_refactoring/seam_refactor10.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <section id="RefactornigWizard">
- <title>Using the Refactorinig Wizard</title>
- <para>This wizard is opened always when the user clicks the <emphasis><property>Rename Seam Component</property>,</emphasis>
- <emphasis><property>Rename Seam Context Variable</property></emphasis>
- or <emphasis><property>Rename</property></emphasis> command in any of the views/editors mentioned later in this chapter.
- </para>
-
- <figure>
- <title>Refactoring Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_refactoring/seam_refactor2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In the <property>Seam Components name</property> field you should enter a new name of the component,
- then click <property>Next</property> and follow the next wizard steps:
+<?dbhtml filename="seam_refactoring.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>Seam refactoring tools</keyword>
+
+ <keyword>seam</keyword>
+
+ <keyword>rename</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Seam Refactoring Tools</title>
+ <para>
+ The goal of Seam components refactoring is to make system-wide code changes without affecting the behavior of the program. The Seam module of <property>JBoss Tools</property> provides assistance in easily code refactoring.
+ </para>
+
+ <para>
+ Starting from Jboss Tools M4 refactoring functionality became also available for managed beans, method and properties used in ELs. Thus now Seam refactoring tools include the next refactoring operations:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <xref linkend="renaming_seam_components"/>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <xref linkend="renaming_seam_context_vars"/>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ Refactoring commands are available from the context menus of several views and editors and use a standard Eclipse refactoring wizard. For details, see <xref linkend="RefactornigWizard"/> later in this chapter.
+ </para>
+
+ <note>
+ <title>Note:</title>
+ <para>
+ Seam refactoring could be only performed in the file that is not marked as <emphasis><property>Read only</property></emphasis> in its properties.
+ </para>
+ </note>
+
+ <figure>
+ <title>Properties View for Java File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_refactoring/seam_refactor10.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <section id="RefactornigWizard">
+ <title>Using the Refactorinig Wizard</title>
+ <para>
+ This wizard is opened always when the user clicks the <emphasis><property>Rename Seam Component</property>,</emphasis> <emphasis><property>Rename Seam Context Variable</property></emphasis> or <emphasis><property>Rename</property></emphasis> command in any of the views/editors mentioned later in this chapter.
+ </para>
+
+ <figure>
+ <title>Refactoring Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_refactoring/seam_refactor2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ In the <property>Seam Components name</property> field you should enter a new name of the component, then click <property>Next</property> and follow the next wizard steps:
+ </para>
+
+ <figure>
+ <title>Navigating Between the Differences</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_refactoring/seam_refactor3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ As you see, when performing a refactoring operation, you can preview all of the changes resulting from a refactoring action before you choose to carry them out.
+ </para>
+
+ <para>
+ The view represents two windows: one with the original source code and the other with refactored one.
+ </para>
+
+ <para>
+ With the help of
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_refactoring/butt1.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ ,
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_refactoring/butt2.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ ,
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_refactoring/butt3.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ ,
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_refactoring/butt4.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ buttons you can quickly navigate between the differences in the code. If you don't agree with some changes you can't undo them but you can remove the class from the list of classes that need refactoring.
+ </para>
+
+ <figure>
+ <title>List of classes that need refactoring </title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_refactoring/seam_refactor4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ To apply the changes click <emphasis><property>Finish</property>.</emphasis>
+ </para>
+
+ <para>
+ Renaming the selected seam component corrects all references to the component (also in other files in the project). Renaming a type doesn't allow to rename similarly named variables and methods.
+ </para>
+ </section>
+
+ <section id="renaming_seam_components">
+ <title>Renaming Seam Components</title>
+ <para>
+ Renaming a Seam component could be performed in the:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <xref linkend="JavaEditor"/>
</para>
-
- <figure>
- <title>Navigating Between the Differences</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_refactoring/seam_refactor3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>As you see, when performing a refactoring operation, you can preview all of the changes resulting from a refactoring
- action before you choose to carry them out.</para>
-
- <para>The view represents two windows: one with the original source code and the other with refactored one.</para>
-
- <para>With the help of
- <inlinemediaobject> <imageobject>
- <imagedata fileref="images/seam_refactoring/butt1.png"/>
- </imageobject></inlinemediaobject>,
- <inlinemediaobject> <imageobject>
- <imagedata fileref="images/seam_refactoring/butt2.png"/>
- </imageobject></inlinemediaobject>,
- <inlinemediaobject> <imageobject>
- <imagedata fileref="images/seam_refactoring/butt3.png"/>
- </imageobject></inlinemediaobject>,
- <inlinemediaobject> <imageobject>
- <imagedata fileref="images/seam_refactoring/butt4.png"/>
- </imageobject></inlinemediaobject> buttons you can quickly navigate between the differences in the code.
- If you don't agree with some changes you can't undo them but you can remove the class from the list of classes that need refactoring.
- </para>
-
- <figure>
- <title>List of classes that need refactoring
- </title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_refactoring/seam_refactor4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>To apply the changes click <emphasis><property>Finish</property>.</emphasis></para>
-
- <para>Renaming the selected seam component corrects all references to the
- component (also in other files in the project). Renaming a type doesn't allow to rename
- similarly named variables and methods.
- </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <xref linkend="SeamComponents"/>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <xref linkend="components_xml_editor"/>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <section id="JavaEditor">
+ <title>Renaming Seam Components in the Java Editor</title>
+ <para>
+ If you want to rename certain seam component using Java editor, first of all it's necessary to open it. If you don't know, where the seam component is declared, use <xref linkend="open_seam_component"/> icon.
+ </para>
+
+ <para>
+ To rename a Seam component in the Java editor it's necessary to select the component, left click the file and then select <menuchoice><guimenuitem>Seam Refactor</guimenuitem><guimenuitem>Rename Seam Component.</guimenuitem></menuchoice>
+ </para>
+
+ <figure>
+ <title>Opening Refactoring Wizard in Java Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_refactoring/seam_refactor1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ For details, see also the movie, <ulink url="http://docs.jboss.org/tools/movies/demos/rename_seam_components_java/rena...">"Renaming a Seam component in the Java Editor"</ulink>.
+ </para>
</section>
-
- <section id="renaming_seam_components">
- <title>Renaming Seam Components</title>
-
- <para>Renaming a Seam component could be performed in the:</para>
-
- <itemizedlist>
- <listitem><para><xref linkend="JavaEditor"/></para></listitem>
- <listitem><para><xref linkend="SeamComponents"/></para></listitem>
- <listitem><para><xref linkend="components_xml_editor"/></para></listitem>
- </itemizedlist>
-
- <section id="JavaEditor">
- <title>Renaming Seam Components in the Java Editor</title>
- <para>If you want to rename certain seam component using Java editor, first of all it's necessary to open it.
- If you don't know, where the seam component is declared, use <xref linkend="open_seam_component"/> icon.</para>
- <para>To rename a Seam component in the Java editor it's necessary to select the component, left click the file and then select
- <emphasis><property>Seam Refactor > Rename Seam Component</property>.</emphasis>
- </para>
- <figure>
- <title>Opening Refactoring Wizard in Java Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_refactoring/seam_refactor1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>For details, see also the movie,
- <ulink url="http://docs.jboss.org/tools/movies/demos/rename_seam_components_java/rena...">"Renaming a Seam component in the Java Editor"</ulink>.</para>
- </section>
-
- <section id="SeamComponents">
- <title>Renaming Seam Components in the Seam Components View</title>
- <para>To open the <property>Refactoring</property> wizard in the <property>Seam Components</property> view
- you should left click the component you want to open and choose <property>Rename Seam Component</property> option.</para>
-
- <figure>
- <title>Opening Refactoring Wizard in Seam Components View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_refactoring/seam_refactor5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>For details, see also the movie,
- <ulink url="http://docs.jboss.org/tools/movies/demos/rename_seam_components_comp_view...">"Renaming a Seam component in the Seam Components view"</ulink>.</para>
- </section>
-
- <section id="components_xml_editor">
- <title>Renaming Seam Components in the Seam Components Editor</title>
- <para>When you open <literal>components.xml</literal> file using <property>JBoss Tools XML Editor</property>, open the
- <property>Refactoring</property> wizard in the Tree tab by left-clicking the component in
- <property>components</property> area and choosing <property>Rename</property> option.</para>
-
- <figure>
- <title>Opening Refactoring Wizard in <emphasis><property>components.xml</property></emphasis> File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_refactoring/seam_refactor6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>For details, see also the movie,
- <ulink url="http://docs.jboss.org/tools/movies/demos/rename_seam_components_comp_xml/...">"Renaming a Seam component in the components.xml file"</ulink>.</para>
- </section>
-
- </section>
-
- <section id="renaming_seam_context_vars">
- <title>Renaming Seam Context Variables in EL</title>
-
- <para>Renaming a Seam context variables in EL could be executed in <literal>.java</literal>, <literal>.xml</literal>, <literal>.jsp</literal>,
- <literal>.xhtml</literal> and <literal>.properties</literal> files in Seam projects using
- the context menu command <emphasis><property>Seam Refactor > Rename Seam Context Variable</property>.</emphasis></para>
-
- <figure>
- <title>Refactoring Seam Context Variable in .properties File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_refactoring/seam_refactor9.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <figure>
- <title>Opening Refactoring wizard in components.xml file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_refactoring/seam_refactor7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <figure>
- <title>Opening Refactoring wizard in .html file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_refactoring/seam_refactor8.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>For details, see also a set of movies about renaming Seam context variables in EL in different locations:</para>
- <itemizedlist>
- <listitem>
- <para><ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variables_java/re...">In the Java editor</ulink></para>
- </listitem>
- <listitem>
- <para><ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variables_propert...">In the JBoss Tools Properties Editor</ulink></para>
- </listitem>
- <listitem>
- <para><ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variables_xml/ren...">In the XML editor</ulink></para>
- </listitem>
- <listitem>
- <para><ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variables_vpe/ren...">In the Visual Page Editor</ulink></para>
- </listitem>
- </itemizedlist>
- </section>
+
+ <section id="SeamComponents">
+ <title>Renaming Seam Components in the Seam Components View</title>
+ <para>
+ To open the <property>Refactoring</property> wizard in the <property>Seam Components</property> view you should left click the component you want to open and choose <property>Rename Seam Component</property> option.
+ </para>
+
+ <figure>
+ <title>Opening Refactoring Wizard in Seam Components View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_refactoring/seam_refactor5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ For details, see also the movie, <ulink url="http://docs.jboss.org/tools/movies/demos/rename_seam_components_comp_view...">"Renaming a Seam component in the Seam Components view"</ulink>.
+ </para>
+ </section>
+
+ <section id="components_xml_editor">
+ <title>Renaming Seam Components in the Seam Components Editor</title>
+ <para>
+ When you open <literal>components.xml</literal> file using <property>JBoss Tools XML Editor</property>, open the <property>Refactoring</property> wizard in the Tree tab by left-clicking the component in <property>components</property> area and choosing <property>Rename</property> option.
+ </para>
+
+ <figure>
+ <title>Opening Refactoring Wizard in <emphasis><property>components.xml</property></emphasis> File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_refactoring/seam_refactor6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ For details, see also the movie, <ulink url="http://docs.jboss.org/tools/movies/demos/rename_seam_components_comp_xml/...">"Renaming a Seam component in the components.xml file"</ulink>.
+ </para>
+ </section>
+ </section>
+
+ <section id="renaming_seam_context_vars">
+ <title>Renaming Seam Context Variables in EL</title>
+ <para>
+ Renaming a Seam context variables in EL could be executed in <literal>.java</literal>, <literal>.xml</literal>, <literal>.jsp</literal>, <literal>.xhtml</literal> and <literal>.properties</literal> files in Seam projects using the context menu command <menuchoice><guimenuitem>Seam Refactor</guimenuitem><guimenuitem>Rename Seam Context Variable.</guimenuitem></menuchoice>
+ </para>
+
+ <figure>
+ <title>Refactoring Seam Context Variable in .properties File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_refactoring/seam_refactor9.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <figure>
+ <title>Opening Refactoring wizard in components.xml file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_refactoring/seam_refactor7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <figure>
+ <title>Opening Refactoring wizard in .html file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_refactoring/seam_refactor8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ For details, see also a set of movies about renaming Seam context variables in EL in different locations:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variables_java/re...">In the Java editor</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variables_propert...">In the JBoss Tools Properties Editor</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variables_xml/ren...">In the XML editor</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variables_vpe/ren...">In the Visual Page Editor</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
</chapter>
-
-
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_view.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_view.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_view.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -29,7 +29,7 @@
<para>The Seam Components View can show a components default scope in two ways:</para>
<itemizedlist>
- <listitem><para>as labels on each component (click on the triangular symbol at the top of the Seam Components View page and select <emphasis><property>Scope Presentation > Label</property></emphasis>)</para></listitem>
+ <listitem><para>as labels on each component (click on the triangular symbol at the top of the Seam Components View page and select <menuchoice><guimenuitem>Scope Presentation</guimenuitem><guimenuitem>Label</guimenuitem></menuchoice>)</para></listitem>
</itemizedlist>
<figure>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_wizards.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_wizards.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_wizards.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,341 +1,370 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="seam_wizards">
- <?dbhtml filename="seam_wizards.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Seam</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Seam Wizards</title>
-
- <para>This chapter introduces you with Seam Components.</para>
- <para>All the Seam component generations options known from Seam-gen are available as wizards
- (with sensible auto-defaulting) for creating various common Seam components:</para>
-
- <itemizedlist>
- <listitem>
- <para>
- <property>Seam Action</property>
- </para>
- </listitem>
- <listitem>
- <para>
- <property>Seam Form</property>
- </para>
- </listitem>
- <listitem>
- <para>
- <property>Seam Entity</property>
- </para>
- </listitem>
- <listitem>
- <para>
- <property>Seam Conversation</property>
- </para>
- </listitem>
- </itemizedlist>
-
- <para>Go to <emphasis>
- <property>File > New</property>
- </emphasis> and select the component wizard.</para>
-
- <figure>
- <title>Seam Component Wizards</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The wizards create multiple resources and place it in the appropriate folders depending on
- your project structure (WAR or EAR).</para>
- <para>Let's create a WAR project using the New Seam Project wizard.</para>
-
- <figure>
- <title>Seam Project WAR Deployment</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After the project is created you need deploy it on server.</para>
-
-
- <section id="seam_action">
-
- <title>New Seam Action</title>
-
- <para>In this and following sections you can see example creating Seam Components.</para>
- <para>To create a New Seam Action you should select a necessary project, type a name for
- <property>Seam component</property>, <property>POJO class</property>,
- <property>Method</property>, <property>Page</property> and select a
- <property>Package</property> using the <emphasis>
- <property>Browse</property>
- </emphasis> button.</para>
-
- <figure>
- <title>New Seam Action Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>If you specify a class which already exists, the wizard will warn you about it.</para>
-
- <figure>
- <title>Wizard Warning against Existing File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/action_warning.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You can see the action page in <property>WebContent</property> folder. Click on it to
- open in JBoss Tools HTML Editor.</para>
-
- <figure>
- <title>Action Page in JBoss Tools HTML Editor.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_5.png" scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <note>
- <title>Note:</title>
- <para>You don't need to restart the server to see how the action component works. Just
- use context menu <emphasis><property>Run As > Run On
- Server</property>.</emphasis></para>
- </note>
-
- <para>Action component was hot-deployed. Forms and Conversations will work the same
- way.</para>
-
- <figure>
- <title>Action Component</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
-
- </section>
- <section id="seam_form">
- <title>New Seam Form</title>
-
- <para>Click on <property>actionMethod</property> in the internal browser and add a form in
- your project using the New Seam Form wizard <emphasis><property>File > New > Seam
- Form</property>.</emphasis></para>
- <para>Select a necessary project, type a name for <property>Seam component</property>,
- <property>POJO class</property>, <property>Method</property>,
- <property>Page</property> and select a <property>Package</property> using <emphasis>
- <property>Browse</property>
- </emphasis> button.</para>
-
- <figure>
- <title>New Seam Form Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>If you specify a class which already exists, the wizard will warn you about it.</para>
-
- <figure>
- <title>Wizard Warning against Existing File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/form_warning.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The Form Page was created in <property>WebContent</property> folder.</para>
-
- <figure>
- <title>Form Page in JBoss Tools HTML Editor.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_8.png" scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Deploy the form on server. Right click on Form Page, select <emphasis><property>Run As
- > Run On Server</property>.</emphasis></para>
-
- <figure>
- <title>Form Component</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_9.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Form component was hot-deployed.</para>
-
- </section>
-
- <section id="seam_conversation">
- <title>New Seam Conversation</title>
-
- <para>Enter some value in the text field (e.g. <property>value1</property>) and click on
- <property>formMethod</property>.</para>
- <para>Add a conversation using the New Seam Conversation wizard <emphasis><property>File >
- New > Seam Form</property>.</emphasis></para>
- <para>You should select a necessary project, type a name for <property>Seam
- component</property>, <property>POJO class</property>, <property>Method</property>,
- <property>Page</property> and select a <property>Package</property> using <emphasis>
- <property>Browse</property>
- </emphasis> button.</para>
-
-
- <figure>
- <title>New Seam Conversation Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_10.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>If you specify a class which already exists, the wizard will warn you about it.</para>
-
- <figure>
- <title>Wizard Warning against Existing File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/conversation_warning.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Conversation page was created in <property>WebContent</property> folder.</para>
-
- <figure>
- <title>Conversation Page in JBoss Tools HTML Editor.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_11.png" scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Right click on Conversation page, select <emphasis><property>Run As > Run On
- Server</property>.</emphasis></para>
-
- <figure>
- <title>Conversation Component</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_12.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Conversation component was hot-deployed.</para>
- <para>Click on <property>Begin</property> and <property>Increment</property> buttons to
- check the conversation functionality.</para>
-
- </section>
-
-
- <section id="seam_entity">
- <title>New Seam Entity</title>
-
- <para>Entities cannot be hot-deployed, so we need to stop the server.</para>
- <para>Create an Entity using the New Entity wizard <emphasis><property>File > New > Seam
- Entity</property>.</emphasis>
- </para>
-
- <para>You should select a necessary project, type a name for <property>Entity
- class</property>, select a <property>Package</property> using <emphasis>
- <property>Browse</property>
- </emphasis> button, type a name for <property>Master Page</property> and
- <property>Page</property>.</para>
-
- <figure>
- <title>New Seam Entity Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_13.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>If you specify a class which already exists, the wizard will warn you about it.</para>
-
- <figure>
- <title>Wizard Warning against Existing File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/entity_warning.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The Master Page and the Entity were created in <property>WebContent</property>
- folder.</para>
-
- <figure>
- <title>Master Page in JBoss Tools HTML Editor.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_14.png" scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The Entity page is:</para>
-
- <figure>
- <title>Entity Page in JBoss Tools HTML Editor.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_15.png" scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Run the Entity page on server. This is what you get:</para>
-
- <figure>
- <title>Customer Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_16.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Let's create two customers <property>c1</property> and <property>c2</property>. Enter
- the name in the text field and press the <property>Save</property> button. Customer
- should be successfully created. Press <property>Done</property>. Do the same for
- <property>c2</property> customer. The result should be:</para>
-
- <figure>
- <title>Two Customers Are Created</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_wizards/seam_wizards_17.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-</chapter>
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="seam_wizards">
+<?dbhtml filename="seam_wizards.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+
+ <keyword>Seam</keyword>
+
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Seam Wizards</title>
+ <para>
+ This chapter introduces you with Seam Components.
+ </para>
+
+ <para>
+ All the Seam component generations options known from Seam-gen are available as wizards (with sensible auto-defaulting) for creating various common Seam components:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <property>Seam Action</property>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <property>Seam Form</property>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <property>Seam Entity</property>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <property>Seam Conversation</property>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ Go to <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem></menuchoice> and select the component wizard.
+ </para>
+
+ <figure>
+ <title>Seam Component Wizards</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The wizards create multiple resources and place it in the appropriate folders depending on your project structure (WAR or EAR).
+ </para>
+
+ <para>
+ Let's create a WAR project using the New Seam Project wizard.
+ </para>
+
+ <figure>
+ <title>Seam Project WAR Deployment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ After the project is created you need deploy it on server.
+ </para>
+
+ <section id="seam_action">
+ <title>New Seam Action</title>
+ <para>
+ In this and following sections you can see example creating Seam Components.
+ </para>
+
+ <para>
+ To create a New Seam Action you should select a necessary project, type a name for <property>Seam component</property>, <property>POJO class</property>, <property>Method</property>, <property>Page</property> and select a <property>Package</property> using the <emphasis> <property>Browse</property> </emphasis> button.
+ </para>
+
+ <figure>
+ <title>New Seam Action Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ If you specify a class which already exists, the wizard will warn you about it.
+ </para>
+
+ <figure>
+ <title>Wizard Warning against Existing File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/action_warning.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ You can see the action page in <property>WebContent</property> folder. Click on it to open in JBoss Tools HTML Editor.
+ </para>
+
+ <figure>
+ <title>Action Page in JBoss Tools HTML Editor.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_5.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+ <para>
+ You don't need to restart the server to see how the action component works. Just use context menu <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run On Server.</guimenuitem></menuchoice>
+ </para>
+ </note>
+
+ <para>
+ Action component was hot-deployed. Forms and Conversations will work the same way.
+ </para>
+
+ <figure>
+ <title>Action Component</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="seam_form">
+ <title>New Seam Form</title>
+ <para>
+ Click on <property>actionMethod</property> in the internal browser and add a form in your project using the New Seam Form wizard <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Form</guimenuitem></menuchoice>.
+ </para>
+
+ <para>
+ Select a necessary project, type a name for <property>Seam component</property>, <property>POJO class</property>, <property>Method</property>, <property>Page</property> and select a <property>Package</property> using <emphasis> <property>Browse</property> </emphasis> button.
+ </para>
+
+ <figure>
+ <title>New Seam Form Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ If you specify a class which already exists, the wizard will warn you about it.
+ </para>
+
+ <figure>
+ <title>Wizard Warning against Existing File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/form_warning.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The Form Page was created in <property>WebContent</property> folder.
+ </para>
+
+ <figure>
+ <title>Form Page in JBoss Tools HTML Editor.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_8.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Deploy the form on server. Right click on Form Page, select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run On Server.</guimenuitem></menuchoice>
+ </para>
+
+ <figure>
+ <title>Form Component</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_9.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Form component was hot-deployed.
+ </para>
+ </section>
+
+ <section id="seam_conversation">
+ <title>New Seam Conversation</title>
+ <para>
+ Enter some value in the text field (e.g. <property>value1</property>) and click on <property>formMethod</property>.
+ </para>
+
+ <para>
+ Add a conversation using the New Seam Conversation wizard <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Form.</guimenuitem></menuchoice>
+ </para>
+
+ <para>
+ You should select a necessary project, type a name for <property>Seam component</property>, <property>POJO class</property>, <property>Method</property>, <property>Page</property> and select a <property>Package</property> using <emphasis> <property>Browse</property> </emphasis> button.
+ </para>
+
+ <figure>
+ <title>New Seam Conversation Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_10.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ If you specify a class which already exists, the wizard will warn you about it.
+ </para>
+
+ <figure>
+ <title>Wizard Warning against Existing File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/conversation_warning.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Conversation page was created in <property>WebContent</property> folder.
+ </para>
+
+ <figure>
+ <title>Conversation Page in JBoss Tools HTML Editor.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_11.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Right click on Conversation page, select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run On Server.</guimenuitem></menuchoice>
+ </para>
+
+ <figure>
+ <title>Conversation Component</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_12.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Conversation component was hot-deployed.
+ </para>
+
+ <para>
+ Click on <property>Begin</property> and <property>Increment</property> buttons to check the conversation functionality.
+ </para>
+ </section>
+
+ <section id="seam_entity">
+ <title>New Seam Entity</title>
+ <para>
+ Entities cannot be hot-deployed, so we need to stop the server.
+ </para>
+
+ <para>
+ Create an Entity using the New Entity wizard <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Entity.</guimenuitem></menuchoice>
+ </para>
+
+ <para>
+ You should select a necessary project, type a name for <property>Entity class</property>, select a <property>Package</property> using <emphasis> <property>Browse</property> </emphasis> button, type a name for <property>Master Page</property> and <property>Page</property>.
+ </para>
+
+ <figure>
+ <title>New Seam Entity Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_13.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ If you specify a class which already exists, the wizard will warn you about it.
+ </para>
+
+ <figure>
+ <title>Wizard Warning against Existing File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/entity_warning.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The Master Page and the Entity were created in <property>WebContent</property> folder.
+ </para>
+
+ <figure>
+ <title>Master Page in JBoss Tools HTML Editor.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_14.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The Entity page is:
+ </para>
+
+ <figure>
+ <title>Entity Page in JBoss Tools HTML Editor.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_15.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Run the Entity page on server. This is what you get:
+ </para>
+
+ <figure>
+ <title>Customer Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_16.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Let's create two customers <property>c1</property> and <property>c2</property>. Enter the name in the text field and press the <property>Save</property> button. Customer should be successfully created. Press <property>Done</property>. Do the same for <property>c2</property> customer. The result should be:
+ </para>
+
+ <figure>
+ <title>Two Customers Are Created</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_17.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+</chapter>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/testng.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/en-US/testng.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/testng.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,249 +1,294 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="testNG">
- <?dbhtml filename="testNG.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>JBDS</keyword>
- <keyword>testNG</keyword>
- </keywordset>
- </chapterinfo>
- <title>Using TestNG project</title>
- <para>With the help this chapter you will get to know with TestNG.</para>
- <section>
- <title>What is TestNG?</title>
- <para><property>TestNG</property> ("Testing, the Next Generation") is a
- Java unit testing framework that aims to overcome many limitations of JUnit. TestNG
- introduces some new functionalities that make it more powerful and easier to use, such
- as:</para>
- <itemizedlist>
- <listitem>
- <para>JDK 5 Annotations (JDK 1.4 is also supported with JavaDoc annotations)</para>
- </listitem>
- <listitem>
- <para>Flexible test configuration</para>
- </listitem>
- <listitem>
- <para>Support for data-driven testing (with @DataProvider)</para>
- </listitem>
- <listitem>
- <para>Support for parameters</para>
- </listitem>
- <listitem>
- <para>Allows distribution of tests on slave machines</para>
- </listitem>
- <listitem>
- <para>Powerful execution model (no more TestSuite)</para>
- </listitem>
- <listitem>
- <para>Supported by a variety of tools and plug-ins (Eclipse, IDEA, Maven,
- etc...)</para>
- </listitem>
- <listitem>
- <para>Embeds BeanShell for further flexibility</para>
- </listitem>
- <listitem>
- <para>Default JDK functions for runtime and logging (no dependencies)</para>
- </listitem>
- <listitem>
- <para>Dependent methods for application server testing</para>
- </listitem>
- </itemizedlist>
-
- <para>More information can be found on home page: <ulink url="http://testng.org"
- >www.testng.org</ulink></para>
- </section>
- <section id="OtherRelevantResourcesOnTheTopic5">
- <?dbhtml filename="OtherRelevantResourcesOnTheTopic5.html"?>
- <title>Other relevant resources on the topic</title>
- <para>
- <ulink url="http://www.artima.com/lejava/articles/testng.html">Next-Generation Testing
- with TestNG (An Interview with Cedric Beust)</ulink>
- </para>
- <para>
- <ulink url="http://www.javaworld.com/javaworld/jw-04-2005/jw-0404-testng.html">TestNG:
- The next generation of unit testing</ulink>
- </para>
- <para>
- <ulink url="http://dev2dev.bea.com/pub/a/2006/09/testng-categorization.html">Test
- Categorization Techniques with TestNG</ulink>
- </para>
- <para>
- <ulink url="http://www-128.ibm.com/developerworks/java/library/j-testng/">TestNG makes
- Java unit testing a breeze</ulink>
- </para>
- <para>
- <ulink url="http://www-128.ibm.com/developerworks/java/library/j-cq08296/index.html">In
- pursuit of code quality: JUnit 4 vs. TestNG</ulink>
- </para>
- </section>
- <section>
- <title>How to use the generated Seam-test project to run Seam tests?</title>
-
- <itemizedlist>
- <listitem>
- <para>Create a new Seam Web Project with EAR deployment using the New Seam Project
- wizard.</para>
- </listitem>
- </itemizedlist>
-
- <itemizedlist>
- <listitem>
- <para>After a project is created you will have the generated Seam-test project that
- is setup to run TestNG directly against the proper libraries and server runtime
- libraries.</para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>Seam-test Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/testng/testng_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Add Seam Action to your project via <emphasis><property>File > New > Seam
- Action</property>.</emphasis></para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>Seam Action Creation</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/testng/testng_6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Fill out the wizard fields. New Seam Action wizard will create resources and
- place them in the appropriate folders dependent on EAR project structure.</para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>New Seam Action Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/testng/testng_7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>When Action is created you will see <property>actionPage.xhtml</property> in
- Package Explorer view. <property>ActionBean.java</property> will be
- automatically opened in Java Editor.</para>
- </listitem>
- </itemizedlist>
-
- <figure>
- <title>Created Action</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/testng/testng_8.png" scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <itemizedlist>
- <listitem>
- <para>Select <property>ActionLocalTest.xml</property> in Seam-test project and run
- the test with right click <emphasis><property>Run As > TestNG
- Suite</property>.</emphasis></para>
- </listitem>
- </itemizedlist>
- <note><para>OpenOn is available in testNG XML files opened in JBoss XML Editor</para></note>
- <figure>
- <title>Running TestNG</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/testng/testng_9.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The test process will start and its output will be written in Console View.</para>
-
- <figure>
- <title>Test is Finished</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/testng/testng_10.png" scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <itemizedlist>
- <listitem>
- <para>After running TestNG you will have the test results in <emphasis>
- <property>test-output</property>
- </emphasis> folder in Seam-test project (press F5 to refresh the Package
- Explorer view). Open <property>index.html</property> file with Web Browser or
- simply use the TestNG view.</para>
- </listitem>
- </itemizedlist>
-
- <para>The below view shows a successful run of the test.</para>
-
- <figure>
- <title>Viewing the Test Results</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/testng/testng_11.png" scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para>You can see the test results in Web Browser.</para>
-
- <figure>
- <title>Test Results in Browser</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/testng/testng_12.png" scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After clicking on <emphasis>
- <property>ActionLocal Tests</property>
- </emphasis> link you will see the Results for ActionLocal Tests.</para>
-
- <figure>
- <title>Test Information</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/testng/testng_13.png" scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Select a result on the left-hand pane and its details will be displayed on the
- right-hand one.</para>
-
- <figure>
- <title>ActionLocal Test Details</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/testng/testng_14.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Thus with Seam tooling you can easily take advantage of TestNG framework. As you can
- see, it generates its own TestNG project as a separate module within which you can
- easily monitor the tests execution and their output.</para>
-
- </section>
-</chapter>
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="testNG">
+<?dbhtml filename="testNG.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+
+ <keyword>JBDS</keyword>
+
+ <keyword>testNG</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Using TestNG project</title>
+ <para>
+ With the help this chapter you will get to know with TestNG.
+ </para>
+
+ <section>
+ <title>What is TestNG?</title>
+ <para>
+ <property>TestNG</property> ("Testing, the Next Generation") is a Java unit testing framework that aims to overcome many limitations of JUnit. TestNG introduces some new functionalities that make it more powerful and easier to use, such as:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ JDK 5 Annotations (JDK 1.4 is also supported with JavaDoc annotations)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Flexible test configuration
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Support for data-driven testing (with @DataProvider)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Support for parameters
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Allows distribution of tests on slave machines
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Powerful execution model (no more TestSuite)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Supported by a variety of tools and plug-ins (Eclipse, IDEA, Maven, etc...)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Embeds BeanShell for further flexibility
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Default JDK functions for runtime and logging (no dependencies)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Dependent methods for application server testing
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ More information can be found on home page: <ulink url="http://testng.org"
+ >www.testng.org</ulink>
+ </para>
+ </section>
+
+ <section id="OtherRelevantResourcesOnTheTopic5">
+<?dbhtml filename="OtherRelevantResourcesOnTheTopic5.html"?>
+ <title>Other relevant resources on the topic</title>
+ <para>
+ <ulink url="http://www.artima.com/lejava/articles/testng.html">Next-Generation Testing with TestNG (An Interview with Cedric Beust)</ulink>
+ </para>
+
+ <para>
+ <ulink url="http://www.javaworld.com/javaworld/jw-04-2005/jw-0404-testng.html">TestNG: The next generation of unit testing</ulink>
+ </para>
+
+ <para>
+ <ulink url="http://dev2dev.bea.com/pub/a/2006/09/testng-categorization.html">Test Categorization Techniques with TestNG</ulink>
+ </para>
+
+ <para>
+ <ulink url="http://www-128.ibm.com/developerworks/java/library/j-testng/">TestNG makes Java unit testing a breeze</ulink>
+ </para>
+
+ <para>
+ <ulink url="http://www-128.ibm.com/developerworks/java/library/j-cq08296/index.html">In pursuit of code quality: JUnit 4 vs. TestNG</ulink>
+ </para>
+ </section>
+
+ <section>
+ <title>How to use the generated Seam-test project to run Seam tests?</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Create a new Seam Web Project with EAR deployment using the New Seam Project wizard.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ After a project is created you will have the generated Seam-test project that is setup to run TestNG directly against the proper libraries and server runtime libraries.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Seam-test Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Add Seam Action to your project via <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Action.</guimenuitem></menuchoice>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Seam Action Creation</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Fill out the wizard fields. New Seam Action wizard will create resources and place them in the appropriate folders dependent on EAR project structure.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>New Seam Action Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ When Action is created you will see <property>actionPage.xhtml</property> in Package Explorer view. <property>ActionBean.java</property> will be automatically opened in Java Editor.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Created Action</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_8.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Select <property>ActionLocalTest.xml</property> in Seam-test project and run the test with right click <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>TestNG Suite.</guimenuitem></menuchoice>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <note>
+ <para>
+ OpenOn is available in testNG XML files opened in JBoss XML Editor
+ </para>
+ </note>
+
+ <figure>
+ <title>Running TestNG</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_9.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The test process will start and its output will be written in Console View.
+ </para>
+
+ <figure>
+ <title>Test is Finished</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_10.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ After running TestNG you will have the test results in <emphasis> <property>test-output</property> </emphasis> folder in Seam-test project (press F5 to refresh the Package Explorer view). Open <property>index.html</property> file with Web Browser or simply use the TestNG view.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ The below view shows a successful run of the test.
+ </para>
+
+ <figure>
+ <title>Viewing the Test Results</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_11.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ You can see the test results in Web Browser.
+ </para>
+
+ <figure>
+ <title>Test Results in Browser</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_12.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ After clicking on <emphasis> <property>ActionLocal Tests</property> </emphasis> link you will see the Results for ActionLocal Tests.
+ </para>
+
+ <figure>
+ <title>Test Information</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_13.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Select a result on the left-hand pane and its details will be displayed on the right-hand one.
+ </para>
+
+ <figure>
+ <title>ActionLocal Test Details</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_14.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Thus with Seam tooling you can easily take advantage of TestNG framework. As you can see, it generates its own TestNG project as a separate module within which you can easily monitor the tests execution and their output.
+ </para>
+ </section>
+</chapter>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/pom.xml
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/pom.xml 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/pom.xml 2011-07-18 02:42:15 UTC (rev 32984)
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.jboss.tools</groupId>
@@ -10,229 +8,237 @@
<packaging>jdocbook</packaging>
<name>${bookname}-(${translation})</name>
- <properties>
- <translation>en-US</translation>
- <docname>Seam_Reference_Guide</docname>
- <bookname>Seam Reference Guide</bookname>
- </properties>
-
- <profiles>
+ <properties>
+ <translation>en-US</translation>
+ <docname>Seam_Reference_Guide</docname>
+ <bookname>Seam Reference Guide</bookname>
+ </properties>
+ <profiles>
+
<!-- mvn compile -->
- <profile>
- <id>all</id>
- <activation>
- <activeByDefault>true</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${docname}.pdf</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>all</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.4</version>
+ <extensions>true</extensions>
+ <configuration>
+ <profiling>
+ <enabled>true</enabled>
+ <attributeName>condition</attributeName>
+ <attributeValue>jbt</attributeValue>
+ </profiling>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${docname}.pdf</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <useRelativeImageUris>true</useRelativeImageUris>
+ </options>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Phtml -->
- <profile>
- <id>html</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>html</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Phtml-single -->
- <profile>
- <id>html-single</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- </plugin>
+ <profile>
+ <id>html-single</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Ppdf -->
- <profile>
- <id>pdf</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${docname}.pdf</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>pdf</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${docname}.pdf</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Peclipse -->
- <profile>
- <id>eclipse</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
- </plugins>
- </build>
- </profile>
+ <profile>
+ <id>eclipse</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
- </profiles>
- <build>
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <dependencies>
- <dependency>
- <groupId>org.jboss.pressgang</groupId>
- <artifactId>pressgang-xslt</artifactId>
- <version>1.2.0</version>
- </dependency>
- <dependency>
- <groupId>org.jboss</groupId>
- <artifactId>jbossorg-jdocbook-style</artifactId>
- <version>1.1.1</version>
- <type>jdocbook-style</type>
- </dependency>
- </dependencies>
- <configuration>
- <sourceDirectory>${project.basedir}</sourceDirectory>
+ </profiles>
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <dependencies>
+ <dependency>
+ <groupId>org.jboss.pressgang</groupId>
+ <artifactId>pressgang-xslt</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss</groupId>
+ <artifactId>jbossorg-jdocbook-style</artifactId>
+ <version>1.1.1</version>
+ <type>jdocbook-style</type>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <sourceDirectory>${project.basedir}</sourceDirectory>
<!-- <sourceDocumentName>${docname}.xml</sourceDocumentName> -->
- <sourceDocumentName>master.xml</sourceDocumentName>
- <masterTranslation>en-US</masterTranslation>
- <imageResource>
- <directory>${project.basedir}/en-US</directory>
- <includes>
- <include>images/**/*</include>
- </includes>
- </imageResource>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${pdf.name}</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- <options>
- <xincludeSupported>true</xincludeSupported>
- <xmlTransformerType>saxon</xmlTransformerType>
- <docbookVersion>1.72.0</docbookVersion>
- <localeSeparator>-</localeSeparator>
- <transformerParameters>
- <property>
- <name>javax.xml.parsers.DocumentBuilderFactory</name>
- <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
- </property>
- <property>
- <name>javax.xml.parsers.SAXParserFactory</name>
- <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
- </property>
- </transformerParameters>
- </options>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
+ <sourceDocumentName>master.xml</sourceDocumentName>
+ <masterTranslation>en-US</masterTranslation>
+ <imageResource>
+ <directory>${project.basedir}/en-US</directory>
+ <includes>
+ <include>images/**/*</include>
+ </includes>
+ </imageResource>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${pdf.name}</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <xincludeSupported>true</xincludeSupported>
+ <xmlTransformerType>saxon</xmlTransformerType>
+ <docbookVersion>1.72.0</docbookVersion>
+ <localeSeparator>-</localeSeparator>
+ <transformerParameters>
+ <property>
+ <name>javax.xml.parsers.DocumentBuilderFactory</name>
+ <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
+ </property>
+ <property>
+ <name>javax.xml.parsers.SAXParserFactory</name>
+ <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
+ </property>
+ </transformerParameters>
+ </options>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
</project>
Modified: branches/jbosstools-3.2.x/seam/docs/reference/publican.cfg
===================================================================
--- branches/jbosstools-3.2.x/seam/docs/reference/publican.cfg 2011-07-18 02:37:17 UTC (rev 32983)
+++ branches/jbosstools-3.2.x/seam/docs/reference/publican.cfg 2011-07-18 02:42:15 UTC (rev 32984)
@@ -4,4 +4,4 @@
xml_lang: en-US
type: Book
brand: JBoss
-
+condition: jbds
14 years, 9 months
- 1
- 0
JBoss Tools SVN: r32983 - in branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide: en-US and 1 other directory.
by jbosstools-commits＠lists.jboss.org
Author: irooskov(a)redhat.com
Date: 2011-07-17 22:37:17 -0400 (Sun, 17 Jul 2011)
New Revision: 32983
Modified:
branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Book_Info.xml
branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Feedback.xml
branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Introduction.xml
branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/ModeShape_Tools_Reference_Guide.ent
branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/ModeShape_Tools_Reference_Guide.xml
branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Preface.xml
branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/modeshape-concepts.xml
branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml
branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml
branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/pom.xml
Log:
updated for GA
Modified: branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Book_Info.xml
===================================================================
--- branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Book_Info.xml 2011-07-18 02:35:43 UTC (rev 32982)
+++ branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Book_Info.xml 2011-07-18 02:37:17 UTC (rev 32983)
@@ -7,9 +7,9 @@
<title>ModeShape Tools Reference Guide</title>
<subtitle>ModeShape tools allows you to interact with the contents of numerous ModeShape repositories.</subtitle>
<productname>JBoss Developer Studio</productname>
- <productnumber>4.0</productnumber>
- <edition>4.0.0</edition>
- <pubsnumber>3</pubsnumber>
+ <productnumber>4.1</productnumber>
+ <edition>4.1.0</edition>
+ <pubsnumber>1</pubsnumber>
<abstract>
<para>
ModeShape Tools provides the ability to publish and remove content from ModeShape repositories.
Modified: branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Feedback.xml
===================================================================
--- branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Feedback.xml 2011-07-18 02:35:43 UTC (rev 32982)
+++ branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Feedback.xml 2011-07-18 02:37:17 UTC (rev 32983)
@@ -1,20 +1,92 @@
<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Document_Conventions.ent">
+%BOOK_ENTITIES;
+]>
+<appendix id="sect_JBoss-Getting_Help_and_Giving_Feedback" lang="en-US">
+ <title>Getting Help and Giving Feedback</title>
+ <section id="sect_JBoss-Do_You_Need_Help">
+ <title>Do You Need Help?</title>
+ <indexterm>
+ <primary>help</primary>
+ <secondary>getting help</secondary>
-<section id="sect-Beginners_Guide-We_Need_Feedback" lang="en-US">
- <title>We Need Feedback!</title>
- <indexterm>
- <primary>feedback</primary>
- <secondary>contact information for this manual</secondary>
- </indexterm>
- <para>
- If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA against JBoss Developer Studio: <ulink url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...">https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...</ulink>
- </para>
- <para>
- When submitting a bug report, be sure to mention the manual's name and to select the "documentation" component.
- </para>
- <para>
- If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.
- </para>
-</section>
+ </indexterm>
+ <para>
+ If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at <ulink url="http://access.redhat.com" />. Through the customer portal, you can:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ search or browse through a knowledgebase of technical support articles about Red Hat products.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ submit a support case to Red Hat Global Support Services (GSS).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ access other product documentation.
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+ <para>
+ Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. You can find a list of publicly available mailing lists at <ulink url="https://www.redhat.com/mailman/listinfo" />. Click on the name of any mailing list to subscribe to that list or to access the list archives.
+ </para>
+
+ </section>
+
+ <section id="jboss-feedback">
+ <title>Give us Feedback</title>
+ <!-- NOTE: You will need the following entities defined in your .ent file.
+ You will need to replace _YOUR_PRODUCT_HERE_, _YOUR_COMPONENT_
+ and _YOUR_SUMMARY_ - entities are not replaced in URLs.
+ <!ENTITY PRODUCT "JBoss Product Name">
+ <!ENTITY BZCOMPONENT "doc-triage">
+ <!ENTITY BZURL "<ulink url='https://bugzilla.example.com/enter_bug.cgi?product=_YOUR_PRODUCT_HERE_&am...'>http://bugzilla.redhat.com/</ulink>">
+
+ These entities should not affect translated documents, since Bugzilla is not localised.
+ --> <indexterm>
+ <primary>feedback</primary>
+ <secondary>contact information for this manual</secondary>
+
+ </indexterm>
+ <para>
+ If you find a typographical error, or know how this guide can be improved, we would love to hear from you. Submit a report in Bugzilla against the product <literal>&BZPRODUCT;</literal> and the component <literal>&BZCOMPONENT;</literal>. The following link will take you to a pre-filled bug report for this product: &BZURL;.
+ </para>
+ <para>
+ Fill out the following template in Bugzilla's <literal>Description</literal> field. Be as specific as possible when describing the issue; this will help ensure that we can fix it quickly.
+ </para>
+
+<screen>Document URL:
+
+
+Section Number and Name:
+
+
+Describe the issue:
+
+
+Suggestions for improvement:
+
+
+Additional information:
+
+
+</screen>
+ <para>
+ Be sure to give us your name so that you can receive full credit for reporting the issue.
+ </para>
+
+ </section>
+
+
+</appendix>
+
+
Modified: branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Introduction.xml
===================================================================
--- branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Introduction.xml 2011-07-18 02:35:43 UTC (rev 32982)
+++ branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Introduction.xml 2011-07-18 02:37:17 UTC (rev 32983)
@@ -6,10 +6,10 @@
<chapter id="chap-ModeShape_Tools_Reference_Guide-introduction">
<title>Introduction</title>
<para>
- ModeShape tools allows you to publish and unpublish resources to the Modeshape repositories you have made available through your workspace. These repositories are persisted within the workspace, from session to session.
+ ModeShape tools allows you to publish and unpublish resources to the ModeShape repositories you have made available through your workspace. These repositories are persisted within the workspace, from session to session.
</para>
<para>
- The Modeshape registry is persisted from session to session.
+ The ModeShape registry is persisted from session to session.
</para>
</chapter>
Modified: branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/ModeShape_Tools_Reference_Guide.ent
===================================================================
--- branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/ModeShape_Tools_Reference_Guide.ent 2011-07-18 02:35:43 UTC (rev 32982)
+++ branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/ModeShape_Tools_Reference_Guide.ent 2011-07-18 02:37:17 UTC (rev 32983)
@@ -1,4 +1,7 @@
<!ENTITY PRODUCT "JBoss Developer Studio">
<!ENTITY BOOKID "ModeShape_Tools_Reference_Guide">
-<!ENTITY YEAR "2010">
+<!ENTITY YEAR "2011">
<!ENTITY HOLDER "Red Hat">
+<!ENTITY BZPRODUCT "JBoss Developer Studio">
+<!ENTITY BZCOMPONENT "ModeShape Tools Reference Guide">
+<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss%20Develope...'>http://bugzilla.redhat.com/</ulink>">
Modified: branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/ModeShape_Tools_Reference_Guide.xml
===================================================================
--- branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/ModeShape_Tools_Reference_Guide.xml 2011-07-18 02:35:43 UTC (rev 32982)
+++ branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/ModeShape_Tools_Reference_Guide.xml 2011-07-18 02:37:17 UTC (rev 32983)
@@ -9,6 +9,7 @@
<xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<index />
</book>
Modified: branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Preface.xml
===================================================================
--- branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Preface.xml 2011-07-18 02:35:43 UTC (rev 32982)
+++ branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Preface.xml 2011-07-18 02:37:17 UTC (rev 32983)
@@ -8,9 +8,5 @@
<para>
This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. To get more information on these conventions please refer to the <guilabel>Document Conventions</guilabel> manual, which can be found on the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index.html">Red Hat Documentation</ulink> website under the <guilabel>JBoss Developer Studio</guilabel> section.
</para>
- <!--<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- </xi:fallback>
- </xi:include>-->
</preface>
Modified: branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/modeshape-concepts.xml
===================================================================
--- branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/modeshape-concepts.xml 2011-07-18 02:35:43 UTC (rev 32982)
+++ branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/modeshape-concepts.xml 2011-07-18 02:37:17 UTC (rev 32983)
@@ -16,7 +16,7 @@
ModeShape repositories can be used in a variety of applications. One such application is provisioning and management. In provisioning and management it is critical to understand and keep track of the metadata for models, databases, services, components, applications, clusters, machines, and other systems used in an enterprise environment. Governance takes this further, by also tracking the policies and expectations against which performance can be verified. In these cases, a repository is an excellent mechanism for managing this complex and highly-varied information.
</para>
<para>
- A ModeShape repository doesn't have to be large and complex. It could be setup to only manage configuration information for an application, or provide a JCR interface on top of non-JCR systems.
+ A ModeShape repository does not have to be large and complex. It could be setup to only manage configuration information for an application, or provide a JCR interface on top of non-JCR systems.
</para>
</section>
Modified: branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml
===================================================================
--- branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml 2011-07-18 02:35:43 UTC (rev 32982)
+++ branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml 2011-07-18 02:37:17 UTC (rev 32983)
@@ -38,7 +38,7 @@
The publishing wizard (shown in <xref linkend="ModeShape_publishing_wizard"/>) allows you to choose which ModeShape Java Content Repositories (JCR) type repository to interact with and displays the selected files the operation will be performed on. When a project or folder is selected all their included files are acted upon.
</para>
<para>
- Publishing to a <guilabel>Publish Area</guilabel> will automatically sequence your files to extract usful informaiton and make it available to our repsitory users. Extracted information depends upon the type of file and the configuration of the ModeShape repository. The location where files will be published is constructed by appending the server URL, the names of the JCR repository and workspace, the path to the publish area, and the path of the files and folders within your Eclipse workspace.
+ Publishing to a <guilabel>Publish Area</guilabel> will automatically sequence your files to extract useful information and make it available to our repository users. Extracted information depends upon the type of file and the configuration of the ModeShape repository. The location where files will be published is constructed by appending the server URL, the names of the JCR repository and workspace, the path to the publish area, and the path of the files and folders within your Eclipse workspace.
</para>
<warning>
<para>
Modified: branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml
===================================================================
--- branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml 2011-07-18 02:35:43 UTC (rev 32982)
+++ branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml 2011-07-18 02:37:17 UTC (rev 32983)
@@ -49,7 +49,7 @@
</para>
<note>
<para>
- It is possible for a ModeShape server instance to have numerious ModeShape repositories stored on it. Once you have registered a connection to the server you will have access to all ModeShape repositories on the server. You do not need to register a new connection for each repository on the same server.
+ It is possible for a ModeShape server instance to have numerous ModeShape repositories stored on it. Once you have registered a connection to the server you will have access to all ModeShape repositories on the server. You do not need to register a new connection for each repository on the same server.
</para>
</note>
<!-- The functionality to delete a resource from the workspace using the Modeshape view does not currently exist, but could in a future version -->
Modified: branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/pom.xml
===================================================================
--- branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/pom.xml 2011-07-18 02:35:43 UTC (rev 32982)
+++ branches/jbosstools-3.2.x/modeshape/docs/ModeShape_Tools_Reference_Guide/pom.xml 2011-07-18 02:37:17 UTC (rev 32983)
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.jboss.tools</groupId>
@@ -10,229 +8,232 @@
<packaging>jdocbook</packaging>
<name>${bookname}-(${translation})</name>
- <properties>
- <translation>en-US</translation>
- <docname>ModeShape_Tools_Reference_Guide</docname>
- <bookname>ModeShape Tools Reference Guide</bookname>
- </properties>
-
- <profiles>
+ <properties>
+ <translation>en-US</translation>
+ <docname>ModeShape_Tools_Reference_Guide</docname>
+ <bookname>ModeShape Tools Reference Guide</bookname>
+ </properties>
+ <profiles>
+
<!-- mvn compile -->
- <profile>
- <id>all</id>
- <activation>
- <activeByDefault>true</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${docname}.pdf</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>all</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.4</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${docname}.pdf</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <useRelativeImageUris>true</useRelativeImageUris>
+ </options>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Phtml -->
- <profile>
- <id>html</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>html</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Phtml-single -->
- <profile>
- <id>html-single</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- </plugin>
+ <profile>
+ <id>html-single</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Ppdf -->
- <profile>
- <id>pdf</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${docname}.pdf</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>pdf</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${docname}.pdf</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Peclipse -->
- <profile>
- <id>eclipse</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
- </plugins>
- </build>
- </profile>
+ <profile>
+ <id>eclipse</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
- </profiles>
- <build>
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <dependencies>
- <dependency>
- <groupId>org.jboss.pressgang</groupId>
- <artifactId>pressgang-xslt</artifactId>
- <version>1.2.0</version>
- </dependency>
- <dependency>
- <groupId>org.jboss</groupId>
- <artifactId>jbossorg-jdocbook-style</artifactId>
- <version>1.1.1</version>
- <type>jdocbook-style</type>
- </dependency>
- </dependencies>
- <configuration>
- <sourceDirectory>${project.basedir}</sourceDirectory>
+ </profiles>
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <dependencies>
+ <dependency>
+ <groupId>org.jboss.pressgang</groupId>
+ <artifactId>pressgang-xslt</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss</groupId>
+ <artifactId>jbossorg-jdocbook-style</artifactId>
+ <version>1.1.1</version>
+ <type>jdocbook-style</type>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <sourceDirectory>${project.basedir}</sourceDirectory>
<!-- <sourceDocumentName>${docname}.xml</sourceDocumentName> -->
- <sourceDocumentName>master.xml</sourceDocumentName>
- <masterTranslation>en-US</masterTranslation>
- <imageResource>
- <directory>${project.basedir}/en-US</directory>
- <includes>
- <include>images/**/*</include>
- </includes>
- </imageResource>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${pdf.name}</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- <options>
- <xincludeSupported>true</xincludeSupported>
- <xmlTransformerType>saxon</xmlTransformerType>
- <docbookVersion>1.72.0</docbookVersion>
- <localeSeparator>-</localeSeparator>
- <transformerParameters>
- <property>
- <name>javax.xml.parsers.DocumentBuilderFactory</name>
- <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
- </property>
- <property>
- <name>javax.xml.parsers.SAXParserFactory</name>
- <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
- </property>
- </transformerParameters>
- </options>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
+ <sourceDocumentName>master.xml</sourceDocumentName>
+ <masterTranslation>en-US</masterTranslation>
+ <imageResource>
+ <directory>${project.basedir}/en-US</directory>
+ <includes>
+ <include>images/**/*</include>
+ </includes>
+ </imageResource>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${pdf.name}</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <xincludeSupported>true</xincludeSupported>
+ <xmlTransformerType>saxon</xmlTransformerType>
+ <docbookVersion>1.72.0</docbookVersion>
+ <localeSeparator>-</localeSeparator>
+ <transformerParameters>
+ <property>
+ <name>javax.xml.parsers.DocumentBuilderFactory</name>
+ <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
+ </property>
+ <property>
+ <name>javax.xml.parsers.SAXParserFactory</name>
+ <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
+ </property>
+ </transformerParameters>
+ </options>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
</project>
14 years, 9 months
- 1
- 0
JBoss Tools SVN: r32981 - in branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial: en-US and 1 other directories.
by jbosstools-commits＠lists.jboss.org
Author: irooskov(a)redhat.com
Date: 2011-07-17 22:23:12 -0400 (Sun, 17 Jul 2011)
New Revision: 32981
Added:
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_11.png
Modified:
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Book_Info.xml
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Feedback.xml
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/JSF_Tools_Tutorial.ent
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/JSF_Tools_Tutorial.xml
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Preface.xml
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Revision_History.xml
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/adding_managed_bean.xml
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/adding_navigation.xml
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_1.png
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_2.png
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_4.png
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_5.png
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_6.png
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_7.png
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_8.png
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_9.png
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/jsf_application.xml
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/jsp_view_files.xml
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/master.xml
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/relevant_resources.xml
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/running_application.xml
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/start_page.xml
branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/pom.xml
Log:
updated for GA
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Book_Info.xml
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Book_Info.xml 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Book_Info.xml 2011-07-18 02:23:12 UTC (rev 32981)
@@ -5,9 +5,9 @@
<title>JSF Tools Tutorial</title>
<subtitle>Provides information relating to the JSF Tools module.</subtitle>
<productname>JBoss Developer Studio</productname>
- <productnumber>4.0</productnumber>
- <edition>4.0.0</edition>
- <pubsnumber>4</pubsnumber>
+ <productnumber>4.1</productnumber>
+ <edition>4.1.0</edition>
+ <pubsnumber>1</pubsnumber>
<abstract>
<para>The JSF Tools Tutorial explains how to use the JSF Tools module to create a simple JSF application.</para>
</abstract>
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Feedback.xml
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Feedback.xml 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Feedback.xml 2011-07-18 02:23:12 UTC (rev 32981)
@@ -1,20 +1,92 @@
<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Document_Conventions.ent">
+%BOOK_ENTITIES;
+]>
+<appendix id="sect_JBoss-Getting_Help_and_Giving_Feedback" lang="en-US">
+ <title>Getting Help and Giving Feedback</title>
+ <section id="sect_JBoss-Do_You_Need_Help">
+ <title>Do You Need Help?</title>
+ <indexterm>
+ <primary>help</primary>
+ <secondary>getting help</secondary>
-<section id="sect-Beginners_Guide-We_Need_Feedback" lang="en-US">
- <title>We Need Feedback!</title>
- <indexterm>
- <primary>feedback</primary>
- <secondary>contact information for this manual</secondary>
- </indexterm>
- <para>
- If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA against JBoss Developer Studio: <ulink url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...">https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...</ulink>
- </para>
- <para>
- When submitting a bug report, be sure to mention the manual's name and to select the "documentation" component.
- </para>
- <para>
- If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.
- </para>
-</section>
+ </indexterm>
+ <para>
+ If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at <ulink url="http://access.redhat.com" />. Through the customer portal, you can:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ search or browse through a knowledgebase of technical support articles about Red Hat products.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ submit a support case to Red Hat Global Support Services (GSS).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ access other product documentation.
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+ <para>
+ Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. You can find a list of publicly available mailing lists at <ulink url="https://www.redhat.com/mailman/listinfo" />. Click on the name of any mailing list to subscribe to that list or to access the list archives.
+ </para>
+
+ </section>
+
+ <section id="jboss-feedback">
+ <title>Give us Feedback</title>
+ <!-- NOTE: You will need the following entities defined in your .ent file.
+ You will need to replace _YOUR_PRODUCT_HERE_, _YOUR_COMPONENT_
+ and _YOUR_SUMMARY_ - entities are not replaced in URLs.
+ <!ENTITY PRODUCT "JBoss Product Name">
+ <!ENTITY BZCOMPONENT "doc-triage">
+ <!ENTITY BZURL "<ulink url='https://bugzilla.example.com/enter_bug.cgi?product=_YOUR_PRODUCT_HERE_&am...'>http://bugzilla.redhat.com/</ulink>">
+
+ These entities should not affect translated documents, since Bugzilla is not localised.
+ --> <indexterm>
+ <primary>feedback</primary>
+ <secondary>contact information for this manual</secondary>
+
+ </indexterm>
+ <para>
+ If you find a typographical error, or know how this guide can be improved, we would love to hear from you. Submit a report in Bugzilla against the product <literal>&BZPRODUCT;</literal> and the component <literal>&BZCOMPONENT;</literal>. The following link will take you to a pre-filled bug report for this product: &BZURL;.
+ </para>
+ <para>
+ Fill out the following template in Bugzilla's <literal>Description</literal> field. Be as specific as possible when describing the issue; this will help ensure that we can fix it quickly.
+ </para>
+
+<screen>Document URL:
+
+
+Section Number and Name:
+
+
+Describe the issue:
+
+
+Suggestions for improvement:
+
+
+Additional information:
+
+
+</screen>
+ <para>
+ Be sure to give us your name so that you can receive full credit for reporting the issue.
+ </para>
+
+ </section>
+
+
+</appendix>
+
+
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/JSF_Tools_Tutorial.ent
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/JSF_Tools_Tutorial.ent 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/JSF_Tools_Tutorial.ent 2011-07-18 02:23:12 UTC (rev 32981)
@@ -1,4 +1,7 @@
<!ENTITY PRODUCT "JBoss">
<!ENTITY BOOKID "JSF_Tools_Tutorial">
-<!ENTITY YEAR "2010">
+<!ENTITY YEAR "2011">
<!ENTITY HOLDER "Red Hat">
+<!ENTITY BZPRODUCT "JBoss Developer Studio">
+<!ENTITY BZCOMPONENT "JSF Tools Tutorial">
+<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss%20Develope...'>http://bugzilla.redhat.com/</ulink>">
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/JSF_Tools_Tutorial.xml
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/JSF_Tools_Tutorial.xml 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/JSF_Tools_Tutorial.xml 2011-07-18 02:23:12 UTC (rev 32981)
@@ -12,5 +12,6 @@
<xi:include href="start_page.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="running_application.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="relevant_resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
+<xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
</book>
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Preface.xml
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Preface.xml 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Preface.xml 2011-07-18 02:23:12 UTC (rev 32981)
@@ -8,9 +8,5 @@
<para>
This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. To get more information on these conventions please refer to the <guilabel>Document Conventions</guilabel> manual, which can be found on the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index.html">Red Hat Documentation</ulink> website under the <guilabel>JBoss Developer Studio</guilabel> section.
</para>
- <!--<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- </xi:fallback>
- </xi:include>-->
</preface>
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Revision_History.xml
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Revision_History.xml 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/Revision_History.xml 2011-07-18 02:23:12 UTC (rev 32981)
@@ -2,31 +2,51 @@
<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
]>
<appendix>
- <title>Revision History</title>
- <simpara>
- <revhistory>
- <revision>
- <revnumber>1</revnumber><date>Wed Jun 09 2010</date>
- <author>
- <firstname>JBoss Tools</firstname><surname>Documentation Team</surname><email>irooskov(a)redhat.com</email>
- </author>
- <revdescription>
- <simplelist>
- <member>General updates</member>
- </simplelist>
- </revdescription>
- </revision>
- <revision>
- <revnumber>0</revnumber><date>Fri Nov 20 2009</date>
- <author>
- <firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email>
- </author>
- <revdescription>
- <simplelist>
- <member>Initial creation of book by publican</member>
- </simplelist>
- </revdescription>
- </revision>
- </revhistory>
- </simpara>
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>1-1</revnumber>
+ <date>Mon Mar 14 2011</date>
+ <author>
+ <firstname>Matthew</firstname>
+ <surname>Casperson</surname>
+ <email>mcaspers(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>General updates, screen shot refresh, and procedure check</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>1-0</revnumber>
+ <date>Wed Jun 09 2010</date>
+ <author>
+ <firstname>JBoss Tools</firstname>
+ <surname>Documentation Team</surname>
+ <email>irooskov(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>General updates</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>0-0</revnumber>
+ <date>Fri Nov 20 2009</date>
+ <author>
+ <firstname>Isaac</firstname>
+ <surname>Rooskov</surname>
+ <email>irooskov(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial creation of book by publican</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
</appendix>
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/adding_managed_bean.xml
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/adding_managed_bean.xml 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/adding_managed_bean.xml 2011-07-18 02:23:12 UTC (rev 32981)
@@ -1,90 +1,60 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="adding_managed_bean">
- <?dbhtml filename="adding_managed_bean.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>JSF application</keyword>
- <keyword>Java</keyword>
- </keywordset>
- </chapterinfo>
+ <?dbhtml filename="adding_managed_bean.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>JSF application</keyword>
+ <keyword>Java</keyword>
+ </keywordset>
+ </chapterinfo>
- <title>Adding a Managed Bean to the Application</title>
- <para>To store data in the application, we will use a managed bean.</para>
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis>
- <property>Tree</property>
- </emphasis> tab at the bottom of the editing window</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis>
- <property>Managed Beans</property>
- </emphasis> node and then click the <emphasis>
- <property>Add...</property>
- </emphasis> button displayed along the right side of the editor window</para>
- </listitem>
- <listitem>
- <para>Type in <emphasis>
- <property>jsfHello.PersonBean</property>
- </emphasis> for Class and <emphasis>
- <property>personBean</property>
- </emphasis> for Name. Leave Scope as is and Generate Source Code as is
- (checked)</para>
- </listitem>
- <listitem>
- <para>Click <emphasis>
- <property>Finish</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>personBean will now be selected and three sections of information: <emphasis>
- <property>Managed Bean</property>
- </emphasis>, <emphasis>
- <property>Properties</property>
- </emphasis>, and <emphasis>
- <property>Advanced</property>
- </emphasis>, will be displayed about it. Under the Properties section, click the <emphasis>
- <property>Add...</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>Type in <emphasis>
- <property>name</property>
- </emphasis> for Property-Name. Leave everything else as is. (When Property-
- Class is not filled in, String is the assumed type)</para>
- </listitem>
- <listitem>
- <para>Click <emphasis>
- <property>Finish</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>Select the <emphasis>
- <property>personBean</property>
- </emphasis> node in the tree</para>
- </listitem>
- </itemizedlist>
- <para>You should see this now:</para>
- <figure>
- <title>Tree View in Config Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Select <emphasis>
- <property>File > Save</property>
- </emphasis> from the menu bar</para>
- </listitem>
- </itemizedlist>
- <para>You have now registered the <emphasis>
- <property>managed bean</property>
- </emphasis> and created a <emphasis>
- <property>stub-coded class</property>
- </emphasis> file for it.</para>
-
- </chapter>
\ No newline at end of file
+ <title>Adding a Managed Bean to the Application</title>
+ <para>To store data in the application, we will use a managed bean.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <guilabel>Tree</guilabel> tab at the bottom of the editing window.</para>
+ </listitem>
+ <listitem>
+ <para>Select the <guilabel>Managed Beans</guilabel> node and then click the <guibutton>Add...</guibutton> button displayed along the right side of the editor window.</para>
+ </listitem>
+ <listitem>
+ <para>Type in <guilabel>jsfHello.PersonBean</guilabel> for Class and <guilabel>personBean</guilabel> for Name. Leave the <guilabel>Scope</guilabel> selection as is and leave the <guilabel>Generate Source Code</guilabel> checkbox checked.</para>
+ </listitem>
+ <listitem>
+ <para>Click the <guibutton>Finish</guibutton> button.</para>
+ </listitem>
+ <listitem>
+ <para>personBean will now be selected and three sections of information: <guilabel>Managed Bean</guilabel>, <guilabel>Properties</guilabel>, and <guilabel>Advanced</guilabel> will be displayed about it. Under the <guilabel>Properties</guilabel> section, click the <guibutton>Add...</guibutton> button.</para>
+ </listitem>
+ <listitem>
+ <para>Type in <guilabel>name</guilabel> for <guilabel>Property-Name</guilabel>. Leave everything else as is. (When <guilabel>Property-Class</guilabel> is not filled in, String is the assumed type.)</para>
+ </listitem>
+ <listitem>
+ <para>Click the <guibutton>Finish</guibutton> button.</para>
+ </listitem>
+ <listitem>
+ <para>Select the <guilabel>personBean</guilabel> node in the tree.</para>
+ </listitem>
+ </itemizedlist>
+ <para>You should see this now:</para>
+ <figure>
+ <title>Tree View in Config Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Select <menuchoice><guimenuitem>File</guimenuitem>
+ <guimenuitem>Save</guimenuitem>
+ </menuchoice> from the menu bar.</para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ You have now registered the <emphasis><property>managed bean</property></emphasis> and created a <emphasis><property>stub-coded class</property></emphasis> file for it.
+ </para>
+
+</chapter>
\ No newline at end of file
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/adding_navigation.xml
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/adding_navigation.xml 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/adding_navigation.xml 2011-07-18 02:23:12 UTC (rev 32981)
@@ -20,45 +20,34 @@
<?dbhtml filename="AddingTwoViewsJSPPages.html"?>
<title>Adding Two Views (JSP Pages)</title>
<itemizedlist>
+ <listitem>
+ <para>Create a new folder called <filename>pages</filename> under the <filename>WebContent</filename> folder.</para>
+ </listitem>
<listitem>
- <para>Right-click anywhere on the diagram and select <emphasis>
- <property>Rule...</property>
- </emphasis> from the pop-up menu</para>
+ <para>Right-click anywhere on the diagram and select <guimenuitem>New View...</guimenuitem> from the context menu.</para>
</listitem>
<listitem>
- <para>In the dialog box, type <emphasis>
- <property>pages/inputname</property>
- </emphasis> as the value for From View ID</para>
+ <para>In the dialog box, type <guilabel>pages/inputname</guilabel> as the value for From View ID.</para>
</listitem>
<listitem>
- <para>Leave everything else as is</para>
+ <para>Leave everything else as is.</para>
</listitem>
<listitem>
- <para>Click <emphasis>
- <property>Finish</property>
- </emphasis></para>
- <para>If you look in the Package Explorer view you should see a <emphasis>
- <property>pages</property>
- </emphasis> folder under WebContent. Opening it will reveal the JSP file you
- just created</para>
+ <para>Click the <guibutton>Finish</guibutton> button.</para>
+ <para>If you look in the Package Explorer view you should see a <filename>pages</filename> folder under the <filename>WebContent</filename> folder. Opening it will reveal the JSP file you
+ just created.</para>
</listitem>
<listitem>
- <para>Back on the diagram, right-click anywhere and select <emphasis>
- <property>Rule...</property>
- </emphasis> from the pop-up menu</para>
+ <para>Back on the diagram, right-click anywhere and select <guimenuitem>New View...</guimenuitem> from the pop-up menu.</para>
</listitem>
<listitem>
- <para>In the dialog box, type <emphasis>
- <property>pages/greeting</property>
- </emphasis> as the value for From View ID</para>
+ <para>In the dialog box, type <guilabel>pages/greeting</guilabel> as the value for From View ID.</para>
</listitem>
<listitem>
- <para>Leave everything else as is</para>
+ <para>Leave everything else as is.</para>
</listitem>
<listitem>
- <para>Click <emphasis>
- <property>Finish</property>
- </emphasis></para>
+ <para>Click the <guibutton>Finish</guibutton>.</para>
</listitem>
</itemizedlist>
@@ -79,11 +68,7 @@
<itemizedlist>
<listitem>
- <para>Click on the <emphasis>
- <property>pages/inputname</property>
- </emphasis> page icon and then click on the <emphasis>
- <property>pages/greeting</property>
- </emphasis> page icon</para>
+ <para>Click on the <guilabel>pages/inputname</guilabel> page icon and then click on the <guilabel>pages/greeting</guilabel> page icon.</para>
</listitem>
</itemizedlist>
@@ -98,9 +83,7 @@
</figure>
<itemizedlist>
<listitem>
- <para>Select <emphasis>
- <property>File > Save</property>
- </emphasis> from the menu bar</para>
+ <para>Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save</guimenuitem></menuchoice> from the menu bar.</para>
</listitem>
</itemizedlist>
</section>
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_1.png
===================================================================
(Binary files differ)
Added: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_11.png
===================================================================
(Binary files differ)
Property changes on: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_11.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_2.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_4.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_5.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_6.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_7.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_8.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_9.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/jsf_application.xml
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/jsf_application.xml 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/jsf_application.xml 2011-07-18 02:23:12 UTC (rev 32981)
@@ -1,100 +1,82 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="jsf_application">
- <?dbhtml filename="jsf_application.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>JSF application</keyword>
- <keyword>Java</keyword>
- </keywordset>
- </chapterinfo>
+ <?dbhtml filename="jsf_application.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>JSF application</keyword>
+ <keyword>Java</keyword>
+ </keywordset>
+ </chapterinfo>
- <title>Creating a Simple JSF Application</title>
+ <title>Creating a Simple JSF Application</title>
- <para>Firstly, we assume that you have already launched Eclipse with <property>JBoss Tools</property>
- plug-ins installed and also that the <property>Web Development perspective</property> is the current
- one. (If not, make it active by selecting <emphasis>
- <property>Window > Open Perspective > Web Development</property>
- </emphasis> from the menu bar or by selecting <emphasis>
- <property>Window > Open Perspective > Other...</property>
- </emphasis> from the menu bar and then selecting <emphasis>
- <property>Web Development</property>
- </emphasis> from the Select Perspective dialog box.)</para>
+ <para>
+ Firstly, we assume that you have already launched Eclipse with <property>JBoss Tools</property> plug-ins installed and also that the <property>Web Development perspective</property> is the current one. (If not, make it active by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Web Development</guimenuitem></menuchoice> from the menu bar or by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other...</guimenuitem></menuchoice> from the menu bar and then selecting <guimenuitem>Web Development</guimenuitem> from the Select Perspective dialog box.)
+ </para>
- <section id="setting_up_the_project">
- <?dbhtml filename="SettingUpTheProject.html"?>
- <title>Setting Up the Project</title>
- <para>Now we are going to create a new project for the application.</para>
- <itemizedlist>
- <listitem>
- <para>For that go to the menu bar and select <emphasis>
- <property>File > New > Project...</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>Select <emphasis>
- <property>JBoss Tools Web > JSF > JSF Project</property>
- </emphasis> in the New Project dialog box</para>
- </listitem>
- <listitem>
- <para>Click <emphasis>
- <property>Next</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>Enter "jsfHello" as the project name.</para>
- </listitem>
- <listitem>
- <para>Leave everything else as is, and click <emphasis>
- <property>Finish</property>
- </emphasis></para>
- </listitem>
+ <section id="setting_up_the_project">
+ <?dbhtml filename="SettingUpTheProject.html"?>
+ <title>Setting Up the Project</title>
+ <para>Now we are going to create a new project for the application.</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ For that go to the menu bar and select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Project...</guimenuitem></menuchoice>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Select <menuchoice><guimenuitem>JBoss Tools Web</guimenuitem><guimenuitem>JSF</guimenuitem><guimenuitem>JSF Project</guimenuitem></menuchoice> in the New Project dialog box.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Click the <guibutton>Next</guibutton> button.</para>
+ </listitem>
+ <listitem>
+ <para>Enter <guilabel>jsfHello</guilabel> as the project name.</para>
+ </listitem>
+ <listitem>
+ <para>Leave everything else as is, and click the <guibutton>Finish</guibutton> button.</para>
+ </listitem>
- </itemizedlist>
- </section>
+ </itemizedlist>
+ </section>
- <section id="TheJSFApplicationConfigurationFile">
- <?dbhtml filename="TheJSFApplicationConfigurationFile.html"?>
- <title>JSF Configuration File</title>
- <para>A jsfHello node should appear in the upper-left Package Explorer view.</para>
- <figure>
- <title>Package Explorer View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Click the plus sign next to <emphasis>
- <property>jsfHello</property>
- </emphasis> to reveal the child nodes</para>
- </listitem>
- <listitem>
- <para>Click the plus sign next to <emphasis>
- <property>WebContent</property>
- </emphasis> under jsfHello</para>
- </listitem>
- <listitem>
- <para>Click the plus sign next to <emphasis>
- <property>WEB-INF</property>
- </emphasis> under WebContent</para>
- </listitem>
+ <section id="TheJSFApplicationConfigurationFile">
+ <?dbhtml filename="TheJSFApplicationConfigurationFile.html"?>
+ <title>JSF Configuration File</title>
+ <para>A <guilabel>jsfHello</guilabel> node should appear in the upper-left <guilabel>Package Explorer</guilabel> view.</para>
+ <figure>
+ <title>Package Explorer View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Click the plus sign next to <guilabel>jsfHello</guilabel> to reveal the child nodes</para>
+ </listitem>
+ <listitem>
+ <para>Click the plus sign next to <guilabel>WebContent</guilabel> under jsfHello</para>
+ </listitem>
+ <listitem>
+ <para>Click the plus sign next to <guilabel>WEB-INF</guilabel> under WebContent</para>
+ </listitem>
+ <listitem>
+ <para>Then double-click on the <filename>faces-config.xml</filename> node to display the JSF application configuration file editor</para>
+ </listitem>
+ </itemizedlist>
+ <figure>
+ <title>Configuration File Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <listitem>
- <para>Then double-click on the <property>faces-config.xml</property> node to display
- the JSF application configuration file editor</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Configuration File Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
+ </section>
</chapter>
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/jsp_view_files.xml
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/jsp_view_files.xml 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/jsp_view_files.xml 2011-07-18 02:23:12 UTC (rev 32981)
@@ -1,239 +1,205 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="jsp_view_files">
- <?dbhtml filename="jsp_view_files.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>JSF application</keyword>
- <keyword>Java</keyword>
- </keywordset>
- </chapterinfo>
+ <?dbhtml filename="jsp_view_files.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>JSF application</keyword>
+ <keyword>Java</keyword>
+ </keywordset>
+ </chapterinfo>
- <title>Editing the JSP View Files</title>
-
- <para>Now we will finish editing the JSP files for our two "views" using
- JSP Visual Page.</para>
- <section id="Inputname.jsp">
- <title>inputname.jsp</title>
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis>
- <property>Diagram</property>
- </emphasis> tab for the configuration file editor</para>
- </listitem>
- <listitem>
- <para>Open the editor for this first JSP file by double-clicking on the <emphasis>
- <property>/pages/inputname. jsp</property>
- </emphasis> icon</para>
- </listitem>
- </itemizedlist>
-
- <para>The Visual Page Editor will open in a screen split between source code along the
- top and a WYSIWIG view along the bottom:</para>
- <figure>
- <title>Visual Page Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Some JSF code is already in the file, because we have chosen a template to create
- a page.</para>
- <itemizedlist>
- <listitem>
- <para>Select the <emphasis>
- <property>Visual</property>
- </emphasis> tab, so we can work with the editor completely in its WYSIWYG
- mode</para>
- </listitem>
- <listitem>
- <para>To the right of the editor, in the JBoss Tools Palette, expand the <emphasis>
- <property>JSF HTML</property>
- </emphasis> palette folder by selecting it</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>JBoss Tools Palette</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Click on <emphasis>
- <property>form</property>
- </emphasis> within this folder, drag the cursor over to the editor, and drop
- it inside the red box in the editor</para>
- </listitem>
- <listitem>
- <para>Another red box will appear inside the first red box</para>
- </listitem>
- <listitem>
- <para>Right-click on the innermost box and select <emphasis role="bold">
- <property><h:form></property>
- </emphasis> Attributes from the menu</para>
- </listitem>
- <listitem>
- <para>In the value field next to id, type <emphasis>
- <property>greeting</property>
- </emphasis> and click on the <emphasis>
- <property>Close</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>Type "Please enter name:" inside the boxes</para>
- </listitem>
- <listitem>
- <para>Select <emphasis>
- <property>inputText</property>
- </emphasis> within the JSF HTML palette folder and drag it into the
- innermost box in the editor after "Please enter
- name:"</para>
- </listitem>
- <listitem>
- <para>In the attributes dialog, click in the <emphasis>
- <property>value</property>
- </emphasis> field next to the value attribute and click on the <property>...
- </property>button</para>
- </listitem>
- <listitem>
- <para>Then, select the <emphasis>
- <property>Managed Beans > personBean > name</property>
- </emphasis> node and click on the <emphasis>
- <property>Ok</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>Back in the attributes dialog, select the <emphasis>
- <property>Advanced</property>
- </emphasis> tab, type in <emphasis>
- <property>name</property>
- </emphasis> as the value for the <emphasis role="italic">
- <property>"id"</property>
- </emphasis> attribute, and then click on the <emphasis>
- <property>Finish</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>Select <emphasis>
- <property>commandButton</property>
- </emphasis> within the JSF HTML palette folder and drag it into the
- innermost box in the editor after the input box</para>
- </listitem>
- <listitem>
- <para>In the attributes dialog, click in the value field next to the <emphasis
- role="italic">
- <property>"action"</property>
- </emphasis> attribute and click on the <property>...
- </property>button</para>
- </listitem>
- <listitem>
- <para>Then, select the <emphasis>
- <property>View Actions > greeting</property>
- </emphasis> node and click on the <emphasis>
- <property>OK</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>Back in the attributes dialog box, type in "Say Hello"
- as the value for the value attribute ("Say Hello") and
- then click on the <emphasis>
- <property>Finish</property>
- </emphasis> button</para>
- </listitem>
- </itemizedlist>
- <para>The source coding should be something like this now:</para>
- <programlisting role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
-<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %>
+ <title>Editing the JSP View Files</title>
+
+ <para>Now we will finish editing the JSP files for our two "views" using
+ JSP Visual Page Editor.</para>
+ <section id="Inputname.jsp">
+ <title>inputname.jsp</title>
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <guilabel>Diagram</guilabel> tab of the configuration file editor.</para>
+ </listitem>
+ <listitem>
+ <para>Open the editor for this first JSP file by double-clicking on the <guilabel>/pages/inputname.jsp</guilabel> icon.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The Visual Page Editor will open in a screen split between source code along the top and a WYSIWIG view along the bottom:</para>
+ <figure>
+ <title>Visual Page Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Some JSF code is already in the file, because we have chosen a template to create a page.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Select the <guilabel>Visual</guilabel> tab, so we can work with the editor completely in its WYSIWYG mode.</para>
+ </listitem>
+ <listitem>
+ <para>To the right of the editor, in the JBoss Tools Palette, expand the <guilabel>JSF HTML</guilabel> palette folder by selecting it.</para>
+ </listitem>
+ </itemizedlist>
+ <figure>
+ <title>JBoss Tools Palette</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Click on <guimenuitem>form</guimenuitem> within this folder, drag the cursor over to the editor, and drop it inside the <code><f:view></code> element. This can be done by dragging the form element onto the horizontal line at the top of the <code><f:view></code> element. You should see a message saying <guilabel>Place at the beginning of <f:view></guilabel>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <figure>
+ <title>Inserting the form element</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_7a.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>The <guilabel>Insert Tags</guilabel> dialog box will be displayed.</para>
+ </listitem>
+ <listitem>
+ <para>
+ In the value field next to <guilabel>id</guilabel>, type <guilabel>greeting</guilabel> and click on the <guibutton>Close</guibutton> button.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Type "Please enter name:" inside the <code><h:form></code> element.</para>
+ </listitem>
+ <listitem>
+ <para>
+ Select <guimenuitem>inputText</guimenuitem> within the JSF HTML palette folder place it at the end of the <code><h:form></code> element.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <figure>
+ <title>Inserting the input text element</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_7b.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>
+ In the attributes dialog, click in the <guilabel>value</guilabel> field next to the value attribute and click on the <guibutton>...</guibutton>button.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Then, select the <menuchoice><guimenuitem>Managed Beans</guimenuitem><guimenuitem>personBean</guimenuitem><guimenuitem>name</guimenuitem></menuchoice> node and click on the <guibutton>OK</guibutton> button.</para>
+ </listitem>
+ <listitem>
+ <para>
+ Back in the attributes dialog, select the <guilabel>Advanced</guilabel> tab, and type in <guilabel>name</guilabel> as the value for the <guilabel>id</guilabel> attribute, and then click on the <guibutton>Finish</guibutton> button.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Select <guimenuitem>commandButton</guimenuitem> within the <guilabel>JSF HTML palette</guilabel> folder and drag it into the end of the <code><h:form></code> element.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In the attributes dialog, click in the value field next to the <guilabel>action</guilabel> attribute and click on the <guibutton>...</guibutton> button.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Then, select the <menuchoice><guimenuitem>View Actions</guimenuitem><guimenuitem>greeting</guimenuitem></menuchoice> node and click on the <guibutton>OK</guibutton> button.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In the <guilabel>Advanced</guilabel> tab, type in <guilabel>Say Hello</guilabel> as the value for the value attribute ("Say Hello") and then click on the <guibutton>Finish</guibutton> button.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>The source coding should be something like this now:</para>
+ <programlisting role="XML"><![CDATA[<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
+<%@ taglib prefix="f" uri="http://java.sun.com/jsf/core"%>
+<%@ taglib prefix="h" uri="http://java.sun.com/jsf/html"%>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
-<title></title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>Insert title here</title>
</head>
-<body>
-<f:view>
-<h:form id="greeting">
-Please enter name:
-<h:inputText id="name" value="#{personBean.name}"/>
-<h:commandButton value=" Say Hello " action="greeting"/>
-</h:form>
-</f:view>
-</body>
-</html>
-]]></programlisting>
- <para>The editor should look like this:</para>
- <figure>
- <title>Visual Page Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_8.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Save the file by selecting <emphasis>
- <property>File > Save</property>
- </emphasis> from the menu bar</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="Greeting.jsp">
- <title>greeting.jsp</title>
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis>
- <property>faces-config.xml</property>
- </emphasis> tab to bring the diagram back</para>
- </listitem>
- <listitem>
- <para>Open the editor for the second file by double-clicking on the <emphasis>
- <property>/pages/greeting.jsp</property>
- </emphasis> icon</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis>
- <property>Visual</property>
- </emphasis> tab, so we can work with the editor completely in its WYSIWYG
- mode</para>
- </listitem>
- <listitem>
- <para>Type "Hello "(note space after Hello) into the
- box</para>
- </listitem>
- <listitem>
- <para>Select <emphasis>
- <property>outputText</property>
- </emphasis> within the JSF HTML palette folder and drag it into the
- innermost box in the editor after "Hello"</para>
- </listitem>
- <listitem>
- <para>In the attributes dialog, click in <emphasis>
- <property>value</property>
- </emphasis> field next to the value attribute and click on the
- <property>...</property> (Browse) button</para>
- </listitem>
- <listitem>
- <para>Then, select the <emphasis>
- <property>Managed Beans > personBean > name</property>
- </emphasis> node, click on the <emphasis>
- <property>Ok</property>
- </emphasis> button, and then click on the <emphasis>
- <property>Finish</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>Right after the output field, type an <emphasis>
+ <body>
+ <f:view>
+ <h:form id="greeting">
+ Please enter name:
+ <h:inputText id="name" value="#{personBean.name}"/>
+ <h:commandButton action="greeting" value="Say Hello"/>
+ </h:form>
+ </f:view>
+ </body>
+</html>]]></programlisting>
+ <para>The editor should look like this:</para>
+ <figure>
+ <title>Visual Page Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Save the file by selecting <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save</guimenuitem></menuchoice> from the menu bar</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="Greeting.jsp">
+ <title>greeting.jsp</title>
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <filename>faces-config.xml</filename> tab to bring the diagram back</para>
+ </listitem>
+ <listitem>
+ <para>Open the editor for the second file by double-clicking on the <filename>/pages/greeting.jsp</filename> icon</para>
+ </listitem>
+ <listitem>
+ <para>Select the <guilabel>Visual</guilabel> tab, so we can work with the editor completely in its WYSIWYG mode</para>
+ </listitem>
+ <listitem>
+ <para>Type "Hello " (note the space after Hello) into the box</para>
+ </listitem>
+ <listitem>
+ <para>Select <guimenuitem>outputText</guimenuitem> within the JSF HTML palette folder and drag it into the
+ innermost box in the editor after "Hello "</para>
+ </listitem>
+ <listitem>
+ <para>In the attributes dialog, click in <guilabel>value</guilabel> field next to the value attribute and click on the
+ <guibutton>...</guibutton> (Browse) button</para>
+ </listitem>
+ <listitem>
+ <para>
+ Then, select the <menuchoice><guimenuitem>Managed Beans</guimenuitem><guimenuitem>personBean</guimenuitem><guimenuitem>name</guimenuitem></menuchoice> node, click on the <guibutton>OK</guibutton> button, and then click on the <guibutton>Finish</guibutton> button.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Right after the output field, type an <emphasis>
<property>exclamation point</property>
- </emphasis> (<emphasis>
+ </emphasis> (<emphasis>
<property>!</property>
- </emphasis>)</para>
- </listitem>
- </itemizedlist>
- <para>The source coding should be something like this now:</para>
- <programlisting role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
+ </emphasis>)</para>
+ </listitem>
+ </itemizedlist>
+ <para>The source coding should be something like this now:</para>
+ <programlisting role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %>
<html>
<head>
@@ -246,10 +212,10 @@
</body>
</html>
]]></programlisting>
- <itemizedlist>
- <listitem>
- <para>Save the file</para>
- </listitem>
- </itemizedlist>
- </section>
- </chapter>
\ No newline at end of file
+ <itemizedlist>
+ <listitem>
+ <para>Save the file</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+</chapter>
\ No newline at end of file
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/master.xml
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/master.xml 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/master.xml 2011-07-18 02:23:12 UTC (rev 32981)
@@ -56,12 +56,12 @@
</releaseinfo>
-<abstract>
+<!--<abstract>
<title/>
<para>
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf_tools_tutorial/p...">PDF version</ulink>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf_tools_tutorial/p...">PDF version</ulink>
</para>
-</abstract>
+</abstract>-->
</bookinfo>
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/relevant_resources.xml
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/relevant_resources.xml 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/relevant_resources.xml 2011-07-18 02:23:12 UTC (rev 32981)
@@ -1,37 +1,60 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="relevant_resources">
- <?dbhtml filename="relevant_resources.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>JSF application</keyword>
- <keyword>Java</keyword>
- </keywordset>
- </chapterinfo>
+ <?dbhtml filename="relevant_resources.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>JSF application</keyword>
+ <keyword>Java</keyword>
+ </keywordset>
+ </chapterinfo>
- <title>Other Relevant Resources on the topic</title>
- <para>JSF on Sun: <ulink url="http://java.sun.com/javaee/javaserverfaces/">JavaServer Faces
- Technology</ulink></para>
- <para>Core JSF: <ulink url="http://www.horstmann.com/corejsf/">Core JavaServer Faces</ulink></para>
- <para>API: <ulink url="http://java.sun.com/javaee/javaserverfaces/1.1/docs/api/index.html">JSF
- API</ulink></para>
- <para>JSF Tags: <ulink url="http://www.horstmann.com/corejsf/jsf-tags.html">JSF Core
- Tags</ulink></para>
- <para>HTML Tags Reference: <ulink url="http://www.exadel.com/tutorial/jsf/jsftags-guide.html"
- >JSF HTML Tags Reference</ulink></para>
- <para>JSF Central: <ulink url="http://www.jsfcentral.com/">JSF Central - Your JavaServer Faces
- Community</ulink></para>
- <para>FAQ: <ulink url="http://wiki.java.net/bin/view/Projects/JavaServerFacesSpecFaq">JSF
- FAQ</ulink></para>
- <para>Download: <ulink url="http://java.sun.com/javaee/javaserverfaces/download.html">JavaServer
- Faces Technology - Download</ulink></para>
-
- <para>In summary, with this tutorial you should now know how to organize JSF sample application
+ <title>Other Relevant Resources on the topic</title>
+ <itemizedlist>
+ <listitem>
+ <para>JSF on Sun: <ulink url="http://java.sun.com/javaee/javaserverfaces/">JavaServer Faces
+ Technology</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Core JSF: <ulink url="http://www.horstmann.com/corejsf/">Core JavaServer Faces</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>API: <ulink url="http://java.sun.com/javaee/javaserverfaces/reference/api/index.html">JSF
+ API</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>JSF Tags: <ulink url="http://www.horstmann.com/corejsf/jsf-tags.html">JSF Core
+ Tags</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>HTML Tags Reference: <ulink url="http://www.exadel.com/tutorial/jsf/jsftags-guide.html">JSF HTML Tags Reference</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>JSF Central: <ulink url="http://www.jsfcentral.com/">JSF Central - Your JavaServer Faces
+ Community</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>FAQ: <ulink url="http://wiki.java.net/bin/view/Projects/JavaServerFacesSpecFaq">JSF
+ FAQ</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Download: <ulink url="http://java.sun.com/javaee/javaserverfaces/download.html">JavaServer
+ Faces Technology - Download</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>In summary, with this tutorial you should now know how to organize JSF sample application
using the wizards provided by <property>JBoss Tools</property>, configure its stuff and
finally run it on the <property>JBoss Server</property>.</para>
- <para>Find out more features on JSF tooling in our JSF Tools
- Reference Guide. If you have questions and suggestions, please refer to <ulink
- url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss
+ <para>Find out more features on JSF tooling in our JSF Tools
+ Reference Guide. If you have questions and suggestions, please refer to <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss
Tools Forum</ulink>.</para>
-</chapter>
+ </chapter>
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/running_application.xml
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/running_application.xml 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/running_application.xml 2011-07-18 02:23:12 UTC (rev 32981)
@@ -34,14 +34,20 @@
<imageobject>
<imagedata fileref="images/jsf_application/jsf_application_10.png"/>
</imageobject>
- </inlinemediaobject>) or right click your project folder and select <emphasis>
- <property>Run As > Run on Server</property>
- </emphasis>:</para>
+ </inlinemediaobject>) or right click your project folder and select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run on Server</guimenuitem></menuchoice>:
+ </para>
</listitem>
</itemizedlist>
- <para>This is the equivalent of launching the browser and typing <emphasis>
- <property>http://localhost:8080/jsfHello</property>
- </emphasis> into your browser. Our <property>JSF application</property> should now
+ <para>This is the equivalent of launching the browser and typing <ulink url="http://localhost:8080/jsfHello/index.jsp">
+ http://localhost:8080/jsfHello/index.jsp</ulink> into your browser. Our <property>JSF application</property> should now
appear.</para>
+ <figure>
+ <title>JSF Application in Firefox 4.0</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_11.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
</chapter>
\ No newline at end of file
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/start_page.xml
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/start_page.xml 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/en-US/start_page.xml 2011-07-18 02:23:12 UTC (rev 32981)
@@ -1,45 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="start_page">
- <?dbhtml filename="start_page.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>JSF application</keyword>
- <keyword>Java</keyword>
- </keywordset>
- </chapterinfo>
+ <?dbhtml filename="start_page.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>JSF application</keyword>
+ <keyword>Java</keyword>
+ </keywordset>
+ </chapterinfo>
- <title>Creating the Start Page</title>
- <para>You also need to create a start page as an entry point into the application.</para>
- <itemizedlist>
- <listitem>
- <para>In the Package Explorer view to the left, right-click <emphasis>
- <property>jsfHello > WebContent</property>
- </emphasis> and select <emphasis>
- <property>New > JSP File</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>For Name type in <emphasis>
- <property>index</property>
- </emphasis>, for Template select <emphasis>
- <property>JSPRedirect</property>
- </emphasis> and click <emphasis>
- <property>Finish</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
- <para>A JSP editor will open up on the newly created file.</para>
-
- <itemizedlist>
- <listitem>
- <para>In the Source part of the split screen, type <emphasis>
- <property>/pages/inputname.jsf</property>
- </emphasis> in between the quotes for the page attribute</para>
- </listitem>
- </itemizedlist>
- <para>The source coding should look like this now:</para>
- <programlisting role="XML"><![CDATA[<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
+ <title>Creating the Start Page</title>
+ <para>You also need to create a start page as an entry point into the application.</para>
+ <itemizedlist>
+ <listitem>
+ <para>In the Package Explorer view to the left, right-click <menuchoice><guimenuitem>jsfHello</guimenuitem><guimenuitem>WebContent</guimenuitem></menuchoice> and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>JSP File</guimenuitem></menuchoice>
+ </para>
+ </listitem>
+ <listitem>
+ <para>For Name type in <guilabel>index</guilabel>, for Template select <guimenuitem>New JSP File (html)</guimenuitem> and click the <guibutton>Finish</guibutton> button.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>A JSP editor will open up on the newly created file.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>In the Source part of the split screen, replace the contents of the file with the code below.</para>
+ </listitem>
+ </itemizedlist>
+ <programlisting role="XML"><![CDATA[<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head></head>
<body>
@@ -47,17 +36,13 @@
</body>
</html>
]]></programlisting>
-
- <para>Note the <emphasis>
- <property>.jsf</property>
- </emphasis> extension for the file name. This is a mapping defined in the web.xml file
- for the project for invoking <property>JavaServer Faces</property> when you run the
- application.</para>
- <itemizedlist>
- <listitem>
- <para>Select<emphasis>
- <property> File > Save</property>
- </emphasis> from the menu bar</para>
- </listitem>
- </itemizedlist>
- </chapter>
\ No newline at end of file
+
+ <para>
+ Note the <filename>.jsf</filename> extension for the file name. This is a mapping defined in the <filename>web.xml</filename> file for the project for invoking <property>JavaServer Faces</property> when you run the application.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save</guimenuitem></menuchoice> from the menu bar</para>
+ </listitem>
+ </itemizedlist>
+</chapter>
\ No newline at end of file
Modified: branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/pom.xml
===================================================================
--- branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/pom.xml 2011-07-18 02:19:56 UTC (rev 32980)
+++ branches/jbosstools-3.2.x/jsf/docs/jsf_tools_tutorial/pom.xml 2011-07-18 02:23:12 UTC (rev 32981)
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.jboss.tools</groupId>
@@ -10,229 +8,232 @@
<packaging>jdocbook</packaging>
<name>${bookname}-(${translation})</name>
- <properties>
- <translation>en-US</translation>
- <docname>JSF_Tools_Tutorial</docname>
- <bookname>JSF Tools Tutorial</bookname>
- </properties>
-
- <profiles>
+ <properties>
+ <translation>en-US</translation>
+ <docname>JSF_Tools_Tutorial</docname>
+ <bookname>JSF Tools Tutorial</bookname>
+ </properties>
+ <profiles>
+
<!-- mvn compile -->
- <profile>
- <id>all</id>
- <activation>
- <activeByDefault>true</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${docname}.pdf</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>all</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.4</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${docname}.pdf</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <useRelativeImageUris>true</useRelativeImageUris>
+ </options>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Phtml -->
- <profile>
- <id>html</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>html</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Phtml-single -->
- <profile>
- <id>html-single</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- </plugin>
+ <profile>
+ <id>html-single</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Ppdf -->
- <profile>
- <id>pdf</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${docname}.pdf</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
+ <profile>
+ <id>pdf</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${docname}.pdf</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
</plugins>
</build>
</profile>
<!-- mvn compile -Peclipse -->
- <profile>
- <id>eclipse</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <configuration>
- <formats>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- </configuration>
- </plugin>
- </plugins>
- </build>
- </profile>
+ <profile>
+ <id>eclipse</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <configuration>
+ <formats>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
- </profiles>
- <build>
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.3.3</version>
- <extensions>true</extensions>
- <dependencies>
- <dependency>
- <groupId>org.jboss.pressgang</groupId>
- <artifactId>pressgang-xslt</artifactId>
- <version>1.2.0</version>
- </dependency>
- <dependency>
- <groupId>org.jboss</groupId>
- <artifactId>jbossorg-jdocbook-style</artifactId>
- <version>1.1.1</version>
- <type>jdocbook-style</type>
- </dependency>
- </dependencies>
- <configuration>
- <sourceDirectory>${project.basedir}</sourceDirectory>
+ </profiles>
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.3.3</version>
+ <extensions>true</extensions>
+ <dependencies>
+ <dependency>
+ <groupId>org.jboss.pressgang</groupId>
+ <artifactId>pressgang-xslt</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss</groupId>
+ <artifactId>jbossorg-jdocbook-style</artifactId>
+ <version>1.1.1</version>
+ <type>jdocbook-style</type>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <sourceDirectory>${project.basedir}</sourceDirectory>
<!-- <sourceDocumentName>${docname}.xml</sourceDocumentName> -->
- <sourceDocumentName>master.xml</sourceDocumentName>
- <masterTranslation>en-US</masterTranslation>
- <imageResource>
- <directory>${project.basedir}/en-US</directory>
- <includes>
- <include>images/**/*</include>
- </includes>
- </imageResource>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
- <finalName>${pdf.name}</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
- </formats>
- <options>
- <xincludeSupported>true</xincludeSupported>
- <xmlTransformerType>saxon</xmlTransformerType>
- <docbookVersion>1.72.0</docbookVersion>
- <localeSeparator>-</localeSeparator>
- <transformerParameters>
- <property>
- <name>javax.xml.parsers.DocumentBuilderFactory</name>
- <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
- </property>
- <property>
- <name>javax.xml.parsers.SAXParserFactory</name>
- <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
- </property>
- </transformerParameters>
- </options>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
+ <sourceDocumentName>{master}</sourceDocumentName>
+ <masterTranslation>en-US</masterTranslation>
+ <imageResource>
+ <directory>${project.basedir}/en-US</directory>
+ <includes>
+ <include>images/**/*</include>
+ </includes>
+ </imageResource>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>${pdf.name}</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ <format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <xincludeSupported>true</xincludeSupported>
+ <xmlTransformerType>saxon</xmlTransformerType>
+ <docbookVersion>1.72.0</docbookVersion>
+ <localeSeparator>-</localeSeparator>
+ <transformerParameters>
+ <property>
+ <name>javax.xml.parsers.DocumentBuilderFactory</name>
+ <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
+ </property>
+ <property>
+ <name>javax.xml.parsers.SAXParserFactory</name>
+ <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
+ </property>
+ </transformerParameters>
+ </options>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
</project>
14 years, 9 months
- 1
- 0