2:07 p.m.
Author: smukhina
Date: 2008-12-19 15:07:03 -0500 (Fri, 19 Dec 2008)
New Revision: 12782
Modified:
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/introduction.xml
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/quick_start.xml
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-324
the latest docs that are done for release 3.0.0.CR1 from trunk are added to branch
Modified: branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/introduction.xml
===================================================================
---
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/introduction.xml 2008-12-19
19:58:24 UTC (rev 12781)
+++
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/introduction.xml 2008-12-19
20:07:03 UTC (rev 12782)
@@ -52,7 +52,7 @@
</sect1>
<sect1>
<title>What is Smooks dev tools?</title>
- <para>Smooks dev tools is a sets 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> User 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: branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/quick_start.xml
===================================================================
---
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/quick_start.xml 2008-12-19
19:58:24 UTC (rev 12781)
+++
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/quick_start.xml 2008-12-19
20:07:03 UTC (rev 12782)
@@ -16,7 +16,7 @@
data
transformation.</para>
<para>
- This chapter should give the readers a brief understanding of
+ This chapter should give you a brief understanding of
the
Smooks
dev tools.
@@ -30,19 +30,16 @@
<tip>
<title>Tip:</title>
<para>
- The example projects is base on Maven, we suggest user to
- create a
- new eclipse Java project and copy the example codes and .jar
- files
- from the
- example project paste them to the eclipse Java
+ 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>
<section>
<title>Smooks configuration file wizard</title>
- <para>Select the Smooks Java-to-Java example project what you created and
right-click, select the menu: "New" ->
+ <para>Select the Smooks Java-to-Java example project what you created and
right-click, select the menu: "New" ->
"Other...", find the
"Smooks Configuration File" wizard. Click
"Next" button.
@@ -55,12 +52,12 @@
</imageobject>
</mediaobject>
</figure>
- <para>First wizard page is file path creation page. Select the
- "src" to be the file's container, and input
+ <para>The first wizard page is a file path creation page. Select the
+ "src" to be the files container, and input
"smooks-newconfig.smooks". Click
"Next".</para>
<figure>
<title>Choose the configuration file container and type the
- file's name</title>
+ file name</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/common/input_file_name.png"
@@ -68,15 +65,13 @@
</imageobject>
</mediaobject>
</figure>
- <para>The second wizard page is the transform data type choose
page.</para>
+ <para>The second wizard page is a transform data type choose page.</para>
<tip>
<title>Note</title>
<para>
- Because the quick start introduce how to create/edit the
- Java-to-Java
- Smooks configuration file, so choose "Java" type
- to be
- the source/target transform data type please.
+ As the quick start introduces how to create/edit the
+ Java-to-Java Smooks configuration file, it's necessary that "Java"
type
+ is the source/target transform data type please.
</para>
</tip>
<figure>
@@ -90,10 +85,10 @@
</figure>
</section>
<section id="quickstart_formeditor">
- <title>Smooks form editor</title>
- <para>When the wizard was finished, a new Smooks configuration file was created
and the Smooks editor will be opened automatically.
+ <title>Smooks form Editor</title>
+ <para>When all the wizard steps are passed, a new Smooks configuration file is
created and the Smooks editor will be opened automatically.
</para>
- <para> We will see the
+ <para> You will see the
"Smooks Form Editor":
</para>
<figure>
@@ -108,15 +103,15 @@
<para> This editor contains several parts:
<orderedlist numeration="loweralpha" inheritnum="inherit">
<listitem>
- <para>Notify message display area. If there are any errors when users are
editing the file,
+ <para>Notify message display area. If there are any errors when you are
editing the file,
the error area will display them.</para>
</listitem>
<listitem>
- <para>Source data tree. The tree will display the structured of transform
source data.</para>
+ <para>Source data tree. The tree will display the structure of transformed
source data.</para>
</listitem>
<listitem>
- <para>Target data tree. The tree will display the structured of transform
target data.</para>
+ <para>Target data tree. The tree will display the structure of transformed
target data.</para>
</listitem>
<listitem>
@@ -125,25 +120,24 @@
<listitem>
<para>Source/Target data selection links. Click the link,
- there will open the
- <link linkend="graphicaleditor_datalink">"Data
+ and <link linkend="graphicaleditor_datalink">"Data
Selection
- Wizard"</link>
- to help user to choose the source/target
+ Wizard"</link> will be opened
+ helping you to choose the source/target
data.</para>
</listitem>
</orderedlist>
</para>
</section>
<section id="graphicaleditor_datalink">
- <title>Choose the source/target data
+ <title>Choosing the source/target data
</title>
<para>Click the data selection links to choose the transform data. The
"Data Selection Wizard" is opened, and there are two data types on the list:
XML and Java.
</para>
<tip>
<title>Note</title>
<para>
- There will be more and more data types on the list as the
+ There will be more and more data types on a list as the
development went on.
</para>
</tip>
@@ -159,7 +153,7 @@
<para>Select the "JavaBean Data Type" and click
"Next", you will see a java class selection page:
</para>
<figure>
- <title>JavaBean data selection wizard</title>
+ <title>JavaBean Data Selection Wizard</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/java2java/java_data_selection_wizard.png"
@@ -167,11 +161,10 @@
</imageobject>
</mediaobject>
</figure>
- <para>When you finished the java class selection, click
"Finish"
- , we will see, the structured of the java class was be displayed on the Source data
tree. Please do the same operation with the target data link.
+ <para>When you select all the necessary java classes, click
"Finish" and the structure of the java class will be displayed on the
Source data tree. Please, do the same with a target data link.
</para>
<figure>
- <title>Display structure of the transform data</title>
+ <title>Displaying Structure of the Transformed Data</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/java2java/java_data_display.png"
@@ -182,9 +175,9 @@
</section>
<section id="quickstart_mapping">
<title>Mapping</title>
- <para> As you see, the source/target data tree display the structure of the
java class. </para>
- <para>How to mapping it?</para>
- <para> First, we should know what is we want to transform:
+ <para> As you see, the source/target data tree displays the structure of the
java class. </para>
+ <para>How to map it?</para>
+ <para> First, you should know what to transform:
<orderedlist numeration="loweralpha" inheritnum="inherit">
<listitem><para>Bind the "customerName" property of
the
Order#header to
@@ -219,12 +212,12 @@
</para>
<para> Make sense?</para>
<para> OK, let's select the "customerName" item of the
- "header" item on the source data tree and start to drag it. When
the drag item cross into the Mapping graphical area, we will see a connection line.
Drop the item onto the "customerName" of the
+ "header" item on the source data tree and start to drag it. When
the drag item crosses the Mapping graphical area, you will see a connection line. Drop
the item onto the "customerName" of the
"LineOrder" on the target data view.</para>
- <para> Now there will open a dialog to ask you to connect the root node:
+ <para> Now a dialog is oped asking you to connect the root node:
</para>
<figure>
- <title>A dialog to ask user to connect the root nodes</title>
+ <title>Dialog Asking You to Connect to the Root Nodes</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/java2java/connect_rootnode.png"
@@ -232,24 +225,23 @@
</imageobject>
</mediaobject>
</figure>
- <para> Please click "Yes" to connect the root node, if you
didn't do that, this dialog will open again when you connect other nodes.
+ <para> Please, click "Yes" to connect the root node, if you
didn't do that, this dialog will be opened again when you connect other nodes.
</para>
<tip>
<title>Note</title>
- <para>Please
+ <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, same with
- XML-to-Java too </para>
+ <para>This rule is not only for Java-to-Java, but the same is also relevant for
XML-to-Java </para>
</tip>
- <para> Now let's do the same operation with the
"customerNumber", that is the what we want to see:
+ <para> Now let's do the same operation with the
"customerNumber", that is what you want to see:
</para>
<figure>
- <title>Correctly mapping editor</title>
+ <title>Correctly Mapping Editor</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/java2java/java_connection1.png"
@@ -257,7 +249,7 @@
</imageobject>
</mediaobject>
</figure>
- <para>Next, we are going to try to bind the properties of the
+ <para>Next, you are going to bind the properties of the
"OrderItem" to the properties of the "LineItem".
</para>
<para>Select the "price" and drag it onto the
"unitPrice" of the other side tree viewer. The error message display
area will show an error:
@@ -272,13 +264,13 @@
</mediaobject>
</figure>
<para>How to deal with the error ?</para>
- <para>Please click the "Fix it" link, there pop a menu and
there are several "resolve methods" on the menu.
+ <para>Please click the "Fix it" link, a menu is popped-up with
several "resolve methods" on it.
</para>
<para> Select the first resolve method: 'Connect the
"OrderItem" to the
- "LineItem" ', then the "OrderItem" was
connected with the
+ "LineItem" ', then the "OrderItem" is
connected with the
"LineItem".
</para>
- <para>But the notify message area still show some other errors:
+ <para>But the notify message area still shows some other errors:
</para>
<figure>
<title>Connection Error 2</title>
@@ -289,28 +281,22 @@
</imageobject>
</mediaobject>
</figure>
- <para>OK,Deal it with the fire error ---- Click "Fix it" link
and select the first resolve method. The "orderItems" was connected
with the "lineItems".
+ <para>OK, let's deal with the fire error ---- Click "Fix
it" link and select the first resolve method. The "orderItems"
is connected with the "lineItems".
</para>
<tip>
<title>Tip</title>
<para>
- Why there will occur error?</para>
- <para> We will find that, if we only
- connect the
- property node without
- to connect the parent node of the
- property,
- the "connection error"
- will happen. </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 "connection error"
occur</para>
<para>The
connection of
the "price-to-unitPrice" is
the "Binding
Connection",
- but there need
+ but it needs
a "Instance
Creation
- Connection" ---- the
+ Connection" -the
connection
of
the
@@ -327,8 +313,8 @@
</imageobject>
</mediaobject>
</figure>
- <para>Now, we should save the file.The Smooks tools will generate the correct
configuration file contents.</para>
- <para>OK, Let run the test class: example.Main (Please make sure that the
Smooks engine load the correct configuration file)
+ <para>Now, you should save the file and the Smooks tools will generate the
correct configuration file content.</para>
+ <para>OK, Let run the test class: example.Main (Please, make sure that the
Smooks engine loads the correct configuration file)
</para>
<para>Success!
</para>
Modified:
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml
===================================================================
---
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2008-12-19
19:58:24 UTC (rev 12781)
+++
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2008-12-19
20:07:03 UTC (rev 12782)
@@ -41,7 +41,7 @@
<section id="configurationpage_parsetype">
<title>Smooks parse type</title>
<para>Open the "Other configuration" section, we will see there
- is a sets of radio buttons:</para>
+ is a set of radio buttons:</para>
<figure>
<title>Smooks parse type</title>
<mediaobject>
@@ -71,14 +71,14 @@
</figure>
<para>
There are three buttons on the right side of the "File Import"
- list. User can click those to add/edit/remove the import files.
+ 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 user double-click the import file in
+ If you double-click the import file in
the "Import File" list, the file will be open with a new default
editor.
</para>
@@ -125,7 +125,7 @@
</orderedlist>
</para>
<para>
- User can modify the parameters of the "Date Decoder" item with the
+ You can modify the parameters of the "Date Decoder" item with the
left detail page.
</para>
<figure>
@@ -138,7 +138,7 @@
</mediaobject>
</figure>
<para>
- When user defined new "Date Decoder", they can use the
+ 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".
</para>
<!--
Modified:
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml
===================================================================
---
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml 2008-12-19
19:58:24 UTC (rev 12781)
+++
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml 2008-12-19
20:07:03 UTC (rev 12782)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="smooksformeditor_graphicaltab" xreflabel="Smooks Graphical
Editor Page">
- <?dbhtml filename="smooks_form_editor_graphicaltab.html"?>
+ <?dbhtml filename="smooks_form_editor_graphicaltab.html"?>
<chapterinfo>
<keywordset>
<keyword>JBoss Tools</keyword>
@@ -9,7 +9,7 @@
</keywordset>
</chapterinfo>
<title>Smooks Graphical Editor Page</title>
- <para>
+ <para>
Smooks Graphical Editor Page is one tab of the Smooks Form
Editor.
</para>
@@ -23,24 +23,24 @@
</mediaobject>
</figure>
<para>
- This graphical editor could allow user to do drug/drop operations
- with the nodes of transform data to mapping the source data to target
+ 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 user save the graphical editor the correct Smooks
- configuration file contents
+ When you save the changes in the graphical editor the correct Smooks
+ configuration file content
will be generated.
</para>
<section>
- <title>Introduce the areas of graphical editor</title>
- <para> Please read the
+ <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> 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>
@@ -51,7 +51,7 @@
</imageobject>
</mediaobject>
</figure>
- <para> There are a sets of transform data type on the wizard page,select one
type and click
+ <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>
@@ -79,61 +79,60 @@
</imageobject>
</mediaobject>
</figure>
- <para> When finish the data selection(file path selection), Click
+ <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>User the graphical editor to mapping</title>
- <para> Please read the
+ <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>
</section>
<section>
<title>Error messages</title>
- <para> When user do any mapping operations, the Smooks tools will validate the
file contents with "Mapping Logic", If there is any errors of the configuration
file contents
- ,error messages will be shown on the
+ <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
+ <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> User can edit the properties of the "connection lines" with the
properties viewer.
+ <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 will be opened.
+ <para> Select the menu: "Window -> Show View -> Other ->
Properties", the properties viewer is opened.
</para>
<para>
- When user select on the connection lines, the properties viewer
- will show a sets of section GUI for editing the properties of the
+ 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>Note</title>
+ <title>Tip</title>
<para>
- These GUI on the properties viewer will be displayed when the
+ This GUI on the properties viewer is displayed when the
"Smooks
- Graphical Page" was active,if not the properties viewer will
- display empty GUI.
+ Graphical Page" is active, if not, the properties viewer
+ displays empty GUI.
</para>
<para>
- If the source data type of the selected connection line was
- "XML",The properties viewer will show a "XML Properties" section
+ If the source data type of the selected connection line is
+ "XML", The properties viewer shows a "XML Properties" section
GUI.
</para>
<para>
- But the source data type of the selected connection line was
- "Java",
- the "XML Properties" section GUI doesn't display.
+ 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 was different, the properties viewer will show
+ connection line is different, the properties viewer shows
different GUI.
</para>
</tip>
Modified:
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml
===================================================================
---
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml 2008-12-19
19:58:24 UTC (rev 12781)
+++
branches/jbosstools-3.0.0.CR1/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml 2008-12-19
20:07:03 UTC (rev 12782)
@@ -11,7 +11,7 @@
<title>Smooks Source Editor Page</title>
<section>
<title>XML Source Editor</title>
- <para> User can use this editor to edit the Smooks configuration file
directly.
+ <para>You can use this editor to edit the Smooks configuration file directly.
</para>
<figure>
<title>Graphical Editor</title>
@@ -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 was illegal(XML structure isn't right for Smooks configuration
file, etc.),The error message panel will display 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>
@@ -36,16 +36,16 @@
</imageobject>
</mediaobject>
</figure>
- <tip>
- <title>Note</title>
+ <note>
+ <title>Tip</title>
<para>
- When the error message panel was displayed, other editors (
- Graphical Editor, Configuration Editor ) will be disabled.
+ When the error message panel is displayed, other editors (
+ Graphical Editor, Configuration Editor ) are disabled.
</para>
<para>
- User can't edit the configuration file with other editors until
- file was right.
+ You can't edit the configuration file with other editors until
+ file becomes valid.
</para>
- </tip>
+ </note>
</section>
</chapter>
\ No newline at end of file