Author: mcaspers Date: 2011-01-12 20:02:12 -0500 (Wed, 12 Jan 2011) New Revision: 28169 Modified: trunk/smooks/docs/reference/en-US/introduction.xml trunk/smooks/docs/reference/en-US/tasks.xml Log: General Updates Modified: trunk/smooks/docs/reference/en-US/introduction.xml =================================================================== --- trunk/smooks/docs/reference/en-US/introduction.xml 2011-01-13 00:29:57 UTC (rev 28168) +++ trunk/smooks/docs/reference/en-US/introduction.xml 2011-01-13 01:02:12 UTC (rev 28169) @@ -13,7 +13,7 @@ <para>First, have a look at the key features of Smooks tools:</para> <section> <title>Key Features of Smooks Tools</title> - <para>Here, we provide you with a key functionality which is integrated in Smooks tools.</para> + <para>The table below provides you with a list of the key features integrated in Smooks tools.</para> <table> <title>Key Functionality for Smooks Tools</title> @@ -34,64 +34,78 @@ <tbody> <row> - <entry><para>Smooks Configuration File Wizard</para></entry> - <entry><para>Smooks tools allows to create/edit the Smooks configuration file for Java2Java data transformation.</para></entry> <entry> + <para>Smooks Configuration File Wizard</para> + </entry> + <entry> + <para>Smooks tools allows you to create and edit the Smooks configuration file for Java2Java data transformation.</para> + </entry> + <entry> <xref linkend="config_file_wizzard"/> </entry> </row> <row> - <entry><para>Smooks Editor</para></entry> - <entry><para>Smooks Editor helps configure the created Smooks configuration file.</para></entry> <entry> + <para>Smooks Editor</para> + </entry> + <entry> + <para>Smooks Editor helps configure the created Smooks configuration file.</para> + </entry> + <entry> <xref linkend="process_tab"/> </entry> </row> - + </tbody> - + </tgroup> </table> - + </section> <section> <title>What is Smooks?</title> - - <para><property>Smooks</property> is a Java Framework/Engine for processing XML and non XML - data (CSV, EDI, Java, JSON etc).It provides: </para> + + <para> + <property>Smooks</property> is a Java Framework/Engine for processing XML and non XML + data (CSV, EDI, Java, JSON etc). It provides: </para> <para/> <para> <orderedlist numeration="upperroman" inheritnum="inherit"> <listitem> - <para><emphasis role="bold">Transformation</emphasis>: Perform a wide range of + <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><emphasis role="bold">Java Binding</emphasis>: Bind into a Java Object + <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><emphasis role="bold">Huge Message Processing</emphasis>: Process huge + <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><emphasis role="bold">Message Enrichment</emphasis>: Enrich a message with + <para> + <emphasis role="bold">Message Enrichment</emphasis>: Enrich a message with data from a Database, or other Datasources. </para> </listitem> - + <listitem> - <para><emphasis role="bold">Combine</emphasis>: Combine the above features in + <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> @@ -105,14 +119,12 @@ </imageobject> </mediaobject> </figure> - <para> For more informations about <property>Smooks</property>, please visit <ulink - url="http://www.smooks.org">Smooks official site</ulink>.</para> + <para> For more informations about <property>Smooks</property>, please visit the <ulink url="http://www.smooks.org">Smooks official site</ulink>.</para> </section> <section> <title>What is Smooks Tools?</title> - - <para>Smooks tools is a set of graphical tools for editing Smooks configuration file - based on Eclipse.</para> + + <para>Smooks tools is a set of graphical tools, based on Eclipse, for editing Smooks configuration files.</para> <figure> <title>Smooks Form editor</title> <mediaobject> @@ -130,20 +142,28 @@ <section> <title>Adding Smooks jars</title> - <para>During your development, you probably will be faced with the - necessity to include some additional Smooks jars to your project. - This problem can be solved in such a way:</para> + <para>During your development, you probably will be required to include additional Smooks jars to your project. This can be achieved with the following steps:</para> <itemizedlist> - <listitem><para>Create the folder named "lib" inside your project,if it doesn't exist yet. - Copy all the Smooks jars you need to include into the <emphasis><property>lib</property></emphasis> directory. - </para></listitem> - <listitem><para>Right-click on the project and select Properties.</para></listitem> - <listitem><para>Select the "Java Build Path" item in the Properties list, then the Libraries tab, and click "Add JARs". - </para></listitem> - <listitem><para>In the Jar Selection dialog, select all the jars in the "lib" directory you want to include and click OK.</para></listitem> - <listitem><para> - Now you should see all the jars - included to your project hierarchy. </para></listitem> + <listitem> + <para>If it doesn't yet exist, create the folder named "lib" inside your project. + Copy all the Smooks jars you need to include into the <emphasis><property>lib</property> + </emphasis> directory. + </para> + </listitem> + <listitem> + <para>Right-click (or Control-click on Mac OS) on the project and select <guilabel>Properties.</guilabel></para> + </listitem> + <listitem> + <para>Select the <guilabel>Java Build Path</guilabel> item in the Properties list, then the <guilabel>Libraries tab</guilabel>, and click the <guibutton>Add JARs</guibutton> button. + </para> + </listitem> + <listitem> + <para>In the Jar Selection dialog, select all the jars in the "lib" directory you want to include and click the <guibutton>OK</guibutton> button.</para> + </listitem> + <listitem> + <para> + Now you should see all the jars included to your project hierarchy. </para> + </listitem> </itemizedlist> <figure> Modified: trunk/smooks/docs/reference/en-US/tasks.xml =================================================================== --- trunk/smooks/docs/reference/en-US/tasks.xml 2011-01-13 00:29:57 UTC (rev 28168) +++ trunk/smooks/docs/reference/en-US/tasks.xml 2011-01-13 01:02:12 UTC (rev 28169) @@ -9,18 +9,15 @@ </keywordset> </chapterinfo> <title>Tasks</title> - <para>This chapter describes the main tasks a user can be faced during Smooks tools usage. + <para>This chapter describes the main tasks that can be performed with Smooks tools. In this chapter we use the example that can be downloaded from <ulink url="http://anonsvn.jboss.org/repos/jbosstools/trunk/smooks/docs/ref... here</ulink>. </para> <section id="config_file_wizzard"> <title>New Smooks Configuration File Creation</title> - <para>Select the project where you want to create new Smooks Configuration File and right-click on it, - select in 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> + <para> + Select the project where you want to create the new Smooks Configuration File and right-click on it. Select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Smooks</guimenuitem><guimenuitem>Smooks Configuration File</guimenuitem></menuchoice>. Then click the <guibutton>Next</guibutton> button. + </para> <figure> <title>Selecting Smooks Configuration File Wizard</title> <mediaobject> @@ -29,11 +26,9 @@ </imageobject> </mediaobject> </figure> - <para>The 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>smooks-config.xml</property>.</emphasis> Click - <emphasis><property>Next</property>.</emphasis></para> + <para> + Select the <emphasis><property>src</property></emphasis> folder to be the files container, and type the name <filename>smooks-config.xml</filename>. Click the <guibutton>Next</guibutton> button. + </para> <figure> <title>Choosing the configuration file container and the file name</title> <mediaobject> @@ -47,8 +42,7 @@ <section> <title>Input Task Configuring</title> <para> - <property>Input task configuring</property> is an obligatory step for your smooks project creation. - You can configure it on the Process page of the editor: look for the "Input Task" in the Process Map at the top of the page. + Configuring an <property>Input task</property> is mandatory step when creating a smooks project. You can configure it on the Process page of the editor: look for the "Input Task" in the Process Map at the top of the page. </para> <figure> <title>Input Task Configuring</title> @@ -64,12 +58,12 @@ Each reader type has slightly different configuration details that must be set in the "Input configuration" area. For instance, the CSV reader requires you to specify details such as the encoding, quote character, separator character, and the list of incoming fields. The EDI reader requires the encoding and the path to the Mapping Model describing the incoming data. - In the <emphasis>Input data</emphasis> section, you specify some sample data that conforms to your reader configuration. + In the <emphasis>Input data</emphasis> section, you can specify some sample data that conforms to your reader configuration. </para> <para> Once you've specified your reader configuration and sample data, you can see the input model rendered in a tree form in the <emphasis>Input model</emphasis> section. - On the picture below you can see the correct configuration of some XML input task where <emphasis><property>input-message.xml</property></emphasis> is set as an input data file. + In the picture below you can see the correct configuration of an XML input task where <emphasis><property>input-message.xml</property></emphasis> is set as an input data file. </para> <figure> <title>Input Task Configuring</title> @@ -83,19 +77,10 @@ <section> <title>"Java Mapping" or "Apply Template"?</title> - <para>Though there are many options in Smooks as far as what you can do with input - data such as transformation, routing, and persistence, this version - of the Smooks Configuration Editor focuses only on these areas: - mapping to java and applying templates to create different output formats. - If you have a set of Java classes you want to use the incoming data for, - you can use the "Java Mapping" task to specify those classes and use drag and - drop to map between the input model generated by the reader and elements in the output model. - Or if you simply want to transform your output to one or more formats, you can use the "Apply Template" - task to map it to a CSV file, XML or XSD file (and other formats in the future). + <para> + Though there are many options in Smooks regarding what you can do with input data, such as transformation, routing, and persistence, this version of the Smooks Configuration Editor focuses only on mapping to java and applying templates to create different output formats. If you have a set of Java classes you want to use the incoming data for, you can use the "Java Mapping" task to specify those classes and use drag and drop to map between the input model generated by the reader and elements in the output model. Or if you simply want to transform your output to one or more formats, you can use the <guilabel>Apply Template</guilabel> task to map it to a CSV file, XML or XSD file (with other formats being provided in the future). <note><title>Note</title> - <para>Now you can't transform your output directly, - using only Input and Template tasks. - You should use Mapping as an interagent between these tasks.</para> + <para>You can't transform your output directly using only Input and Template tasks. You should use Mapping as an interagent between these tasks.</para> </note> </para> </section>