9:22 a.m.
Author: chukhutsina
Date: 2009-06-20 10:22:56 -0400 (Sat, 20 Jun 2009)
New Revision: 16102
Modified:
trunk/smooks/docs/reference/en/images/quick_start/quick_start2.png
trunk/smooks/docs/reference/en/images/quick_start/quick_start6.png
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
Log:
<html><head><meta name="qrichtext" content="1"
/></head><body style="font-size:9pt;font-family:Sans Serif">
<p>https://jira.jboss.org/jira/browse/JBDS-755 - Updated Smooks-doc.Corrected some
mistakes and inaccuracies . </p>
</body></html>
Modified: trunk/smooks/docs/reference/en/images/quick_start/quick_start2.png
===================================================================
(Binary files differ)
Modified: trunk/smooks/docs/reference/en/images/quick_start/quick_start6.png
===================================================================
(Binary files differ)
Modified: trunk/smooks/docs/reference/en/modules/introduction.xml
===================================================================
--- trunk/smooks/docs/reference/en/modules/introduction.xml 2009-06-20 06:51:49 UTC (rev
16101)
+++ trunk/smooks/docs/reference/en/modules/introduction.xml 2009-06-20 14:22:56 UTC (rev
16102)
@@ -9,7 +9,7 @@
</keywordset>
</chapterinfo>
<title>Introduction</title>
- <para>This chapter give you a short introduction to Smooks, Smooks tools and its
installation</para>
+ <para>This chapter gives you a short introduction to Smooks, Smooks tools and its
installation.</para>
<para>First, have a look at the key features of Smooks tools:</para>
<section>
<title>Key Features of Smooks Tools</title>
Modified: trunk/smooks/docs/reference/en/modules/quick_start.xml
===================================================================
--- trunk/smooks/docs/reference/en/modules/quick_start.xml 2009-06-20 06:51:49 UTC (rev
16101)
+++ trunk/smooks/docs/reference/en/modules/quick_start.xml 2009-06-20 14:22:56 UTC (rev
16102)
@@ -55,7 +55,7 @@
</imageobject>
</mediaobject>
</figure>
- <para>The second wizard page is a Smooks configuration file version choose
page.Select appropriate one and click finish.</para>
+ <para>The second wizard page is a Smooks configuration file version choose
page.Select appropriate one and click
<emphasis><property>Finish</property></emphasis>.</para>
<!--<para> As the quick start introduces how to create/edit the Java-to-Java
Smooks
configuration file, let's select the<emphasis>
<property>Java-to-Java</property>
@@ -193,9 +193,10 @@
<section id="graphicaleditor_datalink">
<title>Choosing the transform data</title>
- <para>To choose the transform data you should click add button in the Input Data
section.</para>
+ <para>To choose the transform data you should click <emphasis>
+ <property>Add</property></emphasis> button in the Input Data
section.</para>
<para>After clicking the button the <property>Data Type Selection
wizard</property> is
- opened, and there are two data types on the list: Java and XML.</para>
+ opened, and there are two data types in the list: Java and XML.</para>
<note>
<title>Note</title>
<para> There will become more and more data types on the list as the development
goes on.
@@ -289,7 +290,10 @@
You should right click Resource List , select <emphasis>
<property>Add Smooks Resource>Java
Binding>Bindings</property></emphasis>.
</para>
- <para>First of all, you should bind Order to LineOrder. To do this one Bindings
Item should be added to the Resource List.</para>
+ <para>First of all, you should bind <emphasis>
+ <property>Order</property></emphasis> to <emphasis>
+ <property>LineOrder</property></emphasis>. To do this one
<emphasis>
+ <property>Bindings</property></emphasis> Item should be added to
the Resource List.</para>
<figure>
<title>Mapping</title>
<mediaobject>
@@ -297,8 +301,15 @@
<imagedata fileref="images/quick_start/quick_start10.png"
scale="90"/>
</imageobject>
</mediaobject>
- </figure><para>Click on it and you should see Bindings Section to the
right of Message Filtering Resources.Write <emphasis>
<property>lineOrder</property></emphasis> in the Bean id
field.</para>
- <para>Select example.trgmodel.LineOrder in the Class field and
example.srcmodel.Order in the Name field.Your <emphasis> <property>Smooks
Configuration Editor</property></emphasis> should look like this:
</para>
+ </figure><para>Click on it and you should see <emphasis>
+ <property>Bindings</property></emphasis> Section to the right of
<emphasis>
+ <property>Message Filtering Resources</property></emphasis>.Write
<emphasis> <property>lineOrder</property></emphasis> in the
<emphasis>
+ <property>Bean id</property></emphasis> field.</para>
+ <para>Select <emphasis>
+ <property>example.trgmodel.LineOrder</property></emphasis> in the
<emphasis>
+ <property>Class</property></emphasis> field and <emphasis>
+ <property>example.srcmodel.Order</property></emphasis> in the
<emphasis>
+ <property>Name</property></emphasis> field.Your <emphasis>
<property>Smooks Configuration Editor</property></emphasis> should look
like this: </para>
<figure>
<title>Mapping</title>
<mediaobject>
@@ -355,9 +366,12 @@
<para> Then you should right click <emphasis>
<property>lineOrder</property></emphasis> binding
item<emphasis>
<property>>Add Smooks
Resource>Wiring</property></emphasis>.Select <emphasis>
- <property>lineItem</property></emphasis> in Bean id Ref.
+ <property>lineItem</property></emphasis> in <emphasis>
+ <property>Bean id Ref</property></emphasis>.
</para>
- <para>The final step is to add new Wiring item to lineOrder Binding.In the Bean
id Ref select lineItems and in Property select <emphasis>
+ <para>The final step is to add new Wiring item to lineOrder
<property>Binding</property>.In the <property>Bean id
Ref</property> select <emphasis>
+ <property>lineItems</property></emphasis> and in <emphasis>
+ <property>Property</property></emphasis> select <emphasis>
<property>lineItems</property></emphasis>.</para>
<!--
<para>Next, you are going to bind the properties of the
<property>OrderItem</property> to
Modified: trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml
===================================================================
---
trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2009-06-20
06:51:49 UTC (rev 16101)
+++
trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2009-06-20
14:22:56 UTC (rev 16102)
@@ -19,17 +19,22 @@
</imageobject>
</mediaobject>
</figure>
- <para>This page consists of 3 setions: Message Filtering Resources, Input Data and
Section devoted to the configurations of a selected in a Message Filtering Resources
section Item.</para>
+ <para>This page consists of 3 sections: Message Filtering Resources, Input Data
and the section devoted to the configurations of a selected in a Message Filtering
Resources section Item.</para>
<para> You can bind classes <link
linkend="quickstart_mapping">using Bindings item
</link> on the Design page of the <property>Smooks
Editor</property>. </para>
<para><emphasis>
<property>Resource list</property></emphasis> item in
<emphasis>
- <property>Message Filtering Resources</property></emphasis>
corresponds to the root element of the smooks-config.xml file.You can configurate the
next two properties using corresponding fields:</para>
+ <property>Message Filtering Resources</property></emphasis>
corresponds to the root element of the <emphasis>
+ <property>smooks-config.xml</property></emphasis> file.You can
configurate the next four properties using corresponding fields:</para>
<itemizedlist>
<listitem><para><emphasis>
- <property>default-target-profile</property></emphasis>: Default
target profile that will be applied to all resources in the smooks configuration file,
where a <emphasis>
- <property>target-profile</property></emphasis> is not defined.
</para></listitem>
+ <property>default-selector</property></emphasis>:Defines the
selector that will be applied to all resource-config elements in the <emphasis>
+ <property>smooks-config.xml</property></emphasis>, where a
selector is not defined. </para></listitem>
<listitem><para><emphasis>
+ <property>default-selector-namespace</property></emphasis>:Defines
the default selector namespace. </para></listitem>
+ <listitem><para><emphasis>
+ <property>default-target-profile</property></emphasis>: Defines the
default target profile that will be applied to all resources in the smooks-config.xml.
</para></listitem>
+ <listitem><para><emphasis>
<property>default-condition-ref</property></emphasis>:The condition
is applied to resources where an empty "condition" element (i.e.
<code><condition/></code>)is defined.The condition element does
not reference a globally defined condition. </para></listitem>
</itemizedlist>
<para> The configuration editor also edits the <link
linkend="configurationpage_parsetype">Smooks parse
@@ -39,7 +44,11 @@
<section id="configurationpage_parsetype">
<title>Smooks Parse Type</title>
- <para>If your config file doesn't contain Global Parametres item yet, you
should add it by right click Resource List>Add Smooks Resource>Global
Parametres.After this step you should add Param to just created Global Parametres.
</para>
+ <para>If your config file doesn't contain <emphasis>
+ <property>Global Parametres</property></emphasis> item yet, you
should add it by right click <emphasis>
+ <property>Resource List>Add Smooks Resource>Global
Parametres</property></emphasis>.After this step you should add
<emphasis>
+ <property>Param</property></emphasis> to just created
<emphasis>
+ <property>Global Parametres</property></emphasis>. </para>
<figure>
<title>Smooks Parse Types</title>
<mediaobject>
@@ -50,7 +59,11 @@
</figure>
<para>Then left click <emphasis>
<property>Param</property>
- </emphasis>and in the Param section, you will see a set of text fields:
Name,Type and Text.Name value is required. To set a parse type you should write SAX/DOM to
the
+ </emphasis>and in the Param section, you will see a set of text fields:
<emphasis>
+ <property>Name</property></emphasis>,<emphasis>
+ <property>Type</property></emphasis> and <emphasis>
+ <property>Text</property></emphasis>.<emphasis>
+ <property>Name</property></emphasis> value is required. To set a
parse type you should write SAX/DOM to the
<emphasis>
<property>Text</property></emphasis> field.</para>
@@ -62,7 +75,8 @@
</imageobject>
</mediaobject>
</figure>
- <para>To apply changes to the smooks-config.xml click <emphasis>
+ <para>To apply changes to the <emphasis>
+ <property>smooks-config.xml</property></emphasis> click
<emphasis>
<property>Save</property></emphasis> button (<emphasis>
<property>Ctrl+S</property></emphasis>). </para>
</section>
@@ -89,7 +103,7 @@
</emphasis> button and select the file you want to import. </para>
<para>Click <emphasis>
<property>Save</property></emphasis> and the
<code><import></code> tag with the corresponding file path as a
<emphasis>
- <property>file</property></emphasis> property will be addded to the
<emphasis>
+ <property>file</property></emphasis> property will be added to the
<emphasis>
<property>smooks-config.xml</property></emphasis>.</para>
</section>
<!--<section id="configurationpage_datedecoder">