[jbosstools-commits] JBoss Tools SVN: r12272 - trunk/smooks/docs/reference/en/modules.

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>