Author: mcaspers Date: 2011-01-12 22:13:00 -0500 (Wed, 12 Jan 2011) New Revision: 28177 Modified: trunk/smooks/docs/reference/en-US/references.xml Log: General Updates Modified: trunk/smooks/docs/reference/en-US/references.xml =================================================================== --- trunk/smooks/docs/reference/en-US/references.xml 2011-01-13 03:02:11 UTC (rev 28176) +++ trunk/smooks/docs/reference/en-US/references.xml 2011-01-13 03:13:00 UTC (rev 28177) @@ -9,12 +9,10 @@ </keywordset> </chapterinfo> <title>Reference</title> - <para>This chapter includes detailed reference information about all tabs of the Smooks Configuration Editor.</para> + <para>This chapter includes detailed reference information on all tabs in the Smooks Configuration Editor.</para> <section id="process_tab"> <title>Process tab</title> - <para>The Process tab of the Smooks Configuration Editor helps to configure different types of transformations. - By default smooks configuration file is opened in this editor.If you have another default settings for editor opening - you should left click smooks configuration file and select:<emphasis>Open With->Smooks Configuration Editor</emphasis>.</para> + <para>The Process tab of the Smooks Configuration Editor provides a way to configure different types of transformations. By default the smooks configuration file is opened in this editor. If you have set another editor to open the file by default, you should right click on the smooks configuration file and select <menuchoice><guimenuitem>Open With</guimenuitem><guimenuitem>Smooks Configuration Editor</guimenuitem></menuchoice>.</para> <para>The Process tab has two sections:</para> <itemizedlist> <listitem><para><xref linkend="processing_task_section"/></para></listitem> @@ -31,8 +29,7 @@ </figure> <section id="processing_task_section"> <title>Processing Task section</title> - <para>Using the popup menu in the Processing Task section you - can select which types of technologies(templating or mapping ones) you will use for transofmation: </para> + <para>Using the popup menu in the Processing Task section you can select which types of technologies (templating or mapping ones) you will use for transformation: </para> <para>The descriptions of the popup menu options are in the following table.</para> <table> <title>Process Tab. Processing Task section.</title> @@ -51,11 +48,9 @@ <tbody> <row> <entry>Add Task</entry> - <entry>Select one of the following tasks according to the necessary type of Source and Result types of the files: + <entry>Select one of the following tasks according to the required Source and Result file types: <itemizedlist> - <listitem><para><emphasis>Input</emphasis> - this task is required and - appears automatically when Smooks config file is created. - You should just configure it properly.</para></listitem> + <listitem><para><emphasis>Input</emphasis> - this task is required and appears automatically when Smooks config file is created. You should just configure it properly.</para></listitem> <listitem><para><emphasis>Java Mapping</emphasis></para></listitem> <listitem><para><emphasis>Apply Template</emphasis></para></listitem> </itemizedlist> @@ -65,8 +60,7 @@ <row> <entry>Delete</entry> - <entry>Click this option if you want to delete some task from the section. - Note:you can't delete input task because it's required.</entry> + <entry>Click this option if you want to delete some task from the section. Note:you can't delete input task because it's required.</entry> <entry></entry> </row> @@ -100,13 +94,10 @@ </section> <section id="selected_task_details"> <title>Selected Task Details Section</title> - <para>The options of this section depends on the selected task in the Processing Task section. - Because there are 3 types of tasks there are 3 different sets of its options in the Selected Task Details Section. - They will be described one by one. </para> + <para>The options available in this section depends on the selected task in the Processing Task section. Because there are 3 types of tasks there are 3 different sets of its options in the Selected Task Details Section. They will be described one by one. </para> <section> <title>Selected Task Details Section for Input Task.</title> - <para>On the picture below you can find an example of Selected Task Details Section view - if XML is selected as input type.</para> + <para>On the picture below you can find an example of the Selected Task Details Section view if XML is selected as input type.</para> <figure> <title>Selected Task Details Section for Input XML Task.</title> @@ -116,8 +107,7 @@ </imageobject> </mediaobject> </figure> - <para>As you can see on the picture above Input Configuration section is empty for XML input file. - But this section has special configuration options for CSV,EDI,JSON,Custom input files.</para> + <para>As you can see on the picture above the Input Configuration section is empty for XML input file. However, this section has special configuration options for CSV,EDI,JSON,Custom input files.</para> <para>Here are the screens of these configuration options:</para> <itemizedlist> @@ -180,7 +170,7 @@ <row> <entry>Input type</entry> <entry>Select your type of input file. - If don't find your type in the list,you should use Custom type: + If you don't find your type in the list, you should use Custom type: <itemizedlist> <listitem><para>No Input</para></listitem> <listitem><para>XML</para></listitem> @@ -214,10 +204,7 @@ </para></listitem> <listitem><para><emphasis>Record Name</emphasis> - Name of csv record element.</para></listitem> <listitem><para><emphasis>Root Name</emphasis> - Name of csv root element.</para></listitem> - <listitem><para><emphasis>indent</emphasis> - Add indentation character data to - the generated event stream. This simply makes - the generated event stream easier to read in its serialized form. Useful for - testing etc. + <listitem><para><emphasis>indent</emphasis> - Add indentation character data to the generated event stream. This simply makes the generated event stream easier to read in its serialized form. Useful for testing etc. </para></listitem> <listitem><para><emphasis>Skip Lines</emphasis> - Number of lines to skip before processing starts. </para></listitem> @@ -225,17 +212,11 @@ </listitem> <listitem><para><emphasis>EDI</emphasis></para> <itemizedlist> - <listitem><para><emphasis>Target Profile</emphasis> - Defines the output - transformation profile + <listitem><para><emphasis>Target Profile</emphasis> - Defines the output transformation profile </para></listitem> <listitem><para><emphasis>Encoding</emphasis> - The character encoding.</para></listitem> - <listitem><para><emphasis>Mapping Model</emphasis> - Defines the EDI Mapping Model - configuration for processing the - EDI message stream to a stream of SAX events that can be processed by Smooks.</para></listitem> - <listitem><para><emphasis>Validate</emphasis> - This attribute turns on/off datatype validation in the EDI Parser. - Validation is on by default. - It makes sense to turn datatype validation off on the EDI Reader - if the EDI data is being bound into a Java Object model. + <listitem><para><emphasis>Mapping Model</emphasis> - Defines the EDI Mapping Model configuration for processing the EDI message stream to a stream of SAX events that can be processed by Smooks.</para></listitem> + <listitem><para><emphasis>Validate</emphasis> - This attribute turns on/off datatype validation in the EDI Parser. Validation is on by default. It makes sense to turn datatype validation off on the EDI Reader if the EDI data is being bound into a Java Object model. </para></listitem> </itemizedlist> </listitem> @@ -244,26 +225,19 @@ <listitem><para><emphasis>Target Profile</emphasis> - Defines the output transformation profile</para></listitem> <listitem><para><emphasis>Array Element Name</emphasis> - The element name of an array element. </para></listitem> - <listitem><para><emphasis>Encoding</emphasis> - encoding: The default encoding of any JSON message - InputStream processed by this Reader.</para></listitem> - <listitem><para><emphasis>Illegal Element Name Char Replacement</emphasis> - If illegal characters are encountered in a JSON element name then they are replaced with this value. - By default this is not defined, so that the reader doesn't doesn't search for illegal characters. + <listitem><para><emphasis>Encoding</emphasis> - encoding: The default encoding of any JSON message InputStream processed by this Reader.</para></listitem> + <listitem><para><emphasis>Illegal Element Name Char Replacement</emphasis> - If illegal characters are encountered in a JSON element name then they are replaced with this value. By default this is not defined, so that the reader doesn't doesn't search for illegal characters. </para></listitem> - <listitem><para><emphasis>Indent</emphasis> - Add indentation character data to the generated event stream. This simply makes - the generated event stream easier to read in its serialized form. Useful for - testing etc. + <listitem><para><emphasis>Indent</emphasis> - Add indentation character data to the generated event stream. This simply makes the generated event stream easier to read in its serialized form. Useful for testing etc. </para></listitem> - <listitem><para><emphasis>Key Prefix on Numeric</emphasis> - The prefix character to add if the JSON node name starts with a number. - By default this is not defined, so that the reader doesn't search for element names that start with a number. + <listitem><para><emphasis>Key Prefix on Numeric</emphasis> - The prefix character to add if the JSON node name starts with a number. By default this is not defined, so that the reader doesn't search for element names that start with a number. </para></listitem> - <listitem><para><emphasis>Key Whitespace Replacement</emphasis> - The replacement character for whitespaces in a JSON map key. - By default this not defined, so that the reader doesn't search for whitespaces. + <listitem><para><emphasis>Key Whitespace Replacement</emphasis> - The replacement character for whitespaces in a JSON map key. By default this not defined, so that the reader doesn't search for whitespaces. </para></listitem> <listitem><para><emphasis>Null Value Replacement</emphasis> - The replacement string for JSON NULL values.</para></listitem> <listitem><para><emphasis>Root Name</emphasis> - The element name of the document root. </para></listitem> - <listitem><para><emphasis>Key Maps</emphasis> - Defines a JSON element name mapping - The "from" key will be replaced with the "to" key or the contents of the element. + <listitem><para><emphasis>Key Maps</emphasis> - Defines a JSON element name mapping The "from" key will be replaced with the "to" key or the contents of the element. </para></listitem> </itemizedlist> </listitem> @@ -322,13 +296,12 @@ </row> <row> <entry>Input Data</entry> - <entry>You should select a data file using <emphasis>Add</emphasis> and <emphasis>Delete</emphasis> buttons</entry> + <entry>You should select a data file using the <guibutton>Add</guibutton> and <guibutton>Delete</guibutton> buttons</entry> <entry></entry> </row> <row> <entry>Input Model View</entry> - <entry>Using this view you can see the structure of your input file.If the file has been changed, to see the changes - click <emphasis>Refresh</emphasis>link.</entry> + <entry>Using this view you can see the structure of your input file.If the file has been changed, to see the changes click the <emphasis>Refresh</emphasis>link.</entry> <entry></entry> </row> </tbody> @@ -336,8 +309,7 @@ </table> </section> <section id="mapping_task"><title>Selected Task Details section for Java Mapping Task.</title> - <para>Selected Task Details section for this task is presented by the graf, - that lighten the process of java mapping. </para> + <para>Selected Task Details section for this task is presented by the graph, which eases the process of java mapping. </para> <figure> <title>Selected Task Details Section for Mapping Task.</title> <mediaobject> @@ -346,10 +318,8 @@ </imageobject> </mediaobject> </figure> - <para>This graphical editor allows you to perform drag&amp;drop operation with the nodes of transformed data to map the source data to target data. - When you save the changes in the graphical editor the correct Smooks configuration file content will be generated. </para> - <para>Using the popup menu in the <emphasis>Selected Task Details</emphasis> section you - can manage the diagram elements on the canvas. </para> + <para>This graphical editor allows you to perform drag&amp;drop operations with the nodes of transformed data to map the source data to target data. When you save the changes in the graphical editor the correct Smooks configuration file content will be generated. </para> + <para>Using the popup menu in the <emphasis>Selected Task Details</emphasis> section you can manage the diagram elements on the canvas. </para> <para>The descriptions of the popup menu options are in the following table.</para> <table id="popup"> <title>Popup menu. Selected Task Details section.</title> @@ -370,37 +340,32 @@ <entry>Add</entry> <entry>Select one of the following tasks: <itemizedlist> - <listitem><para><emphasis>Java Class</emphasis> - adds bean context item to the config file. - This option is available when no elements are selected and a user right click the canvas. + <listitem><para><emphasis>Java Class</emphasis> - adds a bean context item to the config file. This option is available when no elements are selected and a user right clicks on the canvas. </para></listitem> - <listitem><para><emphasis>Expession Binding</emphasis> - adds expression based - binding to selected java binding element.</para></listitem> - <listitem><para><emphasis>Value Binding</emphasis> - adds Value binding (&lt;jb:value&gt;) - to the selected java binding element.</para></listitem> - <listitem><para><emphasis>Bean Binding</emphasis> - adds Wiring binding (&lt;jb:wiring&gt;) - to the selected java binding element.</para></listitem> + <listitem><para><emphasis>Expession Binding</emphasis> - adds expression based binding to selected java binding element.</para></listitem> + <listitem><para><emphasis>Value Binding</emphasis> - adds Value binding (&lt;jb:value&gt;) to the selected java binding element.</para></listitem> + <listitem><para><emphasis>Bean Binding</emphasis> - adds Wiring binding (&lt;jb:wiring&gt;) to the selected java binding element.</para></listitem> </itemizedlist> </entry> <entry></entry> </row> <row> <entry>Undo</entry> - <entry>By this option you can revert the changes made at the previous step. + <entry>This option allows you to revert any changes made in the previous step. </entry> <entry></entry> </row> <row> <entry>Redo</entry> - <entry>By this option you can redo the changes made at the previous step. + <entry>This option allows you to redo the changes made at the previous step. </entry> <entry></entry> </row> <row> <entry>Delete</entry> - <entry>This option is available only if you select some element on the canvas. - Click this option if you want to delete the element from it. + <entry>This option is available only if you select an element on the canvas. Click this option if you want to delete the element from it. </entry> <entry></entry> @@ -413,11 +378,8 @@ </row> <row> <entry>Properties</entry> - <entry>Click this option if you want to add <emphasis>Properties view</emphasis> - to the current perspective. - The just opened <emphasis>Properties view</emphasis> - will automatically reflect the properties of the selected - diagram element. + <entry>Click this option if you want to add the <emphasis>Properties view</emphasis> to the current perspective. The <emphasis>Properties view</emphasis> + will automatically display the properties of the selected diagram element. </entry> <entry></entry> </row> @@ -450,8 +412,7 @@ </table> </section> <section><title>Selected Task Details section for Template Task.</title> - <para>Selected Task Details section for this task is presented by the graf, - that is similar to the <xref linkend="mapping_task"/>. + <para>Selected Task Details section for this task is presented by the graph, which is similar to what is described in the section <xref linkend="mapping_task"/>. </para> <figure> <title>Selected Task Details Section for Template Task.</title> @@ -468,7 +429,7 @@ </section> <section id="options_tab"> <title>Options Tab</title> - <para>This section describes Options tab of the Smooks Configuration File editor, gives short recommendations how this tab can be used during the project configuring.</para> + <para>This section describes Options tab of the Smooks Configuration File editor, and gives short recommendations how this tab can be used during the project configuring.</para> <figure> <title> Options tab of the Smooks Configuration File editor</title> <mediaobject> @@ -480,8 +441,7 @@ <section> <title>Smooks Configuration section</title> <para> - In the <property>Smooks Configuration</property> section of <property>Options Tab</property> - only one element is availible:Smooks Platform Version + The <property>Smooks Configuration</property> section in the <property>Options Tab</property> displays only the Smooks Platform Version value. </para> <figure> <title>Smooks Configuration section of Options tab</title> @@ -491,16 +451,14 @@ </imageobject> </mediaobject> </figure> - <para>This parameter is not rechangable, - and is set according to the vesion of the Smooks libraries that are added to the project. + <para>This value can not be modified, and is set according to the version of the Smooks libraries that are added to the project. </para> </section> <section> <title>Filter Settings Filter section</title> <para> - In Filter Settings section you can set - the following global options responsible for Smooks filtering configuring:</para> + In Filter Settings section you can set the following global options responsible for the Smooks filtering configuration:</para> <figure> <title>Filter Settings section of Options tab</title> <mediaobject> @@ -509,7 +467,7 @@ </imageobject> </mediaobject> </figure> - <para>This behavior can be turned off using this global configuration parameter and can be overriden on a per fragment basis by targetting a Visitor implementation at that fragment that takes ownership of the Result writer (in the case of SAX filtering), or simply modifies the DOM (in the case of DOM filtering). As an example of this, see the FreeMarkerTemplateProcessor. + <para>This behavior can be turned off using this global configuration parameter and can be overridden on a per fragment basis by targeting a Visitor implementation at that fragment that takes ownership of the Result writer (in the case of SAX filtering), or simply modifies the DOM (in the case of DOM filtering). As an example of this, see the FreeMarkerTemplateProcessor. </para> <table> <title>Options Tab. Filter Settings section.</title> @@ -528,10 +486,7 @@ <tbody> <row> <entry>Stream Filter Type</entry> - <entry>Determines the type of processing model that will be used. - Please refer to <ulink url="http://www.smooks.org/mediawiki/index.php?title=V1.2:Smooks_v1.... - Filtering Process Selection section</ulink> - of the official Smooks User Guide for more information about these models: + <entry>Determines the type of processing model that will be used. Please refer to the <ulink url="http://www.smooks.org/mediawiki/index.php?title=V1.2:Smooks_v1.... Filtering Process Selection section</ulink> of the official Smooks User Guide for more information about these models: <itemizedlist> <listitem><para><emphasis>SAX</emphasis></para></listitem> <listitem><para><emphasis>DOM</emphasis></para></listitem> @@ -542,10 +497,7 @@ <row> <entry>Default Serialization is On</entry> - <entry>Defines whether default serialization should be switched on. - Default serialization being turned on leads to locating StreamResult/DOMResult - to the Result objects provided to the Smooks.filterSource method and to - serialization all the events to that Result.</entry> + <entry>Defines whether the default serialization should be switched on. Default serialization being enabled leads to locating StreamResult/DOMResult to the Result objects provided to the Smooks.filterSource method and to serialization all the events to that Result.</entry> <entry>false</entry> </row> @@ -557,7 +509,7 @@ <section id="smooksformeditor_sourcetab"> <title>Source Tab</title> - <para>This section provides information about Smooks Source Editor Page.</para> + <para>This section provides information about the 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> @@ -572,9 +524,7 @@ </section> <section> <title>Error underlining in Graphical Editor</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 is underlined.</para> + <para>If the <property>Smooks tools</property> can&apos;t understand the configuration file or the configuration file is illegal (e.g. XML structure isn&apos;t valid for a Smooks Configuration file), the error is underlined.</para> <figure> <title>Graphical Editor</title> <mediaobject> @@ -588,7 +538,9 @@ <section> <title>Smooks Configuration File Validator</title> - <para>Smooks configuration file validator will validate your Smooks configuration file. Just right-click on the file and then click on the <property>Validate</property> button. The validator can be enabled/disabled in <emphasis><property>Window -> Preferences -> Validation</property></emphasis>:</para> + <para> + The Smooks configuration file validator will validate your Smooks configuration file. Just right-click on the file and then click on the <guibutton>Validate</guibutton> button. The validator can be enabled/disabled by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>Validation</guimenuitem></menuchoice>, as you can see in the image below: + </para> <figure> <title>Validation: Smooks Configuration File Validator</title> @@ -599,7 +551,7 @@ </mediaobject> </figure> - <para>You can set up your Smooks validator to include, exclude groups to validate and specify rules for validation. Just click on the <property>Settings</property> button and use the options provided:</para> + <para>You can set up your Smooks validator to include and exclude groups to validate, and specify rules for validation. Just click on the <guibutton>Settings</guibutton> button and use the options provided, which you can see in the image below:</para> <figure> <title>Smooks Configuration File Validator Settings</title> @@ -609,22 +561,18 @@ </imageobject> </mediaobject> </figure> - <para>For more details about Smooks editor, also see the movie, <ulink url="">"Overview of the Smooks Editor"</ulink>.</para> </section> </section> <section> <title>Properties View</title> - <para><emphasis><property>Properties View</property></emphasis> is available for some - elements on the canvas of Java Mapping and Apply Template Tasks,like:</para> + <para><emphasis><property>Properties View</property></emphasis> is available for some elements on the canvas of Java Mapping and Apply Template Tasks, like:</para> <itemizedlist> <listitem><para><emphasis><property>Java mapping</property></emphasis>:java class members,its fields, links between input values and the class members;</para></listitem> <listitem><para><emphasis><property>Apply Template</property></emphasis>:output template.</para></listitem> </itemizedlist> <para>To add <emphasis><property>Properties View</property></emphasis> - to the opened perspective the user can either open <property>Window->Show View->Preferences</property> - in the toolbar or right click the element which properties he wants to inspect and select <property>Properties</property> - in the popup menu.On the picture below you can see how this view looks like when some csv template is selected. + to the opened perspective the user can either open <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Preferences</guimenuitem></menuchoice> in the toolbar or right click the element which properties he wants to inspect and select <property>Properties</property> in the popup menu. On the picture below you can see how this view looks like when some csv template is selected. </para> <figure> <title>Properties View</title> @@ -635,9 +583,7 @@ </mediaobject> </figure> <para> - This view is fully syncronized with the canvas of <emphasis><property>Smooks Configuration Editor</property></emphasis>. - This means that when you change selected element by click,the properties of a new element are immediatly displayed in it. - Using <emphasis><property>Properties View</property></emphasis> you can edit all the properties of the selected item. + This view is fully synchronized with the canvas of the <emphasis><property>Smooks Configuration Editor</property></emphasis>. This means that when you change the selected element by clicking on it, the properties of a new element are immediately displayed in it. Using <emphasis><property>Properties View</property></emphasis> you can then edit all the properties of the selected item. </para> <figure> <title>Synchronization between Properties View and the canvas</title> @@ -649,9 +595,7 @@ </figure> <section> <title>Decode Configuration</title> - <para>Smooks tools support decode parameter configuration through the Decode tab in <emphasis> - <property>Properties View</property></emphasis> - activated by clicking the connection between input model and bean items. </para> + <para>Smooks tools support decode parameter configuration through the Decode tab in <emphasis> <property>Properties View</property></emphasis> activated by clicking the connection between input model and bean items. </para> <para>On the picture below you can see an example of decode configurations for mapping some <property>Input Model</property> Item to <property>Date</property> format:</para> <figure>