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

Author: smukhina Date: 2009-01-09 09:14:01 -0500 (Fri, 09 Jan 2009) New Revision: 12962 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 correcting language for Smooks guide all chapters are corrected Modified: trunk/smooks/docs/reference/en/modules/introduction.xml =================================================================== --- trunk/smooks/docs/reference/en/modules/introduction.xml 2009-01-09 12:02:48 UTC (rev 12961) +++ trunk/smooks/docs/reference/en/modules/introduction.xml 2009-01-09 14:14:01 UTC (rev 12962) @@ -11,7 +11,7 @@ <title>Introduction</title> <sect1> <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>Smooks is a Java Framework/Engine for processing XML and non XML data (CSV, EDI, Java, JSON etc).</para> <para></para> <para> <orderedlist numeration="Upperroman" inheritnum="inherit"> @@ -52,7 +52,7 @@ </sect1> <sect1> <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> @@ -69,10 +69,10 @@ </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 + <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. + </link>. 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 2009-01-09 12:02:48 UTC (rev 12961) +++ trunk/smooks/docs/reference/en/modules/quick_start.xml 2009-01-09 14:14:01 UTC (rev 12962) @@ -11,29 +11,19 @@ </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> + 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. + This chapter should give you a brief understanding of the Smooks dev tools. </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. + <ulink url="http://www.smooks.org/documentation/documentation-smooks-1-1-x/... 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. + 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> @@ -179,30 +169,30 @@ <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 + <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 + <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 + <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; + <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 + <listitem><para>Bind the &quot;quantity&quot; property of the OrderItem to the &quot;unitQuantity&quot; property of @@ -288,21 +278,11 @@ <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 + <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 &quot;OrderItem-to-LineItem&quot;.</para> </tip> - <para> After that, connect the quantity to the unitQuantity ; connect the productId to the productCode: + <para> After that, connect the quantity to the unitQuantity ; connect the productId to the productCode: </para> <figure> <title>Complete mapping</title> Modified: trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml =================================================================== --- trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2009-01-09 12:02:48 UTC (rev 12961) +++ trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2009-01-09 14:14:01 UTC (rev 12962) @@ -22,26 +22,14 @@ </imageobject> </mediaobject> </figure> - <para> - The - <link linkend="configurationpage_datedecoder">"Date Decoder"</link> - can - add/edit/remove on the - configuration editor - page. + <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> - . + The configuration also edit the <link linkend="configurationpage_parsetype">"Smooks parse type"</link> and manage the <link linkend="configurationpage_importfile">"Import File"</link> . </para> <section id="configurationpage_parsetype"> <title>Smooks parse type</title> - <para>Open the "Other configuration" section, we will see there - is a set of radio buttons:</para> + <para>Open the "Other configuration" section, you will see there is a set of radio buttons:</para> <figure> <title>Smooks parse type</title> <mediaobject> @@ -58,8 +46,7 @@ <section id="configurationpage_importfile"> <title>Import file</title> <para> - Open the "Other configuration" section, there is a "Import - File" list under the "Smooks parse type" buttons. + Open the "Other configuration" section, there is an "Import File" list under the "Smooks parse type" buttons. </para> <figure> <title>Import File</title> @@ -70,30 +57,22 @@ </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. + 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> <tip> <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. + 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> </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 describe how to transform the "Date" type. + "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> + Click "New" button to open the "New Resource Type" wizard dialog.</para> <figure> <title>Resource Type Selection Wizard</title> <mediaobject> @@ -104,29 +83,23 @@ </mediaobject> </figure> - <para>There are several resource type 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>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 parameters in the "Date Decoder" - resourceConfig element: + There are several parameters in the "Date Decoder" resourceConfig element: </para> <para> <orderedlist numeration="loweralpha" inheritnum="inherit"> - <listitem><para>locale-language</para> + <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> </para> <para> - You can modify the parameters of the "Date Decoder" item with the - left detail page. + You can modify the parameters of the "Date Decoder" item with the left detail page. </para> <figure> <title>Date Decoder Detail Page</title> @@ -138,8 +111,8 @@ </mediaobject> </figure> <para> - When you defined new "Date Decoder", they can use the - <link linkend="graphicalpage_propertiesview"> "JavaBean Properties"</link> GUI to set the them to be the "Java type". + 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> The XML fragment generated by Smooks tools for the "Date Modified: trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml =================================================================== --- trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml 2009-01-09 12:02:48 UTC (rev 12961) +++ trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml 2009-01-09 14:14:01 UTC (rev 12962) @@ -9,64 +9,47 @@ </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 Smooks Form Editor. </para> <figure> <title>Graphical Editor</title> <mediaobject> <imageobject> - <imagedata fileref="images/java2java/correct_editor.png" - scale="90" /> + <imagedata fileref="images/java2java/correct_editor.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 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> <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> + <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> </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> + <para> Click the links under the data viewer, the data type selection wizard page will be shown. </para> <figure> <title>Data type selection wizard page</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/data_type_wizard.png" - scale="90" /> + <imagedata fileref="images/common/data_type_wizard.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> + <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 wizard are - different too. </para> + <para> For different data type, the data source selection wizards are different too. + </para> </tip> </para> <figure> <title>Java data source selection wizard page</title> <mediaobject> <imageobject> - <imagedata fileref="images/java2java/java_data_selection_wizard.png" - scale="90" /> + <imagedata fileref="images/java2java/java_data_selection_wizard.png" scale="90" + /> </imageobject> </mediaobject> </figure> @@ -75,73 +58,43 @@ <mediaobject> <imageobject> <imagedata fileref="images/xml2java/xml_filepath_selection_wizard.png" - scale="90" /> + 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 + <property>Finish</property> , the data viewer will display the selected data structure. </para> </section> <section> <title>Using the graphical editor for mapping</title> - <para>To get information on the topic please, read the - <link linkend="quickstart_mapping">"Quick Start/Mapping"</link> + <para>To get information on the topic please, read the <link linkend="quickstart_mapping" + >"Quick Start/Mapping"</link> </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 is 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> + <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> </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> + <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> <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> + <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> </tip> <figure> <title>JavaBean Properties Section</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/java_property_view.png" - scale="90" /> + <imagedata fileref="images/common/java_property_view.png" scale="90"/> </imageobject> </mediaobject> </figure> @@ -149,8 +102,7 @@ <title>XML properties section</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/xml_property_view.png" - scale="90" /> + <imagedata fileref="images/common/xml_property_view.png" scale="90"/> </imageobject> </mediaobject> </figure> @@ -158,8 +110,7 @@ <title>Mapping properties section</title> <mediaobject> <imageobject> - <imagedata fileref="images/common/mapping_property_view.png" - scale="90" /> + <imagedata fileref="images/common/mapping_property_view.png" scale="90"/> </imageobject> </mediaobject> </figure> Modified: trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml =================================================================== --- trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml 2009-01-09 12:02:48 UTC (rev 12961) +++ trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml 2009-01-09 14:14:01 UTC (rev 12962) @@ -25,7 +25,7 @@ </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>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> <figure> <title>Graphical Editor</title> @@ -43,8 +43,7 @@ Graphical Editor, Configuration Editor ) are disabled. </para> <para> - You can't edit the configuration file with other editors until - file becomes valid. + You can't edit the configuration file with other editors until file becomes valid. </para> </note> </section>