[jbosstools-commits] JBoss Tools SVN: r32985 - in branches/jbosstools-3.2.x/smooks/docs/reference: en-US and 1 other directories.

Author: irooskov(a)redhat.com Date: 2011-07-17 22:45:08 -0400 (Sun, 17 Jul 2011) New Revision: 32985 Added: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/images/process_page/direct_source_to_target_mapping_1.png Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Book_Info.xml branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Feedback.xml branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Preface.xml branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml branches/jbosstools-3.2.x/smooks/docs/reference/en-US/introduction.xml branches/jbosstools-3.2.x/smooks/docs/reference/en-US/master.xml branches/jbosstools-3.2.x/smooks/docs/reference/en-US/references.xml branches/jbosstools-3.2.x/smooks/docs/reference/en-US/summary.xml branches/jbosstools-3.2.x/smooks/docs/reference/en-US/tasks.xml branches/jbosstools-3.2.x/smooks/docs/reference/pom.xml Log: updated for GA Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Book_Info.xml 2011-07-18 02:42:15 UTC (rev 32984) +++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Book_Info.xml 2011-07-18 02:45:08 UTC (rev 32985) @@ -5,9 +5,9 @@ <title>Smooks Developer Tools Reference Guide</title> <subtitle>Provides information relating to the Smooks Tools module.</subtitle> <productname>JBoss Developer Studio</productname> - <productnumber>4.0</productnumber> - <edition>4.0.0</edition> - <pubsnumber>4</pubsnumber> + <productnumber>4.1</productnumber> + <edition>4.1.0</edition> + <pubsnumber>1</pubsnumber> <abstract> <para>The Smooks Developer Tools Reference Guide explains how to use Smooks Tools to graphically edit Smooks configuration files.</para> </abstract> Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Feedback.xml =================================================================== --- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Feedback.xml 2011-07-18 02:42:15 UTC (rev 32984) +++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Feedback.xml 2011-07-18 02:45:08 UTC (rev 32985) @@ -1,20 +1,92 @@ <?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "../Document_Conventions.ent"> +%BOOK_ENTITIES; +]> +<appendix id="sect_JBoss-Getting_Help_and_Giving_Feedback" lang="en-US"> + <title>Getting Help and Giving Feedback</title> + <section id="sect_JBoss-Do_You_Need_Help"> + <title>Do You Need Help?</title> + <indexterm> + <primary>help</primary> + <secondary>getting help</secondary> -<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> + </indexterm> + <para> + If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at <ulink url="http://access.redhat.com" />. Through the customer portal, you can: + </para> + <itemizedlist> + <listitem> + <para> + search or browse through a knowledgebase of technical support articles about Red Hat products. + </para> + </listitem> + <listitem> + <para> + submit a support case to Red Hat Global Support Services (GSS). + </para> + </listitem> + <listitem> + <para> + access other product documentation. + </para> + + </listitem> + + </itemizedlist> + <para> + Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. You can find a list of publicly available mailing lists at <ulink url="https://www.redhat.com/mailman/listinfo" />. Click on the name of any mailing list to subscribe to that list or to access the list archives. + </para> + + </section> + + <section id="jboss-feedback"> + <title>Give us Feedback</title> + <!-- NOTE: You will need the following entities defined in your .ent file. + You will need to replace _YOUR_PRODUCT_HERE_, _YOUR_COMPONENT_ + and _YOUR_SUMMARY_ - entities are not replaced in URLs. + <!ENTITY PRODUCT "JBoss Product Name"> + <!ENTITY BZCOMPONENT "doc-triage"> + <!ENTITY BZURL "<ulink url='https://bugzilla.example.com/enter_bug.cgi?product=_YOUR_PRODUCT... + + These entities should not affect translated documents, since Bugzilla is not localised. + --> <indexterm> + <primary>feedback</primary> + <secondary>contact information for this manual</secondary> + + </indexterm> + <para> + If you find a typographical error, or know how this guide can be improved, we would love to hear from you. Submit a report in Bugzilla against the product <literal>&BZPRODUCT;</literal> and the component <literal>&BZCOMPONENT;</literal>. The following link will take you to a pre-filled bug report for this product: &BZURL;. + </para> + <para> + Fill out the following template in Bugzilla's <literal>Description</literal> field. Be as specific as possible when describing the issue; this will help ensure that we can fix it quickly. + </para> + +<screen>Document URL: + + +Section Number and Name: + + +Describe the issue: + + +Suggestions for improvement: + + +Additional information: + + +</screen> + <para> + Be sure to give us your name so that you can receive full credit for reporting the issue. + </para> + + </section> + + +</appendix> + + Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Preface.xml 2011-07-18 02:42:15 UTC (rev 32984) +++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Preface.xml 2011-07-18 02:45:08 UTC (rev 32985) @@ -8,9 +8,5 @@ <para> This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. To get more information on these conventions please refer to the <guilabel>Document Conventions</guilabel> manual, which can be found on the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index.... Hat Documentation</ulink> website under the <guilabel>JBoss Developer Studio</guilabel> section. </para> - <!--<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include 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:fallback> - </xi:include>--> </preface> Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent =================================================================== --- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent 2011-07-18 02:42:15 UTC (rev 32984) +++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent 2011-07-18 02:45:08 UTC (rev 32985) @@ -1,4 +1,7 @@ <!ENTITY PRODUCT "JBoss"> <!ENTITY BOOKID "Smooks_Developer_Tools_Reference_Guide"> -<!ENTITY YEAR "2010"> +<!ENTITY YEAR "2011"> <!ENTITY HOLDER "Red Hat"> +<!ENTITY BZPRODUCT "JBoss Developer Studio"> +<!ENTITY BZCOMPONENT "Smooks Developer Tools Reference Guide"> +<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc... Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml =================================================================== --- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml 2011-07-18 02:42:15 UTC (rev 32984) +++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml 2011-07-18 02:45:08 UTC (rev 32985) @@ -8,5 +8,6 @@ <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="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> </book> Added: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/images/process_page/direct_source_to_target_mapping_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/images/process_page/direct_source_to_target_mapping_1.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/introduction.xml =================================================================== --- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/introduction.xml 2011-07-18 02:42:15 UTC (rev 32984) +++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/introduction.xml 2011-07-18 02:45:08 UTC (rev 32985) @@ -13,7 +13,7 @@ <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> + <para>The table below provides you with a list of the key features integrated in Smooks tools.</para> <table> <title>Key Functionality for Smooks Tools</title> @@ -34,64 +34,78 @@ <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> + <para>Smooks Configuration File Wizard</para> + </entry> + <entry> + <para>Smooks tools allows you to create and edit the Smooks configuration file for Java2Java data transformation.</para> + </entry> + <entry> <xref linkend="config_file_wizzard"/> </entry> </row> <row> - <entry><para>Smooks Editor</para></entry> - <entry><para>Smooks Editor helps configure the created Smooks configuration file.</para></entry> <entry> + <para>Smooks Editor</para> + </entry> + <entry> + <para>Smooks Editor helps configure the created Smooks configuration file.</para> + </entry> + <entry> <xref linkend="process_tab"/> </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> + <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 + <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 + <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 + <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 + <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 + <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> @@ -105,14 +119,12 @@ </imageobject> </mediaobject> </figure> - <para> For more informations about <property>Smooks</property>, please visit <ulink - url="http://www.smooks.org">Smooks official site</ulink>.</para> + <para> For more informations about <property>Smooks</property>, please visit the <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> + + <para>Smooks tools is a set of graphical tools, based on Eclipse, for editing Smooks configuration files.</para> <figure> <title>Smooks Form editor</title> <mediaobject> @@ -130,30 +142,30 @@ <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> + <para>During your development, you probably will be required to include additional Smooks jars to your project. This can be achieved with the following steps:</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> + <listitem> + <para>If it doesn't yet exist, create the folder named "lib" inside your project. + Copy all the Smooks jars you need to include into the <emphasis><property>lib</property> + </emphasis> directory. + </para> + </listitem> + <listitem> + <para>Right-click (or Control-click on Mac OS) on the project and select <guilabel>Properties.</guilabel></para> + </listitem> + <listitem> + <para>Select the <guilabel>Java Build Path</guilabel> item in the Properties list, then the <guilabel>Libraries tab</guilabel>, and click the <guibutton>Add JARs</guibutton> button. + </para> + </listitem> + <listitem> + <para>In the Jar Selection dialog, select all the jars in the "lib" directory you want to include and click the <guibutton>OK</guibutton> button.</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> Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/master.xml =================================================================== --- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/master.xml 2011-07-18 02:42:15 UTC (rev 32984) +++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/master.xml 2011-07-18 02:45:08 UTC (rev 32985) @@ -35,13 +35,13 @@ Version: 1.1.1.GA </releaseinfo> - <abstract> +<!-- <abstract> <title/> <para> <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/smooks/pdf... version</ulink> </para> - </abstract> + </abstract> --> </bookinfo> Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/references.xml =================================================================== --- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/references.xml 2011-07-18 02:42:15 UTC (rev 32984) +++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/references.xml 2011-07-18 02:45:08 UTC (rev 32985) @@ -1,879 +1,1740 @@ <?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><xref linkend="processing_task_section"/></para></listitem> - <listitem><para><xref linkend="selected_task_details"/></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> +<chapter id="references"> +<?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 on all tabs in the Smooks Configuration Editor. + </para> + + <section id="process_tab"> + <title>Process tab</title> + <para> + The Process tab of the Smooks Configuration Editor provides a way to configure different types of transformations. By default the smooks configuration file is opened in this editor. If you have set another editor to open the file by default, you should right click on the smooks configuration file and select <menuchoice><guimenuitem>Open With</guimenuitem><guimenuitem>Smooks Configuration Editor</guimenuitem></menuchoice>. + </para> + + <para> + The Process tab has two sections: + </para> + + <itemizedlist> + <listitem> + <para> + <xref linkend="processing_task_section"/> + </para> + </listitem> + + <listitem> + <para> + <xref linkend="selected_task_details"/> + </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 transformation: + </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 required Source and Result file types: <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> + <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> - <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 <xref linkend="mapping_task"/>. - </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 <xref linkend="popup"/>.</para> - </section> - </section> - + </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> + IBus (Inteligent Input Bus) + </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> + + <listitem> + <para> + None + </para> + </listitem> + </itemizedlist> + </entry> + + <entry> + System + </entry> + </row> + </tbody> + </tgroup> + </table> </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> + + <section id="selected_task_details"> + <title>Selected Task Details Section</title> + <para> + The options available in this section depends on the selected task in the Processing Task section. Because there are 3 types of tasks there are 3 different sets of its options in the Selected Task Details Section. They will be described one by one. + </para> + + <section> + <title>Selected Task Details Section for Input Task.</title> + <para> + On the picture below you can find an example of the Selected Task Details Section view if XML is selected as input type. + </para> + <figure> - <title> Options tab of the Smooks Configuration File editor</title> - <mediaobject> + <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 the Input Configuration section is empty for XML input file. However, this section has special configuration options for CSV,EDI,JSON,Custom input files. + </para> + + <para> + Here are the screens of these configuration options: + </para> + + <itemizedlist> + <listitem> + <para> + CSV: + </para> + + <figure> + <title>Selected Task Details Section for Input CSV Task.</title> + <mediaobject> <imageobject> - <imagedata fileref="images/reference/reference_8.png" scale="90"/> + <imagedata fileref="images/reference/reference_3.png" /> </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 + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + EDI: </para> + <figure> - <title>Smooks Configuration section of Options tab</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_9.png" scale="90"/> - </imageobject> - </mediaobject> + <title>Selected Task Details Section for Input EDI Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_4.png"/> + </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. + </listitem> + + <listitem> + <para> + JSON: </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> + <title>Selected Task Details Section for Input JSON Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_5.png"/> + </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. + </listitem> + + <listitem> + <para> + Custom: </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"> - - <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> + <title>Selected Task Details Section for Input Custom Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_6.png"/> + </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> + </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> + 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 you don't find your type in the list, you should use Custom type: + <itemizedlist> + <listitem> + <para> + No Input + </para> + </listitem> + + <listitem> + <para> + XML + </para> + </listitem> + + <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>Parameters</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 the + <guibutton> + Add + </guibutton> + and + <guibutton> + Delete + </guibutton> + buttons + </entry> + + <entry></entry> + </row> + + <row> + <entry> + Input Model View + </entry> + + <entry> + Using this view you can see the structure of your input file.If the file has been changed, to see the changes click the <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 graph, which eases the process of java mapping. + </para> + <figure> - <title>Properties View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_12.png" scale="90"/> - </imageobject> - </mediaobject> + <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 view is fully syncronized with the canvas of <emphasis><property>Smooks Configuration Editor</property></emphasis>. - This means that when you change selected element by click,the properties of a new element are immediatly displayed in it. - Using <emphasis><property>Properties View</property></emphasis> you can edit all the properties of the selected item. + This graphical editor allows you to perform drag&amp;drop operations with the nodes of transformed data to map the source data to target data. When you save the changes in the graphical editor the correct Smooks configuration file content will be generated. </para> + + <para> + Using the popup menu in the <emphasis>Selected Task Details</emphasis> section you can manage the diagram elements on the canvas. + </para> + + <para> + The descriptions of the popup menu options are in the following table. + </para> + + <table id="popup"> + <title>Popup menu. Selected Task Details section.</title> + <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 a bean context item to the config file. This option is available when no elements are selected and a user right clicks on the canvas. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Expression 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> + This option allows you to revert any changes made in the previous step. + </entry> + + <entry></entry> + </row> + + <row> + <entry> + Redo + </entry> + + <entry> + This option allows you to redo the changes made at the previous step. + </entry> + + <entry></entry> + </row> + + <row> + <entry> + Delete + </entry> + + <entry> + This option is available only if you select an 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 the <emphasis>Properties view</emphasis> to the current perspective. The <emphasis>Properties view</emphasis> will automatically display the properties of the selected diagram element. + </entry> + + <entry></entry> + </row> + + <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 graph, which is similar to what is described in the section <xref linkend="mapping_task"/>. + </para> + <figure> - <title>Synchronization between Properties View and the canvas</title> + <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 <xref linkend="popup"/>. + </para> + </section> + </section> + </section> + + <section id="options_tab"> + <title>Options Tab</title> + <para> + This section describes Options tab of the Smooks Configuration File editor, and gives short recommendations how this tab can be used during the project configuring. + </para> + + <figure> + <title> Options tab of the Smooks Configuration File editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_8.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <section> + <title>Smooks Configuration section</title> + <para> + The <property>Smooks Configuration</property> section in the <property>Options Tab</property> displays only the Smooks Platform Version value. + </para> + + <figure> + <title>Smooks Configuration section of Options tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_9.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para> + This value can not be modified, and is set according to the version of the Smooks libraries that are added to the project. + </para> + </section> + + <section> + <title>Filter Settings Filter section</title> + <para> + In Filter Settings section you can set the following global options responsible for the Smooks filtering configuration: + </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 overridden on a per fragment basis by targeting a Visitor implementation at that fragment that takes ownership of the Result writer (in the case of SAX filtering), or simply modifies the DOM (in the case of DOM filtering). As an example of this, see the FreeMarkerTemplateProcessor. + </para> + + <table> + <title>Options Tab. Filter Settings section.</title> + <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 the <ulink url="http://www.smooks.org/mediawiki/index.php?title=V1.2:Smooks_v1.... Filtering Process Selection section</ulink> of the official Smooks User Guide for more information about these models: + <itemizedlist> + <listitem> + <para> + <emphasis>SAX</emphasis> + </para> + </listitem> + + <listitem> + <para> + <emphasis>DOM</emphasis> + </para> + </listitem> + </itemizedlist> + </entry> + + <entry> + SAX + </entry> + </row> + + <row> + <entry> + Default Serialization is On + </entry> + + <entry> + Defines whether the default serialization should be switched on. Default serialization being enabled leads to locating StreamResult/DOMResult to the Result objects provided to the Smooks.filterSource method and to serialization all the events to that Result. + </entry> + + <entry> + false + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + </section> + + <section id="smooksformeditor_sourcetab"> + <title>Source Tab</title> + <para> + This section provides information about the Smooks Source Editor Page. + </para> + + <section> + <title>XML Source Editor</title> + <para> + You can use this editor to edit the Smooks Configuration file directly. + </para> + + <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 (e.g. XML structure isn&apos;t valid for a Smooks Configuration file), 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> + The Smooks configuration file validator will validate your Smooks configuration file. Just right-click on the file and then click on the + <guibutton> + Validate + </guibutton> + button. The validator can be enabled/disabled by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>Validation</guimenuitem></menuchoice>, as you can see in the image below: + </para> + + <figure> + <title>Validation: Smooks Configuration File Validator</title> + <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 and exclude groups to validate, and specify rules for validation. Just click on the + <guibutton> + Settings + </guibutton> + button and use the options provided, which you can see in the image below: + </para> + + <figure> + <title>Smooks Configuration File Validator Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/source_editor/smooks_conf_validator_settings.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + </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 <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Preferences</guimenuitem></menuchoice> in the toolbar or right click the element which properties he wants to inspect and select <property>Properties</property> in the popup menu. On the picture below you can see how this view looks like when some csv template is selected. + </para> + + <figure> + <title>Properties View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_12.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para> + This view is fully synchronized with the canvas of the <emphasis><property>Smooks Configuration Editor</property></emphasis>. This means that when you change the selected element by clicking on it, the properties of a new element are immediately displayed in it. Using <emphasis><property>Properties View</property></emphasis> you can then edit all the properties of the selected item. + </para> + + <figure> + <title>Synchronization between Properties View and the canvas</title> + <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 an <property>Input Model</property> Item to a <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 the <emphasis><property>Decoder Parameters 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 the 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 parameters read the <ulink url="http://www.smooks.org/mediawiki/index.php?title=Main_Page"... 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 the Smooks configuration file. You can call it from the popup menu when the <property>Java Mapping</property> item in the Processing Task section is selected by following <menuchoice><guimenuitem>Add Task</guimenuitem><guimenuitem>Apply Template</guimenuitem></menuchoice> (see <xref linkend="apply_templ"/> 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_13.png" scale="90"/> - </imageobject> + <imageobject> + <imagedata fileref="images/reference/reference_24.png"/> + </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> + </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 in 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_14.png" scale="90"/> - </imageobject> + <imageobject> + <imagedata fileref="images/reference/reference_25.png"/> + </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> + </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" 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> + <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 to also include field names. + </entry> + + <entry></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> + </table> + </listitem> + + <listitem> + <para> + The following second wizard page will appear if the <property>XML</property> output message type was selected in 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_15.png" scale="90"/> - </imageobject> + <imageobject> + <imagedata fileref="images/reference/reference_22.png"/> + </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 <xref linkend="apply_templ"/> 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> - + </figure> + + <para> + Here you should first select the XSD or Sample XML output template format and then click the <property>Browse File System</property> or the <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 the + <guibutton> + OK + </guibutton> + button. + </para> + + <para> + If you selected XSD format after adjusting the template path you should click the + <guibutton> + Load + </guibutton> + 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 the root node for the template in the <property>Select Root Element</property>. Then click the + <guibutton> + Finish + </guibutton> + button. + </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 the + <guibutton> + Finish + </guibutton> + button: + </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> Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/summary.xml =================================================================== --- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/summary.xml 2011-07-18 02:42:15 UTC (rev 32984) +++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/summary.xml 2011-07-18 02:45:08 UTC (rev 32985) @@ -1,24 +1,17 @@ <?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> + <?dbhtml filename="summary.html"?> + <title>Summary</title> + <para>The document summarizes the capabilities of Smooks Tools, and provides some instructions on how to use them. The chapters above also walked you through the steps on creating and configuring a 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 can be found 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 the <ulink url="http://www.smooks.org/mediawiki/index.php?title=Main_Page"... Technology Home Page</ulink> + </para> + <para>You can find a collection of screencasts covering the Smooks tools technology <ulink url="http://community.jboss.org/wiki/JBossTools-SmooksEditor"&g... + </section> </chapter> Modified: branches/jbosstools-3.2.x/smooks/docs/reference/en-US/tasks.xml =================================================================== --- branches/jbosstools-3.2.x/smooks/docs/reference/en-US/tasks.xml 2011-07-18 02:42:15 UTC (rev 32984) +++ branches/jbosstools-3.2.x/smooks/docs/reference/en-US/tasks.xml 2011-07-18 02:45:08 UTC (rev 32985) @@ -9,18 +9,15 @@ </keywordset> </chapterinfo> <title>Tasks</title> - <para>This chapter describes the main tasks a user can be faced during Smooks tools usage. + <para>This chapter describes the main tasks that can be performed with Smooks tools. 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> + <para> + Select the project where you want to create the new Smooks Configuration File and right-click on it. Select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Smooks</guimenuitem><guimenuitem>Smooks Configuration File</guimenuitem></menuchoice>. Then click the <guibutton>Next</guibutton> button. + </para> <figure> <title>Selecting Smooks Configuration File Wizard</title> <mediaobject> @@ -29,11 +26,9 @@ </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> + <para> + Select the <emphasis><property>src</property></emphasis> folder to be the files container, and type the name <filename>smooks-config.xml</filename>. Click the <guibutton>Next</guibutton> button. + </para> <figure> <title>Choosing the configuration file container and the file name</title> <mediaobject> @@ -47,8 +42,7 @@ <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. + Configuring an <property>Input task</property> is mandatory step when creating a smooks project. 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> @@ -64,12 +58,12 @@ 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. + In the <emphasis>Input data</emphasis> section, you can 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. + In the picture below you can see the correct configuration of an 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> @@ -81,31 +75,39 @@ </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> + <title>Mapping processes</title> + <para> + In previous versions of the Smooks tooling you were required to manually create a java mapping task before applying a transformation template to the data. A new method is now available called <emphasis>Direct source to target mapping</emphasis>. This allows you to skip the manual creation of Java mapping and apply a template directly to your data. + </para> + <!-- <para> + Though there are many options in Smooks regarding what you can do with input data, such as transformation, routing, and persistence, this version of the Smooks Configuration Editor focuses only on 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 <guilabel>Apply Template</guilabel> task to map it to a CSV file, XML or XSD file (with other formats being provided in the future). + <note> + <title>Note</title> + <para>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> + <title>Direct source to target mapping</title> + <para> + A new simplified mapping process is supported within the Smooks Editor called <emphasis>Direct source to target mapping</emphasis>. This allows for you to skip the intermediate Java mapping step when applying a template to your data. + </para> + <para> + An example of the new editor performing a transformation (EDI to XML): + </para> + <figure> + <title>Java Mapping configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/direct_source_to_target_mapping_1.png"/> + </imageobject> + </mediaobject> + </figure> + </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. + 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> @@ -115,9 +117,7 @@ </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> + <para>Another method of adding a <emphasis>Java Mapping</emphasis> element to the canvas in the Processing Tasks section is to right click on the Input Task element and select <emphasis>Java Mapping</emphasis> in the popup menu. </para> <figure> <title>Java Mapping configuration</title> <mediaobject> @@ -127,7 +127,7 @@ </mediaobject> </figure> <para> - Right-click on the canvas in an empty space and select "Add ->Java Class". + Right-click on the canvas in an empty space and select <menuchoice><guimenuitem>Add</guimenuitem><guimenuitem>Java Class</guimenuitem></menuchoice>. </para> <figure> <title>Java Mapping configuration</title> @@ -138,14 +138,7 @@ </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. + This will display the <emphasis>Java Bean Creation</emphasis> wizard. Specify a unique identifier for the new class and the class path. If the Java class is specified, you'll see a list of the properties in the box below. Click the <guibutton>Finish</guibutton> button 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 something like the one on the picture below. </para> <figure> <title>Final Mapping schema</title> @@ -155,17 +148,14 @@ </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>The movie <ulink url="http://www.screencast.com/users/tfennelly/folders/Camtasia/medi... to Java"</ulink> has more information on this process. </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... + <para>If you are interested in transforming EDI to Java you can find more information <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 <xref linkend="mapping"/>, 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>The "Apply Template" task works very similarly to the section <xref linkend="mapping"/>, where you define a mapping 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> @@ -176,8 +166,7 @@ </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> + This will display the <property>Message Type Selection</property> wizard. In our example we will transfer our data to csv output format, so you should select <emphasis><property>CSV</property></emphasis> and click the <guibutton>Next</guibutton> button.</para> <figure> <title>Message Type Selection</title> <mediaobject> @@ -187,7 +176,7 @@ </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> + On the next wizard page put the following string into the Fields, select <property>Output Fields Names</property> and click the <property>Finish</property> button.</para> <figure> <title>CSV output message configuration</title> <mediaobject> @@ -197,15 +186,9 @@ </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): + After these steps the <property>"Apply Template"</property> task will appear to the right, connected to the task you created it from. To continue the configuration processyou should click on it and find the <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 corresponding <emphasis>csv-record</emphasis>. In our example output only the elements + of <property>orderItems</property> collection to the CSV format (see the picture below): </para> <figure> <title>Relations between input and output models</title> @@ -216,14 +199,11 @@ </mediaobject> </figure> </section> +</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>This option is used 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 select the <emphasis><property>Run->Smooks Run Configuration</property></emphasis> option in the top menu bar. The Smooks Configuration file will then be run automatically. </para> <figure> <title>Smooks Configuration testing</title> @@ -233,9 +213,7 @@ </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> + <para>Any errors or warnings will appear in a pop up 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" Modified: branches/jbosstools-3.2.x/smooks/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.2.x/smooks/docs/reference/pom.xml 2011-07-18 02:42:15 UTC (rev 32984) +++ branches/jbosstools-3.2.x/smooks/docs/reference/pom.xml 2011-07-18 02:45:08 UTC (rev 32985) @@ -1,7 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> -<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"> +<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> @@ -10,229 +8,232 @@ <packaging>jdocbook</packaging> <name>${bookname}-(${translation})</name> - <properties> - <translation>en-US</translation> - <docname>Smooks_Reference_Guide</docname> - <bookname>Smooks Reference Guide</bookname> - </properties> - - <profiles> + <properties> + <translation>en-US</translation> + <docname>Smooks_Reference_Guide</docname> + <bookname>Smooks Reference Guide</bookname> + </properties> + <profiles> + <!-- mvn compile --> - <profile> - <id>all</id> - <activation> - <activeByDefault>true</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>${docname}.pdf</finalName> - </format> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>html_single</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>eclipse</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - </configuration> - </plugin> + <profile> + <id>all</id> + <activation> + <activeByDefault>true</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.4</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${docname}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + <options> + <useRelativeImageUris>true</useRelativeImageUris> + </options> + </configuration> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Phtml --> - <profile> - <id>html</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - </configuration> - </plugin> + <profile> + <id>html</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + </configuration> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Phtml-single --> - <profile> - <id>html-single</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - </plugin> + <profile> + <id>html-single</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Ppdf --> - <profile> - <id>pdf</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>${docname}.pdf</finalName> - </format> - </formats> - </configuration> - </plugin> + <profile> + <id>pdf</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${docname}.pdf</finalName> + </format> + </formats> + </configuration> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Peclipse --> - <profile> - <id>eclipse</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>eclipse</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - </configuration> - </plugin> - </plugins> - </build> - </profile> + <profile> + <id>eclipse</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + </configuration> + </plugin> + </plugins> + </build> + </profile> - </profiles> - <build> - <pluginManagement> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <dependencies> - <dependency> - <groupId>org.jboss.pressgang</groupId> - <artifactId>pressgang-xslt</artifactId> - <version>1.2.0</version> - </dependency> - <dependency> - <groupId>org.jboss</groupId> - <artifactId>jbossorg-jdocbook-style</artifactId> - <version>1.1.1</version> - <type>jdocbook-style</type> - </dependency> - </dependencies> - <configuration> - <sourceDirectory>${project.basedir}</sourceDirectory> + </profiles> + <build> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <dependencies> + <dependency> + <groupId>org.jboss.pressgang</groupId> + <artifactId>pressgang-xslt</artifactId> + <version>1.2.0</version> + </dependency> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-jdocbook-style</artifactId> + <version>1.1.1</version> + <type>jdocbook-style</type> + </dependency> + </dependencies> + <configuration> + <sourceDirectory>${project.basedir}</sourceDirectory> <!-- <sourceDocumentName>${docname}.xml</sourceDocumentName> --> - <sourceDocumentName>master.xml</sourceDocumentName> - <masterTranslation>en-US</masterTranslation> - <imageResource> - <directory>${project.basedir}/en-US</directory> - <includes> - <include>images/**/*</include> - </includes> - </imageResource> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>${pdf.name}</finalName> - </format> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>html_single</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>eclipse</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - <options> - <xincludeSupported>true</xincludeSupported> - <xmlTransformerType>saxon</xmlTransformerType> - <docbookVersion>1.72.0</docbookVersion> - <localeSeparator>-</localeSeparator> - <transformerParameters> - <property> - <name>javax.xml.parsers.DocumentBuilderFactory</name> - <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value> - </property> - <property> - <name>javax.xml.parsers.SAXParserFactory</name> - <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value> - </property> - </transformerParameters> - </options> - </configuration> - </plugin> - </plugins> - </pluginManagement> - </build> + <sourceDocumentName>master.xml</sourceDocumentName> + <masterTranslation>en-US</masterTranslation> + <imageResource> + <directory>${project.basedir}/en-US</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${pdf.name}</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <docbookVersion>1.72.0</docbookVersion> + <localeSeparator>-</localeSeparator> + <transformerParameters> + <property> + <name>javax.xml.parsers.DocumentBuilderFactory</name> + <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value> + </property> + <property> + <name>javax.xml.parsers.SAXParserFactory</name> + <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value> + </property> + </transformerParameters> + </options> + </configuration> + </plugin> + </plugins> + </pluginManagement> + </build> </project>