[jbosstools-commits] JBoss Tools SVN: r12271 - in trunk/smooks/docs/reference/en: images/common and 1 other directories.

Author: DartPeng Date: 2008-12-04 02:15:33 -0500 (Thu, 04 Dec 2008) New Revision: 12271 Added: trunk/smooks/docs/reference/en/images/common/configuration_page.png trunk/smooks/docs/reference/en/images/common/date_type_detail_page.png trunk/smooks/docs/reference/en/images/common/import_file.png trunk/smooks/docs/reference/en/images/common/java_property_view.png trunk/smooks/docs/reference/en/images/common/mapping_property_view.png trunk/smooks/docs/reference/en/images/common/resource_type_wizard.png trunk/smooks/docs/reference/en/images/common/smooks_parse_type.png trunk/smooks/docs/reference/en/images/common/xml_property_view.png trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml Modified: trunk/smooks/docs/reference/en/master.xml trunk/smooks/docs/reference/en/modules/introduction.xml trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml Log: JBIDE-3296 Add some new chapters. Added: trunk/smooks/docs/reference/en/images/common/configuration_page.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en/images/common/configuration_page.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en/images/common/date_type_detail_page.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en/images/common/date_type_detail_page.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en/images/common/import_file.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en/images/common/import_file.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en/images/common/java_property_view.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en/images/common/java_property_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en/images/common/mapping_property_view.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en/images/common/mapping_property_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en/images/common/resource_type_wizard.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en/images/common/resource_type_wizard.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en/images/common/smooks_parse_type.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en/images/common/smooks_parse_type.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en/images/common/xml_property_view.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en/images/common/xml_property_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: trunk/smooks/docs/reference/en/master.xml =================================================================== --- trunk/smooks/docs/reference/en/master.xml 2008-12-04 05:59:25 UTC (rev 12270) +++ trunk/smooks/docs/reference/en/master.xml 2008-12-04 07:15:33 UTC (rev 12271) @@ -7,6 +7,7 @@ <!ENTITY quickstart SYSTEM "modules/quick_start.xml"> <!ENTITY smooksformeditor_graphicaltab SYSTEM "modules/smooksformeditor_graphicalpage.xml"> <!ENTITY smooksformeditor_configurationtab SYSTEM "modules/smooksformeditor_configurationpage.xml"> +<!ENTITY smooksformeditor_sourcetab SYSTEM "modules/smooksformeditor_sourcepage.xml"> ]> <book> @@ -42,4 +43,5 @@ &quickstart; &smooksformeditor_graphicaltab; &smooksformeditor_configurationtab; + &smooksformeditor_sourcetab; </book> Modified: trunk/smooks/docs/reference/en/modules/introduction.xml =================================================================== --- trunk/smooks/docs/reference/en/modules/introduction.xml 2008-12-04 05:59:25 UTC (rev 12270) +++ trunk/smooks/docs/reference/en/modules/introduction.xml 2008-12-04 07:15:33 UTC (rev 12271) @@ -84,15 +84,21 @@ </sect1> <sect1> <title>How to install Smooks dev tools?</title> - <para>The Smooks dev tools was contained by JBossTools since 3.0.0 + <para> + The Smooks dev tools was contained in the JBossTools since 3.0.0 beta1 version. You can download the JBossTools form : - .</para> + <link>http://www.jboss.org/tools/download/index.html + </link> + . + </para> <para> Smooks dev tools(JBossTools) need the latest Eclipse and other required plug-ins(GEF,EMF,etc.), - User can download the latest IDE for Java EE developers from this site( + User can download the latest IDE for + Java EE developers from this site( <link>http://www.eclipse.org/downloads/ - </link>) for installing JBossTools. + </link> + ) for installing JBossTools. </para> </sect1> </chapter> Modified: trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml =================================================================== --- trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2008-12-04 05:59:25 UTC (rev 12270) +++ trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml 2008-12-04 07:15:33 UTC (rev 12271) @@ -25,10 +25,6 @@ <para> The <link linkend="configurationpage_datedecoder">"Date Decoder"</link> - , - <link linkend="configurationpage_documenttype">"Document Type"</link> - , - <link linkend="configurationpage_unhandleresourceconfig">"Unhandle ResourceConfig"</link> can add/edit/remove on the configuration editor @@ -89,12 +85,81 @@ </tip> </section> <section id="configurationpage_datedecoder"> - <title>Date Decoder</title> + <title>Date Decoder Detail Page</title> + <para> + "Date Decoder" is a resourceConfig element in the Smooks + configuration + file.It describe how to transform the "Date" type. + </para> + <para> + Click "New" button to open the "New Resource Type" wizard + dialog.</para> + <figure> + <title>Resource Type Selection Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/common/resource_type_wizard.png" + scale="90" /> + </imageobject> + </mediaobject> + </figure> + + <para>There are several resource type on the list. Select the + "Date + Decoder" and click "Finish" button , a new "Date Decoder" item + is + added and shown on the resource type list. + </para> + <para> + There are several parameters in the "Date Decoder" + resourceConfig element: + </para> + <para> + <orderedlist numeration="loweralpha" inheritnum="inherit"> + <listitem> + locale-language + </listitem> + <listitem> + format + </listitem> + <listitem> + locale-country + </listitem> + </orderedlist> + </para> + <para> + User can modify the parameters of the "Date Decoder" item on the + left detail page. + </para> + <figure> + <title>Date Decoder Detail Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/common/date_type_detail_page.png" + scale="90" /> + </imageobject> + </mediaobject> + </figure> + <para> + When user defined new "Date Decoder" , they can use the + <link linkend="graphicalpage_propertiesview"> "JavaBean Properties" GUI</link> + to set the them to + be the "Java type". + </para> + <!-- + <para> The XML fragment generated by Smooks tools for the "Date + Decoder": </para> <para> <programlisting> <![CDATA[<resource-config + selector="decoder:DateLong"> + <resource>org.milyn.javabean.decoders.DateDecoder</resource> <param + name="locale-language">en</param> <param name="format">yyy-MM-dd + HH:mm:ss</param> <param name="locale-country">IE</param> + </resource-config>]]> </programlisting> </para> + --> </section> - <section id="configurationpage_documenttype"> - <title>Document Type</title> - </section> - <section id="configurationpage_unhandleresourceconfig"> - <title>Unhandle ResourceConfig</title> - </section> + <!-- + <section id="configurationpage_documenttype"> <title>Document Type + Detail Page</title> <para> </para> </section> <section + id="configurationpage_unhandleresourceconfig"> <title>Unhandle + ResourceConfig</title> </section> + --> </chapter> \ No newline at end of file Modified: trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml =================================================================== --- trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml 2008-12-04 05:59:25 UTC (rev 12270) +++ trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml 2008-12-04 07:15:33 UTC (rev 12271) @@ -106,7 +106,8 @@ "Mapping Logic" ,Some error messages will be shown on the <link linkend="quickstart_formeditor">"Error - message area"</link>. + message area"</link> + . </para> <para> Please read the @@ -114,4 +115,71 @@ to find how to fix the errors. </para> </section> + <section id="graphicalpage_propertiesview"> + <title>Properties Viewer</title> + <para> + User can edit the properties of the "connection lines" with the + properties viewer. + </para> + <para> + Select the menu : "Window -> Show View -> Other -> Properties" , + the properties viewer will be opened. + </para> + <para> + When user select the connection lines , the properties viewer + will show a sets of sections GUI for editing the properties of the + connection line. + </para> + <tip> + <title>Note</title> + <para> + These GUI on the properties viewer will be displayed when the + "Smooks + Graphical Page" was active,if not the properties viewer will + display empty GUI. + </para> + <para> + If the source data type of the selected connection line was + "XML" ,The properties viewer will show a "XML Properties" section + GUI. + </para> + <para> + But the source data type of the selected connection line was + "Java" , + the "XML Properties" section GUI dosen't display. + </para> + <para> + It means that if the source/target data type of the selected + connection line was different , the properties viewer will show + different GUI. + </para> + </tip> + <figure> + <title>JavaBean Properties Section</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/common/java_property_view.png" + scale="90" /> + </imageobject> + </mediaobject> + </figure> + <figure> + <title>XML properties section</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/common/xml_property_view.png" + scale="90" /> + </imageobject> + </mediaobject> + </figure> + <figure> + <title>Mapping properties section</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/common/mapping_property_view.png" + scale="90" /> + </imageobject> + </mediaobject> + </figure> + </section> </chapter> \ No newline at end of file Added: trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml =================================================================== --- trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml (rev 0) +++ trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml 2008-12-04 07:15:33 UTC (rev 12271) @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="smooksformeditor_sourcetab" xreflabel="Smooks Source Editor Page"> + <?dbhtml filename="smooks_form_editor_sourcetab.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Smooks</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Smooks Source Editor Page</title> + <section> + <title>XML Source Editor</title> + <para> + User can use this editor to edit the Smooks configuration file + directly. + </para> + <figure> + <title>Graphical Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/common/xml_source_editor.png" + scale="90" /> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Error Messages GUI</title> + <para> + If the Smooks tools can't understand the configuration file or + the configuration file was illegal(XML structure isn't right for + Smooks configuration file , etc.),The error message panel will + display above the XML editor. + </para> + <figure> + <title>Graphical Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/common/xml_source_editor_error.png" + scale="90" /> + </imageobject> + </mediaobject> + </figure> + <tip> + <title>Note</title> + <para> + When the error message panel was displayed , other editors ( + Graphical Editor , Configuration Editor ) will be disabled. + </para> + <para> + User can't edit the configuration file with other editors until + file was right. + </para> + </tip> + </section> +</chapter> \ No newline at end of file Property changes on: trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml ___________________________________________________________________ Name: svn:mime-type + text/plain