JBoss Tools SVN: r12280 - trunk/seam/docs/reference/en/images/crud_application_walkthrough.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2008-12-04 10:57:47 -0500 (Thu, 04 Dec 2008)
New Revision: 12280
Modified:
trunk/seam/docs/reference/en/images/crud_application_walkthrough/crud_application_walkthrough_4.png
trunk/seam/docs/reference/en/images/crud_application_walkthrough/crud_application_walkthrough_5.png
trunk/seam/docs/reference/en/images/crud_application_walkthrough/crud_application_walkthrough_6.png
trunk/seam/docs/reference/en/images/crud_application_walkthrough/crud_application_walkthrough_7.png
trunk/seam/docs/reference/en/images/crud_application_walkthrough/crud_application_walkthrough_8.png
Log:
https://jira.jboss.org/jira/browse/JBDS-472 - updating the screens according to the Seam Generate Entities wizard redesign;
Modified: trunk/seam/docs/reference/en/images/crud_application_walkthrough/crud_application_walkthrough_4.png
===================================================================
(Binary files differ)
Modified: trunk/seam/docs/reference/en/images/crud_application_walkthrough/crud_application_walkthrough_5.png
===================================================================
(Binary files differ)
Modified: trunk/seam/docs/reference/en/images/crud_application_walkthrough/crud_application_walkthrough_6.png
===================================================================
(Binary files differ)
Modified: trunk/seam/docs/reference/en/images/crud_application_walkthrough/crud_application_walkthrough_7.png
===================================================================
(Binary files differ)
Modified: trunk/seam/docs/reference/en/images/crud_application_walkthrough/crud_application_walkthrough_8.png
===================================================================
(Binary files differ)
17 years, 4 months
JBoss Tools SVN: r12279 - trunk/seam/docs/reference/en/modules.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2008-12-04 10:56:49 -0500 (Thu, 04 Dec 2008)
New Revision: 12279
Modified:
trunk/seam/docs/reference/en/modules/crud_application_walkthrough.xml
trunk/seam/docs/reference/en/modules/crud_database_application.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-472 - updating the chapters according to Seam Generate Entities wizard redesign;
Modified: trunk/seam/docs/reference/en/modules/crud_application_walkthrough.xml
===================================================================
--- trunk/seam/docs/reference/en/modules/crud_application_walkthrough.xml 2008-12-04 15:03:24 UTC (rev 12278)
+++ trunk/seam/docs/reference/en/modules/crud_application_walkthrough.xml 2008-12-04 15:56:49 UTC (rev 12279)
@@ -1,121 +1,170 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="crud_application_walkthrough" xreflabel="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>
+ <?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>Start JBoss Application Server if it was not started before. </para></listitem>
+ <listitem>
+ <para>Start JBoss Application Server if it was not started before. </para>
+ </listitem>
</itemizedlist>
-
- <para>On<emphasis><property> JBossServer View </property></emphasis> right click on the <emphasis><property>JBoss Application Server</property></emphasis> and select
- <emphasis><property> Start </property></emphasis></para>
-
+
+ <para>On<emphasis>
+ <property> JBossServer View </property>
+ </emphasis> right click on the <emphasis>
+ <property>JBoss Application Server</property>
+ </emphasis> and select <emphasis>
+ <property> Start </property>
+ </emphasis></para>
+
<figure>
<title>Start the Server</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_1.png" scale="70"/>
+ <imagedata
+ fileref="images/crud_application_walkthrough/crud_application_walkthrough_1.png"
+ scale="70"/>
</imageobject>
</mediaobject>
</figure>
-
-
- <itemizedlist>
- <listitem><para>Run a project on the Server. </para></listitem>
+
+
+ <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>
-
+
+ <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>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_2.png" scale="70"/>
+ <imagedata
+ fileref="images/crud_application_walkthrough/crud_application_walkthrough_2.png"
+ scale="70"/>
</imageobject>
</mediaobject>
- </figure>
-
- <para>Select a Server and click <property>Finish</property></para>
-
+ </figure>
+
+ <para>Select a Server and click <property>Finish</property></para>
+
<figure>
<title>Select a Server</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_3.png"/>
+ <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>
+
+ <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>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_4.png" scale="70"/>
+ <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>
+
+ <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</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_5.png" scale="70"/>
+ <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>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</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_6.png" scale="70"/>
+ <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>
-
+ <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>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_7.png"/>
+ <imagedata
+ fileref="images/crud_application_walkthrough/crud_application_walkthrough_7.png"
+ />
</imageobject>
</mediaobject>
</figure>
<figure>
<title>Edit Employee</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
- <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_8.png" scale="70"/>
+ <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>Update</property>.</para>
+ <para> Fill in <emphasis>
+ <property>firstname</property>
+ </emphasis> and press <property>Save</property>.</para>
<para> Database will be updated.</para>
- </section>
+ </section>
</chapter>
-
Modified: trunk/seam/docs/reference/en/modules/crud_database_application.xml
===================================================================
--- trunk/seam/docs/reference/en/modules/crud_database_application.xml 2008-12-04 15:03:24 UTC (rev 12278)
+++ trunk/seam/docs/reference/en/modules/crud_database_application.xml 2008-12-04 15:56:49 UTC (rev 12279)
@@ -24,8 +24,8 @@
<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>
+ <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 <link linkend="intro">Seam</link> Web application,
connect it to the <ulink url="http://www.hsqldb.org/">HSQL</ulink> database and add
<property>CRUD</property> support. </para>
@@ -37,7 +37,7 @@
<itemizedlist>
<listitem>
<para>First, you should <ulink url="http://docs.jboss.org/tools/resources/"
- >download</ulink> a database and start it by running <emphasis>
+ >download</ulink> a database and start it by running <emphasis>
<property>./runDBServer.sh</property>
</emphasis> or <emphasis>
<property>runDBServer.bat</property>
@@ -45,8 +45,8 @@
</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>
+ wizard</property> or main menu <emphasis><property>File > New > Seam Web
+ Project</property>.</emphasis></para>
</listitem>
</itemizedlist>
<figure>
@@ -115,8 +115,7 @@
</emphasis> connection profile type, name it <emphasis>
<property>cruddb</property>
</emphasis> and click <emphasis>
- <property>Next</property>.
- </emphasis></para>
+ <property>Next</property>. </emphasis></para>
</listitem>
</itemizedlist>
@@ -153,8 +152,7 @@
<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>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>
@@ -173,8 +171,8 @@
<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>
+ 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>
@@ -199,11 +197,10 @@
</emphasis> and <emphasis>
<property>User ID</property>
</emphasis> and click <emphasis>
- <property>OK</property>.
- </emphasis></para>
+ <property>OK</property>. </emphasis></para>
</listitem>
</itemizedlist>
-
+
<figure>
<title>Driver Definitions Properties</title>
<mediaobject>
@@ -286,7 +283,7 @@
</emphasis> will be created.</para>
</listitem>
</itemizedlist>
-
+
<figure>
<title>CRUDAPP Seam Project</title>
<mediaobject>
@@ -297,17 +294,17 @@
</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>
+ <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>CRUDAPP Seam Project</title>
+ <title>login.xhtml in VPE</title>
<mediaobject>
<imageobject>
<imagedata
@@ -342,10 +339,10 @@
<para>Expand <emphasis>
<property>cruddb</property>
</emphasis> nodes to view its <emphasis>
- <property>Schemas</property>
- </emphasis>, <emphasis>
- <property>Tables</property>
- </emphasis>, <emphasis>
+ <property>Schemas</property>, </emphasis>
+ <emphasis>
+ <property>Tables</property>, </emphasis>
+ <emphasis>
<property>Columns</property>
</emphasis> etc.</para>
</listitem>
@@ -367,13 +364,13 @@
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. In the <emphasis>
+ pages based on existing tables in the database. On the first page of <emphasis>
<property>Generate Seam Entities</property>
- </emphasis> dialog keep everything by default and press <emphasis>
- <property>Finish</property>
- </emphasis>. </para>
+ </emphasis> wizard keep everything by default and press <emphasis>
+ <property>Next</property>. </emphasis></para>
</listitem>
</itemizedlist>
+
<figure>
<title>Generate Seam Entities</title>
<mediaobject>
@@ -387,12 +384,51 @@
<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
+ 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 a lot of generated <property>xhtml</property>
+ </emphasis> folder you can find all generated <property>xhtml</property>
files:</para>
</listitem>
</itemizedlist>
+
<figure>
<title>Entities Web Pages</title>
<mediaobject>
@@ -417,7 +453,7 @@
<imageobject>
<imagedata
fileref="images/crud_database_application/crud_database_application_20.png"
- scale="75"/>
+ />
</imageobject>
</mediaobject>
</figure>
@@ -425,8 +461,8 @@
<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>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>
@@ -447,13 +483,12 @@
<itemizedlist>
<listitem>
- <para>Observe that <property>Mapping Diagram</property> is opened in the editor.
- Here you can see the relations between models and database tables. Select
- <property>Customers</property> entity model, right click and select <emphasis>
- <property>Open Source File</property>
- </emphasis>.</para>
+ <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>
@@ -467,10 +502,15 @@
<itemizedlist>
<listitem>
- <para>This will open the <property>Customers.java</property> file in the java
- editor.</para>
+ <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>
@@ -482,7 +522,7 @@
</mediaobject>
</figure>
- <para>After that you are ready to deploy your application to J2EE application server. This
+ <para>So far, you are ready to deploy your application to JBoss Application Server. This
is described in the next chapter.</para>
</section>
17 years, 4 months
JBoss Tools SVN: r12277 - trunk/documentation/guides/GettingStartedGuide/en/images/first_seam.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2008-12-04 10:02:20 -0500 (Thu, 04 Dec 2008)
New Revision: 12277
Added:
trunk/documentation/guides/GettingStartedGuide/en/images/first_seam/first_seam34a.png
Log:
https://jira.jboss.org/jira/browse/JBDS-472 - adding new screen;
Added: trunk/documentation/guides/GettingStartedGuide/en/images/first_seam/first_seam34a.png
===================================================================
(Binary files differ)
Property changes on: trunk/documentation/guides/GettingStartedGuide/en/images/first_seam/first_seam34a.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
17 years, 4 months
JBoss Tools SVN: r12276 - trunk/documentation/guides/GettingStartedGuide/en/modules.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2008-12-04 08:02:00 -0500 (Thu, 04 Dec 2008)
New Revision: 12276
Modified:
trunk/documentation/guides/GettingStartedGuide/en/modules/first_seam.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-472 - updating the "Reverse Engineer CRUD from a Running Database";
Modified: trunk/documentation/guides/GettingStartedGuide/en/modules/first_seam.xml
===================================================================
--- trunk/documentation/guides/GettingStartedGuide/en/modules/first_seam.xml 2008-12-04 12:45:33 UTC (rev 12275)
+++ trunk/documentation/guides/GettingStartedGuide/en/modules/first_seam.xml 2008-12-04 13:02:00 UTC (rev 12276)
@@ -60,7 +60,8 @@
<para>After startup, you see the welcome page. You could read how to work with welcome pages
in <link linkend="Welcome">previous</link> chapter. Now select <property>Create
- New...</property> icon and then press on <property>Create Seam Project</property> link.</para>
+ New...</property> icon and then press on <property>Create Seam Project</property>
+ link.</para>
<para>The <property>New Seam Project wizard</property> is started. You need to enter a name
(e.g., "workshop") and a location directory for your new project. The
@@ -77,10 +78,12 @@
</mediaobject>
</figure>
- <para>All settings are already specified here, you can just modify the Configuration. Click on the <emphasis>
- <property>Modify...</property></emphasis> button to configure your custom facets pattern:</para>
+ <para>All settings are already specified here, you can just modify the Configuration. Click on
+ the <emphasis>
+ <property>Modify...</property>
+ </emphasis> button to configure your custom facets pattern:</para>
-
+
<figure id="ProjectFacetsSpecifyingScreen">
<title>Project Facets Specifying</title>
<mediaobject>
@@ -90,17 +93,16 @@
</mediaobject>
</figure>
- <para>On the whole the dialog allows to select the "features" you want to use in your
- project. Doing this <property>JBoss Developer Studio</property> setups the appropriate
- tooling for your project. Since JBoss Seam integrates all popular Java EE frameworks, you
- can select any combination of technologies from the list. Here, for the default
- configuration, Dynamic Web Module, Java, JavaServer Faces (JSF), and Seam Facet are already
- selected for a typical database-driven web application. The default project facets should
- suffice.</para>
+ <para>On the whole the dialog allows to select the "features" you want to use in your project.
+ Doing this <property>JBoss Developer Studio</property> setups the appropriate tooling for
+ your project. Since JBoss Seam integrates all popular Java EE frameworks, you can select any
+ combination of technologies from the list. Here, for the default configuration, Dynamic Web
+ Module, Java, JavaServer Faces (JSF), and Seam Facet are already selected for a typical
+ database-driven web application. The default project facets should suffice.</para>
- <para>In the <property>Project Facets</property> form you can also bring up server
- runtimes panel by clicking <property> Runtimes</property> tab on the right corner. This
- panel shows available server runtimes.</para>
+ <para>In the <property>Project Facets</property> form you can also bring up server runtimes
+ panel by clicking <property> Runtimes</property> tab on the right corner. This panel shows
+ available server runtimes.</para>
<figure>
<title>Runtimes Selecting</title>
@@ -110,13 +112,13 @@
</imageobject>
</mediaobject>
</figure>
-
+
<para>Click on <emphasis>
- <property>Ok</property>
- </emphasis> and then <emphasis>
- <property>Next</property>
- </emphasis> to proceed further.</para>
-
+ <property>Ok</property>
+ </emphasis> and then <emphasis>
+ <property>Next</property>
+ </emphasis> to proceed further.</para>
+
<para>A dynamic web application contains both web pages and Java code. The wizard will ask you
where you want to put those files. You can just leave the default values or choose another
folder.</para>
@@ -136,8 +138,10 @@
setup window.</para>
<itemizedlist>
<listitem>
- <para>Check <emphasis><property>Server Supplied JSF Implementation</property></emphasis>.
- We will use <ulink url="&seamlink;#addJSFCapab">JSF implementation</ulink> that comes with JBoss server</para>
+ <para>Check <emphasis>
+ <property>Server Supplied JSF Implementation</property>
+ </emphasis>. We will use <ulink url="&seamlink;#addJSFCapab">JSF
+ implementation</ulink> that comes with JBoss server</para>
</listitem>
<listitem>
<para>Click <emphasis>
@@ -156,7 +160,7 @@
</figure>
<para>Next wizard step needs more settings that previous. Let's start with
- <property>General</property> section.</para>
+ <property>General</property> section.</para>
<para>Leave the default Seam runtime and check a WAR deployment.</para>
<figure>
@@ -172,7 +176,8 @@
Profile</property> needs to be edited so that the new project works properly with the
external HSQLDB server. By default the project wizard tries to use the JBoss embedded
HSQLDB, but the tutorial uses an external database to replicate a more real world
- development scenario. Click on <property>Edit</property> to modify the Connection Profile.</para>
+ development scenario. Click on <property>Edit</property> to modify the Connection
+ Profile.</para>
<figure>
<title>DataBase Setting</title>
@@ -203,7 +208,7 @@
<para>The proper Driver JAR File should be listed under <property>Driver File(s)</property>.
Select the hsqldb.jar file found in the database/lib directory and click on
- <property>Ok</property>.</para>
+ <property>Ok</property>.</para>
<figure>
<title>Driver Details</title>
@@ -427,7 +432,8 @@
<property>MyAction.myAction()</property> logic.</para>
<para>To run the test case, right click on <property>MyActionTest.xml</property> and click <emphasis>
<property>Run As > TestNG Suite</property>
- </emphasis> or use the <property>Run As...</property> toolbar shortcut as shown below.</para>
+ </emphasis> or use the <property>Run As...</property> toolbar shortcut as shown
+ below.</para>
<figure>
<title>TestNG Running</title>
@@ -540,7 +546,8 @@
<title>Declarative Security</title>
<para>In this section you will see how it’s easy to secure the facelets and facelet components
- in Seam. Let’s go ahead and secure the action button, then we will secure the entire page.</para>
+ in Seam. Let’s go ahead and secure the action button, then we will secure the entire
+ page.</para>
<section id="edit_login">
<title>Edit Login Authentication Logic</title>
@@ -602,7 +609,8 @@
components is easy but securing pages is pretty simple as well. </para>
<para>Open <emphasis>
<property>WebContent/WEB-INF/pages.xml</property>
- </emphasis>. Then add this markup directly underneath the <pages> element:</para>
+ </emphasis>. Then add this markup directly underneath the <pages>
+ element:</para>
<programlisting><![CDATA[<page view-id="/myAction.xhtml" login-required="true"/>]]></programlisting>
@@ -620,9 +628,9 @@
</figure>
<para>Thus, if you enter login credentials for the
- <property>"admin"</property> user, you will be re-directed to the secured
- page and secured component. If you enter different login credentials, page access will be
- granted, but the secured component will not be displayed.</para>
+ <property>"admin"</property> user, you will be re-directed to the
+ secured page and secured component. If you enter different login credentials, page access
+ will be granted, but the secured component will not be displayed.</para>
<para>Congratulations! You have secured your new action both at the facelet component and page
level. You also added custom authentication logic to the login action.</para>
@@ -646,7 +654,7 @@
> Other > Database Development</property>.</emphasis></para>
<para>In the Data Source Explorer, expand a <property>Databases</property> node and select a
<property>Default</property> database. Right click on it, select
- <property>Connect</property> from the context menu.</para>
+ <property>Connect</property> from the context menu.</para>
<figure>
<title>Data Source Explorer</title>
@@ -713,12 +721,15 @@
<section id="reverse_engineer_crud">
<title>Reverse Engineer CRUD from a Running Database</title>
- <para>In JBoss Developer Studio, switch to Seam perspective and click on
- <emphasis><property>File > New > Seam Generate Entities</property>.</emphasis></para>
+ <para>In <property>JBoss Developer Studio</property>, switch to <property>Seam
+ perspective</property>, and then right-click the project and select
+ <emphasis><property>New > Seam Generate Entities</property>.</emphasis></para>
- <para>In the Seam Generate Entities wizard, select "workshop" project using
- the <property>Browse</property> button. There is no need to change something more, click on
- <property>Finish</property>.</para>
+ <para>"workshop" project in the <property>Seam Generate Entities
+ wizard</property> will be selected automatically. There is no need to change something
+ more, click <emphasis>
+ <property>Next</property>
+ </emphasis> to proceed further.</para>
<figure>
<title>Generate Seam Entities</title>
@@ -729,6 +740,20 @@
</mediaobject>
</figure>
+ <para>On the next page use the <emphasis>
+ <property>Include</property>
+ </emphasis> button to include all the tables from the database and click <emphasis>
+ <property>Finish</property>.</emphasis></para>
+
+ <figure>
+ <title>Selecting Tables</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/first_seam/first_seam34a.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
<para>After running the Generate Entities action, you will see new <emphasis>
<property>org.domain.workshop.entity</property>
</emphasis> classes. These classes represent insert/update/delete/query logic.</para>
@@ -800,7 +825,7 @@
</figure>
<para>Right click on the <property>Session Factory</property> and select <property>HQL
- Editor</property>. This will open a JPA query scratch pad window.</para>
+ Editor</property>. This will open a JPA query scratch pad window.</para>
<para>Write your query and click on the "Hibernate Dynamic SQL Preview" tab.
You should see the SQL that will be executed if this JPA query is run.</para>
@@ -880,7 +905,7 @@
<para>In the Hibernate Configurations view, select "workshop" project and
expand the <property>Configuration</property> node. Select the
- <property>Customers</property> entity, right click on it, choose <property>Open Mapping
+ <property>Customers</property> entity, right click on it, choose <property>Open Mapping
Diagram</property>.</para>
<figure>
@@ -963,7 +988,8 @@
</mediaobject>
</figure>
- <para>The end result is an edit page that has better form labels and a new RichFaces control.</para>
+ <para>The end result is an edit page that has better form labels and a new RichFaces
+ control.</para>
<figure>
<title>The Result Page</title>
17 years, 4 months
JBoss Tools SVN: r12275 - trunk/documentation/whatsnew.
by jbosstools-commits@lists.jboss.org
Author: max.andersen(a)jboss.com
Date: 2008-12-04 07:45:33 -0500 (Thu, 04 Dec 2008)
New Revision: 12275
Added:
trunk/documentation/whatsnew/.project
Log:
whatsnew project
Added: trunk/documentation/whatsnew/.project
===================================================================
--- trunk/documentation/whatsnew/.project (rev 0)
+++ trunk/documentation/whatsnew/.project 2008-12-04 12:45:33 UTC (rev 12275)
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>whatsnew</name>
+ <comment></comment>
+ <projects>
+ </projects>
+ <buildSpec>
+ </buildSpec>
+ <natures>
+ </natures>
+</projectDescription>
17 years, 4 months
JBoss Tools SVN: r12274 - in trunk/smooks/docs/reference/en/images: xml2java and 1 other directory.
by jbosstools-commits@lists.jboss.org
Author: DartPeng
Date: 2008-12-04 03:34:11 -0500 (Thu, 04 Dec 2008)
New Revision: 12274
Added:
trunk/smooks/docs/reference/en/images/common/xml_source_editor.png
trunk/smooks/docs/reference/en/images/common/xml_source_editor_error.png
Removed:
trunk/smooks/docs/reference/en/images/xml2java/xml_filepath_selection_wziard.png
Log:
JBIDE-3296
Add/Remove some pictures
Added: trunk/smooks/docs/reference/en/images/common/xml_source_editor.png
===================================================================
(Binary files differ)
Property changes on: trunk/smooks/docs/reference/en/images/common/xml_source_editor.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/smooks/docs/reference/en/images/common/xml_source_editor_error.png
===================================================================
(Binary files differ)
Property changes on: trunk/smooks/docs/reference/en/images/common/xml_source_editor_error.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Deleted: trunk/smooks/docs/reference/en/images/xml2java/xml_filepath_selection_wziard.png
===================================================================
(Binary files differ)
17 years, 4 months
JBoss Tools SVN: r12273 - trunk/smooks/docs/reference/en/images/xml2java.
by jbosstools-commits@lists.jboss.org
Author: DartPeng
Date: 2008-12-04 03:32:42 -0500 (Thu, 04 Dec 2008)
New Revision: 12273
Added:
trunk/smooks/docs/reference/en/images/xml2java/xml_filepath_selection_wizard.png
Log:
JBIDE-3296
change the picture's name
Copied: trunk/smooks/docs/reference/en/images/xml2java/xml_filepath_selection_wizard.png (from rev 12240, trunk/smooks/docs/reference/en/images/xml2java/xml_filepath_selection_wziard.png)
===================================================================
(Binary files differ)
Property changes on: trunk/smooks/docs/reference/en/images/xml2java/xml_filepath_selection_wizard.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
17 years, 4 months
JBoss Tools SVN: r12272 - trunk/smooks/docs/reference/en/modules.
by jbosstools-commits@lists.jboss.org
Author: DartPeng
Date: 2008-12-04 03:32:17 -0500 (Thu, 04 Dec 2008)
New Revision: 12272
Modified:
trunk/smooks/docs/reference/en/modules/introduction.xml
trunk/smooks/docs/reference/en/modules/quick_start.xml
trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml
trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml
Log:
JBIDE-3296
modify some errors of the documents
Modified: trunk/smooks/docs/reference/en/modules/introduction.xml
===================================================================
--- trunk/smooks/docs/reference/en/modules/introduction.xml 2008-12-04 07:15:33 UTC (rev 12271)
+++ trunk/smooks/docs/reference/en/modules/introduction.xml 2008-12-04 08:32:17 UTC (rev 12272)
@@ -71,7 +71,7 @@
</sect1>
<sect1>
<title>What is Smooks dev tools?</title>
- <para>Smooks dev tools is a set of graphical tools for editing
+ <para>Smooks dev tools is a sets of graphical tools for editing
Smooks configuration file base on Eclipse.</para>
<figure>
<title>Smooks form editor</title>
@@ -85,20 +85,24 @@
<sect1>
<title>How to install Smooks dev tools?</title>
<para>
- The Smooks dev tools was contained in the JBossTools since 3.0.0
- beta1 version. You can download the JBossTools form :
+ The Smooks dev tools was included by the JBossTools since 3.0.0
+ beta1
+ version. You can download the JBossTools from :
<link>http://www.jboss.org/tools/download/index.html
</link>
.
</para>
<para>
- Smooks dev tools(JBossTools) need the latest Eclipse and other
- required plug-ins(GEF,EMF,etc.),
- User can download the latest IDE for
- Java EE developers from this site(
- <link>http://www.eclipse.org/downloads/
+ Smooks dev tools(JBossTools) run with the latest Eclipse and
+ other
+ required plug-ins(GEF,EMF,etc.).</para>
+ <para>
+ User should download the latest IDE for
+ Java EE developers from this
+ <link linkend="http://www.eclipse.org/downloads/">site
</link>
- ) for installing JBossTools.
+ . It contains many plug-ins ( GEF,EMF,etc. ) required by Smooks dev
+ tools.
</para>
</sect1>
</chapter>
Modified: trunk/smooks/docs/reference/en/modules/quick_start.xml
===================================================================
--- trunk/smooks/docs/reference/en/modules/quick_start.xml 2008-12-04 07:15:33 UTC (rev 12271)
+++ trunk/smooks/docs/reference/en/modules/quick_start.xml 2008-12-04 08:32:17 UTC (rev 12272)
@@ -17,7 +17,8 @@
transformation.</para>
<para>
This chapter should give the readers a brief understanding of
- the Smooks
+ the
+ Smooks
dev tools.
</para>
<section>
@@ -31,19 +32,23 @@
<tip>
<title>Tip:</title>
<para>
- The example projects is Maven project, we suggest user to
+ The example projects is base on Maven , we suggest user to
create a
- new eclipse Java project, Copy the example codes and .jars
+ new eclipse Java project and copy the example codes and .jar
+ files
from the
- example project and paste them to the eclipse Java project.
- </para>
+ example project paste them to the eclipse Java
+ project.
+ </para>
</tip>
</section>
<section>
<title>Smooks configuration file wizard</title>
- <para>First , select the Java project what you created first to
- create Smooks configuration file and right-click , select : “New” ->
- “Other...” , find the “Smooks Configuration File” wizard. Click
+ <para>Select the Smooks Java-to-Java example project what you
+ created and right-click , select the menu: “New” ->
+ “Other...” , find
+ the
+ “Smooks Configuration File” wizard. Click
“Next” button.
</para>
<figure>
@@ -55,9 +60,8 @@
</mediaobject>
</figure>
<para>First wizard page is file path creation page. Select the
- “src” to be the file's container , and type
- “smooks-newconfig.smooks”
- to be the file's name. Click “Next”.</para>
+ “src” to be the file's container , and input
+ “smooks-newconfig.smooks”. Click “Next”.</para>
<figure>
<title>Choose the configuration file container and type the
file's name</title>
@@ -70,6 +74,16 @@
</figure>
<para>The second wizard page is the transform data type choose
page.</para>
+ <tip>
+ <title>Note</title>
+ <para>
+ Because the quick start introduce how to create/edit the
+ Java-to-Java
+ Smooks configuration file , so choose "Java" type
+ to be
+ the source/target transform data type please.
+ </para>
+ </tip>
<figure>
<title>Select Data Type</title>
<mediaobject>
@@ -82,10 +96,12 @@
</section>
<section id="quickstart_formeditor">
<title>Smooks form editor</title>
- <para>When the wizard finish to create a new Smooks configuration
- file , the Smooks editor will be opened automatically. We will see a
- “Form Editor”.
+ <para>When the wizard was finished , a new Smooks configuration
+ file was created and the Smooks editor will be opened automatically.
</para>
+ <para> We will see the
+ “Smooks Form Editor”:
+ </para>
<figure>
<title>Smooks form editor</title>
<mediaobject>
@@ -100,15 +116,12 @@
<orderedlist numeration="loweralpha" inheritnum="inherit">
<listitem>
Notify message display
- area. If there are any errors ,
- this
+ area. If there are any errors when
+ users are editing the file ,
+ the error
area will
- display them.(You will
- see a empty area , because now
- there
- aren't
- any errors)
- </listitem>
+ display them.
+ </listitem>
<listitem>
Source data
tree. The tree will display the
@@ -121,15 +134,16 @@
Target data tree. The tree
will display the structured of
transform
- source
- target.
+ target
+ data.
</listitem>
<listitem>
Mapping
graphical area. Show the data
- mapping lines.
- </listitem>
+ mapping connection
+ lines.
+ </listitem>
<listitem>
Source/Target data
@@ -137,23 +151,33 @@
link ,
there
will
- open a data
- selection
- wizard to help user to choose
+ open the
+ <link linkend="graphicaleditor_datalink">"Data
+ Selection
+ Wizard"</link>
+ to help user to choose
the
source/target
data.
- </listitem>
+ </listitem>
</orderedlist>
</para>
</section>
- <section>
+ <section id="graphicaleditor_datalink">
<title>Choose the source/target data
</title>
<para>Click the data selection links to choose the transform
- data. You will see a wizard , and there are two items on it :
- XML,Java.
+ data. The "Data Selection Wizard" is opened , and there are two data
+ types on the list :
+ XML and Java.
</para>
+ <tip>
+ <title>Note</title>
+ <para>
+ There will be more and more data types on the list as the
+ development went on.
+ </para>
+ </tip>
<figure>
<title>Data type wizard</title>
<mediaobject>
@@ -175,9 +199,12 @@
</imageobject>
</mediaobject>
</figure>
- <para>After you confirm the java class , click “Finish” , you
- will find , the structured of the class was be display on the Source
- data tree. Please do the same operation for the target data link.
+ <para>When you finished the java class selection , click “Finish”
+ , we
+ will see , the structured of the java class was be displayed on
+ the Source
+ data tree. Please do the same operation with the target
+ data link.
</para>
<figure>
<title>Display structure of the transform data</title>
@@ -189,12 +216,13 @@
</mediaobject>
</figure>
</section>
- <section id ="quickstart_mapping">
+ <section id="quickstart_mapping">
<title>Mapping</title>
<para>
As you see , the source/target data tree display the structure
of the
- java class. How to mapping it?</para>
+ java class. </para>
+ <para>How to mapping it?</para>
<para>
First , we should know what is
we
@@ -237,20 +265,27 @@
</orderedlist>
</para>
<para>
- Make sense ? OK, let's select the “customerName”
+ Make sense ?</para>
+ <para> OK, let's select the “customerName”
item of the
“header”
- item on the source data tree and start to drag
+ item on
+ the source data tree and start to drag
it. When the
drag item
- cross into the Mapping graphical area , we will
+ cross into
+ the Mapping graphical area , we will
see a
connection
- line. Drop the item onto the “customerName” of the
+ line. Drop the
+ item onto the “customerName” of the
“LineOrder” on the
- target data view.
+ target data
+ view.</para>
+ <para>
Now there will open a dialog to
- ask you that do you want to connect the
+ ask you to
+ connect the
root node:
</para>
<figure>
@@ -263,16 +298,22 @@
</mediaobject>
</figure>
<para>
- Please click “Yes” to connect the root node , if you don't ,
+ Please click “Yes” to connect the root node , if you didn't do
+ that,
this dialog
- will open again when you connect other nodes. Please
- remember that :
- The root nodes of the source data and target data
- MUST
- be connected.
- (Not only Java-to-Java , the same as XML-to-Java).
-
- </para>
+ will open again when you connect other nodes.
+ </para>
+ <tip>
+ <title>Note</title>
+ <para>Please
+ remember that :
+ The root nodes of the source data
+ and target data
+ *MUST*
+ be connected.</para>
+ <para>This rule is not only for Java-to-Java , same with
+ XML-to-Java too </para>
+ </tip>
<para>
Now let's do the same operation with the “customerNumber” ,
that
@@ -294,7 +335,7 @@
</para>
<para>Select the “price” and drag it onto the “unitPrice” of
the
- other side tree viewer. The notify message display area will show
+ other side tree viewer. The error message display area will show
an
error :
</para>
@@ -308,14 +349,13 @@
</mediaobject>
</figure>
<para>How to deal with the error ?</para>
- <para>Please click the “Fix it” link , you will see a menu and
- there will show several resolves on the menu (Sorry , can't get the
- captures when the menu opened ).
+ <para>Please click the “Fix it” link , there pop a menu and
+ there are several "resolve methods" on the menu.
</para>
<para>
- Select the first resolve : 'Connect the “OrderItem” to the
+ Select the first resolve method: 'Connect the “OrderItem” to the
“LineItem” ' ,
- then you will find that the “OrderItem” was connected
+ then the “OrderItem” was connected
with the
“LineItem”.
</para>
@@ -331,23 +371,35 @@
</mediaobject>
</figure>
<para>OK,Deal it with the fire error ---- Click “Fix it” link
- and select the first resolve item. The “orderItems” was connected
+ and select the first resolve method. The “orderItems” was connected
with the “lineItems”.
</para>
+ <tip>
+ <title>Tip</title>
+ <para>
+ Why there will occur error?</para>
+ <para> We will find that , if we only
+ connect the
+ property node without
+ to connect the parent node of the
+ property ,
+ the “connection error”
+ will happen. </para>
+ <para>The
+ connection of
+ the “price-to-unitPrice” is
+ the “Binding
+ Connection” ,
+ but there need
+ a “Instance
+ Creation
+ Connection” ---- the
+ connection
+ of
+ the
+ “OrderItem-to-LineItem”.</para>
+ </tip>
<para>
- Why there will occur error? We will find that , if we only
- connect the
- property node without to connect the parent node of the
- property ,
- the “connection error” will happen. We can say that the
- connection of
- the “price to unitPrice” is the “Binding Connection” ,
- but there need
- a “Instance Creation Connection” ---- the connection
- of
- the
- “OrderItem to LineItem”.</para>
- <para>
After that , connect the quantity to
the
unitQuantity ; connect
@@ -363,7 +415,8 @@
</imageobject>
</mediaobject>
</figure>
- <para>Now , we should save the file.</para>
+ <para>Now , we should save the file.The Smooks tools will generate
+ the correct configuration file contents.</para>
<para>OK,Let run the test class : example.Main (Please make
sure
that the Smooks engine load the correct configuration file)
Modified: trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml
===================================================================
--- trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2008-12-04 07:15:33 UTC (rev 12271)
+++ trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2008-12-04 08:32:17 UTC (rev 12272)
@@ -107,7 +107,7 @@
<para>There are several resource type on the list. Select the
"Date
Decoder" and click "Finish" button , a new "Date Decoder" item
- is
+ was
added and shown on the resource type list.
</para>
<para>
@@ -128,7 +128,7 @@
</orderedlist>
</para>
<para>
- User can modify the parameters of the "Date Decoder" item on the
+ User can modify the parameters of the "Date Decoder" item with the
left detail page.
</para>
<figure>
@@ -142,7 +142,7 @@
</figure>
<para>
When user defined new "Date Decoder" , they can use the
- <link linkend="graphicalpage_propertiesview"> "JavaBean Properties" GUI</link>
+ <link linkend="graphicalpage_propertiesview"> "JavaBean Properties"</link> GUI
to set the them to
be the "Java type".
</para>
Modified: trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml
===================================================================
--- trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml 2008-12-04 07:15:33 UTC (rev 12271)
+++ trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml 2008-12-04 08:32:17 UTC (rev 12272)
@@ -28,8 +28,9 @@
data.
</para>
<para>
- When user save the graphical editor , a Smooks configuration file
- will be generate.
+ When user save the graphical editor the correct Smooks
+ configuration file contents
+ will be generated.
</para>
<section>
<title>Introduce the areas of graphical editor</title>
@@ -102,9 +103,10 @@
<para>
When user do any mapping operaions , the Smooks tools will
validate
- the "Mapping Logic" , If there is any errors about the
- "Mapping Logic"
- ,Some error messages will be shown on the
+ the file contents with "Mapping Logic" , If there is any errors of
+ the configuration file contents
+ ,error messages will be shown on
+ the
<link linkend="quickstart_formeditor">"Error
message area"</link>
.
@@ -126,8 +128,8 @@
the properties viewer will be opened.
</para>
<para>
- When user select the connection lines , the properties viewer
- will show a sets of sections GUI for editing the properties of the
+ When user select on the connection lines , the properties viewer
+ will show a sets of section GUI for editing the properties of the
connection line.
</para>
<tip>
17 years, 4 months
JBoss Tools SVN: r12271 - in trunk/smooks/docs/reference/en: images/common and 1 other directories.
by jbosstools-commits@lists.jboss.org
Author: DartPeng
Date: 2008-12-04 02:15:33 -0500 (Thu, 04 Dec 2008)
New Revision: 12271
Added:
trunk/smooks/docs/reference/en/images/common/configuration_page.png
trunk/smooks/docs/reference/en/images/common/date_type_detail_page.png
trunk/smooks/docs/reference/en/images/common/import_file.png
trunk/smooks/docs/reference/en/images/common/java_property_view.png
trunk/smooks/docs/reference/en/images/common/mapping_property_view.png
trunk/smooks/docs/reference/en/images/common/resource_type_wizard.png
trunk/smooks/docs/reference/en/images/common/smooks_parse_type.png
trunk/smooks/docs/reference/en/images/common/xml_property_view.png
trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml
Modified:
trunk/smooks/docs/reference/en/master.xml
trunk/smooks/docs/reference/en/modules/introduction.xml
trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml
trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml
Log:
JBIDE-3296
Add some new chapters.
Added: trunk/smooks/docs/reference/en/images/common/configuration_page.png
===================================================================
(Binary files differ)
Property changes on: trunk/smooks/docs/reference/en/images/common/configuration_page.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/smooks/docs/reference/en/images/common/date_type_detail_page.png
===================================================================
(Binary files differ)
Property changes on: trunk/smooks/docs/reference/en/images/common/date_type_detail_page.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/smooks/docs/reference/en/images/common/import_file.png
===================================================================
(Binary files differ)
Property changes on: trunk/smooks/docs/reference/en/images/common/import_file.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/smooks/docs/reference/en/images/common/java_property_view.png
===================================================================
(Binary files differ)
Property changes on: trunk/smooks/docs/reference/en/images/common/java_property_view.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/smooks/docs/reference/en/images/common/mapping_property_view.png
===================================================================
(Binary files differ)
Property changes on: trunk/smooks/docs/reference/en/images/common/mapping_property_view.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/smooks/docs/reference/en/images/common/resource_type_wizard.png
===================================================================
(Binary files differ)
Property changes on: trunk/smooks/docs/reference/en/images/common/resource_type_wizard.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/smooks/docs/reference/en/images/common/smooks_parse_type.png
===================================================================
(Binary files differ)
Property changes on: trunk/smooks/docs/reference/en/images/common/smooks_parse_type.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/smooks/docs/reference/en/images/common/xml_property_view.png
===================================================================
(Binary files differ)
Property changes on: trunk/smooks/docs/reference/en/images/common/xml_property_view.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: trunk/smooks/docs/reference/en/master.xml
===================================================================
--- trunk/smooks/docs/reference/en/master.xml 2008-12-04 05:59:25 UTC (rev 12270)
+++ trunk/smooks/docs/reference/en/master.xml 2008-12-04 07:15:33 UTC (rev 12271)
@@ -7,6 +7,7 @@
<!ENTITY quickstart SYSTEM "modules/quick_start.xml">
<!ENTITY smooksformeditor_graphicaltab SYSTEM "modules/smooksformeditor_graphicalpage.xml">
<!ENTITY smooksformeditor_configurationtab SYSTEM "modules/smooksformeditor_configurationpage.xml">
+<!ENTITY smooksformeditor_sourcetab SYSTEM "modules/smooksformeditor_sourcepage.xml">
]>
<book>
@@ -42,4 +43,5 @@
&quickstart;
&smooksformeditor_graphicaltab;
&smooksformeditor_configurationtab;
+ &smooksformeditor_sourcetab;
</book>
Modified: trunk/smooks/docs/reference/en/modules/introduction.xml
===================================================================
--- trunk/smooks/docs/reference/en/modules/introduction.xml 2008-12-04 05:59:25 UTC (rev 12270)
+++ trunk/smooks/docs/reference/en/modules/introduction.xml 2008-12-04 07:15:33 UTC (rev 12271)
@@ -84,15 +84,21 @@
</sect1>
<sect1>
<title>How to install Smooks dev tools?</title>
- <para>The Smooks dev tools was contained by JBossTools since 3.0.0
+ <para>
+ The Smooks dev tools was contained in the JBossTools since 3.0.0
beta1 version. You can download the JBossTools form :
- .</para>
+ <link>http://www.jboss.org/tools/download/index.html
+ </link>
+ .
+ </para>
<para>
Smooks dev tools(JBossTools) need the latest Eclipse and other
required plug-ins(GEF,EMF,etc.),
- User can download the latest IDE for Java EE developers from this site(
+ User can download the latest IDE for
+ Java EE developers from this site(
<link>http://www.eclipse.org/downloads/
- </link>) for installing JBossTools.
+ </link>
+ ) for installing JBossTools.
</para>
</sect1>
</chapter>
Modified: trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml
===================================================================
--- trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2008-12-04 05:59:25 UTC (rev 12270)
+++ trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2008-12-04 07:15:33 UTC (rev 12271)
@@ -25,10 +25,6 @@
<para>
The
<link linkend="configurationpage_datedecoder">"Date Decoder"</link>
- ,
- <link linkend="configurationpage_documenttype">"Document Type"</link>
- ,
- <link linkend="configurationpage_unhandleresourceconfig">"Unhandle ResourceConfig"</link>
can
add/edit/remove on the
configuration editor
@@ -89,12 +85,81 @@
</tip>
</section>
<section id="configurationpage_datedecoder">
- <title>Date Decoder</title>
+ <title>Date Decoder Detail Page</title>
+ <para>
+ "Date Decoder" is a resourceConfig element in the Smooks
+ configuration
+ file.It describe how to transform the "Date" type.
+ </para>
+ <para>
+ Click "New" button to open the "New Resource Type" wizard
+ dialog.</para>
+ <figure>
+ <title>Resource Type Selection Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/common/resource_type_wizard.png"
+ scale="90" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>There are several resource type on the list. Select the
+ "Date
+ Decoder" and click "Finish" button , a new "Date Decoder" item
+ is
+ added and shown on the resource type list.
+ </para>
+ <para>
+ There are several parameters in the "Date Decoder"
+ resourceConfig element:
+ </para>
+ <para>
+ <orderedlist numeration="loweralpha" inheritnum="inherit">
+ <listitem>
+ locale-language
+ </listitem>
+ <listitem>
+ format
+ </listitem>
+ <listitem>
+ locale-country
+ </listitem>
+ </orderedlist>
+ </para>
+ <para>
+ User can modify the parameters of the "Date Decoder" item on the
+ left detail page.
+ </para>
+ <figure>
+ <title>Date Decoder Detail Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/common/date_type_detail_page.png"
+ scale="90" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ When user defined new "Date Decoder" , they can use the
+ <link linkend="graphicalpage_propertiesview"> "JavaBean Properties" GUI</link>
+ to set the them to
+ be the "Java type".
+ </para>
+ <!--
+ <para> The XML fragment generated by Smooks tools for the "Date
+ Decoder": </para> <para> <programlisting> <![CDATA[<resource-config
+ selector="decoder:DateLong">
+ <resource>org.milyn.javabean.decoders.DateDecoder</resource> <param
+ name="locale-language">en</param> <param name="format">yyy-MM-dd
+ HH:mm:ss</param> <param name="locale-country">IE</param>
+ </resource-config>]]> </programlisting> </para>
+ -->
</section>
- <section id="configurationpage_documenttype">
- <title>Document Type</title>
- </section>
- <section id="configurationpage_unhandleresourceconfig">
- <title>Unhandle ResourceConfig</title>
- </section>
+ <!--
+ <section id="configurationpage_documenttype"> <title>Document Type
+ Detail Page</title> <para> </para> </section> <section
+ id="configurationpage_unhandleresourceconfig"> <title>Unhandle
+ ResourceConfig</title> </section>
+ -->
</chapter>
\ No newline at end of file
Modified: trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml
===================================================================
--- trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml 2008-12-04 05:59:25 UTC (rev 12270)
+++ trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml 2008-12-04 07:15:33 UTC (rev 12271)
@@ -106,7 +106,8 @@
"Mapping Logic"
,Some error messages will be shown on the
<link linkend="quickstart_formeditor">"Error
- message area"</link>.
+ message area"</link>
+ .
</para>
<para>
Please read the
@@ -114,4 +115,71 @@
to find how to fix the errors.
</para>
</section>
+ <section id="graphicalpage_propertiesview">
+ <title>Properties Viewer</title>
+ <para>
+ User can edit the properties of the "connection lines" with the
+ properties viewer.
+ </para>
+ <para>
+ Select the menu : "Window -> Show View -> Other -> Properties" ,
+ the properties viewer will be opened.
+ </para>
+ <para>
+ When user select the connection lines , the properties viewer
+ will show a sets of sections GUI for editing the properties of the
+ connection line.
+ </para>
+ <tip>
+ <title>Note</title>
+ <para>
+ These GUI on the properties viewer will be displayed when the
+ "Smooks
+ Graphical Page" was active,if not the properties viewer will
+ display empty GUI.
+ </para>
+ <para>
+ If the source data type of the selected connection line was
+ "XML" ,The properties viewer will show a "XML Properties" section
+ GUI.
+ </para>
+ <para>
+ But the source data type of the selected connection line was
+ "Java" ,
+ the "XML Properties" section GUI dosen't display.
+ </para>
+ <para>
+ It means that if the source/target data type of the selected
+ connection line was different , the properties viewer will show
+ different GUI.
+ </para>
+ </tip>
+ <figure>
+ <title>JavaBean Properties Section</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/common/java_property_view.png"
+ scale="90" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure>
+ <title>XML properties section</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/common/xml_property_view.png"
+ scale="90" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure>
+ <title>Mapping properties section</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/common/mapping_property_view.png"
+ scale="90" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
</chapter>
\ No newline at end of file
Added: trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml
===================================================================
--- trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml (rev 0)
+++ trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml 2008-12-04 07:15:33 UTC (rev 12271)
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="smooksformeditor_sourcetab" xreflabel="Smooks Source Editor Page">
+ <?dbhtml filename="smooks_form_editor_sourcetab.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Smooks</keyword>
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Smooks Source Editor Page</title>
+ <section>
+ <title>XML Source Editor</title>
+ <para>
+ User can use this editor to edit the Smooks configuration file
+ directly.
+ </para>
+ <figure>
+ <title>Graphical Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/common/xml_source_editor.png"
+ scale="90" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section>
+ <title>Error Messages GUI</title>
+ <para>
+ If the Smooks tools can't understand the configuration file or
+ the configuration file was illegal(XML structure isn't right for
+ Smooks configuration file , etc.),The error message panel will
+ display above the XML editor.
+ </para>
+ <figure>
+ <title>Graphical Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/common/xml_source_editor_error.png"
+ scale="90" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <tip>
+ <title>Note</title>
+ <para>
+ When the error message panel was displayed , other editors (
+ Graphical Editor , Configuration Editor ) will be disabled.
+ </para>
+ <para>
+ User can't edit the configuration file with other editors until
+ file was right.
+ </para>
+ </tip>
+ </section>
+</chapter>
\ No newline at end of file
Property changes on: trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml
___________________________________________________________________
Name: svn:mime-type
+ text/plain
17 years, 4 months