[jbosstools-commits] JBoss Tools SVN: r20724 - trunk/smooks/docs/reference/en-US.
jbosstools-commits at lists.jboss.org
jbosstools-commits at lists.jboss.org
Wed Mar 10 06:11:24 EST 2010
Author: ochikvina
Date: 2010-03-10 06:11:24 -0500 (Wed, 10 Mar 2010)
New Revision: 20724
Modified:
trunk/smooks/docs/reference/en-US/references.xml
trunk/smooks/docs/reference/en-US/tasks.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-1133 - corrected the issues of Smooks guide reported by Jiri Peterka.Updated "Apply Template" section and "Smooks Configuration testing using Smooks Run Configuration" section.</p>
</body></html>
Modified: trunk/smooks/docs/reference/en-US/references.xml
===================================================================
--- trunk/smooks/docs/reference/en-US/references.xml 2010-03-10 10:37:57 UTC (rev 20723)
+++ trunk/smooks/docs/reference/en-US/references.xml 2010-03-10 11:11:24 UTC (rev 20724)
@@ -208,27 +208,29 @@
<listitem><para><emphasis>CSV</emphasis></para><itemizedlist>
<listitem><para><emphasis>Fields</emphasis> - Comma separated list of CSV record field names
</para></listitem>
- <listitem><para><emphasis>Separator Character</emphasis> - Field separator character. Default of ','.
+ <listitem><para><emphasis>Separator Character</emphasis> - Field separator character.
</para></listitem>
- <listitem><para><emphasis>Quote Character</emphasis> - Quote character. Default of '"'.
+ <listitem><para><emphasis>Quote Character</emphasis> - Quote character.
</para></listitem>
- <listitem><para><emphasis>Record Name</emphasis> - Name of csv record element.Default:csv-record</para></listitem>
- <listitem><para><emphasis>Root Name</emphasis> - Name of csv root element.Default:csv-set</para></listitem>
- <listitem><para><emphasis>indent</emphasis> - Add indentation character data to the generated event stream. This simply makes
+ <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.Default:true
+ testing etc.
</para></listitem>
- <listitem><para><emphasis>Skip Lines</emphasis> - Number of lines to skip before processing starts. Default of 0.
-
+ <listitem><para><emphasis>Skip Lines</emphasis> - Number of lines to skip before processing starts.
</para></listitem>
</itemizedlist>
</listitem>
<listitem><para><emphasis>EDI</emphasis></para>
<itemizedlist>
- <listitem><para><emphasis>Target Profile</emphasis> - Defines the target profile
+ <listitem><para><emphasis>Target Profile</emphasis> - Defines the output
+ transformation profile
</para></listitem>
- <listitem><para><emphasis>Encoding</emphasis> - The character encoding. Default "UTF-8"</para></listitem>
- <listitem><para><emphasis>Mapping Model</emphasis> - Defines the EDI Mapping Model configuration for processing the
+ <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.
@@ -240,16 +242,16 @@
<listitem><para><emphasis>JSON</emphasis></para>
<itemizedlist>
<listitem><para><emphasis>Target Profile</emphasis> - Defines the output transformation profile</para></listitem>
- <listitem><para><emphasis>Array Element Name</emphasis> - The element name of a array element. Default of 'element'.
+ <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. Default of 'UTF-8'.</para></listitem>
+ 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.Default:false.
+ 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.
@@ -257,8 +259,8 @@
<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. Default is ""(an empty string). </para></listitem>
- <listitem><para><emphasis>Root Name</emphasis> - The element name of the document root. Default of 'json'.
+ <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.
Modified: trunk/smooks/docs/reference/en-US/tasks.xml
===================================================================
--- trunk/smooks/docs/reference/en-US/tasks.xml 2010-03-10 10:37:57 UTC (rev 20723)
+++ trunk/smooks/docs/reference/en-US/tasks.xml 2010-03-10 11:11:24 UTC (rev 20724)
@@ -10,7 +10,9 @@
</chapterinfo>
<title>Tasks</title>
<para>This chapter describes the main tasks a user can be faced during Smooks tools usage.
- Here we use the example that can be downloaded from <ulink url="http://sourceforge.net/projects/smooks/files/Smooks%20v1.2/Smooks%20v1.2/smooks-examples-1.2.4.zip/download">here</ulink> </para>
+ In this chapter we use the example that can be downloaded from
+ <ulink url="http://anonsvn.jboss.org/repos/jbosstools/trunk/smooks/docs/reference/xml-to-java.zip">
+ 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,
@@ -180,7 +182,7 @@
</mediaobject>
</figure>
<para>
- On the next wizard page put the following string into the Fields,select Output fields Names and click <property>Finish</property>.</para>
+ On the next wizard page put the following string into the Fields,select <property>Output Fields Names</property> and click <property>Finish</property>.</para>
<figure>
<title>CSV output message configuration</title>
<mediaobject>
@@ -190,11 +192,15 @@
</mediaobject>
</figure>
<para>
- After these steps "Apply Template" task will appear to the right, connected to the task you created it from.
+ After these steps <property>"Apply Template"</property>
+ task will appear to the right, connected to the task you created it from.
To continue the process of configuration you should click on it and find <emphasis>CSV Template</emphasis>
- item with entered fields on the canvas.Now you can click and drag from various input elements to corresponding output elements
- in the template. Make sure to connect collection elements to corresponding <emphasis>csv-record</emphasis>
- In our example we transfer into CSV output only the elements of orderItems collection(see picture below)
+ item with entered fields on the canvas.Now you can click and drag from various
+ input elements to corresponding output elements
+ in the template. Make sure to connect collection elements to the c
+ orresponding <emphasis>csv-record</emphasis>.
+ In our example we transfer into CSV output only the elements
+ of <property>orderItems</property> collection (see the picture below):
</para>
<figure>
<title>Relations between input and output models</title>
More information about the jbosstools-commits
mailing list