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

Author: ochikvina Date: 2009-01-14 08:17:11 -0500 (Wed, 14 Jan 2009) New Revision: 13037 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 trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml Log: https://jira.jboss.org/jira/browse/JBIDE-3296 - updating the chapters of the Smooks Tools guide; Modified: trunk/smooks/docs/reference/en/modules/introduction.xml =================================================================== --- trunk/smooks/docs/reference/en/modules/introduction.xml 2009-01-14 12:36:37 UTC (rev 13036) +++ trunk/smooks/docs/reference/en/modules/introduction.xml 2009-01-14 13:17:11 UTC (rev 13037) @@ -9,31 +9,40 @@ </keywordset> </chapterinfo> <title>Introduction</title> - <sect1> + <section> <title>What is Smooks?</title> - <para>Smooks is a Java Framework/Engine for processing XML and non XML data (CSV, EDI, Java, JSON etc).</para> - <para></para> + + <para><property>Smooks</property> is a Java Framework/Engine for processing XML and non XML + data (CSV, EDI, Java, JSON etc).</para> + <para/> <para> - <orderedlist numeration="Upperroman" inheritnum="inherit"> - <listitem><para>Transformation: 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> + <orderedlist numeration="upperroman" inheritnum="inherit"> + <listitem> + <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>Java Binding: Bind into a Java Object Model from any data source (CSV, EDI, XML, Java, JSON etc). </para> + <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>Huge Message Processing: 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> + <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>Message Enrichment: Enrich a message with data from a Database, or other Datasources. - </para> + <para><emphasis role="bold">Message Enrichment</emphasis>: Enrich a message with + data from a Database, or other Datasources. </para> </listitem> - + <listitem> - <para>Combine: Combine the above features in different ways e.g. add Message Enrichment as part of a Splitting and Routing process. - </para> + <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> </orderedlist> </para> @@ -41,38 +50,37 @@ <title>Smooks</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/smooks-usecase.png" - scale="90" /> + <imagedata fileref="images/introduction/introduction1.png" scale="90"/> </imageobject> </mediaobject> </figure> - <para> For More informations about Smooks, please visit Smooks official site: - <ulink url="http://www.smooks.org">Smooks official site</ulink> - </para> - </sect1> - <sect1> + <para> For More informations about <property>Smooks</property>, please visit <ulink + url="http://www.smooks.org">Smooks official site</ulink>.</para> + </section> + <section> <title>What is Smooks dev tools?</title> - <para>Smooks dev tools is a set of graphical tools for editing Smooks configuration file base on Eclipse.</para> + + <para>Smooks dev tools is a set of graphical tools for editing Smooks configuration file + base on Eclipse.</para> <figure> <title>Smooks form editor</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/form_editor.png" scale="90" /> + <imagedata fileref="images/introduction/introduction2.png" scale="90"/> </imageobject> </mediaobject> </figure> - </sect1> - <sect1> + </section> + <section> <title>How to install Smooks dev tools?</title> - <para> 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) run with the latest Eclipse and other required plug-ins (GEF, EMF, etc.).</para> - <para> You should download the latest IDE for Java EE developers from this - <link linkend="http://www.eclipse.org/downloads/">site - </link>. It contains many plug-ins ( GEF, EMF, etc. ) required by Smooks dev tools. - </para> - </sect1> + + <para> The Smooks dev tools was included by the <property>JBoss Tools</property> since 3.0.0 + Beta1 version. You can download the <property>JBoss Tools</property> from <ulink + url="http://www.jboss.org/tools/download/index.html">here<... + <para> Smooks dev tools (<property>JBoss Tools</property>) run with the latest Eclipse and + other required plug-ins (GEF, EMF, etc.).</para> + <para> You should download the latest IDE for Java EE developers from this <ulink + url="http://www.eclipse.org/downloads/">site</ulink>;. It contains many plug-ins ( + GEF, EMF, etc. ) required by Smooks dev tools. </para> + </section> </chapter> Modified: trunk/smooks/docs/reference/en/modules/quick_start.xml =================================================================== --- trunk/smooks/docs/reference/en/modules/quick_start.xml 2009-01-14 12:36:37 UTC (rev 13036) +++ trunk/smooks/docs/reference/en/modules/quick_start.xml 2009-01-14 13:17:11 UTC (rev 13037) @@ -10,293 +10,417 @@ </keywordset> </chapterinfo> <title>Quick Start</title> - <para> - This "Quick Start" will show how to use the Smooks tools to create/edit the Smooks configuration file for Java2Java data transformation.</para> - <para> - This chapter should give you a brief understanding of the Smooks dev tools. - </para> + <para> This "Quick Start" will show how to use the <property>Smooks tools</property> to create/edit the Smooks + configuration file for Java2Java data transformation.</para> + <para> This chapter should give you a brief understanding of the <property>Smooks dev tools</property>.</para> <section> - <title>Download Smooks Java-to-Java example</title> - <para> Visit - <ulink url="http://www.smooks.org/documentation/documentation-smooks-1-1-x/... to download the "java-to-java" example project. - </para> + <title>Download Smooks Java-to-Java Example</title> + <para> Visit <ulink + url="http://www.smooks.org/documentation/documentation-smooks-1-1-x/... + >here</ulink> to download the "java-to-java" example project. </para> <tip> <title>Tip:</title> - <para> - The example project is base on Maven, you suggest you to create a new eclipse Java project and copy the example code and .jar files from the example project paste them into the eclipse Java project. - </para> + + <para> The example project is base on Maven, you suggest you to create a new eclipse + Java project and copy the example code and .jar files from the example project paste + them into the eclipse Java project. </para> </tip> </section> <section> - <title>Smooks configuration file wizard</title> - <para>Select the Smooks Java-to-Java example project what you created and right-click, select the menu: &quot;New&quot; -> - &quot;Other...&quot;, find the - &quot;Smooks Configuration File&quot; wizard. Click - &quot;Next&quot; button. - </para> + <title>Smooks Configuration File Wizard</title> + <para>Select the Smooks Java-to-Java example project what you created and right-click, + select 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> <figure> - <title>To select Smooks Configuration File wizard</title> + <title>Selecting Smooks Configuration File Wizard</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/new_wizard.png" scale="90" /> + <imagedata fileref="images/quick_start/quick_start1.png" scale="90"/> </imageobject> </mediaobject> </figure> - <para>The first wizard page is a file path creation page. Select the - &quot;src&quot; to be the files container, and input - &quot;smooks-newconfig.smooks&quot;. Click &quot;Next&quot;.</para> + <para>The first 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>newConfig.smooks</property>.</emphasis> Click + <emphasis><property>Next</property>.</emphasis></para> <figure> - <title>Choose the configuration file container and type the - file name</title> + <title>Choosing the configuration file container and the file name</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/input_file_name.png" - scale="90" /> + <imagedata fileref="images/quick_start/quick_start2.png" scale="90"/> </imageobject> </mediaobject> </figure> <para>The second wizard page is a transform data type choose page.</para> - <tip> - <title>Note</title> - <para> - As the quick start introduces how to create/edit the - Java-to-Java Smooks configuration file, it's necessary that "Java" type - is the source/target transform data type please. - </para> - </tip> + <para> As the quick start introduces how to create/edit the Java-to-Java Smooks + configuration file, let&apos;s select the<emphasis> + <property>Java-to-Java</property> + </emphasis> type as the source/target transform data type. </para> + <figure> - <title>Select Data Type</title> + <title>Selecting Data Type</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/data_type_selection.png" - scale="90" /> + <imagedata fileref="images/quick_start/quick_start3.png" scale="90"/> </imageobject> </mediaobject> </figure> + + <para>On the next page you are prompted to choose the source data for transformation. + Let&apos;s select the <property>Order</property> class from the example project as + the source JavaBean class.</para> + + <figure> + <title>Selecting the Source Data</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start4.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para>Then the wizard page asks you to choose the target data for transformation. We select + the <property>ListOrder</property> class as the target JavaBean class.</para> + <figure> + <title>Selecting the Target Data</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start5.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para/> + + <tip> + <title>Tip:</title> + <para>You can omit two these steps and just press + <emphasis><property>Finish</property>.</emphasis> This will open the empty + Smooks Configuration file. It&apos;s possible to <link + linkend="graphicaleditor_datalink">select source/target data</link> afterwards + in the Smooks Graph editor.</para> + </tip> </section> <section id="quickstart_formeditor"> - <title>Smooks form Editor</title> - <para>When all the wizard steps are passed, a new Smooks configuration file is created and the Smooks editor will be opened automatically. - </para> - <para> You will see the - &quot;Smooks Form Editor&quot;: - </para> + <title>Smooks Editor</title> + + <para>When all the wizard steps are passed, a new Smooks Configuration file is created and + the <property>Smooks Editor</property> will be opened automatically:</para> <figure> - <title>Smooks form editor</title> + <title>Smooks Editor</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/form_editor.png" scale="90" /> + <imagedata fileref="images/quick_start/quick_start6.png" scale="90"/> </imageobject> </mediaobject> </figure> - - <para> This editor contains several parts: - <orderedlist numeration="loweralpha" inheritnum="inherit"> - <listitem> - <para>Notify message display area. If there are any errors when you are editing the file, - the error area will display them.</para> - </listitem> - <listitem> - <para>Source data tree. The tree will display the structure of transformed source data.</para> - </listitem> - - <listitem> - <para>Target data tree. The tree will display the structure of transformed target data.</para> - </listitem> - - <listitem> - <para>Mapping graphical area. Show the data mapping connection lines.</para> - </listitem> - - <listitem> - <para>Source/Target data selection links. Click the link, - and <link linkend="graphicaleditor_datalink">"Data - Selection - Wizard"</link> will be opened - helping you to choose the source/target - data.</para> - </listitem> - </orderedlist> + + <para> This editor contains several parts: <table> + <title>The Smooks Editor Parts</title> + <tgroup cols="2"> + + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="5*"/> + + <thead> + <row> + <entry>Editor feature</entry> + <entry>Functionality</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>Problems area</para> + </entry> + <entry> + <para>If there are any errors when you are editing the file, the + Problems area will display them</para> + </entry> + </row> + + <row> + <entry> + <para>Source data tree</para> + </entry> + <entry> + <para>The tree will display the structure of transformed source + data</para> + </entry> + </row> + + <row> + <entry> + <para>Target data tree</para> + </entry> + <entry> + <para>The tree will display the structure of transformed target + data</para> + </entry> + </row> + + <row> + <entry> + <para>Mapping graphical area</para> + </entry> + <entry> + <para>Show the data mapping connection lines</para> + </entry> + </row> + + <row> + <entry> + <para>Source/Target data selection links</para> + </entry> + <entry> + <para>Click the link, and <link linkend="graphicaleditor_datalink" + >Data Selection wizard</link> will be opened helping you to + choose the source/target data</para> + </entry> + </row> + </tbody> + </tgroup> + </table> </para> </section> + <section id="graphicaleditor_datalink"> - <title>Choosing the source/target data - </title> - <para>Click the data selection links to choose the transform data. The "Data Selection Wizard" is opened, and there are two data types on the list: XML and Java. - </para> - <tip> + <title>Choosing the Source/Target Data</title> + + <para>To choose the transform data you should make use of the data selection links:</para> + + <itemizedlist> + <listitem> + <para><emphasis> + <property>Source Select</property> + </emphasis> for selecting source data</para> + </listitem> + + <listitem> + <para><emphasis> + <property>Target Select</property> + </emphasis> for selecting target data</para> + </listitem> + </itemizedlist> + + <para>After clicking the link the <property>Data Type Selection wizard</property> will be + opened, and there are two data types on the list: Java and XML.</para> + <note> <title>Note</title> - <para> - There will be more and more data types on a list as the - development went on. + <para> There will be more and more data types on the list as the development went on. </para> - </tip> + </note> + <figure> - <title>Data type wizard</title> + <title>Data Type Wizard</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/data_type_wizard.png" - scale="90" /> + <imagedata fileref="images/quick_start/quick_start7.png" scale="90"/> </imageobject> </mediaobject> </figure> - <para>Select the &quot;JavaBean Data Type&quot; and click &quot;Next&quot;, you will see a java class selection page: - </para> + + <para>Select the <emphasis> + <property>Java</property> + </emphasis> data type and click <emphasis><property>Next</property>,</emphasis> you will + see the JavaBean class selection page:</para> + <figure> - <title>JavaBean Data Selection Wizard</title> + <title>JavaBean Data Selection</title> <mediaobject> <imageobject> - <imagedata fileref="images/java2java/java_data_selection_wizard.png" - scale="90" /> + <imagedata fileref="images/quick_start/quick_start8.png" scale="90"/> </imageobject> </mediaobject> </figure> - <para>When you select all the necessary java classes, click &quot;Finish&quot; and the structure of the java class will be displayed on the Source data tree. Please, do the same with a target data link. - </para> + + <para>When you select all the necessary java classes, click <emphasis> + <property>Finish</property> + </emphasis> and the structure of the java class will be displayed on the source/target + data tree.</para> <figure> - <title>Displaying Structure of the Transformed Data</title> + <title>Displaying the Structure of the Transformed Data</title> <mediaobject> <imageobject> - <imagedata fileref="images/java2java/java_data_display.png" - scale="90" /> + <imagedata fileref="images/quick_start/quick_start9.png" scale="90"/> </imageobject> </mediaobject> </figure> </section> + <section id="quickstart_mapping"> <title>Mapping</title> - <para> As you see, the source/target data tree displays the structure of the java class. </para> + + <para> As you see, the source/target data tree displays the structure of the java class. </para> <para>How to map it?</para> - <para> First, you should know what to transform: - <orderedlist numeration="loweralpha" inheritnum="inherit"> - <listitem><para>Bind the &quot;customerName&quot; property of the - Order#header to - the - &quot;customerName&quot; property of LineOrder.</para> - </listitem> - <listitem><para>Bind the - &quot;customerNumber&quot; property of the Order#header to - the - &quot;customerId&quot; - property of LineOrder.</para> - </listitem> - <listitem><para>Bind the &quot;price&quot; property of the OrderItem - to - the - &quot;unitPrice&quot; property of - LineItem.</para> - </listitem> - <listitem><para>Bind the &quot;productId&quot; - property - of the OrderItem to the - &quot;productCode&quot; - property of LineItem.</para> - </listitem> - <listitem><para>Bind the - &quot;quantity&quot; property of the OrderItem to the - &quot;unitQuantity&quot; - property of - LineItem.</para> - </listitem> - </orderedlist> - </para> - <para> Make sense?</para> - <para> OK, let's select the &quot;customerName&quot; item of the - &quot;header&quot; item on the source data tree and start to drag it. When the drag item crosses the Mapping graphical area, you will see a connection line. Drop the item onto the &quot;customerName&quot; of the - &quot;LineOrder&quot; on the target data view.</para> - <para> Now a dialog is oped asking you to connect the root node: - </para> + + <para>First, you should know what to transform:</para> + + <orderedlist numeration="loweralpha" inheritnum="inherit"> + <listitem> + <para>Bind the <emphasis> + <property>&quot;customerName&quot;</property> + </emphasis> property of the <property>Order#header</property> to the <emphasis> + <property>&quot;customerName&quot;</property> + </emphasis> property of <property>LineOrder</property>.</para> + </listitem> + <listitem> + <para>Bind the <emphasis> + <property>&quot;customerNumber&quot;</property> + </emphasis> property of the <property>Order#header</property> to the <emphasis> + <property>&quot;customerId&quot;</property> + </emphasis> property of <property>LineOrder</property>.</para> + </listitem> + <listitem> + <para>Bind the <emphasis> + <property>&quot;price&quot;</property> + </emphasis> property of the <property>OrderItem</property> to the <emphasis> + <property>&quot;unitPrice&quot;</property> + </emphasis> property of <property>LineItem</property>.</para> + </listitem> + <listitem> + <para>Bind the <emphasis> + <property>&quot;productId&quot;</property> + </emphasis> property of the <property>OrderItem</property> to the <emphasis> + <property>&quot;productCode&quot;</property> + </emphasis> property of <property>LineItem</property>.</para> + </listitem> + <listitem> + <para>Bind the <emphasis> + <property>&quot;quantity&quot;</property> + </emphasis> property of the <property>OrderItem</property> to the <emphasis> + <property>&quot;unitQuantity&quot;</property> + </emphasis> property of <property>LineItem</property>.</para> + </listitem> + </orderedlist> + + <para> Make sense?</para> + <para> OK, let&apos;s select the <emphasis> + <property>&quot;customerName&quot;</property> + </emphasis> item of the <emphasis> + <property>&quot;header&quot;</property> + </emphasis> item on the source data tree and start to drag it. When the drag item + crosses the Mapping graphical area, you will see a connection line. Drop the item onto + the <emphasis> + <property>&quot;customerName&quot;</property> + </emphasis> of the <property>LineOrder</property> on the target data + view.</para> + <para> Now a dialog is opened asking you to connect the root node:</para> + <figure> <title>Dialog Asking You to Connect to the Root Nodes</title> <mediaobject> <imageobject> - <imagedata fileref="images/java2java/connect_rootnode.png" - scale="90" /> + <imagedata fileref="images/quick_start/quick_start10.png" scale="90"/> </imageobject> </mediaobject> </figure> - <para> Please, click &quot;Yes&quot; to connect the root node, if you didn't do that, this dialog will be opened 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, but the same is also relevant for XML-to-Java </para> - </tip> - <para> Now let's do the same operation with the &quot;customerNumber&quot;, that is what you want to see: - - </para> + <para> Please, click <emphasis> + <property>Yes</property> + </emphasis> to connect the root node. If you don&apos;t do that, this dialog will be + opened again when you connect other nodes.</para> + <note> + <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, but the same is also relevant for + XML-to-Java </para> + </note> + <para> Now let&apos;s do the same operation with the <emphasis> + <property>&quot;customerNumber&quot;</property>,</emphasis> that is what you + should see:</para> <figure> <title>Correctly Mapping Editor</title> <mediaobject> <imageobject> - <imagedata fileref="images/java2java/java_connection1.png" - scale="90" /> + <imagedata fileref="images/quick_start/quick_start11.png" scale="90"/> </imageobject> </mediaobject> </figure> - <para>Next, you are going to bind the properties of the - &quot;OrderItem&quot; to the properties of the &quot;LineItem&quot;. - </para> - <para>Select the &quot;price&quot; and drag it onto the &quot;unitPrice&quot; of the other side tree viewer. The error message display area will show an error: - </para> + <para>Next, you are going to bind the properties of the <property>OrderItem</property> to + the properties of the <property>LineItem</property>.</para> + <para>Select the <emphasis> + <property>&quot;price&quot;</property> + </emphasis> and drag it onto the <emphasis> + <property>&quot;unitPrice&quot;</property> + </emphasis> of the other side tree viewer. The Problems area will show an + error:</para> <figure> <title>Connection Error 1</title> <mediaobject> <imageobject> - <imagedata fileref="images/java2java/connection_error1.png" - scale="90" /> + <imagedata fileref="images/quick_start/quick_start12.png" scale="90"/> </imageobject> </mediaobject> </figure> - <para>How to deal with the error ?</para> - <para>Please click the &quot;Fix it&quot; link, a menu is popped-up with several "resolve methods" on it. - </para> - <para> Select the first resolve method: 'Connect the &quot;OrderItem&quot; to the - &quot;LineItem&quot; ', then the &quot;OrderItem&quot; is connected with the - &quot;LineItem&quot;. - </para> - <para>But the notify message area still shows some other errors: - </para> + <para>How to deal with the error?</para> + <para>Please click the <emphasis> + <property>Fix it</property></emphasis> link, a menu is popped-up with several + resolve methods on it.</para> <figure> + <title>Fixing the Connection Error</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start13.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <para> Select the first resolve method: <emphasis> + 'Connect the &quot;OrderItem&quot; to the + &quot;LineItem&quot; '.</emphasis> As the result the <emphasis> + <property>&quot;OrderItem&quot;</property></emphasis> is connected with + the <emphasis> + <property>&quot;LineItem&quot;</property>.</emphasis></para> + <para>But the notify message area still shows some other errors:</para> + <figure> <title>Connection Error 2</title> <mediaobject> <imageobject> - <imagedata fileref="images/java2java/connection_error2.png" - scale="90" /> + <imagedata fileref="images/quick_start/quick_start14.png" scale="90"/> </imageobject> </mediaobject> </figure> - <para>OK, let's deal with the fire error ---- Click &quot;Fix it&quot; link and select the first resolve method. The &quot;orderItems&quot; is connected with the &quot;lineItems&quot;. - </para> + <para>OK, let&apos;s deal with the fire error. Click the <emphasis> + <property>Fix it</property></emphasis> link and + select the first resolve method. The <emphasis> + <property>&quot;orderItems&quot;</property></emphasis> is connected with + the <emphasis> + <property>&quot;lineItems&quot;</property>.</emphasis></para> + <tip> - <title>Tip</title> - <para> - Why does the occur error?</para> - <para> You will find that, if you only connect the property node without connecting the parent node of the property, the &quot;connection error&quot; occur</para> - <para>The connection of the &quot;price-to-unitPrice&quot; is the &quot;Binding Connection&quot;, - but it needs a &quot;Instance Creation Connection&quot; -the connection of the + <title>Tip:</title> + <para> Why does the error occur?</para> + <para> You will find that, if you only connect the property node without connecting the + parent node of the property, the &quot;connection error&quot; occurs.</para> + <para>The connection of the &quot;price-to-unitPrice&quot; is the + &quot;Binding Connection&quot;, but it needs an &quot;Instance Creation + Connection&quot; - the connection of the &quot;OrderItem-to-LineItem&quot;.</para> </tip> - <para> After that, connect the quantity to the unitQuantity ; connect the productId to the productCode: - </para> + <para> After that, connect <emphasis> + <property>&quot;quantity&quot;</property></emphasis> to the <emphasis> + <property>&quot;unitQuantity&quot;</property></emphasis> and <emphasis> + <property>&quot;productId&quot;</property></emphasis> to the + <emphasis> + <property>&quot;productCode&quot;</property>:</emphasis></para> <figure> - <title>Complete mapping</title> + <title>Complete Mapping</title> <mediaobject> <imageobject> - <imagedata fileref="images/java2java/correct_editor.png" - scale="90" /> + <imagedata fileref="images/quick_start/quick_start15.png" scale="90"/> </imageobject> </mediaobject> </figure> - <para>Now, you should save the file and the Smooks tools will generate the correct configuration file content.</para> - <para>OK, Let run the test class: example.Main (Please, make sure that the Smooks engine loads the correct configuration file) - </para> - <para>Success! - </para> + <para>Now, you should save the file and the <property>Smooks tools</property> will generate the correct + configuration file content.</para> + <para>OK, let run the test class: <property>example.Main</property>. (Please, make sure that the Smooks engine + loads the correct configuration file).</para> + <para>Success!</para> </section> </chapter> Modified: trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml =================================================================== --- trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2009-01-14 12:36:37 UTC (rev 13036) +++ trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2009-01-14 13:17:11 UTC (rev 13037) @@ -9,111 +9,136 @@ </keywordset> </chapterinfo> <title>Smooks Configuration Editor Page</title> - <para> - Smooks Configuration Editor Page is one tab of the Smooks Form - Editor. - </para> + <para> Smooks Configuration Editor Page is one tab of the <property>Smooks Editor</property>. </para> <figure> <title>Graphical Editor</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/configuration_page.png" - scale="90" /> + <imagedata fileref="images/config_page/config_page1.png" scale="90"/> </imageobject> </mediaobject> </figure> - <para> The <link linkend="configurationpage_datedecoder">"Date Decoder"</link> can add/edit/remove on the configuration editor page. - </para> - <para> - The configuration also edit the <link linkend="configurationpage_parsetype">"Smooks parse type"</link> and manage the <link linkend="configurationpage_importfile">"Import File"</link> . - </para> + + <para> You can add/edit/remove the <link linkend="configurationpage_datedecoder">Date + Decoder</link> on the Сonfiguration page of the <property>Smooks Editor</property>. </para> + <para> The configuration also edit the <link linkend="configurationpage_parsetype">Smooks parse + type</link> and manage the <link linkend="configurationpage_importfile">Import + Files</link>.</para> + <section id="configurationpage_parsetype"> - <title>Smooks parse type</title> - <para>Open the "Other configuration" section, you will see there is a set of radio buttons:</para> + + <title>Smooks Parse Type</title> + <para>Open the <emphasis> + <property>Other Configurations</property> + </emphasis> section, we will see there is a set of radio buttons:</para> + <figure> - <title>Smooks parse type</title> + <title>Smooks Parse Types</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/smooks_parse_type.png" - scale="90" /> + <imagedata fileref="images/config_page/config_page2.png" scale="90"/> </imageobject> </mediaobject> </figure> - <para> - Select the radio button to change the Smooks parse type. - </para> + <para> Select the radio button to change the Smooks parse type. </para> </section> <section id="configurationpage_importfile"> - <title>Import file</title> - <para> - Open the "Other configuration" section, there is an "Import File" list under the "Smooks parse type" buttons. - </para> + + <title>Import File</title> + <para> Open the <emphasis> + <property>Other Configurations</property> + </emphasis> section, there is an <emphasis> + <property>Import Files</property> + </emphasis> list under the Smooks parse type buttons.</para> + <figure> <title>Import File</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/import_file.png" scale="90" /> + <imagedata fileref="images/config_page/config_page2.png" scale="90"/> </imageobject> </mediaobject> </figure> - <para> - There are three buttons on the right side of the "File Import" list. You can click those to add/edit/remove the import files. - </para> + + <para>There are three buttons on the right side of the <emphasis> + <property>File Import</property> + </emphasis> list. You can click those to add/edit/remove the import files.</para> + <tip> - <title>Tip</title> - <para> - If the import file doesn't exist, the image of the import file will change to "Error Image". If you double-click the import file in the "Import File" list, the file will be opened with a new default editor. - </para> + + <title>Tip:</title> + <para> If the import file dosen't exist, the image of the import file will change to + "Error Image". If you double-click the import file in the Import File list, the file + will be open with a new default editor. </para> + </tip> </section> <section id="configurationpage_datedecoder"> <title>Date Decoder Detail Page</title> - <para> - "Date Decoder" is a resourceConfig element in the Smooks configuration file.It describing how to transform the "Date" type. - </para> - <para> - Click "New" button to open the "New Resource Type" wizard dialog.</para> + + <para>Date Decoder is a resourceConfig element in the Smooks configuration file. It + describes how to transform the &quot;Date&quot; type.</para> + <para> Click the <emphasis> + <property>New</property> + </emphasis> button to open the <property>New Resource Type wizard</property> + dialog.</para> += <figure> <title>Resource Type Selection Wizard</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/resource_type_wizard.png" - scale="90" /> + <imagedata fileref="images/config_page/config_page4.png" scale="90"/> </imageobject> </mediaobject> </figure> - - <para>There are several resource types on the list. Select the "Date Decoder" and click "Finish" button, a new "Date Decoder" item was added and shown on the resource type list. - </para> + + <para>There are several resource type on the list. Select the <emphasis> + <property>Date Decoder</property> + </emphasis> and click the <emphasis> + <property>Finish</property> + </emphasis> button, a new <emphasis> + <property>Date Decoder</property> + </emphasis> item was added and shown on the resource type list.</para> + <para> There are several parameters in the <emphasis> + <property>Date Decoder</property> + </emphasis> resourceConfig element:</para> + <para> - There are several parameters in the "Date Decoder" resourceConfig element: - </para> - <para> - <orderedlist numeration="loweralpha" inheritnum="inherit"> - <listitem><para>locale-language</para> + + <itemizedlist> + <listitem> + <para>locale-language</para> + </listitem> - <listitem><para>format</para> + + <listitem> + <para>format</para> </listitem> - <listitem><para>locale-country</para> + + <listitem> + <para>locale-country</para> + </listitem> - </orderedlist> + </itemizedlist> </para> - <para> - You can modify the parameters of the "Date Decoder" item with the left detail page. - </para> + + <para> You can modify the parameters of the <emphasis> + <property>Date Decoder</property></emphasis> item with 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" /> + <imagedata fileref="images/config_page/config_page5.png" scale="90"/> </imageobject> </mediaobject> </figure> - <para> - When you define a new "Date Decoder", it becomes possible to use the - <link linkend="graphicalpage_propertiesview"> "JavaBean Properties"</link> GUI to set it to the "Java type". - </para> + + <para> When you defined a new <emphasis> + <property>Date Decoder</property></emphasis>, they can use the <link + linkend="graphicalpage_propertiesview">JavaBean Properties</link> GUI to set the + them to be the &quot;Java type&quot;.</para> + <!-- <para> The XML fragment generated by Smooks tools for the "Date Decoder": </para> <para> <programlisting> <![CDATA[<resource-config @@ -130,4 +155,4 @@ id="configurationpage_unhandleresourceconfig"> <title>Unhandle ResourceConfig</title> </section> --> -</chapter> \ No newline at end of file +</chapter> Modified: trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml =================================================================== --- trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml 2009-01-14 12:36:37 UTC (rev 13036) +++ trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml 2009-01-14 13:17:11 UTC (rev 13037) @@ -9,110 +9,143 @@ </keywordset> </chapterinfo> <title>Smooks Graphical Editor Page</title> - <para> Smooks Graphical Editor Page is one tab of the Smooks Form Editor. </para> + + <para>Smooks Graphical Editor page is one tab of the <property>Smooks Editor</property>.</para> <figure> <title>Graphical Editor</title> <mediaobject> <imageobject> - <imagedata fileref="images/java2java/correct_editor.png" scale="90"/> + <imagedata fileref="images/graph_editor/graph_editor1.png" scale="90"/> </imageobject> </mediaobject> </figure> - <para> This graphical editor could allow you to perform drug/drop operations with the nodes of transform data to map the source data to target data. </para> - <para> When you save the changes in the graphical editor, the correct Smooks configuration file content will be generated. </para> + + <para> This <property>Graphical editor</property> allows you to perform drug/drop operations + with the nodes of transform data to map the source data to target data. </para> + <para> When you save the changes in the Graphical editor the correct Smooks Configuration file + content will be generated. </para> <section> + <title>Introducing the areas of graphical editor</title> - <para>Information on the topic could be found here <link linkend="quickstart_formeditor" - >"Quick Start/Smooks Form Editor"</link> - </para> + <para>Information on the topic could be found in the <link linkend="quickstart_formeditor">Quick Start/Smooks Editor</link> section.</para> </section> <section> - <title>Load source/target data</title> - <para> Click the links under the data viewer, the data type selection wizard page will be shown. </para> + + <title>Load Source/Target Data</title> + <para> Click the links under the data view, the <property>Data Type Selection wizard</property> page will be + shown.</para> <figure> - <title>Data type selection wizard page</title> + <title>Data Type Selection Wizard Page</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/data_type_wizard.png" scale="90"/> + + <imagedata fileref="images/graph_editor/graph_editor2.png" scale="90"/> + </imageobject> </mediaobject> </figure> + <para> There are sets of transform data type on the wizard page, select one type and click - <property>Next</property> , the data source selection wizard page will be shown. <tip> - <title>Note</title> - <para> For different data type, the data source selection wizards are different too. - </para> - </tip> - </para> + <emphasis><property>Next</property>,</emphasis> the data source selection wizard + page will be shown.</para> + + <tip> + <title>Note:</title> + <para>For different data type, the Data source selection wizard are different too. + </para> + </tip> <figure> - <title>Java data source selection wizard page</title> + <title>Java Data Source Selection Wizard Page</title> <mediaobject> <imageobject> - <imagedata fileref="images/java2java/java_data_selection_wizard.png" scale="90" - /> + + <imagedata fileref="images/graph_editor/graph_editor3.png" scale="90"/> + </imageobject> </mediaobject> </figure> + <figure> - <title>XML file path selection wizard page</title> + <title>XML File Path Selection Wizard Page</title> <mediaobject> <imageobject> - <imagedata fileref="images/xml2java/xml_filepath_selection_wizard.png" - scale="90"/> + + <imagedata fileref="images/graph_editor/graph_editor4.png" scale="90"/> + </imageobject> </mediaobject> </figure> - <para> When you finish the data selection (file path selection), Click - <property>Finish</property> , the data viewer will display the selected data structure. </para> + + <para> When you finish the data selection (file path selection), click + <emphasis><property>Finish</property>,</emphasis> the data view will display the + selected data structure.</para> </section> <section> - <title>Using the graphical editor for mapping</title> + + <title>Using Graphical Editor for Mapping</title> <para>To get information on the topic please, read the <link linkend="quickstart_mapping" - >"Quick Start/Mapping"</link> - </para> + >Quick Start/Mapping</link> section. </para> </section> <section> - <title>Error messages</title> - <para>When you do any mapping operations, the Smooks tools validates the file content with - "Mapping Logic", If there are any errors of the configuration file content , error messages are shown on the <link linkend="quickstart_formeditor">"Error message area"</link>. </para> - <para> Please, read the <link linkend="quickstart_mapping">"Quick Start/Mapping"</link> to find how to fix the errors. </para> + + <title>Error Messages</title> + <para>When you do any mapping operations, the <property>Smooks tools</property> validate the + file content with "Mapping Logic". If there are any errors of the configuration file + content, error messages are shown in the <link linkend="quickstart_formeditor">Problems + area</link>.</para> + <para> Please, read the <link linkend="quickstart_mapping">Quick Start/Mapping</link> section to + find how to fix the errors.</para> </section> <section id="graphicalpage_propertiesview"> - <title>Properties Viewer</title> - <para> You 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 is opened. </para> - <para> When you select on the connection lines, the properties viewer will show a set of section GUI for editing the properties of the connection line. </para> + <title>Properties View</title> + + <para> You can edit the properties of the connection lines with the <property>Properties + view</property>.</para> + <para>Navigate to <emphasis><property>Window > Show View > Other > + Properties</property>,</emphasis> to open the <property>Properties + view</property>.</para> + <para> When you select on the connection lines, the <property>Properties view</property> + will show a set of section GUI for editing the properties of the connection line.</para> <tip> - <title>Tip</title> - <para> This GUI on the properties viewer is displayed when the "Smooks Graphical Page" - is active, if not, the properties viewer displays empty GUI. </para> - <para> If the source data type of the selected connection line is "XML", The properties viewer shows a "XML Properties" section GUI. </para> - <para> But if the source data type of the selected connection line is "Java", the "XML Properties" section GUI isn't 'displayed. </para> - <para> It means that if the source/target data type of the selected connection line is different, the properties viewer shows different GUI. </para> + + <title>Tip:</title> + <para>This GUI on the <property>Properties view</property> is displayed when the Smooks + Graphical editor is active, if not, the <property>Properties view</property> + displays empty GUI.</para> + <para>If the source data type of the selected connection line is + &quot;XML&quot;, the <property>Properties view</property> shows an XML + Properties section GUI.</para> + <para>But if the source data type of the selected connection line is + &quot;Java&quot;, the XML Properties section GUI isn&apos;t + displayed.</para> + <para>It means that if the source/target data type of the selected connection line is + different, the <property>Properties view</property> shows different GUI.</para> </tip> <figure> <title>JavaBean Properties Section</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/java_property_view.png" scale="90"/> + + <imagedata fileref="images/graph_editor/graph_editor5.png" scale="90"/> + </imageobject> </mediaobject> </figure> <figure> - <title>XML properties section</title> + <title>XML Properties Section</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/xml_property_view.png" scale="90"/> + <imagedata fileref="images/graph_editor/graph_editor6.png" scale="90"/> </imageobject> </mediaobject> </figure> <figure> - <title>Mapping properties section</title> + <title>Mapping Properties Section</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/mapping_property_view.png" scale="90"/> + <imagedata fileref="images/graph_editor/graph_editor7.png" scale="90"/> </imageobject> </mediaobject> </figure> </section> -</chapter> \ No newline at end of file +</chapter> Modified: trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml =================================================================== --- trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml 2009-01-14 12:36:37 UTC (rev 13036) +++ trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml 2009-01-14 13:17:11 UTC (rev 13037) @@ -11,40 +11,36 @@ <title>Smooks Source Editor Page</title> <section> <title>XML Source Editor</title> - <para>You can use this editor to edit the Smooks configuration file directly. - </para> + <para>You 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" /> + <imagedata fileref="images/source_editor/source_editor1.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 is illegal (XML structure isn't right for Smooks configuration file, etc.), The error message panel will be displayed above the XML editor. - </para> + <para>If the <property>Smooks tools</property> can&apos;t understand the configuration + file or the configuration file is illegal (XML structure isn&apos;t right for Smooks + Configuration file, etc.), the error will be underlined.</para> <figure> <title>Graphical Editor</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/xml_source_editor_error.png" - scale="90" /> + <imagedata fileref="images/source_editor/source_editor2.png" scale="90"/> </imageobject> </mediaobject> </figure> - <note> - <title>Tip</title> - <para> - When the error message panel is displayed, other editors ( - Graphical Editor, Configuration Editor ) are disabled. - </para> - <para> - You can't edit the configuration file with other editors until file becomes valid. - </para> - </note> + <!--note> + <title>Tip:</title> + <para> When the error message panel is displayed, other editors ( Graphical Editor, + Configuration Editor ) are disabled. </para> + <para> You can't edit the configuration file with other editors until file becomes + valid. </para> + </note--> + </section> -</chapter> \ No newline at end of file +</chapter>