[jbosstools-commits] JBoss Tools SVN: r15211 - in branches/jbosstools-3.0.x/smooks/docs/reference: en/images/config_page and 3 other directories.

Author: smukhina Date: 2009-05-11 12:42:46 -0400 (Mon, 11 May 2009) New Revision: 15211 Modified: branches/jbosstools-3.0.x/smooks/docs/reference/en/images/config_page/config_page1.png branches/jbosstools-3.0.x/smooks/docs/reference/en/images/config_page/config_page2.png branches/jbosstools-3.0.x/smooks/docs/reference/en/images/graph_editor/graph_editor1.png branches/jbosstools-3.0.x/smooks/docs/reference/en/images/quick_start/quick_start4.png branches/jbosstools-3.0.x/smooks/docs/reference/en/images/quick_start/quick_start5.png branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/introduction.xml branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/quick_start.xml branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml branches/jbosstools-3.0.x/smooks/docs/reference/pom.xml Log: https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch Modified: branches/jbosstools-3.0.x/smooks/docs/reference/en/images/config_page/config_page1.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.0.x/smooks/docs/reference/en/images/config_page/config_page2.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.0.x/smooks/docs/reference/en/images/graph_editor/graph_editor1.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.0.x/smooks/docs/reference/en/images/quick_start/quick_start4.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.0.x/smooks/docs/reference/en/images/quick_start/quick_start5.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/introduction.xml =================================================================== --- branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/introduction.xml 2009-05-11 16:42:22 UTC (rev 15210) +++ branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/introduction.xml 2009-05-11 16:42:46 UTC (rev 15211) @@ -9,6 +9,7 @@ </keywordset> </chapterinfo> <title>Introduction</title> + <para>This chapter give you a short introduction to Smooks, Smooks tools and its installation</para> <section> <title>What is Smooks?</title> @@ -58,12 +59,12 @@ url="http://www.smooks.org">Smooks official site</ulink>.</para> </section> <section> - <title>What is Smooks dev tools?</title> + <title>What is Smooks Tools?</title> - <para>Smooks dev tools is a set of graphical tools for editing Smooks configuration file - base on Eclipse.</para> + <para>Smooks tools is a set of graphical tools for editing Smooks configuration file + based on Eclipse.</para> <figure> - <title>Smooks form editor</title> + <title>Smooks Form editor</title> <mediaobject> <imageobject> <imagedata fileref="images/introduction/introduction2.png" scale="90"/> @@ -74,13 +75,16 @@ <section> <title>How to install Smooks dev tools?</title> - <para> The Smooks dev tools was included by the <property>JBoss Tools</property> since 3.0.0 + <para> The Smooks 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 + url="http://www.jboss.org/tools/download/index.html">JBoss download site</ulink>.</para> + <para> Smooks 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> + <para> You should download the latest IDE for Java EE developers from <ulink + url="http://www.eclipse.org/downloads/"> Eclipse site</ulink>. It contains many plug-ins ( + GEF, EMF, etc. ) required by Smooks dev tools. </para> + + <para>Now let's progress to more advanced topics.</para> </section> + </chapter> Modified: branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/quick_start.xml =================================================================== --- branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/quick_start.xml 2009-05-11 16:42:22 UTC (rev 15210) +++ branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/quick_start.xml 2009-05-11 16:42:46 UTC (rev 15211) @@ -12,7 +12,7 @@ <title>Quick Start</title> <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> + <para> This chapter gives you a brief understanding of the <property>Smooks tools</property>.</para> <section> <title>Download Smooks Java-to-Java Example</title> <para> Visit <ulink @@ -21,14 +21,14 @@ <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 + <para> The example project is based on Maven, we suggest you to create a new eclipse + Java project, copy the example code and .jar files from the example project and 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, + <para>Select the Smooks Java-to-Java example project that 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> @@ -141,7 +141,7 @@ </entry> <entry> <para>If there are any errors when you are editing the file, the - Problems area will display them</para> + Problems area displays them</para> </entry> </row> @@ -150,7 +150,7 @@ <para>Source data tree</para> </entry> <entry> - <para>The tree will display the structure of transformed source + <para>The tree displays a structure of the transformed source data</para> </entry> </row> @@ -160,7 +160,7 @@ <para>Target data tree</para> </entry> <entry> - <para>The tree will display the structure of transformed target + <para>The tree displays a structure of the transformed target data</para> </entry> </row> @@ -180,7 +180,7 @@ </entry> <entry> <para>Click the link, and <link linkend="graphicaleditor_datalink" - >Data Selection wizard</link> will be opened helping you to + >Data Selection wizard</link> is opened helping you to choose the source/target data</para> </entry> </row> @@ -209,11 +209,11 @@ </listitem> </itemizedlist> - <para>After clicking the link the <property>Data Type Selection wizard</property> will be + <para>After clicking the link the <property>Data Type Selection wizard</property> is 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 the list as the development went on. + <para> There will become more and more data types on the list as the development goes on. </para> </note> @@ -242,7 +242,7 @@ <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 + </emphasis> and the structure of the java class is displayed on the source/target data tree.</para> <figure> <title>Displaying the Structure of the Transformed Data</title> @@ -323,13 +323,13 @@ </figure> <para> Please, click <emphasis> <property>Yes</property> - </emphasis> to connect the root node. If you don&apos;t do that, this dialog will be + </emphasis> to connect the root node. If you don&apos;t do that, this dialog is 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 + <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 + <para>This rule is not only for Java-to-Java, but also is relevant for XML-to-Java </para> </note> <para> Now let&apos;s do the same operation with the <emphasis> @@ -349,7 +349,7 @@ <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 + </emphasis> of the other side tree viewer. The Problems area shows an error:</para> <figure> <title>Connection Error 1</title> @@ -417,7 +417,7 @@ </imageobject> </mediaobject> </figure> - <para>Now, you should save the file and the <property>Smooks tools</property> will generate the correct + <para>Now, you should save the file and the <property>Smooks tools</property> 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> Modified: branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml =================================================================== --- branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2009-05-11 16:42:22 UTC (rev 15210) +++ branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2009-05-11 16:42:46 UTC (rev 15211) @@ -9,7 +9,8 @@ </keywordset> </chapterinfo> <title>Smooks Configuration Editor Page</title> - <para> Smooks Configuration Editor Page is one tab of the <property>Smooks Editor</property>. </para> + <para>In this section you will explore the details of Smooks Configuration Editor usage</para> + <para><property>Smooks Configuration Editor</property> is one tab of the <property>Smooks Editor</property>. </para> <figure> <title>Graphical Editor</title> <mediaobject> @@ -20,9 +21,9 @@ </figure> <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 + Decoder</link> on the Configuration page of the <property>Smooks Editor</property>. </para> + <para> The configuration editor also edits the <link linkend="configurationpage_parsetype">Smooks parse + type</link> and manages the <link linkend="configurationpage_importfile">Import Files</link>.</para> <section id="configurationpage_parsetype"> @@ -40,7 +41,7 @@ </imageobject> </mediaobject> </figure> - <para> Select the radio button to change the Smooks parse type. </para> + <para>Select the needed radio button to change the Smooks parse type. </para> </section> <section id="configurationpage_importfile"> @@ -49,17 +50,8 @@ <property>Other Configurations</property> </emphasis> section, there is an <emphasis> <property>Import Files</property> - </emphasis> list under the Smooks parse type buttons.</para> + </emphasis> list under the Smooks parse type buttons (see the figure above).</para> - <figure> - <title>Import File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/config_page/config_page2.png" scale="90"/> - </imageobject> - </mediaobject> - </figure> - <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> @@ -67,9 +59,9 @@ <tip> <title>Tip:</title> - <para> If the import file dosen't exist, the image of the import file will change to + <para> If the import file doesn&amp;t exist, the image of the import file is changed 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> + is opened with a new default editor. </para> </tip> </section> @@ -106,16 +98,16 @@ <itemizedlist> <listitem> - <para>locale-language</para> - + <para>Format</para> </listitem> - + <listitem> - <para>format</para> + <para>Locale-Language</para> + </listitem> <listitem> - <para>locale-country</para> + <para>Locale-Country</para> </listitem> </itemizedlist> @@ -128,15 +120,16 @@ <title>Date Decoder Detail Page</title> <mediaobject> <imageobject> - <imagedata fileref="images/config_page/config_page5.png" scale="90"/> + <imagedata fileref="images/config_page/config_page1.png" scale="90"/> </imageobject> </mediaobject> </figure> <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> + <property>Date Decoder</property></emphasis>, then you can use the <link + linkend="graphicalpage_propertiesview">JavaBean Properties</link> GUI to set + it to be the &quot;Java type&quot;.</para> + <para>Now when we've learnt Smooks Configuration Editor Page, let's have a look at one more Smooks Editor Page - Smooks Source Editor Page and investigate its functionality</para> <!-- <para> The XML fragment generated by Smooks tools for the "Date Modified: branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml =================================================================== --- branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml 2009-05-11 16:42:22 UTC (rev 15210) +++ branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml 2009-05-11 16:42:46 UTC (rev 15211) @@ -9,7 +9,7 @@ </keywordset> </chapterinfo> <title>Smooks Graphical Editor Page</title> - + <para>This chapter is packed with useful information about Smooks Graphical Editor Page usage</para> <para>Smooks Graphical Editor page is one tab of the <property>Smooks Editor</property>.</para> <figure> <title>Graphical Editor</title> @@ -22,18 +22,37 @@ <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> + <para> When you save the changes in the <property>Graphical editor</property> the correct Smooks + Configuration file content is generated. </para> + + <para>To adjust the properties of the connection lines in the editor, you should use the <link + linkend="graphicalpage_propertiesview">Properties view</link> (activate it by following + to <emphasis> + <property>Window &gt; Show View &gt; Other &gt; General &gt; Properties</property>).</emphasis></para> + + <para>For example, if you defined a date decoder in the <link + linkend="configurationpage_datedecoder">Smooks Configuration Editor</link>, in the <property>Properties view</property> you can + select it as a Mapping type for the &quot;Date&quot; type element.</para> + + <figure> + <title>Browsing Custom Type for the Date Type Element</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/graph_editor/graph_editor1a.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> <section> <title>Introducing the areas of graphical editor</title> - <para>Information on the topic could be found in the <link linkend="quickstart_formeditor">Quick Start/Smooks Editor</link> section.</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 view, the <property>Data Type Selection wizard</property> page will be - shown.</para> + <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> <mediaobject> @@ -77,7 +96,7 @@ </figure> <para> When you finish the data selection (file path selection), click - <emphasis><property>Finish</property>,</emphasis> the data view will display the + <emphasis><property>Finish</property>,</emphasis> the data view displays the selected data structure.</para> </section> <section> @@ -93,8 +112,8 @@ 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> + <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 View</title> @@ -104,8 +123,8 @@ <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> + <para> When you select the connection line, the <property>Properties view</property> will + show a set of section GUI for editing its properties.</para> <tip> <title>Tip:</title> @@ -119,7 +138,7 @@ &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> + different, the <property>Properties view</property> shows a different GUI.</para> </tip> <figure> <title>JavaBean Properties Section</title> @@ -147,5 +166,7 @@ </imageobject> </mediaobject> </figure> + + <para>To discover about other Editor pages, read the next chapters</para> </section> </chapter> Modified: branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml =================================================================== --- branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml 2009-05-11 16:42:22 UTC (rev 15210) +++ branches/jbosstools-3.0.x/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml 2009-05-11 16:42:46 UTC (rev 15211) @@ -9,6 +9,7 @@ </keywordset> </chapterinfo> <title>Smooks Source Editor Page</title> + <para>This section provides information about Smooks Source Editor Page</para> <section> <title>XML Source Editor</title> <para>You can use this editor to edit the Smooks Configuration file directly. </para> @@ -25,7 +26,7 @@ <title>Error Messages GUI</title> <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> + Configuration file, etc.), the error is underlined.</para> <figure> <title>Graphical Editor</title> <mediaobject> @@ -41,6 +42,7 @@ <para> You can't edit the configuration file with other editors until file becomes valid. </para> </note--> - + <para>We hope, our guide will help you to get started with JBoss Smooks Tools. Besides, for additional information you are welcome on <ulink + url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... forum</ulink>.</para> </section> </chapter> Modified: branches/jbosstools-3.0.x/smooks/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.0.x/smooks/docs/reference/pom.xml 2009-05-11 16:42:22 UTC (rev 15210) +++ branches/jbosstools-3.0.x/smooks/docs/reference/pom.xml 2009-05-11 16:42:46 UTC (rev 15211) @@ -86,6 +86,11 @@ <version>1.1.0</version> <type>jdocbook-style</type> </dependency> + <dependency> + <groupId>org.apache.xmlgraphics</groupId> + <artifactId>fop</artifactId> + <version>0.95</version> + </dependency> </dependencies> <configuration>