[jbosstools-commits] JBoss Tools SVN: r22663 - in tags/jbosstools-3.1.1.GA/smooks/docs: reference and 7 other directories.

Author: irooskov(a)redhat.com Date: 2010-06-08 20:37:26 -0400 (Tue, 08 Jun 2010) New Revision: 22663 Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Author_Group.xml tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Book_Info.xml tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Feedback.xml tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Preface.xml tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Revision_History.xml tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/favicon.ico tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/introduction/ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/introduction/introduction1.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/introduction/introduction2.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/jbosstools_logo.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process1.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process2.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process3.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process4.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process5.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process6.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process7.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process7a.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process7b.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process7c.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process8.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start1.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start10.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start11.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start12.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start13a.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start2.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start6.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start7.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start8.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start9.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start9a.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start9b.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start9c.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start_6a.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/sourcemodel_structured.jpg tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/targetmodel_structured.jpg tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_1.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_10.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_11.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_12.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_13.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_14.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_15.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_16.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_17.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_18.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_19.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_2.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_20.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_21.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_22.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_23.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_24.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_25.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_3.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_4.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_5.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_6.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_7.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_7a.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_8.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_9.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/source_editor/ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/source_editor/smooks_conf_validator.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/source_editor/smooks_conf_validator_settings.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/source_editor/source_editor1.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/source_editor/source_editor2.png tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/introduction.xml tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/master.xml tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/master_output.xml tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/references.xml tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/summary.xml tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/tasks.xml tags/jbosstools-3.1.1.GA/smooks/docs/reference/pom.xml tags/jbosstools-3.1.1.GA/smooks/docs/reference/publican.cfg tags/jbosstools-3.1.1.GA/smooks/docs/reference/test.txt tags/jbosstools-3.1.1.GA/smooks/docs/reference/xml-to-java.zip Log: uploading Smooks ref guide restructured Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Author_Group.xml =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Author_Group.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Author_Group.xml 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,7 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup><author> + <firstname>Xue(Dart)</firstname> + <surname>Peng</surname> + </author></authorgroup> Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Book_Info.xml =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Book_Info.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Book_Info.xml 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<bookinfo><title>Smooks Developer Tools Reference Guide</title><subtitle>Provides information relating to the Smooks Tools module.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The Smooks Developer Tools Reference Guide explains how to use Smooks Tools to graphically edit Smooks configuration files.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Feedback.xml =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Feedback.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Feedback.xml 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,20 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<section id="sect-Beginners_Guide-We_Need_Feedback" lang="en-US"> + <title>We Need Feedback!</title> + <indexterm> + <primary>feedback</primary> + <secondary>contact information for this manual</secondary> + </indexterm> + <para> + If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA against JBoss Developer Studio: <ulink url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=1231050... + </para> + <para> + When submitting a bug report, be sure to mention the manual's name and to select the "documentation" component. + </para> + <para> + If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily. + </para> +</section> + + Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Preface.xml =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Preface.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Preface.xml 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<preface><title>Preface</title><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Revision_History.xml =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Revision_History.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Revision_History.xml 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<appendix><title>Revision History</title><simpara><revhistory><revision><revnumber>0</revnumber><date>Fri Nov 20 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov@redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "Smooks_Developer_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,12 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<book> +<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="references.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="summary.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +</book> Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/introduction/introduction1.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/introduction/introduction1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/introduction/introduction2.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/introduction/introduction2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process1.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process2.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process3.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process4.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process5.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process6.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process7.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process7a.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process7a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process7b.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process7b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process7c.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process7c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process8.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/process_page/process8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start1.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start10.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start11.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start11.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start12.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start12.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start13a.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start13a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start2.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start6.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start7.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start8.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start9.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start9a.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start9a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start9b.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start9b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start9c.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start9c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start_6a.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/quick_start_6a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/sourcemodel_structured.jpg =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/sourcemodel_structured.jpg ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/targetmodel_structured.jpg =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/quick_start/targetmodel_structured.jpg ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_1.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_10.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_11.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_11.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_12.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_12.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_13.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_13.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_14.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_14.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_15.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_15.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_16.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_16.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_17.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_17.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_18.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_18.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_19.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_19.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_2.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_20.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_20.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_21.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_21.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_22.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_22.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_23.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_23.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_24.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_24.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_25.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_25.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_3.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_4.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_5.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_6.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_7.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_7a.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_7a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_8.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_9.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/reference/reference_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/source_editor/smooks_conf_validator.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/source_editor/smooks_conf_validator.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/source_editor/smooks_conf_validator_settings.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/source_editor/smooks_conf_validator_settings.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/source_editor/source_editor1.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/source_editor/source_editor1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/source_editor/source_editor2.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/images/source_editor/source_editor2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/introduction.xml =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/introduction.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/introduction.xml 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,195 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="introduction"> + <?dbhtml filename="introduction.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Smooks</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Introduction</title> + <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> + <para>Here, we provide you with a key functionality which is integrated in Smooks tools.</para> + <table> + + <title>Key Functionality for Smooks Tools</title> + <tgroup cols="3"> + + <colspec colnum="1" align="left" colwidth="2*"/> + <colspec colnum="2" colwidth="4*"/> + <colspec colnum="3" align="left" colwidth="2*"/> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <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> + <link linkend="config_file_wizzard">Smooks Configuration File Wizard</link> + </entry> + </row> + + <row> + <entry><para>Smooks Editor</para></entry> + <entry><para>Smooks Editor helps configure the created Smooks configuration file.</para></entry> + <entry> + <link linkend="process_tab">Smooks Editor</link> + </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/> + <para> + <orderedlist numeration="upperroman" inheritnum="inherit"> + <listitem> + <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 + Model from any data source (CSV, EDI, XML, Java, JSON etc). </para> + </listitem> + + <listitem> + <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 + data from a Database, or other Datasources. </para> + </listitem> + + <listitem> + <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> + </orderedlist> + </para> + <figure> + <title>Smooks</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/introduction/introduction1.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <para> For more informations about <property>Smooks</property>, please visit <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> + <figure> + <title>Smooks Form editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/introduction/introduction2.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <!-- <para>The easiest way to use the Smooks Configuration Editor is to create a project + (Java project, an ESB project, etc.), right-click on it and select <property>New -> Other</property> + to open the New wizard. Drill into <property>Smooks -> Smooks Configuration File</property> + and continue through the wizard. + Once the file is created, it will open in the Smooks Configuration Editor.</para> --> + </section> + <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> + <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> + </itemizedlist> + + <figure> + <title>Smooks Form editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/introduction/introduction2.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <!-- <para>The easiest way to use the Smooks Configuration Editor is to create a project + (Java project, an ESB project, etc.), right-click on it and select <property>New -> Other</property> + to open the New wizard. Drill into <property>Smooks -> Smooks Configuration File</property> + and continue through the wizard. + Once the file is created, it will open in the Smooks Configuration Editor.</para> --> + </section> + <!-- <section> + <title>How to install Smooks dev tools?</title> + + <para> The Smooks tools was included by the <property>JBoss Tools</property> since 3.0.0 + Beta1 version. You can download the <property>JBoss Tools</property> from <ulink + url="http://jboss.org/tools/download.html">JBoss download site</ulink>.</para> + <para> Smooks tools (<property>JBoss Tools</property>) 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 <ulink + url="http://www.eclipse.org/downloads/"> Eclipse site</ulink>. It contains many plug-ins ( + GEF, EMF, etc. ) required by Smooks dev tools. </para> + <para>The Smooks Configuration depends on having all of the appropriate Smooks runtime jars in the path of the Eclipse Plug-in or Java Project in the Eclipse workspace. + + The easiest solution is to do the following: + <itemizedlist> + <listitem><para>1) Download the Smooks distribution from here: http://www.smooks.org/mediawiki/index.php?title=Downloads . + Grab the latest "ALL" distribution (as of today, it is the Smooks v.1.2.2 "ALL" distribution) and it will include binaries, examples, etc.</para></listitem> + <listitem><para>2) Extract files from the archive somewhere on your machine.</para></listitem> + <listitem><para>3) In your Eclipse workspace, copy the Smooks jars into a directory of your Eclipse plug-in or Java project named "lib".</para></listitem> + <listitem><para>4) For your Eclipse Plug-in or Java Project, right-click on the project and select Properties.</para></listitem> + <listitem><para>5) Select the "Java Build Path" item in the Properties list, select the Libraries tab, and click "Add JARs" + </para></listitem> + <listitem><para>6) In the Jar Selection dialog, select all the jars in the "lib" directory mentioned in step 3 and click <property>OK</property>. + </para></listitem> + <listitem><para>7) Click <property>OK</property> to close the Properties dialog. Now you should see a "Referenced Libraries" node that appeared in your project hierarchy in Eclipse. + </para></listitem> + </itemizedlist> + + </para> + <para>Now let's progress to more advanced topics.</para> + </section> + --> +</chapter> Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/master.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/master.xml 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[ +<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY tasks SYSTEM "tasks.xml"> +<!ENTITY references SYSTEM "references.xml"> +<!ENTITY summary SYSTEM "summary.xml"> +]> +<book> + + <bookinfo> + + <title>Smooks Developer Tools Reference Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author> + <firstname>Xue(Dart)</firstname> + <surname>Peng</surname> + </author> + <copyright> + <year>2009,2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 1.1.1.GA + </releaseinfo> + + <abstract> + <title/> + <para> + <ulink + url="http://download.jboss.org/jbosstools/nightly-docs/en/smooks/pdf... version</ulink> + </para> + </abstract> + + + </bookinfo> + <toc/> + &introduction; + &tasks; + &references; + &summary; +</book> Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/master_output.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/master_output.xml 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,1422 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[ +<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY tasks SYSTEM "tasks.xml"> +<!ENTITY references SYSTEM "references.xml"> +<!ENTITY summary SYSTEM "summary.xml"> +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + + <title>Smooks Developer Tools Reference Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author> + <firstname>Xue(Dart)</firstname> + <surname>Peng</surname> + </author> + <copyright> + <year>2009,2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> + Version: 1.1.1.GA + </diffmk:wrapper></releaseinfo> + + <abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/smooks/pdf... version</ulink> + </para> + </abstract> + + + </bookinfo> + <toc></toc> + +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/smooks/docs/reference/en-US/introduction.xml"> + <?dbhtml filename="introduction.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Smooks</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Introduction</title> + <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> + <para>Here, we provide you with a key functionality which is integrated in Smooks tools.</para> + <table> + + <title>Key Functionality for Smooks Tools</title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <colspec align="left" colnum="3" colwidth="2*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <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> + <link linkend="config_file_wizzard">Smooks Configuration File Wizard</link> + </entry> + </row> + + <row> + <entry><para>Smooks Editor</para></entry> + <entry><para>Smooks Editor helps configure the created Smooks configuration file.</para></entry> + <entry> + <link linkend="process_tab">Smooks Editor</link> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + + + </section> + + + + <section> + <title>What is Smooks?</title> + + <para><property moreinfo="none">Smooks</property> is a Java Framework/Engine for processing XML and non XML + data (CSV, EDI, Java, JSON etc).It provides: </para> + <para></para> + <para> + <orderedlist continuation="restarts" inheritnum="inherit" numeration="upperroman"> + <listitem> + <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 + Model from any data source (CSV, EDI, XML, Java, JSON etc). </para> + </listitem> + + <listitem> + <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 + data from a Database, or other Datasources. </para> + </listitem> + + <listitem> + <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> + </orderedlist> + </para> + <figure float="0"> + <title>Smooks</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/introduction/introduction1.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> For more informations about <property moreinfo="none">Smooks</property>, please visit <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> + <figure float="0"> + <title>Smooks Form editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/introduction/introduction2.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <!-- <para>The easiest way to use the Smooks Configuration Editor is to create a project + (Java project, an ESB project, etc.), right-click on it and select <property>New -> Other</property> + to open the New wizard. Drill into <property>Smooks -> Smooks Configuration File</property> + and continue through the wizard. + Once the file is created, it will open in the Smooks Configuration Editor.</para> --> + </section> + <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> + <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 moreinfo="none">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> + </itemizedlist> + + <figure float="0"> + <title>Smooks Form editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/introduction/introduction2.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <!-- <para>The easiest way to use the Smooks Configuration Editor is to create a project + (Java project, an ESB project, etc.), right-click on it and select <property>New -> Other</property> + to open the New wizard. Drill into <property>Smooks -> Smooks Configuration File</property> + and continue through the wizard. + Once the file is created, it will open in the Smooks Configuration Editor.</para> --> + </section> + <!-- <section> + <title>How to install Smooks dev tools?</title> + + <para> The Smooks tools was included by the <property>JBoss Tools</property> since 3.0.0 + Beta1 version. You can download the <property>JBoss Tools</property> from <ulink + url="http://jboss.org/tools/download.html">JBoss download site</ulink>.</para> + <para> Smooks tools (<property>JBoss Tools</property>) 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 <ulink + url="http://www.eclipse.org/downloads/"> Eclipse site</ulink>. It contains many plug-ins ( + GEF, EMF, etc. ) required by Smooks dev tools. </para> + <para>The Smooks Configuration depends on having all of the appropriate Smooks runtime jars in the path of the Eclipse Plug-in or Java Project in the Eclipse workspace. + + The easiest solution is to do the following: + <itemizedlist> + <listitem><para>1) Download the Smooks distribution from here: http://www.smooks.org/mediawiki/index.php?title=Downloads . + Grab the latest "ALL" distribution (as of today, it is the Smooks v.1.2.2 "ALL" distribution) and it will include binaries, examples, etc.</para></listitem> + <listitem><para>2) Extract files from the archive somewhere on your machine.</para></listitem> + <listitem><para>3) In your Eclipse workspace, copy the Smooks jars into a directory of your Eclipse plug-in or Java project named "lib".</para></listitem> + <listitem><para>4) For your Eclipse Plug-in or Java Project, right-click on the project and select Properties.</para></listitem> + <listitem><para>5) Select the "Java Build Path" item in the Properties list, select the Libraries tab, and click "Add JARs" + </para></listitem> + <listitem><para>6) In the Jar Selection dialog, select all the jars in the "lib" directory mentioned in step 3 and click <property>OK</property>. + </para></listitem> + <listitem><para>7) Click <property>OK</property> to close the Properties dialog. Now you should see a "Referenced Libraries" node that appeared in your project hierarchy in Eclipse. + </para></listitem> + </itemizedlist> + + </para> + <para>Now let's progress to more advanced topics.</para> + </section> + --> +</chapter> + + +<chapter id="process_page" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/smooks/docs/reference/en-US/tasks.xml"> + <?dbhtml filename="tasks.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Smooks</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Tasks</title> + <para><diffmk:wrapper diffmk:change="added">This chapter describes the main tasks a user can be faced during Smooks tools usage. + In this chapter we use the example that can be downloaded from + </diffmk:wrapper><ulink diffmk:change="added" url="http://anonsvn.jboss.org/repos/jbosstools/trunk/smooks/docs/ref... diffmk:change="added"> + here</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></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 moreinfo="none">New &gt; Other</property>,</emphasis> then find + <emphasis><property moreinfo="none">Smooks &gt; Smooks Configuration File</property>.</emphasis> + Click the <emphasis> + <property moreinfo="none">Next</property> + </emphasis> button. </para> + <figure float="0"> + <title>Selecting Smooks Configuration File Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start1.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para><diffmk:wrapper diffmk:change="changed">The wizard page is a file path creation page. Select the </diffmk:wrapper><emphasis> + <property moreinfo="none">src</property> + </emphasis> folder to be the files container, and input the name + <emphasis><property moreinfo="none">smooks-config.xml</property>.</emphasis> Click + <emphasis><property moreinfo="none">Next</property>.</emphasis></para> + <figure float="0"> + <title>Choosing the configuration file container and the file name</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start2.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + <section> + <title>Input Task Configuring</title> + <para> + <property moreinfo="none">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. + </para> + <figure float="0"> + <title>Input Task Configuring</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process1.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Select it and you will see all the properties to set for the Input reader of your Smooks configuration. + "Input type" corresponds to the type of data that you will be working with. + For example, to work with incoming CSV (Comma-separated Values) data, you would specify "CSV" in the drop-down list. + 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. + </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><diffmk:wrapper diffmk:change="added"> section. + On the picture below you can see the correct configuration of some XML input task where </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">input-message.xml</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> is set as an input data file. + </diffmk:wrapper></para> + <figure float="0"> + <title>Input Task Configuring</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process2.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <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). + <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> + </note> + </para> + </section> + <section id="mapping"> + <title>Java Mapping Task</title> + + <para> + If you decide to do Java Mapping, you need to make sure that your Input reader has been set up and you have some sample data specified. + Then you should select <emphasis>Input Task</emphasis> in the Process tab and click the plus (+) sign to the right of the icon. + Select <emphasis>Java Mapping</emphasis> from the popup menu and it will appear to the right, connected to <emphasis>Input Task</emphasis>. Then select <emphasis>Java Mapping</emphasis> task. + </para> + <figure float="0"> + <title>Java Mapping configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Another method of adding <emphasis>Java Mapping</emphasis> element + to the canvas in the Processing Tasks section is to right click Input Task + element and select <emphasis>Java Mapping</emphasis><diffmk:wrapper diffmk:change="changed"> in the popup menu. </diffmk:wrapper></para> + <figure float="0"> + <title>Java Mapping configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> + Right-click on the canvas in an empty space and select "Add -&gt;Java Class". + </para> + <figure float="0"> + <title>Java Mapping configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> + <emphasis>Java Bean Creation</emphasis><diffmk:wrapper diffmk:change="changed"> wizard appears. + Specify a unique identifier for the new class, the class path. + If the Java class is specified, you'll see a list of the properties in the box below. + Click </diffmk:wrapper><emphasis>Finish</emphasis> when you're done. + Now with the input and output models on the canvas, you can click and drag + from the various input elements to corresponding output elements. + Make sure to connect collection elements to corresponding collection elements. + Finally your mapping should look nearly like the one on the picture below. + </para> + <figure float="0"> + <title>Final Mapping schema</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For details, also see the movie, + </diffmk:wrapper><ulink diffmk:change="added" url="http://www.screencast.com/users/tfennelly/folders/Camtasia/medi... diffmk:change="added">"XML to Java"</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. + </diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you are interested in transforming EDI to Java, please, follow the + </diffmk:wrapper><ulink diffmk:change="added" url="http://www.screencast.com/users/tfennelly/folders/Camtasia/medi... diffmk:change="added">link</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </section> + <section> + <title>Apply Template Task</title> + + <para>The "Apply Template" task works very similarly to the <link linkend="mapping">"Java Mapping" task</link>, where you map between an input model and an output model. + Select the <emphasis>Java Mapping</emphasis> task you want to use as the input model in the Process Map pane and click the plus (+) sign to the right of the icon. + </para> + <figure float="0" id="apply_templ"> + <title>Apply Template configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> + The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Message Type Selection</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> wizard will appear. + In our example we will transfer our data to csv output format,so you should select </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">CSV</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and click </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Message Type Selection</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/process_page/process7a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para><diffmk:wrapper diffmk:change="added"> + On the next wizard page put the following string into the Fields,select </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Output Fields Names</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and click </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">CSV output message configuration</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/process_page/process7b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> + After these steps </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">"Apply Template"</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> + 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 </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">CSV Template</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> + 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 </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">csv-record</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added">. + In our example we transfer into CSV output only the elements + of </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">orderItems</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> collection (see the picture below): + </diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Relations between input and output models</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/process_page/process7c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Smooks Configuration testing using Smooks Run Configuration</title> + + <para><diffmk:wrapper diffmk:change="added">This option is intended to view the results of Smooks transforming procedure. + To do the testing you should select your </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Smooks Configuration file</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> you want to transfer in the Project Navigator or open it in + the Smooks Configuration Editor and then select "Run As..." from the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Run</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> + toolbar button + or </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Run-&gt;Smooks Run Configuration</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> option in the top menu bar. And Smooks Configuration file will be run automatically. + </diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Smooks Configuration testing</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/process_page/process8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If any errors or warnings appear, they will pop up in a dialog. + The output of the test will appear in the Console view. + In our case the following streaming output will appear:</diffmk:wrapper></para> + <programlisting diffmk:change="added" format="linespecific" role="JAVA"><diffmk:wrapper diffmk:change="added"><![CDATA[[Stream Templating Result ...] + |-- + |"productId","quantity","price" + |"111","2","8.9" + |"222","7","5.2" + |-- + +[Java Mapping Results...] + |-- + |> order (beanId = "order") + | > header (beanId = "header") + | > date = "2006-11-15 20:45:28.0 EET" + | > customerNumber = 123123L + | > customerName = "Joe" + | > orderItems (beanId = "orderItems") + | > example.model.OrderItem (beanId = "orderItem") + | > productId = 111L + | > quantity = 2I + | > price = 8.9D + | > example.model.OrderItem (beanId = "orderItem") + | > productId = 222L + | > quantity = 7I + | > price = 5.2D + |-- +]]></diffmk:wrapper></programlisting> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If the test runs but doesn't generate any streaming output the Console output will be the following: + </diffmk:wrapper></para> + <programlisting diffmk:change="added" format="linespecific" role="JAVA"><diffmk:wrapper diffmk:change="added"><![CDATA[ Nothing to Display: + - No Java Mappings. + - No Templates Applied.]]></diffmk:wrapper> + </programlisting> + + </section> +</chapter> + + + +<chapter id="reference" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/smooks/docs/reference/en-US/references.xml"> + <?dbhtml filename="reference.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Smooks</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Reference</title> + <para><diffmk:wrapper diffmk:change="added">This chapter includes detailed reference information about all tabs of the Smooks Configuration Editor.</diffmk:wrapper></para> + <section id="process_tab"> + <title>Process tab</title> + <para><diffmk:wrapper diffmk:change="changed">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:</diffmk:wrapper><emphasis>Open With-&gt;Smooks Configuration Editor</emphasis>.</para> + <para>The Process tab has two sections:</para> + <itemizedlist> + <listitem><para><link linkend="processing_task_section">Processing Task section</link></para></listitem> + <listitem><para><link linkend="selected_task_details">Selected Task Details section</link></para></listitem> + </itemizedlist> + <para>You can see them on the picture below.</para> + <figure float="0"> + <title>Two Sections of the Process tab.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_1.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <section id="processing_task_section"> + <title>Processing Task section</title> + <para><diffmk:wrapper diffmk:change="changed">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: </diffmk:wrapper></para> + <para>The descriptions of the popup menu options are in the following table.</para> + <table> + <title>Process Tab. Processing Task section.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Add Task</entry> + <entry><diffmk:wrapper diffmk:change="changed">Select one of the following tasks according to the necessary type of Source and Result types of the files: + </diffmk:wrapper><itemizedlist> + <listitem><para><emphasis>Input</emphasis><diffmk:wrapper diffmk:change="changed"> - this task is required and + appears automatically when Smooks config file is created. + You should just configure it properly.</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Java Mapping</emphasis></para></listitem> + <listitem><para><emphasis>Apply Template</emphasis></para></listitem> + </itemizedlist> + </entry> + <entry></entry> + </row> + + <row> + <entry>Delete</entry> + <entry><diffmk:wrapper diffmk:change="changed">Click this option if you want to delete some task from the section. + Note:you can't delete input task because it's required.</diffmk:wrapper></entry> + <entry></entry> + + </row> + + <row> + <entry>Input Methods</entry> + <entry><diffmk:wrapper diffmk:change="changed">Choose one of the following methods: + </diffmk:wrapper><itemizedlist> + <listitem><para>System</para></listitem> + <listitem><para>Simple</para></listitem> + <listitem><para>Amharic(EZ+)</para></listitem> + <listitem><para>Cedilla</para></listitem> + <listitem><para>Cyrillic</para></listitem> + <listitem><para>Inuktitut</para></listitem> + <listitem><para>IPA</para></listitem> + <listitem><para>Multipress</para></listitem> + <listitem><para>SCIM Bridge Input Method</para></listitem> + <listitem><para>SCIM Input Method</para></listitem> + <listitem><para>Thai-Lio</para></listitem> + <listitem><para>Tigrigna-Eritrean(EZ+)</para></listitem> + <listitem><para>Tigrigna-Ethiopian(EZ+)</para></listitem> + <listitem><para>Vietnamese</para></listitem> + <listitem><para>X input Method</para></listitem> + </itemizedlist> + </entry> + <entry>System</entry> + </row> + </tbody> + </tgroup> + </table> + </section> + <section id="selected_task_details"> + <title>Selected Task Details Section</title> + <para><diffmk:wrapper diffmk:change="changed">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. </diffmk:wrapper></para> + <section> + <title>Selected Task Details Section for Input Task.</title> + <para><diffmk:wrapper diffmk:change="changed">On the picture below you can find an example of Selected Task Details Section view + if XML is selected as input type.</diffmk:wrapper></para> + + <figure float="0"> + <title>Selected Task Details Section for Input XML Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_2.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para><diffmk:wrapper diffmk:change="changed">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.</diffmk:wrapper></para> + + <para>Here are the screens of these configuration options:</para> + <itemizedlist> + <listitem><para>CSV:</para> + <figure float="0"> + <title>Selected Task Details Section for Input CSV Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>EDI:</para> + <figure float="0"> + <title>Selected Task Details Section for Input EDI Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>JSON:</para> + <figure float="0"> + <title>Selected Task Details Section for Input JSON Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>Custom:</para> + <figure float="0"> + <title>Selected Task Details Section for Input Custom Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>All the input task configuration positions can be found in the table below:</para> + <table> + <title>Selected Task Details Section. Options for Input Task.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Input type</entry> + <entry><diffmk:wrapper diffmk:change="changed">Select your type of input file. + If don't find your type in the list,you should use Custom type: + </diffmk:wrapper><itemizedlist> + <listitem><para>No Input</para></listitem> + <listitem><para>XML</para></listitem> + <listitem><para>Java</para></listitem> + <listitem><para>XSD/WSDL</para></listitem> + <listitem><para>CSV</para></listitem> + <listitem><para>EDI</para></listitem> + <listitem><para>JSON</para></listitem> + <listitem><para>Custom</para></listitem> + </itemizedlist> + </entry> + <entry>XML</entry> + </row> + + <row> + <entry><diffmk:wrapper diffmk:change="changed">Input configuration + + </diffmk:wrapper></entry> + <entry> + <itemizedlist> + <listitem><para><emphasis>No Input</emphasis><diffmk:wrapper diffmk:change="changed"> - no info required</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>XML</emphasis><diffmk:wrapper diffmk:change="changed"> - no info required</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Java</emphasis><diffmk:wrapper diffmk:change="changed"> - no info required</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>XSD/WSDL</emphasis><diffmk:wrapper diffmk:change="changed"> - no info required</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>CSV</emphasis></para><itemizedlist> + <listitem><para><emphasis>Fields</emphasis><diffmk:wrapper diffmk:change="changed"> - Comma separated list of CSV record field names + </diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Separator Character</emphasis><diffmk:wrapper diffmk:change="changed"> - Field separator character. + </diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Quote Character</emphasis><diffmk:wrapper diffmk:change="changed"> - Quote character. + </diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Record Name</emphasis><diffmk:wrapper diffmk:change="changed"> - Name of csv record element.</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Root Name</emphasis><diffmk:wrapper diffmk:change="changed"> - Name of csv root element.</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>indent</emphasis><diffmk:wrapper diffmk:change="changed"> - 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. + </diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Skip Lines</emphasis><diffmk:wrapper diffmk:change="changed"> - Number of lines to skip before processing starts. + </diffmk:wrapper></para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>EDI</emphasis></para> + <itemizedlist> + <listitem><para><emphasis>Target Profile</emphasis><diffmk:wrapper diffmk:change="changed"> - Defines the output + transformation profile + </diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Encoding</emphasis><diffmk:wrapper diffmk:change="changed"> - The character encoding.</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Mapping Model</emphasis><diffmk:wrapper diffmk:change="changed"> - Defines the EDI Mapping Model + configuration for processing the + EDI message stream to a stream of SAX events that can be processed by Smooks.</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Validate</emphasis><diffmk:wrapper diffmk:change="changed"> - 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. + </diffmk:wrapper></para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>JSON</emphasis></para> + <itemizedlist> + <listitem><para><emphasis>Target Profile</emphasis><diffmk:wrapper diffmk:change="changed"> - Defines the output transformation profile</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Array Element Name</emphasis><diffmk:wrapper diffmk:change="changed"> - The element name of an array element. + </diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Encoding</emphasis><diffmk:wrapper diffmk:change="changed"> - encoding: The default encoding of any JSON message + InputStream processed by this Reader.</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Illegal Element Name Char Replacement</emphasis><diffmk:wrapper diffmk:change="changed"> - 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. + </diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Indent</emphasis><diffmk:wrapper diffmk:change="changed"> - 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. + </diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Key Prefix on Numeric</emphasis><diffmk:wrapper diffmk:change="changed"> - 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. + </diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Key Whitespace Replacement</emphasis><diffmk:wrapper diffmk:change="changed"> - The replacement character for whitespaces in a JSON map key. + By default this not defined, so that the reader doesn't search for whitespaces. + </diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Null Value Replacement</emphasis><diffmk:wrapper diffmk:change="changed"> - The replacement string for JSON NULL values.</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Root Name</emphasis><diffmk:wrapper diffmk:change="changed"> - The element name of the document root. + </diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Key Maps</emphasis><diffmk:wrapper diffmk:change="changed"> - Defines a JSON element name mapping + The "from" key will be replaced with the "to" key or the contents of the element. + </diffmk:wrapper></para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>Custom</emphasis></para> + <itemizedlist> + <listitem><para><emphasis>Target Profile</emphasis><diffmk:wrapper diffmk:change="changed"> - Defines the output transformation profile</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Class</emphasis><diffmk:wrapper diffmk:change="changed"> - Custom reader class.</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Handlers</emphasis><diffmk:wrapper diffmk:change="changed"> - Set a handler on the reader instance e.g. an EntityResolver, ErrorHandler etc. + </diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Features</emphasis><diffmk:wrapper diffmk:change="changed"> - Reader Features List</diffmk:wrapper></para></listitem> + <listitem><para><emphasis>Parametres</emphasis><diffmk:wrapper diffmk:change="changed"> - Resource Parameters</diffmk:wrapper></para></listitem> + + </itemizedlist> + </listitem> + </itemizedlist></entry> + <entry><itemizedlist> + <listitem><para><emphasis>CSV</emphasis></para><itemizedlist> + <listitem><para>not defined</para></listitem> + <listitem><para>','</para></listitem> + <listitem><para>'"'</para></listitem> + <listitem><para>csv-record</para></listitem> + <listitem><para>csv-set</para></listitem> + <listitem><para>true</para></listitem> + <listitem><para>0</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>EDI</emphasis></para> + <itemizedlist> + <listitem><para>not defined</para></listitem> + <listitem><para>UTF-8</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>true</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>JSON</emphasis></para> + <itemizedlist> + <listitem><para>not defined</para></listitem> + <listitem><para>element</para></listitem> + <listitem><para>UTF-8</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>false</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>""(an empty string)</para></listitem> + <listitem><para>'json'</para></listitem> + <listitem><para>not defined</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>Custom</emphasis></para> + <itemizedlist> + <listitem><para>no defaults</para></listitem> + + </itemizedlist> + </listitem> + </itemizedlist></entry> + </row> + <row> + <entry>Input Data</entry> + <entry>You should select a data file using <emphasis>Add</emphasis> and <emphasis>Delete</emphasis> buttons</entry> + <entry></entry> + </row> + <row> + <entry>Input Model View</entry> + <entry><diffmk:wrapper diffmk:change="changed">Using this view you can see the structure of your input file.If the file has been changed, to see the changes + click </diffmk:wrapper><emphasis>Refresh</emphasis>link.</entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + <section id="mapping_task"><title>Selected Task Details section for Java Mapping Task.</title> + <para><diffmk:wrapper diffmk:change="changed">Selected Task Details section for this task is presented by the graf, + that lighten the process of java mapping. </diffmk:wrapper></para> + <figure float="0"> + <title>Selected Task Details Section for Mapping Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_7.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">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. </diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Using the popup menu in the </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Selected Task Details</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> section you + can manage the diagram elements on the canvas. </diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The descriptions of the popup menu options are in the following table.</diffmk:wrapper></para> + <table diffmk:change="added" id="popup"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Popup menu. Selected Task Details section.</diffmk:wrapper></title> + <tgroup cols="3" diffmk:change="added"> + <colspec align="left" colnum="1" colwidth="1*" diffmk:change="added"></colspec> + <colspec align="left" colnum="2" colwidth="3*" diffmk:change="added"></colspec> + <colspec align="left" colnum="3" colwidth="1*" diffmk:change="added"></colspec> + + <thead diffmk:change="added"> + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Option</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Description</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Default</diffmk:wrapper></entry> + </row> + </thead> + <tbody diffmk:change="added"> + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Add</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Select one of the following tasks: + </diffmk:wrapper><itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Java Class</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - adds bean context item to the config file. + This option is available when no elements are selected and a user right click the canvas. + </diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Expession Binding</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - adds expression based + binding to selected java binding element.</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Value Binding</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - adds Value binding (&lt;jb:value&gt;) + to the selected java binding element.</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Bean Binding</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - adds Wiring binding (&lt;jb:wiring&gt;) + to the selected java binding element.</diffmk:wrapper></para></listitem> + </itemizedlist> + </entry> + <entry diffmk:change="added"></entry> + </row> + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Undo</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">By this option you can revert the changes made at the previous step. + </diffmk:wrapper></entry> + <entry diffmk:change="added"></entry> + + </row> + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Redo</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">By this option you can redo the changes made at the previous step. + </diffmk:wrapper></entry> + <entry diffmk:change="added"></entry> + + </row> + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Delete</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">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. + </diffmk:wrapper></entry> + <entry diffmk:change="added"></entry> + + </row> + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Auto Layout</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Sets the default layout of the elements on the canvas.</diffmk:wrapper></entry> + <entry diffmk:change="added"></entry> + + </row> + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Properties</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click this option if you want to add </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Properties view</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> + to the current perspective. + The just opened </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Properties view</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> + will automatically reflect the properties of the selected + diagram element. + </diffmk:wrapper></entry> + <entry diffmk:change="added"></entry> + </row> + + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Input Methods</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Choose one of the following methods: + </diffmk:wrapper><itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">System</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Simple</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Amharic(EZ+)</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Cedilla</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Cyrillic</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Inuktitut</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">IPA</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Multipress</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">SCIM Bridge Input Method</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">SCIM Input Method</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Thai-Lio</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tigrigna-Eritrean(EZ+)</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tigrigna-Ethiopian(EZ+)</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Vietnamese</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para><diffmk:wrapper diffmk:change="changed">X input Method</diffmk:wrapper></para></listitem> + </itemizedlist> + </entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">System</diffmk:wrapper></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + <section><title>Selected Task Details section for Template Task.</title> + <para><diffmk:wrapper diffmk:change="changed">Selected Task Details section for this task is presented by the graf, + that is similar to the one in the </diffmk:wrapper><link linkend="mapping_task">previous section</link><diffmk:wrapper diffmk:change="changed">. + </diffmk:wrapper></para> + <figure float="0"> + <title>Selected Task Details Section for Template Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_7a.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Popup menu similar to the one in </diffmk:wrapper><link diffmk:change="added" linkend="popup"><diffmk:wrapper diffmk:change="added">Selected Task Details section + for Java Mapping Task</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> is also available here.</diffmk:wrapper></para> + </section> + </section> + + </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> + <figure float="0"> + <title> Options tab of the Smooks Configuration File editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_8.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <section> + <title>Smooks Configuration section</title> + <para><diffmk:wrapper diffmk:change="changed"> + In the </diffmk:wrapper><property moreinfo="none">Smooks Configuration</property> section of <property moreinfo="none">Options Tab</property><diffmk:wrapper diffmk:change="changed"> + only one element is availible:Smooks Platform Version + </diffmk:wrapper></para> + <figure float="0"> + <title>Smooks Configuration section of Options tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_9.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para><diffmk:wrapper diffmk:change="changed">This parameter is not rechangable, + and is set according to the vesion of the Smooks libraries that are added to the project. + </diffmk:wrapper></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> + <figure float="0"> + <title>Filter Settings section of Options tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_10.png" scale="90"></imagedata> + </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> + <table> + <title>Options Tab. Filter Settings section.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <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: + <itemizedlist> + <listitem><para><emphasis>SAX</emphasis></para></listitem> + <listitem><para><emphasis>DOM</emphasis></para></listitem> + </itemizedlist> + </entry> + <entry><diffmk:wrapper diffmk:change="changed">SAX</diffmk:wrapper></entry> + </row> + + <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><diffmk:wrapper diffmk:change="changed">false</diffmk:wrapper></entry> + + </row> + </tbody> + </tgroup> + </table> + </section> + </section> + <section id="smooksformeditor_sourcetab" xreflabel="Smooks Source Tab"> + + <title>Source Tab</title> + <para>This section provides information about 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> + <figure float="0"> + <title>Graphical Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/source_editor/source_editor1.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Error underlining in Graphical Editor</title> + <para>If the <property moreinfo="none">Smooks tools</property><diffmk:wrapper diffmk:change="changed"> can't understand the configuration + file or the configuration file is illegal (XML structure isn't right for Smooks + Configuration file, etc.), the error is underlined.</diffmk:wrapper></para> + <figure float="0"> + <title>Graphical Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_11.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <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 moreinfo="none">Validate</property> button. The validator can be enabled/disabled in <emphasis><property moreinfo="none">Window -&gt; Preferences -&gt; Validation</property></emphasis>:</para> + + <figure float="0"> + <title>Validation: Smooks Configuration File Validator</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/source_editor/smooks_conf_validator.png" scale="90"></imagedata> + </imageobject> + </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 moreinfo="none">Settings</property> button and use the options provided:</para> + + <figure float="0"> + <title>Smooks Configuration File Validator Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/source_editor/smooks_conf_validator_settings.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For more details about Smooks editor, also see the movie, </diffmk:wrapper><ulink diffmk:change="added" url=""><diffmk:wrapper diffmk:change="added">"Overview of the Smooks Editor"</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </section> + </section> + <section diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Properties View</diffmk:wrapper></title> + <para diffmk:change="added"><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties View</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> is available for some + elements on the canvas of Java Mapping and Apply Template Tasks,like:</diffmk:wrapper></para> + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Java mapping</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">:java class members,its fields, + links between input values and the class members;</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Apply Template</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">:output template.</diffmk:wrapper></para></listitem> + </itemizedlist> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To add </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties View</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> + to the opened perspective the user can either open </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Window-&gt;Show View-&gt;Preferences</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> + in the toolbar or right click the element which properties he wants to inspect and select </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> + in the popup menu.On the picture below you can see how this view looks like when some csv template is selected. + </diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Properties View</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/reference/reference_12.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> + This view is fully syncronized with the canvas of </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Smooks Configuration Editor</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">. + This means that when you change selected element by click,the properties of a new element are immediatly displayed in it. + Using </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties View</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> you can edit all the properties of the selected item. + </diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Synchronization between Properties View and the canvas</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/reference/reference_13.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <section diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Decode Configuration</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Smooks tools support decode parameter configuration through the Decode tab in </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties View</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> + activated by clicking the connection between input model and bean items. </diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On the picture below you can see an example of decode configurations + for mapping some </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Input Model</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> Item to </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Date</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> format:</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Decode Configuration tab in Properties View</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/reference/reference_14.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The descriptions of the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Decode Configuration</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> tab options are listed in the following table:</diffmk:wrapper></para> + <table diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Decode Configuration tab in Properties View</diffmk:wrapper></title> + <tgroup cols="3" diffmk:change="added"> + <colspec align="left" colnum="1" colwidth="1*" diffmk:change="added"></colspec> + <colspec align="left" colnum="2" colwidth="3*" diffmk:change="added"></colspec> + <colspec align="left" colnum="3" colwidth="1*" diffmk:change="added"></colspec> + + <thead diffmk:change="added"> + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Option</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Description</diffmk:wrapper></entry> + </row> + </thead> + <tbody diffmk:change="added"> + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Decoder</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Select from the dropdown list the type of decoder you need. + </diffmk:wrapper></entry> + </row> + + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Decoder Parameters</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">For most of decoders </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Decoder Parametres table</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> is empty. + But some of the decoders require additional configuration + (like Date decoder on the picture above),so you should configure them + by editing the corresponding line in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Value</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> row. + For example for Date Decoder: + </diffmk:wrapper><itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"><para diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">format</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> - Date format string.</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">locale country</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> - ISO Country Code. + Upper case two-letter code defined by ISO-3166. </diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">locale language</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> - ISO Language Code. + Lower case two-letter code defined by ISO-639. </diffmk:wrapper></para></listitem> + </itemizedlist> + </entry> + </row> + </tbody> + </tgroup> + </table> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Decoder Parameters</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> section for </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EnumDecoder</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> + quite differs from other types of decoders. + See the picture below:</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">EnumDecoder in Properties View</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/reference/reference_15.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The Decoder Parameters section for EnumDecoder in Properties View consists of 2 rows:</diffmk:wrapper></para> + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"><para diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">From Data Value</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> - The lines in this row are editable. + You can change them according to the names of enum types you used in input file. + </diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">To Enum Value</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> - The lines in this row are not editable. + Here a set of all constants declared in mapped Enum type is listed. + The user is responsible for correspondence between the values in these two rows. </diffmk:wrapper></para></listitem> + </itemizedlist> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For more information about different decoder parametres read </diffmk:wrapper><ulink diffmk:change="added" url="http://www.smooks.org/mediawiki/index.php?title=Main_Page"... diffmk:change="added"> + Smooks Technology Documentation</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </section> + <section diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Apply Template Wizard</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Apply Template Wizard</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> + helps you to add a new </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Apply Template Task</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> to + Smooks configuration file. + You can call it from the popup menu when </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Java Mapping</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> item in Processing + Task section is selected by following </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Add Task &gt; Apply Template</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> + (see </diffmk:wrapper><link diffmk:change="added" linkend="apply_templ"><diffmk:wrapper diffmk:change="added">Apply Template configuration</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> picture).</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The wizard consists of several pages:</diffmk:wrapper></para> + + <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The first one includes only one option to adjust.The user should select in + which of the two formats(</diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">XML</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> or </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">CSV</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">) + he prefers to create an output message:</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">The first page of Apply Template Wizard</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/reference/reference_24.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The second page is specific for each of the output message formats:</diffmk:wrapper></para> + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">CSV</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> output message type was selected at + the previous step the second wizard page will be the following :</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">CSV:The second page of Apply Template Wizard</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/reference/reference_25.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The wizard page includes the next options to adjust:</diffmk:wrapper></para> + + <table diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Apply Template Wizard. Second Page Options if CSV output format is selected.</diffmk:wrapper></title> + <tgroup cols="3" diffmk:change="added"> + <colspec align="left" colnum="1" colwidth="1*" diffmk:change="added"></colspec> + <colspec colnum="2" colwidth="3*" diffmk:change="added"></colspec> + <colspec align="left" colnum="3" colwidth="1*" diffmk:change="added"></colspec> + <thead diffmk:change="added"> + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Option</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Description</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Default</diffmk:wrapper></entry> + </row> + </thead> + <tbody diffmk:change="added"> + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Fields</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Comma separated list of CSV record field names.</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Empty</diffmk:wrapper></entry> + </row> + + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Separator Character</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Field separator character in the output message.</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">,</diffmk:wrapper></entry> + </row> + + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Quote Character</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Quote character in the output message.</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">"</diffmk:wrapper></entry> + </row> + + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Output Field name</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click the checkbox if you want the output csv message also include field names.</diffmk:wrapper></entry> + <entry diffmk:change="added"></entry> + </row> + + </tbody> + </tgroup> + </table> + </listitem> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The following second wizard page will appear + if </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">XML</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> output message type was selected at + the previous step:</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Apply Template Wizard. Second Page Options if XML output format is selected.</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/reference/reference_22.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Here you should firstly select XSD or Sample XML format of output template and then + click </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Browse File System</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> + or </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Browse Workspace</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button depending on what + browse type you want to use.For example, if you click </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Browse Workspace</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> + the following view will appear: + </diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Browse Workspace</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/reference/reference_18.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In the workspace you should select the template you + want to use and click </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Ok</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. + </diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you selected XSD format after adjusting the template path you should click Load button: + </diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Load Button</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/reference/reference_19.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">After that it is necessary to select in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Select Root Element + </diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> the root node for the template and click </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Load Button</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/reference/reference_20.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you have chosen Sample XML option after selecting + the template xml file destination you should only + click </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">: + </diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Load Button</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/reference/reference_23.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + </listitem> + </orderedlist> + </section> + + </section> + +</chapter> + + +<chapter xml:base="file:///home/vchukhutsina/repos/ochik_jboss/smooks/docs/reference/en-US/summary.xml"> + <?dbhtml filename="summary.html"?> + <title>Summary</title> + <para>In conclusion, with this document you know all the capabilities of Smooks Tools and could easily start with them. + The chapters above walked you through the steps on how to create and configure some XML to JAVA mapping project. + If you have questions or suggestions concerned both the documentation and tools behavior, + you are welcome to JBoss Tools Users forum. + Please, use Jira to report bugs and requests on documentation.</para> + + <section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at + <ulink url="http://docs.jboss.org/tools">http://docs.jboss.org/tool... in the corresponding release directory. + </para> + <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs">http...;. </para> +<para><diffmk:wrapper diffmk:change="changed"> + For more information about Smooks technology please visit + </diffmk:wrapper><ulink url="http://www.smooks.org/mediawiki/index.php?title=Main_Page"... diffmk:change="changed"> + Smooks Technology Home Page</diffmk:wrapper></ulink> +</para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can find a set of screencasts on Smooks tools technology </diffmk:wrapper><ulink diffmk:change="added" url="http://community.jboss.org/wiki/JBossTools-SmooksEditor"&g... diffmk:change="added">here</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </section> +</chapter> + +</book> Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/references.xml =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/references.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/references.xml 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,880 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="reference"> + <?dbhtml filename="reference.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Smooks</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Reference</title> + <para>This chapter includes detailed reference information about all tabs of 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 has two sections:</para> + <itemizedlist> + <listitem><para><link linkend="processing_task_section">Processing Task section</link></para></listitem> + <listitem><para><link linkend="selected_task_details">Selected Task Details section</link></para></listitem> + </itemizedlist> + <para>You can see them on the picture below.</para> + <figure> + <title>Two Sections of the Process tab.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_1.png" scale="90"/> + </imageobject> + </mediaobject> + </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>The descriptions of the popup menu options are in the following table.</para> + <table> + <title>Process Tab. Processing Task section.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <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: + <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>Java Mapping</emphasis></para></listitem> + <listitem><para><emphasis>Apply Template</emphasis></para></listitem> + </itemizedlist> + </entry> + <entry></entry> + </row> + + <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></entry> + + </row> + + <row> + <entry>Input Methods</entry> + <entry>Choose one of the following methods: + <itemizedlist> + <listitem><para>System</para></listitem> + <listitem><para>Simple</para></listitem> + <listitem><para>Amharic(EZ+)</para></listitem> + <listitem><para>Cedilla</para></listitem> + <listitem><para>Cyrillic</para></listitem> + <listitem><para>Inuktitut</para></listitem> + <listitem><para>IPA</para></listitem> + <listitem><para>Multipress</para></listitem> + <listitem><para>SCIM Bridge Input Method</para></listitem> + <listitem><para>SCIM Input Method</para></listitem> + <listitem><para>Thai-Lio</para></listitem> + <listitem><para>Tigrigna-Eritrean(EZ+)</para></listitem> + <listitem><para>Tigrigna-Ethiopian(EZ+)</para></listitem> + <listitem><para>Vietnamese</para></listitem> + <listitem><para>X input Method</para></listitem> + </itemizedlist> + </entry> + <entry>System</entry> + </row> + </tbody> + </tgroup> + </table> + </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> + <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> + + <figure> + <title>Selected Task Details Section for Input XML Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_2.png" scale="90"/> + </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>Here are the screens of these configuration options:</para> + <itemizedlist> + <listitem><para>CSV:</para> + <figure> + <title>Selected Task Details Section for Input CSV Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_3.png" /> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>EDI:</para> + <figure> + <title>Selected Task Details Section for Input EDI Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_4.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>JSON:</para> + <figure> + <title>Selected Task Details Section for Input JSON Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_5.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>Custom:</para> + <figure> + <title>Selected Task Details Section for Input Custom Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_6.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>All the input task configuration positions can be found in the table below:</para> + <table> + <title>Selected Task Details Section. Options for Input Task.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <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: + <itemizedlist> + <listitem><para>No Input</para></listitem> + <listitem><para>XML</para></listitem> + <listitem><para>Java</para></listitem> + <listitem><para>XSD/WSDL</para></listitem> + <listitem><para>CSV</para></listitem> + <listitem><para>EDI</para></listitem> + <listitem><para>JSON</para></listitem> + <listitem><para>Custom</para></listitem> + </itemizedlist> + </entry> + <entry>XML</entry> + </row> + + <row> + <entry>Input configuration + + </entry> + <entry> + <itemizedlist> + <listitem><para><emphasis>No Input</emphasis> - no info required</para></listitem> + <listitem><para><emphasis>XML</emphasis> - no info required</para></listitem> + <listitem><para><emphasis>Java</emphasis> - no info required</para></listitem> + <listitem><para><emphasis>XSD/WSDL</emphasis> - no info required</para></listitem> + <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. + </para></listitem> + <listitem><para><emphasis>Quote Character</emphasis> - Quote character. + </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. + </para></listitem> + <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 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. + </para></listitem> + </itemizedlist> + </listitem> + <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 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. + </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. + </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. + </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. + </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. + </para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>Custom</emphasis></para> + <itemizedlist> + <listitem><para><emphasis>Target Profile</emphasis> - Defines the output transformation profile</para></listitem> + <listitem><para><emphasis>Class</emphasis> - Custom reader class.</para></listitem> + <listitem><para><emphasis>Handlers</emphasis> - Set a handler on the reader instance e.g. an EntityResolver, ErrorHandler etc. + </para></listitem> + <listitem><para><emphasis>Features</emphasis> - Reader Features List</para></listitem> + <listitem><para><emphasis>Parametres</emphasis> - Resource Parameters</para></listitem> + + </itemizedlist> + </listitem> + </itemizedlist></entry> + <entry><itemizedlist> + <listitem><para><emphasis>CSV</emphasis></para><itemizedlist> + <listitem><para>not defined</para></listitem> + <listitem><para>','</para></listitem> + <listitem><para>'"'</para></listitem> + <listitem><para>csv-record</para></listitem> + <listitem><para>csv-set</para></listitem> + <listitem><para>true</para></listitem> + <listitem><para>0</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>EDI</emphasis></para> + <itemizedlist> + <listitem><para>not defined</para></listitem> + <listitem><para>UTF-8</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>true</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>JSON</emphasis></para> + <itemizedlist> + <listitem><para>not defined</para></listitem> + <listitem><para>element</para></listitem> + <listitem><para>UTF-8</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>false</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>""(an empty string)</para></listitem> + <listitem><para>'json'</para></listitem> + <listitem><para>not defined</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>Custom</emphasis></para> + <itemizedlist> + <listitem><para>no defaults</para></listitem> + + </itemizedlist> + </listitem> + </itemizedlist></entry> + </row> + <row> + <entry>Input Data</entry> + <entry>You should select a data file using <emphasis>Add</emphasis> and <emphasis>Delete</emphasis> 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></entry> + </row> + </tbody> + </tgroup> + </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> + <figure> + <title>Selected Task Details Section for Mapping Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_7.png" scale="90"/> + </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>The descriptions of the popup menu options are in the following table.</para> + <table id="popup"> + <title>Popup menu. Selected Task Details section.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <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. + </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> + <entry></entry> + + </row> + <row> + <entry>Redo</entry> + <entry>By this option you can 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> + <entry></entry> + + </row> + <row> + <entry>Auto Layout</entry> + <entry>Sets the default layout of the elements on the canvas.</entry> + <entry></entry> + + </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> + <entry></entry> + </row> + + <row> + <entry>Input Methods</entry> + <entry>Choose one of the following methods: + <itemizedlist> + <listitem><para>System</para></listitem> + <listitem><para>Simple</para></listitem> + <listitem><para>Amharic(EZ+)</para></listitem> + <listitem><para>Cedilla</para></listitem> + <listitem><para>Cyrillic</para></listitem> + <listitem><para>Inuktitut</para></listitem> + <listitem><para>IPA</para></listitem> + <listitem><para>Multipress</para></listitem> + <listitem><para>SCIM Bridge Input Method</para></listitem> + <listitem><para>SCIM Input Method</para></listitem> + <listitem><para>Thai-Lio</para></listitem> + <listitem><para>Tigrigna-Eritrean(EZ+)</para></listitem> + <listitem><para>Tigrigna-Ethiopian(EZ+)</para></listitem> + <listitem><para>Vietnamese</para></listitem> + <listitem><para>X input Method</para></listitem> + </itemizedlist> + </entry> + <entry>System</entry> + </row> + </tbody> + </tgroup> + </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 one in the <link linkend="mapping_task">previous section</link>. + </para> + <figure> + <title>Selected Task Details Section for Template Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_7a.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <para>Popup menu similar to the one in <link linkend="popup">Selected Task Details section + for Java Mapping Task</link> is also available here.</para> + </section> + </section> + + </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> + <figure> + <title> Options tab of the Smooks Configuration File editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_8.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <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 + </para> + <figure> + <title>Smooks Configuration section of Options tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_9.png" scale="90"/> + </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> + </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> + <figure> + <title>Filter Settings section of Options tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_10.png" scale="90"/> + </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> + <table> + <title>Options Tab. Filter Settings section.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <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: + <itemizedlist> + <listitem><para><emphasis>SAX</emphasis></para></listitem> + <listitem><para><emphasis>DOM</emphasis></para></listitem> + </itemizedlist> + </entry> + <entry>SAX</entry> + </row> + + <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>false</entry> + + </row> + </tbody> + </tgroup> + </table> + </section> + </section> + <section id="smooksformeditor_sourcetab" xreflabel="Smooks Source Tab"> + + <title>Source Tab</title> + <para>This section provides information about 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> + <figure> + <title>Graphical Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/source_editor/source_editor1.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + </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> + <figure> + <title>Graphical Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_11.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <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> + + <figure> + <title>Validation: Smooks Configuration File Validator</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/source_editor/smooks_conf_validator.png" scale="90"/> + </imageobject> + </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> + + <figure> + <title>Smooks Configuration File Validator Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/source_editor/smooks_conf_validator_settings.png" scale="90"/> + </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> + <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. + </para> + <figure> + <title>Properties View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_12.png" scale="90"/> + </imageobject> + </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. + </para> + <figure> + <title>Synchronization between Properties View and the canvas</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_13.png" scale="90"/> + </imageobject> + </mediaobject> + </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>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> + <title>Decode Configuration tab in Properties View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_14.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <para>The descriptions of the <property>Decode Configuration</property> tab options are listed in the following table:</para> + <table> + <title>Decode Configuration tab in Properties View</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Decoder</entry> + <entry>Select from the dropdown list the type of decoder you need. + </entry> + </row> + + <row> + <entry>Decoder Parameters</entry> + <entry>For most of decoders <emphasis><property>Decoder Parametres table</property></emphasis> is empty. + But some of the decoders require additional configuration + (like Date decoder on the picture above),so you should configure them + by editing the corresponding line in the <property>Value</property> row. + For example for Date Decoder: + <itemizedlist> + <listitem><para><property>format</property> - Date format string.</para></listitem> + <listitem><para><property>locale country</property> - ISO Country Code. + Upper case two-letter code defined by ISO-3166. </para></listitem> + <listitem><para><property>locale language</property> - ISO Language Code. + Lower case two-letter code defined by ISO-639. </para></listitem> + </itemizedlist> + </entry> + </row> + </tbody> + </tgroup> + </table> + <para>The <property>Decoder Parameters</property> section for <property>EnumDecoder</property> + quite differs from other types of decoders. + See the picture below:</para> + <figure> + <title>EnumDecoder in Properties View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_15.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <para>The Decoder Parameters section for EnumDecoder in Properties View consists of 2 rows:</para> + <itemizedlist> + <listitem><para><property>From Data Value</property> - The lines in this row are editable. + You can change them according to the names of enum types you used in input file. + </para></listitem> + <listitem><para><property>To Enum Value</property> - The lines in this row are not editable. + Here a set of all constants declared in mapped Enum type is listed. + The user is responsible for correspondence between the values in these two rows. </para></listitem> + </itemizedlist> + + <para>For more information about different decoder parametres read <ulink url="http://www.smooks.org/mediawiki/index.php?title=Main_Page"... + Smooks Technology Documentation</ulink>.</para> + </section> + <section> + <title>Apply Template Wizard</title> + <para>The <property>Apply Template Wizard</property> + helps you to add a new <property>Apply Template Task</property> to + Smooks configuration file. + You can call it from the popup menu when <property>Java Mapping</property> item in Processing + Task section is selected by following <emphasis>Add Task > Apply Template</emphasis> + (see <link linkend="apply_templ">Apply Template configuration</link> picture).</para> + <para>The wizard consists of several pages:</para> + + <orderedlist> + <listitem> + <para>The first one includes only one option to adjust.The user should select in + which of the two formats(<property>XML</property> or <property>CSV</property>) + he prefers to create an output message:</para> + <figure> + <title>The first page of Apply Template Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_24.png"/> + </imageobject> + </mediaobject> + </figure> + + </listitem> + <listitem><para>The second page is specific for each of the output message formats:</para> + <itemizedlist> + <listitem><para>If the <property>CSV</property> output message type was selected at + the previous step the second wizard page will be the following :</para> + <figure> + <title>CSV:The second page of Apply Template Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_25.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The wizard page includes the next options to adjust:</para> + + <table> + <title>Apply Template Wizard. Second Page Options if CSV output format is selected.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Fields</entry> + <entry>Comma separated list of CSV record field names.</entry> + <entry>Empty</entry> + </row> + + <row> + <entry>Separator Character</entry> + <entry>Field separator character in the output message.</entry> + <entry>,</entry> + </row> + + <row> + <entry>Quote Character</entry> + <entry>Quote character in the output message.</entry> + <entry>"</entry> + </row> + + <row> + <entry>Output Field name</entry> + <entry>Click the checkbox if you want the output csv message also include field names.</entry> + <entry></entry> + </row> + + </tbody> + </tgroup> + </table> + </listitem> + <listitem> + <para>The following second wizard page will appear + if <property>XML</property> output message type was selected at + the previous step:</para> + <figure> + <title>Apply Template Wizard. Second Page Options if XML output format is selected.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_22.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Here you should firstly select XSD or Sample XML format of output template and then + click <property>Browse File System</property> + or <property>Browse Workspace</property> button depending on what + browse type you want to use.For example, if you click <property>Browse Workspace</property> + the following view will appear: + </para> + <figure> + <title>Browse Workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_18.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In the workspace you should select the template you + want to use and click <property>Ok</property>. + </para> + <para>If you selected XSD format after adjusting the template path you should click Load button: + </para> + <figure> + <title>Load Button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_19.png"/> + </imageobject> + </mediaobject> + </figure> + <para>After that it is necessary to select in the <property>Select Root Element + </property> the root node for the template and click <property>Finish</property>.</para> + <figure> + <title>Load Button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_20.png"/> + </imageobject> + </mediaobject> + </figure> + <para>If you have chosen Sample XML option after selecting + the template xml file destination you should only + click <property>Finish</property>: + </para> + <figure> + <title>Load Button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_23.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + </listitem> + </orderedlist> + </section> + + </section> + +</chapter> Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/references.xml ___________________________________________________________________ Name: svn:executable + * Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/summary.xml =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/summary.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/summary.xml 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,24 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter> + <?dbhtml filename="summary.html"?> + <title>Summary</title> + <para>In conclusion, with this document you know all the capabilities of Smooks Tools and could easily start with them. + The chapters above walked you through the steps on how to create and configure some XML to JAVA mapping project. + If you have questions or suggestions concerned both the documentation and tools behavior, + you are welcome to JBoss Tools Users forum. + Please, use Jira to report bugs and requests on documentation.</para> + + <section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at + <ulink url="http://docs.jboss.org/tools">http://docs.jboss.org/tool... in the corresponding release directory. + </para> + <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs">http...;. </para> +<para> + For more information about Smooks technology please visit + <ulink url="http://www.smooks.org/mediawiki/index.php?title=Main_Page"... + Smooks Technology Home Page</ulink> +</para> + <para>You can find a set of screencasts on Smooks tools technology <ulink url="http://community.jboss.org/wiki/JBossTools-SmooksEditor"&g... + </section> +</chapter> Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/tasks.xml =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/tasks.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/en-US/tasks.xml 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,273 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="process_page"> + <?dbhtml filename="tasks.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Smooks</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Tasks</title> + <para>This chapter describes the main tasks a user can be faced during Smooks tools usage. + 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> + <figure> + <title>Selecting Smooks Configuration File Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start1.png" scale="90"/> + </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> + <figure> + <title>Choosing the configuration file container and the file name</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start2.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + </section> + <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. + </para> + <figure> + <title>Input Task Configuring</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process1.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <para>Select it and you will see all the properties to set for the Input reader of your Smooks configuration. + "Input type" corresponds to the type of data that you will be working with. + For example, to work with incoming CSV (Comma-separated Values) data, you would specify "CSV" in the drop-down list. + 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. + </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. + </para> + <figure> + <title>Input Task Configuring</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process2.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + </section> + <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). + <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> + </note> + </para> + </section> + <section id="mapping"> + <title>Java Mapping Task</title> + + <para> + If you decide to do Java Mapping, you need to make sure that your Input reader has been set up and you have some sample data specified. + Then you should select <emphasis>Input Task</emphasis> in the Process tab and click the plus (+) sign to the right of the icon. + Select <emphasis>Java Mapping</emphasis> from the popup menu and it will appear to the right, connected to <emphasis>Input Task</emphasis>. Then select <emphasis>Java Mapping</emphasis> task. + </para> + <figure> + <title>Java Mapping configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Another method of adding <emphasis>Java Mapping</emphasis> element + to the canvas in the Processing Tasks section is to right click Input Task + element and select <emphasis>Java Mapping</emphasis> in the popup menu. </para> + <figure> + <title>Java Mapping configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process4.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + Right-click on the canvas in an empty space and select "Add ->Java Class". + </para> + <figure> + <title>Java Mapping configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process5.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + <emphasis>Java Bean Creation</emphasis> wizard appears. + Specify a unique identifier for the new class, the class path. + If the Java class is specified, you'll see a list of the properties in the box below. + Click <emphasis>Finish</emphasis> when you're done. + Now with the input and output models on the canvas, you can click and drag + from the various input elements to corresponding output elements. + Make sure to connect collection elements to corresponding collection elements. + Finally your mapping should look nearly like the one on the picture below. + </para> + <figure> + <title>Final Mapping schema</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process6.png"/> + </imageobject> + </mediaobject> + </figure> + <para>For details, also see the movie, + <ulink url="http://www.screencast.com/users/tfennelly/folders/Camtasia/medi... to Java"</ulink>. + </para> + <para>If you are interested in transforming EDI to Java, please, follow the + <ulink url="http://www.screencast.com/users/tfennelly/folders/Camtasia/medi... + </section> + <section> + <title>Apply Template Task</title> + + <para>The "Apply Template" task works very similarly to the <link linkend="mapping">"Java Mapping" task</link>, where you map between an input model and an output model. + Select the <emphasis>Java Mapping</emphasis> task you want to use as the input model in the Process Map pane and click the plus (+) sign to the right of the icon. + </para> + <figure id="apply_templ"> + <title>Apply Template configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process7.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + The <property>Message Type Selection</property> wizard will appear. + In our example we will transfer our data to csv output format,so you should select <emphasis><property>CSV</property></emphasis> and click <property>Next</property>.</para> + <figure> + <title>Message Type Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process7a.png"/> + </imageobject> + </mediaobject> + </figure> + <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> + <imageobject> + <imagedata fileref="images/process_page/process7b.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + 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 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> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process7c.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Smooks Configuration testing using Smooks Run Configuration</title> + + <para>This option is intended to view the results of Smooks transforming procedure. + To do the testing you should select your <emphasis>Smooks Configuration file</emphasis> you want to transfer in the Project Navigator or open it in + the Smooks Configuration Editor and then select "Run As..." from the <emphasis><property>Run</property></emphasis> + toolbar button + or <emphasis><property>Run->Smooks Run Configuration</property></emphasis> option in the top menu bar. And Smooks Configuration file will be run automatically. + </para> + <figure> + <title>Smooks Configuration testing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process8.png"/> + </imageobject> + </mediaobject> + </figure> + <para>If any errors or warnings appear, they will pop up in a dialog. + The output of the test will appear in the Console view. + In our case the following streaming output will appear:</para> + <programlisting role="JAVA"><![CDATA[[Stream Templating Result ...] + |-- + |"productId","quantity","price" + |"111","2","8.9" + |"222","7","5.2" + |-- + +[Java Mapping Results...] + |-- + |> order (beanId = "order") + | > header (beanId = "header") + | > date = "2006-11-15 20:45:28.0 EET" + | > customerNumber = 123123L + | > customerName = "Joe" + | > orderItems (beanId = "orderItems") + | > example.model.OrderItem (beanId = "orderItem") + | > productId = 111L + | > quantity = 2I + | > price = 8.9D + | > example.model.OrderItem (beanId = "orderItem") + | > productId = 222L + | > quantity = 7I + | > price = 5.2D + |-- +]]></programlisting> + <para>If the test runs but doesn't generate any streaming output the Console output will be the following: + </para> + <programlisting role="JAVA"><![CDATA[ Nothing to Display: + - No Java Mappings. + - No Templates Applied.]]> + </programlisting> + + </section> +</chapter> + Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/pom.xml =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/pom.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/pom.xml 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,181 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <groupId>org.jboss.tools</groupId> + <artifactId>smooks-ref-guide-en-US</artifactId> + <version>1.0-SNAPSHOT</version> + <packaging>jdocbook</packaging> + <name>Smooks_Reference_Guide</name> + + <profiles> + <profile> + <id>release</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseTest</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release-nomarker.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release-nomarker.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseJBDS</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> + <cssdir>${pom.basedir}/target/docbook/staging/css/com/css</cssdir> + </properties> + </profile> + <profile> + <id>diffmk</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-diff.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-diff.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf-diff.xsl</xsl-pdf> + </properties> + </profile> + </profiles> + + <build> + + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.2.1</version> + <extensions>true</extensions> + + <dependencies> + <dependency> + <groupId>org.jboss.tools</groupId> + <artifactId>jbosstools-jdocbook-style</artifactId> + <type>jdocbook-style</type> + <version>1.0.0-SNAPSHOT</version> + </dependency> + <dependency> + <groupId>org.jboss.tools</groupId> + <artifactId>jbosstools-docbook-xslt</artifactId> + <version>1.0.0-SNAPSHOT</version> + </dependency> + + + </dependencies> + + <configuration> + <sourceDocumentName>${master}</sourceDocumentName> + <sourceDirectory>${pom.basedir}</sourceDirectory> + <imageResource> + <directory>${pom.basedir}/en-US</directory> + <includes> + <include>images/**/*</include> + <include>files/*</include> + </includes> + </imageResource> + <cssResource> + <directory>${cssdir}</directory> + </cssResource> + + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>${xsl-pdf}</stylesheetResource> + <finalName>${project.name}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>${xsl-chunked}</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>${xsl-single}</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/tools/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <!-- needed for uri-resolvers; can be ommitted if using 'current' uri scheme --> + <!-- could also locate the docbook dependency and inspect its version... --> + <docbookVersion>1.72.0</docbookVersion> + </options> + + </configuration> + </plugin> + <plugin> + <artifactId>maven-clean-plugin</artifactId> + <version>2.4</version> + <executions> + <execution> + <id>clean</id> + <phase>package</phase> + <goals> + <goal>clean</goal> + </goals> + </execution> + </executions> + <configuration> + <excludeDefaultDirectories>true</excludeDefaultDirectories> + <filesets> + <fileset> + <directory>${pom.basedir}/target/docbook/publish/en-US/</directory> + <includes> + <include>html/org/</include> + <include>html/org/</include> + <include>html_single/org/</include> + <include>html_single/org/</include> + <include>eclipse/org/</include> + <include>eclipse/org/</include> + </includes> + <followSymlinks>false</followSymlinks> + </fileset> + </filesets> + </configuration> + </plugin> + </plugins> + </build> + + <distributionManagement> + <repository> + <!-- Copy the dist to the local checkout of the JBoss maven2 repo ${maven.repository.root} --> + <!-- It is anticipated that ${maven.repository.root} be set in user's settings.xml --> + <!-- todo : replace this with direct svn access once the svnkit providers are available --> + <id>repository.jboss.org</id> + <url>file://${maven.repository.root}</url> + </repository> + <snapshotRepository> + <id>snapshots.jboss.org</id> + <name>JBoss Snapshot Repository</name> + <url>dav:https://snapshots.jboss.org/maven2</url> + </snapshotRepository> + </distributionManagement> + + <properties> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + <stylesdir>classpath:/xslt</stylesdir> + <cssdir>${pom.basedir}/target/docbook/staging/css/org/css</cssdir> + <master>master.xml</master> + </properties> +</project> Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/publican.cfg =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/publican.cfg (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/publican.cfg 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss + Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/test.txt =================================================================== --- tags/jbosstools-3.1.1.GA/smooks/docs/reference/test.txt (rev 0) +++ tags/jbosstools-3.1.1.GA/smooks/docs/reference/test.txt 2010-06-09 00:37:26 UTC (rev 22663) @@ -0,0 +1 @@ +svn commit test Added: tags/jbosstools-3.1.1.GA/smooks/docs/reference/xml-to-java.zip =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/smooks/docs/reference/xml-to-java.zip ___________________________________________________________________ Name: svn:mime-type + application/octet-stream