June 2010 - jbosstools-commits - Jboss List Archives

JBoss Tools SVN: r22666 - tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 20:45:19 -0400 (Tue, 08 Jun 2010) New Revision: 22666 Modified: tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/client.xml tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/master.xml tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/master_output.xml tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/topdown.xml Log: updated for 3.0.1 Modified: tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/client.xml =================================================================== --- tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/client.xml 2010-06-09 00:42:13 UTC (rev 22665) +++ tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/client.xml 2010-06-09 00:45:19 UTC (rev 22666) @@ -66,4 +66,8 @@ </listitem> </itemizedlist> <para>JBoss WS use a Java class to test Web Service. A client sample class will be generated, you may run this client as a java application to call a web service.</para> + <note> + <title>Note:</title> + <para>To run <property>client sample</property> as a Java application you need a <property>JBoss Runtime</property> in build path. </para> + </note> </chapter> Modified: tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/master.xml 2010-06-09 00:42:13 UTC (rev 22665) +++ tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/master.xml 2010-06-09 00:45:19 UTC (rev 22666) @@ -34,7 +34,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 1.1.0.GA + Version: 1.1.1.GA </releaseinfo> <abstract> <title/> Modified: tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/master_output.xml 2010-06-09 00:42:13 UTC (rev 22665) +++ tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/master_output.xml 2010-06-09 00:45:19 UTC (rev 22666) @@ -2,15 +2,15 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" "http://www.docbook.org/xml/4.3/docbookx.dtd" -[<!ENTITY overview SYSTEM "modules/overview.xml"> -<!ENTITY topdown SYSTEM "modules/topdown.xml"> -<!ENTITY preference SYSTEM "modules/preference.xml"> -<!ENTITY webproject SYSTEM "modules/webproject.xml"> -<!ENTITY client SYSTEM "modules/client.xml"> +[<!ENTITY overview SYSTEM "overview.xml"> +<!ENTITY topdown SYSTEM "topdown.xml"> +<!ENTITY preference SYSTEM "preference.xml"> +<!ENTITY webproject SYSTEM "webproject.xml"> +<!ENTITY client SYSTEM "client.xml"> ]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> <bookinfo> - <title>JBoss WS User Guide</title> + <title>JBoss Web Services User Guide</title> <corpauthor> <inlinemediaobject> @@ -32,7 +32,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 1.1.0.GA + Version: 1.1.1.GA </diffmk:wrapper></releaseinfo> <abstract> <title></title> @@ -46,7 +46,7 @@ <toc></toc> -<chapter id="overview" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/ws/docs/reference/en/modules/overview.xml"> +<chapter id="overview" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/ws/docs/reference/en-US/overview.xml"> <title>JBossWS Runtime Overview</title> <para>JBossWS is a web service framework developed as a part of the JBoss Application Server. It implements the JAX-WS specification that defines a programming model and run-time architecture for implementing web services in Java, targeted at the Java Platform, Enterprise Edition 5 (Java EE 5).</para> @@ -132,7 +132,7 @@ </chapter> -<chapter id="create_ws_topdown" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/ws/docs/reference/en/modules/topdown.xml"> +<chapter id="create_ws_topdown" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/ws/docs/reference/en-US/topdown.xml"> <?dbhtml filename="topdown.html"?> <chapterinfo> <keywordset> @@ -196,7 +196,7 @@ </figure> </listitem> </itemizedlist> - <para>If you added the JBoss Web Service facet to the project, now the <property moreinfo="none">Finish</property> button is disable. You must click <property moreinfo="none">Next</property> button to set more information about the JBoss Web Service facet. The page is like <property moreinfo="none">Figure 2.5</property>. Then click on the <property moreinfo="none">Finish</property> button.</para> + <para>If you added the JBoss Web Service facet to the project, now the <property moreinfo="none">Finish</property><diffmk:wrapper diffmk:change="changed"> button is unavailable. You must click </diffmk:wrapper><property moreinfo="none">Next</property> button to set more information about the JBoss Web Service facet. The page is like <property moreinfo="none">Figure 2.5</property>. Then click on the <property moreinfo="none">Finish</property> button.</para> <para>If you didn't add the JBoss Web Service facet to the project, click on the <property moreinfo="none">Finish</property> button. Next you will need to add JBoss Web Service facet to the project.</para> </section> @@ -463,9 +463,9 @@ </figure> <itemizedlist> <listitem> - <para>Generate WSDL file: select it, you will get a generated WSDL file in your - project. But this wsdl's services' address location values are not a real - address. </para> + <para><diffmk:wrapper diffmk:change="changed">Generate WSDL file: select it, you will get a generated WSDL file in your + project. But this wsdl's service address location values are not a real + address. </diffmk:wrapper></para> </listitem> <listitem> <para>After the Web service has been created, the following option can become @@ -510,7 +510,7 @@ <listitem> <para>If you selected to update the default web.xml, you will test the web service in the browser. Open the Explorer, input the url for the web service according to - web.xml plus <property moreinfo="none">?wsdl.</property>, you will get the WSDL file from Explorer. </para> + web.xml plus <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">?wsdl</diffmk:wrapper></property>, you will get the WSDL file from Explorer. </para> <figure float="0"> <title>The Updated web.xml file</title> <mediaobject> @@ -528,7 +528,7 @@ </chapter> -<chapter id="client" revisionflag="added" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/ws/docs/reference/en/modules/client.xml"> +<chapter id="client" revisionflag="added" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/ws/docs/reference/en-US/client.xml"> <title>Creating a Web Service Client from a WSDL Document using JBoss WS</title> <para>To create a Web Service Client from a WSDL Document using JBoss WS you need to fulfil the following steps:</para> <para>Setup <link linkend="preference">JBoss WS and development environment</link>.</para> @@ -595,10 +595,14 @@ </listitem> </itemizedlist> <para>JBoss WS use a Java class to test Web Service. A client sample class will be generated, you may run this client as a java application to call a web service.</para> + <note diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note:</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To run </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">client sample</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> as a Java application you need a </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Runtime</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> in build path. </diffmk:wrapper></para> + </note> </chapter> -<chapter id="preference" revisionflag="added" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/ws/docs/reference/en/modules/preference.xml"> +<chapter id="preference" revisionflag="added" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/ws/docs/reference/en-US/preference.xml"> <title>JBoss WS and development environment</title> <para>In this chapter you will learn how to change JBossWS preferences and how to set default server and runtime.</para> @@ -697,8 +701,8 @@ <property moreinfo="none">JBossWS</property>. It describes how to easily create a Web Service and a Web Service Client using JBossWS Runtime and adjust JBossWS and development environment as well.</para> - <para>If the information on JBossWS tools in this guide isn't enough for you, ask - questions on our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">forum</ulink>. Your comments and suggestions are also welcome.</para> + <para>If the information on JBossWS tools in this guide isn't enough for you, ask + questions on our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">forum</ulink>. Your comments and suggestions are also welcome.</para> </section> </chapter> Modified: tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/topdown.xml =================================================================== --- tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/topdown.xml 2010-06-09 00:42:13 UTC (rev 22665) +++ tags/jbosstools-3.1.1.GA/ws/docs/reference/en-US/topdown.xml 2010-06-09 00:45:19 UTC (rev 22666) @@ -63,7 +63,7 @@ </figure> </listitem> </itemizedlist> - <para>If you added the JBoss Web Service facet to the project, now the <property>Finish</property> button is disable. You must click <property>Next</property> button to set more information about the JBoss Web Service facet. The page is like <property>Figure 2.5</property>. Then click on the <property>Finish</property> button.</para> + <para>If you added the JBoss Web Service facet to the project, now the <property>Finish</property> button is unavailable. You must click <property>Next</property> button to set more information about the JBoss Web Service facet. The page is like <property>Figure 2.5</property>. Then click on the <property>Finish</property> button.</para> <para>If you didn't add the JBoss Web Service facet to the project, click on the <property>Finish</property> button. Next you will need to add JBoss Web Service facet to the project.</para> </section> @@ -332,7 +332,7 @@ <itemizedlist> <listitem> <para>Generate WSDL file: select it, you will get a generated WSDL file in your - project. But this wsdl's services' address location values are not a real + project. But this wsdl's service address location values are not a real address. </para> </listitem> <listitem> @@ -378,7 +378,7 @@ <listitem> <para>If you selected to update the default web.xml, you will test the web service in the browser. Open the Explorer, input the url for the web service according to - web.xml plus <property>?wsdl.</property>, you will get the WSDL file from Explorer. </para> + web.xml plus <property>?wsdl</property>, you will get the WSDL file from Explorer. </para> <figure> <title>The Updated web.xml file</title> <mediaobject>

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22665 - in tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US: images/struts_application and 1 other directory.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 20:42:13 -0400 (Tue, 08 Jun 2010) New Revision: 22665 Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/compiling_and_running.xml tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/images/struts_application/struts_application_6.png tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/master.xml tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/master_output.xml tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/relevant_resources.xml tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/struts_validation.xml Log: updated for 3.0.1 Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/compiling_and_running.xml =================================================================== --- tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/compiling_and_running.xml 2010-06-09 00:39:29 UTC (rev 22664) +++ tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/compiling_and_running.xml 2010-06-09 00:42:13 UTC (rev 22665) @@ -16,10 +16,10 @@ <para>Thus at this point everything is ready for running our application without having to leave JBoss Developer Studio by using the JBoss Application Server engine that comes with the JBoss - Developer Studio. For controlling JBoss AS within JBoss Developer Studio, there is JBoss - Server view.</para> + Developer Studio. For controlling JBoss AS within JBoss Developer Studio, there is + Servers view.</para> <figure> - <title>JBoss Server Panel</title> + <title>Servers Panel</title> <mediaobject> <imageobject> <imagedata fileref="images/struts_application/struts_application_6.png"/> @@ -28,7 +28,7 @@ </figure> <itemizedlist> <listitem> - <para>Start up JBoss AS by clicking on the icon in JBoss Server view. (If JBoss AS + <para>Start up JBoss AS by clicking on the icon in Servers view. (If JBoss AS is already running, stop it by clicking on the red icon and then start it again. Remember, the Struts run-time requires restarting the servlet engine when any changes have been made.)</para> Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/images/struts_application/struts_application_6.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/master.xml 2010-06-09 00:39:29 UTC (rev 22664) +++ tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/master.xml 2010-06-09 00:42:13 UTC (rev 22665) @@ -50,7 +50,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 3.1.0.GA + Version: 3.1.1.GA </releaseinfo> <abstract> Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/master_output.xml 2010-06-09 00:39:29 UTC (rev 22664) +++ tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/master_output.xml 2010-06-09 00:42:13 UTC (rev 22665) @@ -2,13 +2,13 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.docbook.org/xml/4.3/docbookx.dtd" -[<!ENTITY introduction SYSTEM "modules/introduction.xml"> -<!ENTITY struts_application SYSTEM "modules/struts_application.xml"> -<!ENTITY generating_stub SYSTEM "modules/generating_stub.xml"> -<!ENTITY coding_files SYSTEM "modules/coding_files.xml"> -<!ENTITY compiling_and_running SYSTEM "modules/compiling_and_running.xml"> -<!ENTITY struts_validation SYSTEM "modules/struts_validation.xml"> -<!ENTITY relevant_resources SYSTEM "modules/relevant_resources.xml"> +[<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY struts_application SYSTEM "struts_application.xml"> +<!ENTITY generating_stub SYSTEM "generating_stub.xml"> +<!ENTITY coding_files SYSTEM "coding_files.xml"> +<!ENTITY compiling_and_running SYSTEM "compiling_and_running.xml"> +<!ENTITY struts_validation SYSTEM "struts_validation.xml"> +<!ENTITY relevant_resources SYSTEM "relevant_resources.xml"> <!ENTITY seamlink "../../seam/html_single/index.html"> <!ENTITY aslink "../../as/html_single/index.html"> @@ -48,7 +48,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 3.1.0.GA + Version: 3.1.1.GA </diffmk:wrapper></releaseinfo> <abstract> @@ -64,7 +64,7 @@ <toc></toc> -<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_tutorial/en/modules/introduction.xml" xreflabel="introduction"> +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_tutorial/en-US/introduction.xml" xreflabel="introduction"> <?dbhtml filename="introduction.html"?> <chapterinfo> <keywordset> @@ -76,7 +76,7 @@ </chapterinfo> <title>Introduction</title> <para>The following chapters describe how to deal with classic/old style of Struts development. We - recommend users to use <ulink url="../../seam/html_single/index.html">JBoss Seam</ulink> to + recommend users to use JBoss Seam to simplify development, but until then you can read about classical Struts usage here.</para> <para>We are going to show you how to create a simple <emphasis> @@ -165,7 +165,7 @@ </chapter> -<chapter id="struts_application" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_tutorial/en/modules/struts_application.xml" xreflabel="struts_application"> +<chapter id="struts_application" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_tutorial/en-US/struts_application.xml" xreflabel="struts_application"> <?dbhtml filename="struts_application.html"?> <chapterinfo> <keywordset> @@ -592,7 +592,7 @@ </section> </chapter> -<chapter id="generating_stub" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_tutorial/en/modules/generating_stub.xml" xreflabel="generating_stub"> +<chapter id="generating_stub" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_tutorial/en-US/generating_stub.xml" xreflabel="generating_stub"> <?dbhtml filename="generating_stub.html"?> <chapterinfo> <keywordset> @@ -643,7 +643,7 @@ been generated.</para> </chapter> -<chapter id="coding_files" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_tutorial/en/modules/coding_files.xml" xreflabel="coding_files"> +<chapter id="coding_files" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_tutorial/en-US/coding_files.xml" xreflabel="coding_files"> <?dbhtml filename="coding_files.html"?> <chapterinfo> <keywordset> @@ -1072,7 +1072,7 @@ </section> </chapter> -<chapter id="compiling_and_running" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_tutorial/en/modules/compiling_and_running.xml" xreflabel="compiling_and_running"> +<chapter id="compiling_and_running" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_tutorial/en-US/compiling_and_running.xml" xreflabel="compiling_and_running"> <?dbhtml filename="compiling_and_running.html"?> <chapterinfo> <keywordset> @@ -1087,12 +1087,12 @@ <para>As this is the Eclipse environment, no explicit compilation step is required. By default, Eclipse compiles as you go.</para> - <para>Thus at this point everything is ready for running our application without having to leave JBoss + <para><diffmk:wrapper diffmk:change="changed">Thus at this point everything is ready for running our application without having to leave JBoss Developer Studio by using the JBoss Application Server engine that comes with the JBoss - Developer Studio. For controlling JBoss AS within JBoss Developer Studio, there is JBoss - Server view.</para> + Developer Studio. For controlling JBoss AS within JBoss Developer Studio, there is + Servers view.</diffmk:wrapper></para> <figure float="0"> - <title>JBoss Server Panel</title> + <title><diffmk:wrapper diffmk:change="changed">Servers Panel</diffmk:wrapper></title> <mediaobject> <imageobject> <imagedata fileref="images/struts_application/struts_application_6.png"></imagedata> @@ -1101,10 +1101,10 @@ </figure> <itemizedlist> <listitem> - <para>Start up JBoss AS by clicking on the icon in JBoss Server view. (If JBoss AS + <para><diffmk:wrapper diffmk:change="changed">Start up JBoss AS by clicking on the icon in Servers view. (If JBoss AS is already running, stop it by clicking on the red icon and then start it again. Remember, the Struts run-time requires restarting the servlet engine when any - changes have been made.)</para> + changes have been made.)</diffmk:wrapper></para> </listitem> <listitem> <para>After the messages in the Console tabbed view stop scrolling, JBoss AS is @@ -1115,7 +1115,7 @@ <para>The browser should appear with the application started.</para> </chapter> -<chapter id="struts_validation" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_tutorial/en/modules/struts_validation.xml" xreflabel="struts_validation"> +<chapter id="struts_validation" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_tutorial/en-US/struts_validation.xml" xreflabel="struts_validation"> <?dbhtml filename="struts_validation.html"?> <chapterinfo> <keywordset> @@ -1153,7 +1153,7 @@ <listitem><para>In the dialog box, click on the <emphasis><property moreinfo="none">Browse...</property></emphasis>button next to the Folder field, expand the JavaSource folder in this next dialog box, select the sample subfolder, and click on the <emphasis><property moreinfo="none">OK</property></emphasis> button</para></listitem> <listitem><para>Back in the first dialog box, type in "applResources" for the Name field and click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button</para></listitem> -<listitem><para>Right-click on a newly created file and select <emphasis><property moreinfo="none">Add > Default Error Messages</property></emphasis> +<listitem><para>Right-click on a newly created file and select <emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">New > Default Error Messages</diffmk:wrapper></property></emphasis> from the context menu</para></listitem> <listitem><para>Drag up the sample.applResources icon until you can drop it on the resources folder under struts-config.xml</para></listitem> @@ -1354,7 +1354,7 @@ </chapter> -<chapter id="relevant_resources" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_tutorial/en/modules/relevant_resources.xml" xreflabel="relevant_resources"> +<chapter id="relevant_resources" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_tutorial/en-US/relevant_resources.xml" xreflabel="relevant_resources"> <?dbhtml filename="relevant_resources.html"?> <chapterinfo> <keywordset> @@ -1366,7 +1366,7 @@ <title>Other Relevant Resources on the topic</title> - <para>Our reference: <ulink url="../../struts_tools_ref_guide/html_single/index.html">Struts Tools Reference Guide</ulink></para> + <para>Our reference: Struts Tools Reference Guide</para> <para>Apache Struts: <ulink url="http://struts.apache.org/">Struts Technology</ulink></para> <para>Struts 2: <ulink url="http://struts.apache.org/2.x/">Apache Struts 2</ulink></para> <para>Get Started: <ulink url="http://struts.apache.org/2.x/docs/home.html">Struts Getting @@ -1377,15 +1377,15 @@ <para>Download: <ulink url="http://struts.apache.org/download.cgi#struts206">Release of Apache Struts</ulink></para> - <para>Thus, this tutorial should help you to execute the hole development circle for building a - sample Struts-based Web application using <property moreinfo="none">JBoss Tools</property> bundle of Eclipse + <para><diffmk:wrapper diffmk:change="changed">Thus, this tutorial should help you to execute the whole development circle for building a + sample Struts-based Web application using </diffmk:wrapper><property moreinfo="none">JBoss Tools</property> bundle of Eclipse plugins starting from organizing a new Struts project and ending with the running and deploying it onto the <property moreinfo="none">JBoss Server</property>.</para> - <para>To find out all the features of <property moreinfo="none">JBoss Tools</property> for working with Struts - refer to our <ulink url="../../struts_tools_ref_guide/html_single/index.html">Struts Tools Reference Guide</ulink>. If you - still have questions you are always welcome on - <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss + <para>To find out all the features of <property>JBoss Tools</property> for working with Struts + refer to our Struts Tools Reference Guide. If you + still have questions you are always welcome on <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Forum</ulink>.</para> </chapter> Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/relevant_resources.xml =================================================================== --- tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/relevant_resources.xml 2010-06-09 00:39:29 UTC (rev 22664) +++ tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/relevant_resources.xml 2010-06-09 00:42:13 UTC (rev 22665) @@ -22,7 +22,7 @@ <para>Download: <ulink url="http://struts.apache.org/download.cgi#struts206">Release of Apache Struts</ulink></para> - <para>Thus, this tutorial should help you to execute the hole development circle for building a + <para>Thus, this tutorial should help you to execute the whole development circle for building a sample Struts-based Web application using <property>JBoss Tools</property> bundle of Eclipse plugins starting from organizing a new Struts project and ending with the running and deploying it onto the <property>JBoss Server</property>.</para> Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/struts_validation.xml =================================================================== --- tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/struts_validation.xml 2010-06-09 00:39:29 UTC (rev 22664) +++ tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_tutorial/en-US/struts_validation.xml 2010-06-09 00:42:13 UTC (rev 22665) @@ -37,7 +37,7 @@ <listitem><para>In the dialog box, click on the <emphasis><property>Browse...</property></emphasis>button next to the Folder field, expand the JavaSource folder in this next dialog box, select the sample subfolder, and click on the <emphasis><property>OK</property></emphasis> button</para></listitem> <listitem><para>Back in the first dialog box, type in "applResources" for the Name field and click on the <emphasis><property>Finish</property></emphasis> button</para></listitem> -<listitem><para>Right-click on a newly created file and select <emphasis><property>Add > Default Error Messages</property></emphasis> +<listitem><para>Right-click on a newly created file and select <emphasis><property>New > Default Error Messages</property></emphasis> from the context menu</para></listitem> <listitem><para>Drag up the sample.applResources icon until you can drop it on the resources folder under struts-config.xml</para></listitem>

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22664 - in tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US: images/struts and 1 other directory.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 20:39:29 -0400 (Tue, 08 Jun 2010) New Revision: 22664 Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/editors.xml tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_10.png tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_11.png tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_12.png tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_2.png tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_40.png tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_42.png tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_44.png tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_5.png tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_8.png tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_9.png tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/master.xml tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/master_output.xml tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/modules.xml tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/projects.xml Log: updated for 3.0.1 Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/editors.xml =================================================================== --- tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/editors.xml 2010-06-09 00:37:26 UTC (rev 22663) +++ tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/editors.xml 2010-06-09 00:39:29 UTC (rev 22664) @@ -25,7 +25,7 @@ <para><property>JBoss Tools</property> add the <emphasis> <property>web.xml</property></emphasis> file to created Struts project automatically and provides a special editor for its editing. - See the Visual Web Tools guide that gives a descriptive information on the web.xml editor.</para> + See the Visual Web Tools guide that gives a descriptive information on the <filename>web.xml</filename> editor.</para> </section> <section id="struts_config_editor"> @@ -166,7 +166,7 @@ <listitem><para>Under the <emphasis> <property>plug-ins</property></emphasis> node you can define a Struts plug-in. Right-click the node, select <emphasis> <property>Create Plug-in</property></emphasis> - and specify the plug-ib <emphasis> + and specify the plug-in <emphasis> <property>Id</property></emphasis> and <emphasis> <property>ClassName</property></emphasis> by pointing to the Java class which implements the org.apache.struts.action.PlugIn interface. </para></listitem> Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_10.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_11.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_12.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_2.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_40.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_42.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_44.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_5.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_8.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/images/struts/struts_9.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/master.xml 2010-06-09 00:37:26 UTC (rev 22663) +++ tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/master.xml 2010-06-09 00:39:29 UTC (rev 22664) @@ -53,7 +53,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 3.1.0.GA + Version: 3.1.1.GA </releaseinfo> <abstract> Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/master_output.xml 2010-06-09 00:37:26 UTC (rev 22663) +++ tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/master_output.xml 2010-06-09 00:39:29 UTC (rev 22664) @@ -3,15 +3,15 @@ "http://www.docbook.org/xml/4.3/docbookx.dtd" [ -<!ENTITY introduction SYSTEM "modules/introduction.xml"> -<!ENTITY projects SYSTEM "modules/projects.xml"> -<!ENTITY editors SYSTEM "modules/editors.xml"> -<!ENTITY modules SYSTEM "modules/modules.xml"> -<!ENTITY code_generation SYSTEM "modules/code_generation.xml"> -<!ENTITY config_file_debugger SYSTEM "modules/config_file_debugger.xml"> -<!ENTITY page_links_recognizer SYSTEM "modules/page_links_recognizer.xml"> -<!ENTITY project_verification SYSTEM "modules/project_verification.xml"> -<!ENTITY rel_resources_links SYSTEM "modules/rel_resources_links.xml"> +<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY projects SYSTEM "projects.xml"> +<!ENTITY editors SYSTEM "editors.xml"> +<!ENTITY modules SYSTEM "modules.xml"> +<!ENTITY code_generation SYSTEM "code_generation.xml"> +<!ENTITY config_file_debugger SYSTEM "config_file_debugger.xml"> +<!ENTITY page_links_recognizer SYSTEM "page_links_recognizer.xml"> +<!ENTITY project_verification SYSTEM "project_verification.xml"> +<!ENTITY rel_resources_links SYSTEM "rel_resources_links.xml"> <!ENTITY seamlink "../../seam/html_single/index.html"> <!ENTITY aslink "../../as/html_single/index.html"> @@ -52,7 +52,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 3.1.0.GA + Version: 3.1.1.GA </diffmk:wrapper></releaseinfo> <abstract> @@ -68,7 +68,7 @@ <toc></toc> -<chapter id="intoduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en/modules/introduction.xml"> +<chapter id="intoduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en-US/introduction.xml"> <?dbhtml filename="introduction.html"?> <chapterinfo> @@ -179,7 +179,7 @@ </chapter> -<chapter id="projects" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en/modules/projects.xml"> +<chapter id="projects" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en-US/projects.xml"> <?dbhtml filename="projects.html"?> <chapterinfo> @@ -335,7 +335,7 @@ <title>Importing an Existing Struts Project with Any Structure</title> - <para>For detailed information on migration projects to JBoss Developer Studio see <ulink url="../../Exadel-migration/html_single/index.html">Migration Guide</ulink>.</para> + <para><diffmk:wrapper diffmk:change="changed">For detailed information on migration projects to JBoss Developer Studio see the Migration Guide.</diffmk:wrapper></para> </section> <section id="AddingStrutsCapabilityToAnExistingWebApplication532"> @@ -431,9 +431,9 @@ </mediaobject> </figure> - <para>When done, you can open end edit the struts-config.xml file using useful Struts + <para><diffmk:wrapper diffmk:change="changed">When done, you can open and edit the struts-config.xml file using useful Struts configuration file editor provided by JBDS. (The Struts configuration is shown below in - the Tree viewer).</para> + the Tree viewer).</diffmk:wrapper></para> <figure float="0"> <title>Struts-config.xml File</title> @@ -448,13 +448,13 @@ <section> <title>Relevant Resources Links</title> - <para>You can find more in-depth explanation on how to work with special wizards, editors and views that can - be used in various scenarios while developing Struts applications in our <ulink url="../../jsf/html_single/index.html">Visual Web Tools guide</ulink>.</para> + <para><diffmk:wrapper diffmk:change="changed">You can find more in-depth explanation on how to work with special wizards, editors and views that can + be used in various scenarios while developing Struts applications in our Visual Web Tools Guide.</diffmk:wrapper></para> </section> </chapter> -<chapter id="editors" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en/modules/editors.xml"> +<chapter id="editors" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en-US/editors.xml"> <?dbhtml filename="editors.html"?> <chapterinfo> <keywordset> @@ -479,8 +479,8 @@ describes the servlets and other components and deployment properties that make up your application.</para> <para><property moreinfo="none">JBoss Tools</property> add the <emphasis> - <property moreinfo="none">web.xml</property></emphasis> file to created Struts project automatically and provides a special editor for its editing. - See the Visual Web Tools guide that gives a descriptive information on the <ulink url="../../jsf/html_single/index.html#GraphicalWebApplicationFileEditor">web.xml editor</ulink>.</para> + <property moreinfo="none">web.xml</property></emphasis><diffmk:wrapper diffmk:change="added"> file to created Struts project automatically and provides a special editor for its editing. + See the Visual Web Tools guide that gives a descriptive information on the </diffmk:wrapper><filename diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">web.xml</diffmk:wrapper></filename><diffmk:wrapper diffmk:change="added"> editor.</diffmk:wrapper></para> </section> <section id="struts_config_editor"> @@ -620,8 +620,8 @@ <listitem><para>Under the <emphasis> <property moreinfo="none">plug-ins</property></emphasis> node you can define a Struts plug-in. Right-click the node, select <emphasis> - <property moreinfo="none">Create Plug-in</property></emphasis> - and specify the plug-ib <emphasis> + <property moreinfo="none">Create Plug-in</property></emphasis><diffmk:wrapper diffmk:change="changed"> + and specify the plug-in </diffmk:wrapper><emphasis> <property moreinfo="none">Id</property></emphasis> and <emphasis> <property moreinfo="none">ClassName</property></emphasis> by pointing to the Java class which implements the org.apache.struts.action.PlugIn interface. </para></listitem> @@ -655,7 +655,7 @@ <para>File Folding</para> </listitem> </itemizedlist> - <para>You can take advantage of <ulink url="../../jsf/html_single/index.html#CodeAssistAndDynamicCodeAssist42BasedOnProjectData">code assist</ulink>.</para> + <para>You can take advantage of code assist.</para> <figure float="0"> <title>Code Assist</title> <mediaobject> @@ -688,7 +688,7 @@ </mediaobject> </figure> - <para>Find more information about editor features <ulink url="../../jsf/html_single/index.html#editors_features">in the editor features chapter</ulink>.</para> + <para>Find more information about editor features in the editor features chapter.</para> </section> </section> @@ -809,8 +809,8 @@ </imageobject> </mediaobject> </figure> - <para><ulink url="../../jsf/html_single/index.html#CodeAssistAndDynamicCodeAssist42BasedOnProjectData">Code - assist</ulink> is available in the Source mode.</para> + <para>Code + assist is available in the Source mode.</para> <figure float="0"> <title>Code Assist</title> <mediaobject> @@ -934,7 +934,7 @@ </chapter> -<chapter id="modules" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en/modules/modules.xml"> +<chapter id="modules" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en-US/modules.xml"> <?dbhtml filename="modules.html"?> <chapterinfo> <keywordset> @@ -980,11 +980,16 @@ <section id="EditingModulesInAnExistingProject1"> <title>Editing Modules in an Existing Project</title> - <para>To edit modules in an existing project, right click the project and - select <emphasis> - <property moreinfo="none">JBoss Tools > Modules Configuration</property>. - </emphasis></para> - <figure float="0"> + <para><diffmk:wrapper diffmk:change="added">To edit modules in an existing project, right click the project in Web Project view + and select </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Tools Struts > Modules Configuration</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> + (or right click the project in Package Explorer view + and select </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Configure > Modules Configuration</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added">). + </diffmk:wrapper></para> + <figure float="0"> <title>Choosing Modules Configuration</title> <mediaobject> <imageobject> @@ -1034,7 +1039,7 @@ </chapter> -<chapter id="code_generation" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en/modules/code_generation.xml"> +<chapter id="code_generation" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en-US/code_generation.xml"> <?dbhtml filename="code_generation.html"?> <chapterinfo> @@ -1131,7 +1136,7 @@ </figure> </chapter> -<chapter id="config_file_debugger" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en/modules/config_file_debugger.xml"> +<chapter id="config_file_debugger" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en-US/config_file_debugger.xml"> <?dbhtml filename="config_file_debugger.html"?> <chapterinfo> <keywordset> @@ -1161,7 +1166,7 @@ </figure> </chapter> -<chapter id="page_links_recognizer" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en/modules/page_links_recognizer.xml"> +<chapter id="page_links_recognizer" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en-US/page_links_recognizer.xml"> <?dbhtml filename="page_links_recognizer.html"?> <chapterinfo> @@ -1192,7 +1197,7 @@ </figure> </chapter> -<chapter id="project_verification" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en/modules/project_verification.xml"> +<chapter id="project_verification" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en-US/project_verification.xml"> <?dbhtml filename="project_verification.html"?> <chapterinfo> <keywordset> @@ -1295,7 +1300,7 @@ </figure> </chapter> -<chapter id="rel_resources_links" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en/modules/rel_resources_links.xml"> +<chapter id="rel_resources_links" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/struts/docs/struts_tools_ref_guide/en-US/rel_resources_links.xml"> <?dbhtml filename="rel_resources_links.html"?> <chapterinfo> <keywordset> @@ -1320,13 +1325,12 @@ Struts application using a set of views and editors provided by <property moreinfo="none">JBoss Tools</property>.</para> - <para>If you'd like to contribute your feedback is always appreciated. You can - leave your questions and suggestions on our - <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201"> - Forum</ulink>.</para> - <para>We hope, this guide helped you to get started with the JBoss Struts Tools. - Besides, for additional information you are welcome on - <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> + <para>If you'd like to contribute your feedback is always appreciated. You can + leave your questions and suggestions on our <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201" + >Forum</ulink>.</para> + <para>We hope, this guide helped you to get started with the JBoss Struts Tools. Besides, for additional information you are welcome on <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> </chapter> </book> Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/modules.xml =================================================================== --- tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/modules.xml 2010-06-09 00:37:26 UTC (rev 22663) +++ tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/modules.xml 2010-06-09 00:39:29 UTC (rev 22664) @@ -45,11 +45,16 @@ <section id="EditingModulesInAnExistingProject1"> <title>Editing Modules in an Existing Project</title> - <para>To edit modules in an existing project, right click the project and - select <emphasis> - <property>JBoss Tools > Modules Configuration</property>. - </emphasis></para> - <figure> + <para>To edit modules in an existing project, right click the project in Web Project view + and select <emphasis> + <property>JBoss Tools Struts > Modules Configuration</property> + </emphasis> + (or right click the project in Package Explorer view + and select <emphasis> + <property>Configure > Modules Configuration</property> + </emphasis>). + </para> + <figure> <title>Choosing Modules Configuration</title> <mediaobject> <imageobject> Modified: tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/projects.xml =================================================================== --- tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/projects.xml 2010-06-09 00:37:26 UTC (rev 22663) +++ tags/jbosstools-3.1.1.GA/struts/docs/struts_tools_ref_guide/en-US/projects.xml 2010-06-09 00:39:29 UTC (rev 22664) @@ -156,7 +156,7 @@ <title>Importing an Existing Struts Project with Any Structure</title> - <para>For detailed information on migration projects to JBoss Developer Studio see Migration Guide.</para> + <para>For detailed information on migration projects to JBoss Developer Studio see the Migration Guide.</para> </section> <section id="AddingStrutsCapabilityToAnExistingWebApplication532"> @@ -252,7 +252,7 @@ </mediaobject> </figure> - <para>When done, you can open end edit the struts-config.xml file using useful Struts + <para>When done, you can open and edit the struts-config.xml file using useful Struts configuration file editor provided by JBDS. (The Struts configuration is shown below in the Tree viewer).</para> @@ -270,6 +270,6 @@ <title>Relevant Resources Links</title> <para>You can find more in-depth explanation on how to work with special wizards, editors and views that can - be used in various scenarios while developing Struts applications in our Visual Web Tools guide.</para> + be used in various scenarios while developing Struts applications in our Visual Web Tools Guide.</para> </section> </chapter>

14 years, 7 months

1
0
0 / 0

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

by jbosstools-commits＠lists.jboss.org

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

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22662 - tags/jbosstools-3.1.1.GA/smooks/docs.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 20:32:38 -0400 (Tue, 08 Jun 2010) New Revision: 22662 Removed: tags/jbosstools-3.1.1.GA/smooks/docs/reference/ Log: removing book to upload restructure

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22661 - in tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US: images/create_new_seam and 4 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 20:28:36 -0400 (Tue, 08 Jun 2010) New Revision: 22661 Added: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/directory_structure/directory_structure_7.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/directory_structure/directory_structure_8.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_editors/seam_editors_1c.png Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/creating_new_seam.xml tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/directory_structure.xml tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/generate_entities.xml tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_1.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_11.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_12.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_13.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_15.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_16.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_20.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_21.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_7.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_8.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/crud_database_application/crud_database_application_15.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_11.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_14.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_15.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_5.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_8.png tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/intro.xml tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master.xml tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master_output.xml tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/seam_editors.xml Log: updated for 3.0.1 Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml =================================================================== --- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml 2010-06-09 00:21:45 UTC (rev 22660) +++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml 2010-06-09 00:28:36 UTC (rev 22661) @@ -6,7 +6,7 @@ <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="creating_new_seam.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - +<xi:include href="creating_mavenized_seam.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="directory_structure.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="seam_menus_and_actions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="seam_wizards.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/creating_new_seam.xml =================================================================== --- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/creating_new_seam.xml 2010-06-09 00:21:45 UTC (rev 22660) +++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/creating_new_seam.xml 2010-06-09 00:28:36 UTC (rev 22661) @@ -1,464 +1,478 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="create_seam" xreflabel="create_seam" role="updated"> - <?dbhtml filename="create_new_seam.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - </keywordset> - </chapterinfo> - <title>Creating a New Seam Project via the New Seam Project wizard</title> - <para>In this chapter we provide you with the necessary steps to start working with Seam - Framework.</para> - <para>At first, we suggest to set the specific Seam perspective that combines a number of - different views and editors needed for work with resources concerned. For that select - <emphasis> - <property>Window > Open Perspective > Other > Seam</property> - </emphasis> or you can also access it through the button in the right top corner.</para> - <figure> - <title>Seam Perspective Icon</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_0.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Also the <emphasis> - <property>Open Web Browser</property></emphasis> action is directly available in the - <property>Seam perspective</property>.</para> - <figure> - <title>Embedded Web Browser Button</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_01.png"/> - </imageobject> - </mediaobject> - </figure> - <section id="standaloneSeam" role="updated"> - <title>Create standalone Seam Web Project</title> - <para>The best way to get started with Seam is to create a simple Seam Project and - experiment with it.</para> - <para>Thus, you should select <emphasis> - <property>File > New > Seam Web Project</property> - </emphasis> to run the <property>New Seam Project</property> wizard. The wizard form - allows you to create runtime and server instances in order to get started creating, - running, and debugging J2EE (only) applications.</para> - <para>Seam Web Project wizard has an option for selecting the actual Server (not just WTP - runtime) that will be used for the project. This allows the wizard to identify correctly - where the required datasource and driver libraries need to go.</para> - <para>Let's get through the wizard step-by-step. First, you should enter a name and a - location directory for your new project.</para> - <figure id="figure_create_seam1"> - <title>New Seam Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_1.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On the figure above you can see the runtime and the server already created.</para> - <para>If you need to create a new runtime, click on the <emphasis> - <property>New...</property> - </emphasis> button in the <property>Target Runtime</property> section. It brings up the - wizard where you can specify a new JBoss Server Runtime environment or the other type of - runtime appropriate for your project configuration. Let's create one more JBoss 4.2 - Runtime. Hence, after choosing it click on <emphasis> - <property>Next</property> - </emphasis> button.</para> - <figure> - <title>Specifying Target Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_2.png"/> - </imageobject> - </mediaobject> - </figure> - <para>All what you need here is to name runtime, type the path to its install directory or - locate it by using <emphasis> - <property>Browse</property> - </emphasis> button, select a Java Runtime Environment, and select which configuration - you want.</para> - <figure> - <title>Specifying Target Runtime Configurations</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_3.png"/> - </imageobject> - </mediaobject> - </figure> - <para> Clicking on <emphasis> - <property>Finish</property> - </emphasis> returns you to the <link linkend="figure_create_seam1">New Seam Project - wizard page</link>.</para> - <para>The next step is to define a Server by clicking on <emphasis> - <property>New...</property> - </emphasis> button in the <property>Target Server</property> section. In appeared - <property>New Server dialog</property> the last server which matches the runtime - will be selected.</para> - <para>All declared runtimes are listed in the combo-box under the servers view. Here, you - can indicate a server runtime that you need. Click <emphasis> - <property>Add</property> - </emphasis> if you want to add a new Server Runtime.</para> - <figure> - <title>Specifying Target Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_4.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Next page allows you to verify the information for a chosen server. Leave everything - as it is and click on <emphasis> - <property>Next</property> - </emphasis>.</para> - <figure> - <title>JBoss Runtime Summary</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_5.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On the last wizard step you can modify your projects to configure them on the - Server.</para> - <figure> - <title>Project Modification for Configuring on the Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_6.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Once you have the Target Server defined click on <emphasis> - <property>Finish</property> - </emphasis> button to return to the first page of the <property>New Seam Project - wizard</property>.</para> - <tip> - <title>Tip:</title> - <para>We suggest that you look through AS manager guide to - find out more about runtimes and servers.</para> - </tip> - <figure> - <title>Completion of Runtime and Server Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_7.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The last section on this wizard step is <property>Configuration</property>. Here, you - can select one of the pre-defined project configurations either associated with Seam - 1.2, Seam 2.0 or with Seam 2.1. Furthermore, you can create your own configuration by - pressing the <emphasis> - <property>Modify...</property> - </emphasis> button. It will open the dialog which allows to configure your own set of - facets for adding extra functionality to your project.</para> - <para>Pass to the next section to find out more details on this dialog.</para> - </section> - <section id="projectFacets"> - <title>Selecting the Project Facets</title> - <para>The <property>Project Facets wizard</property> allows you to enable or disable - specific facets which define necessary features for the project. When you switch to this - wizard form, all critical facets are already checked for the chosen - Configuration.</para> - <para>Notice that this page of the wizard also allows you to set the necessary version for - any facet. </para> - <figure> - <title>Project Facets Selection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_8.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Moreover, here you can specify your own preset of selected facets by checking needed - ones in project facets window and clicking on <emphasis> - <property>Save</property> - </emphasis> button.</para> - <figure> - <title>Specifying Custom Facet Preset</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_15.png"/> - </imageobject> - </mediaobject> - </figure> - <para>To see all available Server runtimes click on <property>Runtimes</property> tab on the - left. You can create a new one using the <emphasis> - <property>New</property> - </emphasis> button. If more than one runtime is checked here, the <emphasis> - <property>Make Primary</property> - </emphasis> button won't be dimmed yet. Thus, you can make use of it to mark - primary runtime.</para> - <figure> - <title>Setting Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_16.png"/> - </imageobject> - </mediaobject> - </figure> - <para><emphasis> - <property>Ok</property> - </emphasis> button will bring you to the <property>Web Module</property> wizard form - again.</para> - <section id="seamWithJPA"> - <title>Seam project with JPA facets</title> - <para>For creating Seam project with JPA support you need to select<property> Java - Persistent</property> facet on <property>Project Facets</property> page and - click <property>OK</property>.</para> - <para>Then you should press <property>Next</property> and may leave the default value on - <property>Java application building</property> page and <property>Web Module - Settings</property> page.</para> - <para>After that you will see <property>JPA facet</property> page.</para> - <figure> - <title>JPA Facet page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_16b.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On this page you can choose <property>Platform</property> (vendor-specific JPA - implementation) for your project, type of JPA Implementation, and configure the - <property>Connection</property> to database in the <property - >Connection</property> area.</para> - <para>More about <property>JPA facet</property> page you can read in <ulink - url="http://help.eclipse.org/galileo/index.jsp?topic=/org.eclipse.jpt.doc.user..." - >Eclipse documentation</ulink>. </para> - <para>On the next step you will see <property>JSF Capabilities</property> and <property>Seam - facet</property> pages, which are mostly the same as in general Seam - project.</para> - </section> - </section> - <section id="configureJava"> - <title>Java application building configuration</title> - <para>With this wizard you can define Java source directories which will be generated on - build path. Also you can specify a default output folder. If you are agree with default - values, press <property>Next</property></para> - <figure> - <title>Java application building Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_16a.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="configureWebModule"> - <title>How to Configure Web Module Settings</title> - <para> As we deal with a Dynamic Web Application, we should at first specify the top level - directory of our application for deploying it to a server afterwards. You know, this - kind of application contains Web resources. Thus, it's important to indicate the content - directory. The wizard will put all those values itself, so you can leave everything as - is.</para> - <figure> - <title>Web Module Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_9.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Choose <emphasis> - <property>Next</property> - </emphasis> to switch to the next wizard form.</para> - </section> - <section id="addJSFCapab"> - <title>Adding JSF Capabilities</title> - <para>This wizard helps you to add JSF capabilities to your project. </para> - <para>Choose <emphasis> - <property>Library provided by Target Runtime</property> - </emphasis> from Library Type list if you'd like to use a default JSF implementation - given by the present runtime.</para> - <figure> - <title>Adding JSF Capabilities to Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_10.png"/> - </imageobject> - </mediaobject> - </figure> - <para>In case if you prefer to use your custom JSF implementation, choose <property>User - Library</property> Item from Library Type list. In User Library list you can check - required library.</para> - <figure> - <title>Using Custom JSF implementation Library </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_17.png"/> - </imageobject> - </mediaobject> - </figure> - <para> If a new library is required, click <property>Manage libraries...</property> ( - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_17a.png"/> - </imageobject> - </inlinemediaobject>) button. Then you should click <property>New</property>.</para> - <figure> - <title>Using Custom JSF implementation Library </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_18.png"/> - </imageobject> - </mediaobject> - </figure> - <para> Here, it's necessary to type a <property>Library Name</property>. </para> - <figure> - <title>Entering New User Library Name</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_23.png"/> - </imageobject> - </mediaobject> - </figure> - <para>To add proper <property>Library JARs</property>, click <property>Add - JARs...</property> button and select the JARs on your hard drive. </para> - <figure> - <title>Selection Library JARs</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_25.png"/> - </imageobject> - </mediaobject> - </figure> - <para>You can download necessary JSF implementation libraries provided by Sun and Apache - Foundation as well. Click <property>Download...</property> (<inlinemediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_23a.png"/> - </imageobject> - </inlinemediaobject>) button and choose one of proposed libraries.</para> - <figure> - <title>Download JSF Implementation Library</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_24.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The last wizard options allows to edit a path for <property>JSF Configuration - File</property>, a name for <property>JSF Servlet</property>, <property>JSF Servlet - Classname</property> and change <property>URL Mapping Patterns</property>.</para> - <figure> - <title>JSF Capabilities Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_19.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Since we are arranging the Seam Web project, the last step we should do is to adjust - project configurations associated with the Seam.</para> - </section> - <section id="seamFacet"> - <title>Configure Seam Facet Settings</title> - <para>The last wizard step is related to Seam facet and allows you to do the - following:</para> - <figure> - <title>Seam Facet Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_11.png"/> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>Create Seam runtime and define Seam home folder.</para> - </listitem> - </itemizedlist> - <para>For that click on <emphasis> - <property>Add</property> - </emphasis> button in the <property>General</property> section. Note, in the wizard - shown below you can create a Seam runtime only for the version that was selected in the - <link linkend="projectFacets">Project Facets</link> wizard (version 1.2 in our - case).</para> - <figure> - <title>Seam Runtime Creation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_12.png"/> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>Select EAR or WAR deployment by checking a necessary radio button.</para> - </listitem> - <listitem> - <para>Select a <emphasis> - <property>Database Type</property> - </emphasis></para> - </listitem> - </itemizedlist> - <figure> - <title>Database Type Selecting</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_20.png"/> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>and then specify a <emphasis> - <property>Connection profile</property> - </emphasis> appropriate for your database.</para> - </listitem> - </itemizedlist> - <figure> - <title>Connection Profile Options</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_21.png"/> - </imageobject> - </mediaobject> - </figure> - <para>You can edit chosen profile by using <emphasis> - <property>Edit</property> - </emphasis> button or organise a new one by clicking on <emphasis> - <property>New</property> - </emphasis> button and selecting necessary for you type of connection profile.</para> - <figure> - <title>Connection Profile Selecting</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_13.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On the dialog you'll be asked to enter its name and description. And then you - should select a proper driver and adjust connection details. Press <emphasis> - <property>Next</property> - </emphasis> to preview all the adjusted settings and complete the creation of the new - profile.</para> - <figure> - <title>Connection Details</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_22.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The next block of settings in the Seam Facet wizard are describing a Database and a - connection to it.</para> - <para>In the <property>Code Generation</property> section the wizard has already provided - the names for your <property>Session Bean</property>, <property>Entity Bean</property> - and <property>Test</property> packages generation (optional). Of course, you can change - them on others of your choice.</para> - <figure> - <title>Code Generation Section</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_14.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Click on <emphasis> - <property>Finish</property> - </emphasis> to generate a project.</para> - <para/> - </section> -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="create_seam" xreflabel="create_seam" role="updated"> + <?dbhtml filename="create_new_seam.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Seam</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Creating a New Seam Project via the New Seam Project wizard</title> + <para>In this chapter we provide you with the necessary steps to start working with Seam + Framework.</para> + <para>At first, we suggest to set the specific Seam perspective that combines a number of + different views and editors needed for work with resources concerned. For that select + <emphasis> + <property>Window > Open Perspective > Other > Seam</property> + </emphasis> or you can also access it through the button in the right top corner.</para> + <figure> + <title>Seam Perspective Icon</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_0.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Also the <emphasis> + <property>Open Web Browser</property></emphasis> action is directly available in the + <property>Seam perspective</property>.</para> + <figure> + <title>Embedded Web Browser Button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_01.png"/> + </imageobject> + </mediaobject> + </figure> + <section id="standaloneSeam" role="updated"> + <title>Create standalone Seam Web Project</title> + <para>The best way to get started with Seam is to create a simple Seam Project and + experiment with it.</para> + <para>Thus, you should select <emphasis> + <property>File > New > Seam Web Project</property> + </emphasis> to run the <property>New Seam Project</property> wizard. The wizard form + allows you to create runtime and server instances in order to get started creating, + running, and debugging J2EE (only) applications.</para> + <para>Seam Web Project wizard has an option for selecting the actual Server (not just WTP + runtime) that will be used for the project. This allows the wizard to identify correctly + where the required datasource and driver libraries need to go.</para> + <para>Let's get through the wizard step-by-step. First, you should enter a name and a + location directory for your new project.</para> + <figure id="figure_create_seam1"> + <title>New Seam Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>On the figure above you can see the runtime and the server already created.</para> + <para>If you need to create a new runtime, click on the <emphasis> + <property>New...</property> + </emphasis> button in the <property>Target Runtime</property> section. It brings up the + wizard where you can specify a new JBoss Server Runtime environment or the other type of + runtime appropriate for your project configuration. Let's create one more JBoss 4.2 + Runtime. Hence, after choosing it click on <emphasis> + <property>Next</property> + </emphasis> button.</para> + <figure> + <title>Specifying Target Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>All what you need here is to name runtime, type the path to its install directory or + locate it by using <emphasis> + <property>Browse</property> + </emphasis> button, select a Java Runtime Environment, and select which configuration + you want.</para> + <figure> + <title>Specifying Target Runtime Configurations</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_3.png"/> + </imageobject> + </mediaobject> + </figure> + <para> Clicking on <emphasis> + <property>Finish</property> + </emphasis> returns you to the <link linkend="figure_create_seam1">New Seam Project + wizard page</link>.</para> + <para>The next step is to define a Server by clicking on <emphasis> + <property>New...</property> + </emphasis> button in the <property>Target Server</property> section. In appeared + <property>New Server dialog</property> the last server which matches the runtime + will be selected.</para> + <para>All declared runtimes are listed in the combo-box under the servers view. Here, you + can indicate a server runtime that you need. Click <emphasis> + <property>Add</property> + </emphasis> if you want to add a new Server Runtime.</para> + <figure> + <title>Specifying Target Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_4.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Next page allows you to verify the information for a chosen server. Leave everything + as it is and click on <emphasis> + <property>Next</property> + </emphasis>.</para> + <figure> + <title>JBoss Runtime Summary</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_5.png"/> + </imageobject> + </mediaobject> + </figure> + <para>On the last wizard step you can modify your projects to configure them on the + Server.</para> + <figure> + <title>Project Modification for Configuring on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_6.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Once you have the Target Server defined click on <emphasis> + <property>Finish</property> + </emphasis> button to return to the first page of the <property>New Seam Project + wizard</property>.</para> + <tip> + <title>Tip:</title> + <para>We suggest that you look through the Application Server Manager Guide to + find out more about runtimes and servers.</para> + </tip> + <figure> + <title>Completion of Runtime and Server Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_7.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The last section on this wizard step is <property>Configuration</property>. Here, you + can select one of the pre-defined project configurations either associated with Seam + 1.2, Seam 2.0 or with Seam 2.1. Furthermore, you can create your own configuration by + pressing the <emphasis> + <property>Modify...</property> + </emphasis> button. It will open the dialog which allows to configure your own set of + facets for adding extra functionality to your project.</para> + <para>Pass to the next section to find out more details on this dialog.</para> + </section> + <section id="projectFacets"> + <title>Selecting the Project Facets</title> + <para>The <property>Project Facets wizard</property> allows you to enable or disable + specific facets which define necessary features for the project. When you switch to this + wizard form, all critical facets are already checked for the chosen + Configuration.</para> + <para>Notice that this page of the wizard also allows you to set the necessary version for + any facet. </para> + <figure> + <title>Project Facets Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_8.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Moreover, here you can specify your own preset of selected facets by checking needed + ones in project facets window and clicking on <emphasis> + <property>Save</property> + </emphasis> button.</para> + <figure> + <title>Specifying Custom Facet Preset</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_15.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To see all available Server runtimes click on <property>Runtimes</property> tab on the + left. You can create a new one using the <emphasis> + <property>New</property> + </emphasis> button. If more than one runtime is checked here, the <emphasis> + <property>Make Primary</property> + </emphasis> button won't be dimmed yet. Thus, you can make use of it to mark + primary runtime.</para> + <figure> + <title>Setting Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_16.png"/> + </imageobject> + </mediaobject> + </figure> + <para><emphasis> + <property>Ok</property> + </emphasis> button will bring you to the <property>Web Module</property> wizard form + again.</para> + <section id="seamWithJPA"> + <title>Seam project with JPA facets</title> + <para>For creating Seam project with JPA support you need to select<property> Java + Persistent</property> facet on <property>Project Facets</property> page and + click <property>OK</property>.</para> + <para>Then you should press <property>Next</property> and may leave the default value on + <property>Java application building</property> page and <property>Web Module + Settings</property> page.</para> + <para>After that you will see <property>JPA facet</property> page.</para> + <figure> + <title>JPA Facet page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_16b.png"/> + </imageobject> + </mediaobject> + </figure> + <para>On this page you can choose <property>Platform</property> (vendor-specific JPA + implementation) for your project, type of JPA Implementation, and configure the + <property>Connection</property> to database in the <property + >Connection</property> area.</para> + <para>More about <property>JPA facet</property> page you can read in <ulink + url="http://help.eclipse.org/galileo/index.jsp?topic=/org.eclipse.jpt.doc.user..." + >Eclipse documentation</ulink>. </para> + <para>On the next step you will see <property>JSF Capabilities</property> and <property>Seam + facet</property> pages, which are mostly the same as in general Seam + project.</para> + </section> + </section> + <section id="configureJava"> + <title>Java application building configuration</title> + <para>With this wizard you can define Java source directories which will be generated on + build path. Also you can specify a default output folder. If you are agree with default + values, press <property>Next</property></para> + <figure> + <title>Java application building Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_16a.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="configureWebModule"> + <title>How to Configure Web Module Settings</title> + <para> As we deal with a Dynamic Web Application, we should at first specify the top level + directory of our application for deploying it to a server afterwards. You know, this + kind of application contains Web resources. Thus, it's important to indicate the content + directory. The wizard will put all those values itself, so you can leave everything as + is.</para> + <figure> + <title>Web Module Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_9.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Choose <emphasis> + <property>Next</property> + </emphasis> to switch to the next wizard form.</para> + </section> + <section id="addJSFCapab"> + <title>Adding JSF Capabilities</title> + <para>This wizard helps you to add JSF capabilities to your project. </para> + <para>Choose <emphasis> + <property>Library provided by Target Runtime</property> + </emphasis> from Library Type list if you'd like to use a default JSF implementation + given by the present runtime.</para> + <figure> + <title>Adding JSF Capabilities to Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_10.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In case if you prefer to use your custom JSF implementation, choose <property>User + Library</property> Item from Library Type list. In User Library list you can check + required library.</para> + <figure> + <title>Using Custom JSF implementation Library </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_17.png"/> + </imageobject> + </mediaobject> + </figure> + <para> If a new library is required, click <property>Manage libraries...</property> ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_17a.png"/> + </imageobject> + </inlinemediaobject>) button. Then you should click <property>New</property>.</para> + <figure> + <title>Using Custom JSF implementation Library </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_18.png"/> + </imageobject> + </mediaobject> + </figure> + <para> Here, it's necessary to type a <property>Library Name</property>. </para> + <figure> + <title>Entering New User Library Name</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_23.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To add proper <property>Library JARs</property>, click <property>Add + JARs...</property> button and select the JARs on your hard drive. </para> + <figure> + <title>Selection Library JARs</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_25.png"/> + </imageobject> + </mediaobject> + </figure> + <para>You can download necessary JSF implementation libraries provided by Sun and Apache + Foundation as well. Click <property>Download...</property> (<inlinemediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_23a.png"/> + </imageobject> + </inlinemediaobject>) button and choose one of proposed libraries.</para> + <figure> + <title>Download JSF Implementation Library</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_24.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The last wizard options allows to edit a path for <property>JSF Configuration + File</property>, a name for <property>JSF Servlet</property>, <property>JSF Servlet + Classname</property> and change <property>URL Mapping Patterns</property>.</para> + <figure> + <title>JSF Capabilities Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_19.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Since we are arranging the Seam Web project, the last step we should do is to adjust + project configurations associated with the Seam.</para> + </section> + <section id="seamFacet"> + <title>Configure Seam Facet Settings</title> + <para>The last wizard step is related to Seam facet and allows you to do the + following:</para> + <figure> + <title>Seam Facet Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_11.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Create Seam runtime and define Seam home folder.</para> + </listitem> + </itemizedlist> + <para>For that click on <emphasis> + <property>Add</property> + </emphasis> button in the <property>General</property> section. Note, in the wizard + shown below you can create a Seam runtime only for the version that was selected in the + <link linkend="projectFacets">Project Facets</link> wizard (version 1.2 in our + case).</para> + <figure> + <title>Seam Runtime Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_12.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Select EAR or WAR deployment by checking a necessary radio button.</para> + </listitem> + <listitem> + <para>Enter EJB project name and EAR project name in case of EAR radio button is checked.</para> + </listitem> + </itemizedlist> + + <tip> + <title>Tip:</title> + <para>If you want to name your web project "MyProject-war" note that the EJB project should not be "MyProject-war-ejb", + it should be "MyProject-ejb". The same for EAR and Test projects' names. They should be respectively "MyProject-ear" + and "MyProject-test".</para> + </tip> + + <itemizedlist> + <listitem> + <para>Select a <emphasis> + <property>Database Type</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>Database Type Selecting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_20.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>and then specify a <emphasis> + <property>Connection profile</property> + </emphasis> appropriate for your database.</para> + </listitem> + </itemizedlist> + <figure> + <title>Connection Profile Options</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_21.png"/> + </imageobject> + </mediaobject> + </figure> + <para>You can edit chosen profile by using <emphasis> + <property>Edit</property> + </emphasis> button or organise a new one by clicking on <emphasis> + <property>New</property> + </emphasis> button and selecting necessary for you type of connection profile.</para> + <figure> + <title>Connection Profile Selecting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_13.png"/> + </imageobject> + </mediaobject> + </figure> + <para>On the dialog you'll be asked to enter its name and description. And then you + should select a proper driver and adjust connection details. Press <emphasis> + <property>Next</property> + </emphasis> to preview all the adjusted settings and complete the creation of the new + profile.</para> + <figure> + <title>Connection Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_22.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The next block of settings in the Seam Facet wizard are describing a Database and a + connection to it.</para> + <para>In the <property>Code Generation</property> section the wizard has already provided + the names for your <property>Session Bean</property>, <property>Entity Bean</property> + and <property>Test</property> packages generation (optional). Of course, you can change + them on others of your choice.</para> + <figure> + <title>Code Generation Section</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_14.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click on <emphasis> + <property>Finish</property> + </emphasis> to generate a project.</para> + <para/> + </section> +</chapter> \ No newline at end of file Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/directory_structure.xml =================================================================== --- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/directory_structure.xml 2010-06-09 00:21:45 UTC (rev 22660) +++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/directory_structure.xml 2010-06-09 00:28:36 UTC (rev 22661) @@ -1,209 +1,230 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="directory_str" xreflabel="directory_str"> - <?dbhtml filename="directory_structure.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>Eclipse</keyword> - </keywordset> - </chapterinfo> - - <title>Directory Structure of the Generated Project</title> - - <para>In this chapter we describe where the Seam wizard puts the generated files for both EAR - and WAR deployments.</para> - <para>The Seam Project wizard generates projects like Eclipse WTP style in order to utilize - Eclipse WTP features and to have a correct classpath. To be more precise it generates one - project per artifact.</para> - - <section id="WAR"> - <title>WAR Deployment</title> - - <para>The project layout for WAR projects is:</para> - - <figure> - <title>Project Layout for WAR projects</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/directory_structure/directory_structure_1.png" - scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <para>A WAR project can only use Seam JavaBean and JPA Entity bean components; it cannot use - EJB3 Session beans etc.</para> - <para>WAR projects are generated to enable Seam war hotdeploy feature. Classes put - into <emphasis> - <property>src/action</property> - </emphasis> will be deployed to <emphasis> - <property>WEB-INF/dev</property> - </emphasis> from which Seam automatically will perform hotdeploy of new - components.</para> - <note> - <title>Note:</title> - <para>Because of Eclipse WTP limits the hot deployed classes also existed in <emphasis> - <property>WEB-INF/classes</property>, </emphasis> but since Seam gives <emphasis> - <property>WEB-INF/dev</property> - </emphasis> precedence it will work.</para> - </note> - - <para>Furthermore the Seam Project wizard generates a test project that is setup to run - <link linkend="testNG">TestNG</link> directly against the proper libraries and - server runtime libraries. When the TestNG plugin is installed you can just run your - tests via <emphasis><property>Run As > TestNG Test</property>.</emphasis></para> - <para>In order to deploy WAR project on server, right-click on the project and select <emphasis> - <property>Run As > Run on Server</property>.</emphasis> Studio will deploy - WAR project into one web application on server to <property>deploy</property> - folder.</para> - - </section> - - <section id="EAR"> - <title>EAR Deployment</title> - <para>The project layout for EAR projects is:</para> - - <figure> - <title>Project Layout for EAR projects</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/directory_structure/directory_structure_2.png" - scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <para>An EAR project can use the whole range of Seam components, including EJB3 Session - beans.</para> - <para>In order to deploy EAR project on server, right-click on the project with - <property>-ear</property> postfix and select <emphasis> - <property>Run As > Run on Server</property>.</emphasis> Studio will take care - about all modules and deploy EAR project into one enterprise application on server to - <property>deploy</property> folder. EAR application keeps <property>ejb</property> - and <property>war</property> modules of the EAR project.</para> - - <note><title>Note:</title> - <para>The <property>WAR</property> generated for <property>EARs</property> is now configured to utilize Seam hot-deployment (<emphasis><property>WEB-INF/dev</property></emphasis>) similar to standalone <property>WAR</property> projects.</para> - - </note> - - </section> - - <section id="seam_version_changing"> - - <title>Changing the Seam Version</title> - - <para>To upgrade or downgrade your projects Seam version use the facet preferences. You - should right-click your project, open its <property>Properties</property> and choose <emphasis> - <property>Project Facets</property> - </emphasis> category. Next select <emphasis> - <property>Seam</property> - </emphasis> and change its version to needed one.</para> - - <figure> - <title>Changing the Seam Facet Version</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/directory_structure/directory_structure_3.png" - scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <para>After pressing <emphasis> - <property>Apply</property> - </emphasis> the wizard for adjusting new Seam runtime settings appears.</para> - - <figure> - <title>Changing the Seam Facet Version</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/directory_structure/directory_structure_4.png" - scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <para>If you need to update the libraries for you project, check the <emphasis> - <property>Update libraries</property> - </emphasis> option. All libraries you checked will be removed and the libraries from the - new Seam distribution will be added after clicking <emphasis> - <property>Ok</property>.</emphasis></para> - - <figure> - <title>Changing the Seam Facet Version</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/directory_structure/directory_structure_5.png" - scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note:</title> - - <para>The note "Seam configuration files and their XSDs won't be changed" is - meant that the libraries, Seam facet and runtime version will be changed, but - configuration files that refer to the old version will have to be manually - updated.</para> - </note> - </section> - - <section id="changing_seam_parent_project"> - <title>Changing Seam Parent Project</title> - - <para>Starting from the 2.0.0.CR2 version of <property>JBoss Tools</property> it is possible - to change the Seam parent project. In earlier versions this was only controllable at a - project creation time, now it can be changed for existing projects too.</para> - - <para>Go to your project preferences and select <emphasis> - <property>Seam Settings</property> - </emphasis> category on the left. Press the <emphasis> - <property>Browse</property> - </emphasis> button next to the <emphasis> - <property>Main Seam Project</property> - </emphasis> section to select the other Seam parent project.</para> - - <figure> - <title>Changing Seam Parent Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/directory_structure/directory_structure_6.png" - scale="75"/> - </imageobject> - </mediaobject> - </figure> - </section> - - <section id="renaming_projects_folders"> - <title>Renaming the Projects and Folders</title> - - <para>If you need to rename one of the Seam Project artifacts - (<emphasis><project_name></emphasis>, - <emphasis><project_name>-test</emphasis>, - <emphasis><project_name>-test</emphasis> or - <emphasis><project_name>-ejb</emphasis>) or any entire folder like - <emphasis><project_name>/WebContent</emphasis>, - <emphasis><project_name>/ejbModule</emphasis>, - <emphasis><project_name>-test/test-src</emphasis>, or project name in - packages <emphasis>org.domain.<project_name>.session</emphasis>, - <emphasis>org.domain.<project_name>.entity</emphasis>, you can do this - by brining the context menu and navigating <emphasis> - <property>Refactor > Rename...</property> - </emphasis> or just pressing <emphasis> - <property>Shift + Alt + R</property> - </emphasis> under the chosen resource.</para> - - <para>Use <emphasis> - <property>Refactor > Move...</property> - </emphasis> (or <emphasis> - <property>Shift + Alt + V</property> - </emphasis>), if you need to move - <emphasis><project_name>/WebContent</emphasis> folder, - <emphasis><project_name>/ejbModule</emphasis> folder or - <emphasis><project_name>/test-src</emphasis> folder in the other place - within the Project structure.</para> - </section> -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="directory_str" xreflabel="directory_str"> + <?dbhtml filename="directory_structure.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Seam</keyword> + <keyword>Eclipse</keyword> + </keywordset> + </chapterinfo> + + <title>Directory Structure of the Generated Project</title> + + <para>In this chapter we describe where the Seam wizard puts the generated files for both EAR + and WAR deployments.</para> + <para>The Seam Project wizard generates projects like Eclipse WTP style in order to utilize + Eclipse WTP features and to have a correct classpath. To be more precise it generates one + project per artifact.</para> + + <section id="WAR"> + <title>WAR Deployment</title> + + <para>The project layout for WAR projects is:</para> + + <figure> + <title>Project Layout for WAR projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_1.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>A WAR project can only use Seam JavaBean and JPA Entity bean components; it cannot use + EJB3 Session beans etc.</para> + <para>WAR projects are generated to enable Seam war hotdeploy feature. Classes put + into <emphasis> + <property>src/action</property> + </emphasis> will be deployed to <emphasis> + <property>WEB-INF/dev</property> + </emphasis> from which Seam automatically will perform hotdeploy of new + components.</para> + <note> + <title>Note:</title> + <para>Because of Eclipse WTP limits the hot deployed classes also existed in <emphasis> + <property>WEB-INF/classes</property>, </emphasis> but since Seam gives <emphasis> + <property>WEB-INF/dev</property> + </emphasis> precedence it will work.</para> + </note> + + <para>Furthermore the Seam Project wizard generates a test project that is setup to run + <link linkend="testNG">TestNG</link> directly against the proper libraries and + server runtime libraries. When the TestNG plugin is installed you can just run your + tests via <emphasis><property>Run As > TestNG Test</property>.</emphasis></para> + <para>In order to deploy WAR project on server, right-click on the project and select <emphasis> + <property>Run As > Run on Server</property>.</emphasis> Studio will deploy + WAR project into one web application on server to <property>deploy</property> + folder.</para> + + </section> + + <section id="EAR"> + <title>EAR Deployment</title> + <para>The project layout for EAR projects is:</para> + + <figure> + <title>Project Layout for EAR projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_2.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>An EAR project can use the whole range of Seam components, including EJB3 Session + beans.</para> + <para>In order to deploy EAR project on server, right-click on the project with + <property>-ear</property> postfix and select <emphasis> + <property>Run As > Run on Server</property>.</emphasis> Studio will take care + about all modules and deploy EAR project into one enterprise application on server to + <property>deploy</property> folder. EAR application keeps <property>ejb</property> + and <property>war</property> modules of the EAR project.</para> + + <note><title>Note:</title> + <para>The <property>WAR</property> generated for <property>EARs</property> is now configured to utilize Seam hot-deployment (<emphasis><property>WEB-INF/dev</property></emphasis>) similar to standalone <property>WAR</property> projects.</para> + + </note> + + </section> + + <section id="seam_version_changing"> + + <title>Changing the Seam Version</title> + + <para>To upgrade or downgrade your projects Seam version use the facet preferences. You + should right-click your project, open its <property>Properties</property> and choose <emphasis> + <property>Project Facets</property> + </emphasis> category. Next select <emphasis> + <property>Seam</property> + </emphasis> and change its version to needed one.</para> + + <figure> + <title>Changing the Seam Facet Version</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_3.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>After pressing <emphasis> + <property>Apply</property> + </emphasis> the wizard for adjusting new Seam runtime settings appears.</para> + + <figure> + <title>Changing the Seam Facet Version</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_4.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>If you need to update the libraries for you project, check the <emphasis> + <property>Update libraries</property> + </emphasis> option. All libraries you checked will be removed and the libraries from the + new Seam distribution will be added after clicking <emphasis> + <property>Ok</property>.</emphasis></para> + + <figure> + <title>Changing the Seam Facet Version</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_5.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>The note "Seam configuration files and their XSDs won't be changed" is + meant that the libraries, Seam facet and runtime version will be changed, but + configuration files that refer to the old version will have to be manually + updated.</para> + </note> + </section> + + <section id="changing_seam_parent_project"> + <title>Changing Seam Parent Project</title> + + <para>Starting from the 2.0.0.CR2 version of <property>JBoss Tools</property> it is possible + to change the Seam parent project. In earlier versions this was only controllable at a + project creation time, now it can be changed for existing projects too.</para> + + <para>Go to your project preferences and select <emphasis> + <property>Seam Settings</property> + </emphasis> category on the left. Press the <emphasis> + <property>Browse</property> + </emphasis> button next to the <emphasis> + <property>Main Seam Project</property> + </emphasis> section to select the other Seam parent project.</para> + + <figure> + <title>Changing Seam Parent Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_6.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="renaming_projects_folders"> + <title>Renaming the Projects and Folders</title> + + <para>If you need to rename one of the Seam Project artifacts + (<emphasis><project_name></emphasis>, + <emphasis><project_name>-ear</emphasis>, + <emphasis><project_name>-ejb</emphasis> or + <emphasis><project_name>-test</emphasis>) or any entire folder like + <emphasis><project_name>/WebContent</emphasis>, + <emphasis><project_name>/ejbModule</emphasis>, + <emphasis><project_name>-test/test-src</emphasis>, or project name in + packages <emphasis>org.domain.<project_name>.session</emphasis>, + <emphasis>org.domain.<project_name>.entity</emphasis>, you can do this + by brining the context menu and navigating <emphasis> + <property>Refactor > Rename...</property> + </emphasis> or just pressing <emphasis> + <property>Shift + Alt + R</property> + </emphasis> under the chosen resource.</para> + + <figure> + <title>Renaming the folder</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_7.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>Use <emphasis> + <property>Refactor > Move...</property> + </emphasis> (or <emphasis> + <property>Shift + Alt + V</property> + </emphasis>), if you need to move + <emphasis><project_name>/WebContent</emphasis> folder, + <emphasis><project_name>/ejbModule</emphasis> folder or + <emphasis><project_name>/test-src</emphasis> folder in the other place + within the Project structure.</para> + + <figure> + <title>Moving the folder</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_8.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + </section> +</chapter> \ No newline at end of file Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/generate_entities.xml =================================================================== --- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/generate_entities.xml 2010-06-09 00:21:45 UTC (rev 22660) +++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/generate_entities.xml 2010-06-09 00:28:36 UTC (rev 22661) @@ -40,7 +40,7 @@ <note> <title>Note:</title> <para>The entities are generated from a database based on the console configuration that is created automatically during a Seam project creation. - (Read more about console configuration). The created console configuration is based on the + (Read more about the console configuration in the Hibernate guides). The created console configuration is based on the connection profile set on the <link linkend="seamFacet">Seam Facets wizard page</link> while creating a project. Configured connection profile settings are hold in the generated <literal>hibernate-console.properties</literal>. To change the connection profile, double-click the console configuration. It could be found in the <property>Hibernate Configurations</property> view Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_1.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_11.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_12.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_13.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_15.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_16.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_20.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_21.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_7.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_8.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/crud_database_application/crud_database_application_15.png =================================================================== (Binary files differ) Added: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/directory_structure/directory_structure_7.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/directory_structure/directory_structure_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/directory_structure/directory_structure_8.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/directory_structure/directory_structure_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_editors/seam_editors_1c.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_editors/seam_editors_1c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_11.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_14.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_15.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_5.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_8.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/intro.xml =================================================================== --- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/intro.xml 2010-06-09 00:21:45 UTC (rev 22660) +++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/intro.xml 2010-06-09 00:28:36 UTC (rev 22661) @@ -138,7 +138,7 @@ <title>Other relevant resources on the topic</title> <para>The <ulink url="http://seamframework.org/">Seam Framework</ulink> - Next generation enterprise Java development.</para> - <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> + <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at <ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> <para>There is some extra information on <ulink url="http://www.jboss.org/community/wiki/JBossSeam">JBoss Wiki. </ulink></para> <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para> <para>You can find a set of screencasts on how to search/find references and use Seam refactoring tools in the following Max Andersen's Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master.xml 2010-06-09 00:21:45 UTC (rev 22660) +++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master.xml 2010-06-09 00:28:36 UTC (rev 22661) @@ -63,7 +63,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 3.1.0.GA + Version: 3.1.1.GA </releaseinfo> <abstract> @@ -79,7 +79,7 @@ &intro; &creating_new_seam; - +&creating_mavenized_seam; &directory_structure; &menus_and_actions; &seam_wizards; Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master_output.xml 2010-06-09 00:21:45 UTC (rev 22660) +++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master_output.xml 2010-06-09 00:28:36 UTC (rev 22661) @@ -2,23 +2,23 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.docbook.org/xml/4.3/docbookx.dtd" -[<!ENTITY intro SYSTEM "modules/intro.xml"> -<!ENTITY creating_new_seam SYSTEM "modules/creating_new_seam.xml"> -<!ENTITY creating_mavenized_seam SYSTEM "modules/creating_mavenized_seam.xml"> -<!ENTITY directory_structure SYSTEM "modules/directory_structure.xml"> -<!ENTITY menus_and_actions SYSTEM "modules/seam_menus_and_actions.xml"> -<!ENTITY seam_wizards SYSTEM "modules/seam_wizards.xml"> -<!ENTITY generate_entities SYSTEM "modules/generate_entities.xml"> -<!ENTITY seam_refactoring SYSTEM "modules/seam_refactoring.xml"> -<!ENTITY seam_editors SYSTEM "modules/seam_editors.xml"> -<!ENTITY seam_view SYSTEM "modules/seam_view.xml"> -<!ENTITY seam_preferences SYSTEM "modules/seam_preferences.xml"> -<!ENTITY adding_seam_support_to_ear_project SYSTEM "modules/adding_seam_support_to_ear_project.xml"> -<!ENTITY crud_database_application SYSTEM "modules/crud_database_application.xml"> -<!ENTITY crud_application_walkthrough SYSTEM "modules/crud_application_walkthrough.xml"> -<!ENTITY business_application SYSTEM "modules/business_application.xml"> -<!ENTITY testng SYSTEM "modules/testng.xml"> -<!ENTITY seam_faq SYSTEM "modules/seam_faq.xml"> +[<!ENTITY intro SYSTEM "intro.xml"> +<!ENTITY creating_new_seam SYSTEM "creating_new_seam.xml"> +<!ENTITY creating_mavenized_seam SYSTEM "creating_mavenized_seam.xml"> +<!ENTITY directory_structure SYSTEM "directory_structure.xml"> +<!ENTITY menus_and_actions SYSTEM "seam_menus_and_actions.xml"> +<!ENTITY seam_wizards SYSTEM "seam_wizards.xml"> +<!ENTITY generate_entities SYSTEM "generate_entities.xml"> +<!ENTITY seam_refactoring SYSTEM "seam_refactoring.xml"> +<!ENTITY seam_editors SYSTEM "seam_editors.xml"> +<!ENTITY seam_view SYSTEM "seam_view.xml"> +<!ENTITY seam_preferences SYSTEM "seam_preferences.xml"> +<!ENTITY adding_seam_support_to_ear_project SYSTEM "adding_seam_support_to_ear_project.xml"> +<!ENTITY crud_database_application SYSTEM "crud_database_application.xml"> +<!ENTITY crud_application_walkthrough SYSTEM "crud_application_walkthrough.xml"> +<!ENTITY business_application SYSTEM "business_application.xml"> +<!ENTITY testng SYSTEM "testng.xml"> +<!ENTITY seam_faq SYSTEM "seam_faq.xml"> <!ENTITY seamlink "../../seam/html_single/index.html"> <!ENTITY aslink "../../as/html_single/index.html"> @@ -37,7 +37,7 @@ <bookinfo> - <title>Seam Dev Tools Reference Guide</title> + <title>Seam Developer Tools Reference Guide</title> <corpauthor> <inlinemediaobject> <imageobject role="fo"> @@ -62,7 +62,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 3.1.0.GA + Version: 3.1.1.GA </diffmk:wrapper></releaseinfo> <abstract> @@ -77,7 +77,7 @@ <toc></toc> -<chapter id="intro" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/intro.xml" xreflabel="intro"> +<chapter id="intro" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/intro.xml" xreflabel="intro"> <?dbhtml filename="intro.html"?> <chapterinfo> <keywordset> @@ -216,7 +216,7 @@ <title>Other relevant resources on the topic</title> <para>The <ulink url="http://seamframework.org/">Seam Framework</ulink> - Next generation enterprise Java development.</para> - <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> + <para><diffmk:wrapper diffmk:change="changed">All JBoss Developer Studio/JBoss Tools release documentation you can find at </diffmk:wrapper><ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> <para>There is some extra information on <ulink url="http://www.jboss.org/community/wiki/JBossSeam">JBoss Wiki. </ulink></para> <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para> <para>You can find a set of screencasts on how to search/find references and use Seam refactoring tools in the following Max Andersen's @@ -225,7 +225,7 @@ </chapter> -<chapter id="create_seam" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/creating_new_seam.xml" xreflabel="create_seam"> +<chapter id="create_seam" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/creating_new_seam.xml" xreflabel="create_seam"> <?dbhtml filename="create_new_seam.html"?> <chapterinfo> <keywordset> @@ -362,8 +362,8 @@ wizard</property>.</para> <tip> <title>Tip:</title> - <para>We suggest that you look through <ulink url="../../as/html_single/index.html">AS manager guide</ulink> to - find out more about runtimes and servers.</para> + <para><diffmk:wrapper diffmk:change="changed">We suggest that you look through the Application Server Manager Guide to + find out more about runtimes and servers.</diffmk:wrapper></para> </tip> <figure float="0"> <title>Completion of Runtime and Server Configuration</title> @@ -606,12 +606,26 @@ </imageobject> </mediaobject> </figure> + <itemizedlist> <listitem> <para>Select EAR or WAR deployment by checking a necessary radio button.</para> </listitem> <listitem> - <para>Select a <emphasis> + <para><diffmk:wrapper diffmk:change="added">Enter EJB project name and EAR project name in case of EAR radio button is checked.</diffmk:wrapper></para> + </listitem> + </itemizedlist> + + <tip diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tip:</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you want to name your web project "MyProject-war" note that the EJB project should not be "MyProject-war-ejb", + it should be "MyProject-ejb". The same for EAR and Test projects' names. They should be respectively "MyProject-ear" + and "MyProject-test".</diffmk:wrapper></para> + </tip> + + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"> + <para diffmk:change="added">Select a <emphasis> <property moreinfo="none">Database Type</property> </emphasis></para> </listitem> @@ -684,181 +698,10 @@ </emphasis> to generate a project.</para> <para></para> </section> -</chapter> - -<chapter id="mavenized_seam" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/creating_mavenized_seam.xml" xreflabel="mavenized_seam"> - <?dbhtml filename="create_mavenized_seam.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - </keywordset> - </chapterinfo> - <title>Maven Integration for Seam Projects</title> - <para>Starting from 3.1 M2 version <property moreinfo="none">JBoss Tools</property> includes new Jboss Maven - Integration plug-in which for now allows to create mavenized Seam projects and enable Seam - tools support for imported Maven projects.</para> - <para>The Jboss Maven Integration requires <ulink url="http://m2eclipse.sonatype.org/">m2eclipse</ulink> to be installed.</para> - <note> - <title>Note:</title> - <para>For M2 release of <property moreinfo="none">Jboss Tools</property> it is important to use m2eclipse - <ulink url="http://m2eclipse.sonatype.org/update/">stable updatesite</ulink> or the - <ulink url="http://m2eclipse.sonatype.org/releases/0.9.9.200906081351">latest - integration build</ulink> that M2 was developed against. If you want to use the - latest development release of m2eclipse you need to use the <ulink url="http://download.jboss.org/jbosstools/updates/nightly/trunk/">nightly - builds</ulink> of <property moreinfo="none">JBoss Tools</property>.</para> - </note> - <section id="create_mavenized_project"> - <title>Creating Maven ready Seam project</title> - <para>Maven Integration makes the Seam Wizard capable of creating Maven ready projects to - let Maven get the libraries instead of using the Seam runtime.</para> - <para>To create a mavenized Seam project you should perform the following steps:</para> - <itemizedlist> - <listitem> - <para>Navigate to <emphasis> - <property moreinfo="none">File > New Seam Project</property>.</emphasis> Give the project - a meaningful name, specify a target runtime and server and select the proper - configuration for your Seam project:</para> - <figure float="0"> - <title>Starting the Mavenized Seam Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_mavenized_seam/createMavenizedSeamProject.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Click the <emphasis> - <property moreinfo="none">Modify</property></emphasis> button to enable the <emphasis> - <property moreinfo="none">Jboss Maven Integration</property></emphasis> facet:</para> - <figure float="0"> - <title>Enabling the Jboss Maven Integration Facet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_mavenized_seam/jbossMavenIntegrationFacet.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>On the <property moreinfo="none">JBoss M2 capabilities</property> page you'll be prompted - to add the following maven properties: groupId, artifactId, version, packaging, - name and description. Here it's possible to set a maven version of Seam and - also decide whether to remove WTP classpath containers (where the path starts - with org.eclipse.jst). </para> - <figure float="0"> - <title>Adjusting JBoss M2 Capabilities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_mavenized_seam/jbossM2capabilities.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para> On the <property moreinfo="none">JSF Capabilities</property> page you can choose Maven as - libraries provider. This is possible when you use Maven JSF 1.2 Libraries as - type of JSF Implementing Library. Also it gives you capability to edit - Dependencies and Exclusions for the mavenized Seam project directly from the - wizard. </para> - <figure float="0"> - <title>Using JSF Implementation libraries provided by Maven</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_mavenized_seam/seamJSFImplementation.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>On the <property moreinfo="none">Seam Facet</property> page configure the Seam Facet settings - and click <emphasis> - <property moreinfo="none">Finish</property>:</emphasis></para> - <figure float="0"> - <title>Seam Facet Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_mavenized_seam/seamFacetPage.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para>The organized Seam project contains five projects with the Maven nature, builder, - Maven classpath and the <emphasis> - <property moreinfo="none">pom.xml</property></emphasis> files added: projectname, projectname-ear, - projectname-ejb, projectname-parent and projectname-test.</para> - <figure float="0"> - <title>Mavenized Seam Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_mavenized_seam/mavenizedProjectStructure.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="import_maven_project"> - <title>Existing Maven Projects Import</title> - <para>Maven Integration includes the Seam Maven configurator which is called when importing - a project, changing <emphasis> - <property moreinfo="none">pom.xml</property></emphasis> and/or calling <emphasis> - <property moreinfo="none">Maven > Update Project Configuration</property>.</emphasis> When - importing a Maven Seam project, the Seam Maven configurator picks up the settings set up - in <emphasis> - <property moreinfo="none">pom.xml</property></emphasis> and adds to the project the - following:</para> - <itemizedlist> - <listitem> - <para>Seam nature</para> - </listitem> - <listitem> - <para>Seam facet and dependent facets to the EJB, EAR and WAR projects</para> - </listitem> - <listitem> - <para>JBoss Maven Integration facet if the Maven project contains a dependency with - the org.jboss.seam groupId and an artifactId starting with 'jboss-seam'</para> - </listitem> - <listitem> - <para>other required facets (Web Module, Java, JSF, etc.)</para> - </listitem> - </itemizedlist> - <para>If the Seam version from <emphasis> - <property moreinfo="none">pom.xml</property></emphasis> matches a version of a Seam runtime - configured in the workspace, Seam configurator will set that runtime, otherwise no Seam - runtime will be set and you'll have to set it manually under <link linkend="project_pref">Seam Settings in the project preferences</link>.</para> - <para>Seam configurator recognizes the Seam artifacts in the following way: the view folder - is a web content folder from the WAR project, the source folder is the first Eclipse - source folder. If there is a folder containing "hot" in the name, it will be - chosen as the action source folder. Package is the first package that has children or - doesn't have any subpackage. </para> - <para>Configuring the Seam when importing a Maven project as well as a Seam Runtime, Seam - artifacts and some facets could be suspended in the JBoss Maven Integration preferences - (<emphasis> - <property moreinfo="none">Window > Preferences > JBoss Tools > JBoss Maven - Integration</property></emphasis>).</para> - <figure float="0"> - <title>JBoss Maven Integration Preferences</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_mavenized_seam/configure_maven_integration.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </section> - <section> - <title>Relevant Resources Links</title> - <para>In the <ulink url="http://in.relation.to/Bloggers/UsingMavenWithJBossTools">Using - Maven with JBoss Tools</ulink> article written by Max Andersen you'll find - references to the screencasts on how to use the examples of mavenized Seam projects - provided by <property moreinfo="none">JBoss Tools</property>.</para> - </section> +  </chapter> - - -<chapter id="directory_str" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/directory_structure.xml" xreflabel="directory_str"> +<chapter id="directory_str" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/directory_structure.xml" xreflabel="directory_str"> <?dbhtml filename="directory_structure.html"?> <chapterinfo> <keywordset> @@ -951,8 +794,8 @@ <title>Changing the Seam Version</title> - <para><diffmk:wrapper diffmk:change="added">To upgrade or downgrade your projects Seam version use the facet preferences. You - should right-click your project, open its </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and choose </diffmk:wrapper><emphasis> + <para>To upgrade or downgrade your projects Seam version use the facet preferences. You + should right-click your project, open its <property moreinfo="none">Properties</property> and choose <emphasis> <property moreinfo="none">Project Facets</property> </emphasis> category. Next select <emphasis> <property moreinfo="none">Seam</property> @@ -1035,9 +878,9 @@ <para>If you need to rename one of the Seam Project artifacts (<emphasis><project_name></emphasis>, - <emphasis><project_name>-test</emphasis>, - <emphasis><project_name>-test</emphasis> or - <emphasis><project_name>-ejb</emphasis>) or any entire folder like + <emphasis><diffmk:wrapper diffmk:change="changed"><project_name>-ear</diffmk:wrapper></emphasis>, + <emphasis><diffmk:wrapper diffmk:change="changed"><project_name>-ejb</diffmk:wrapper></emphasis> or + <emphasis><diffmk:wrapper diffmk:change="changed"><project_name>-test</diffmk:wrapper></emphasis>) or any entire folder like <emphasis><project_name>/WebContent</emphasis>, <emphasis><project_name>/ejbModule</emphasis>, <emphasis><project_name>-test/test-src</emphasis>, or project name in @@ -1048,6 +891,15 @@ </emphasis> or just pressing <emphasis> <property moreinfo="none">Shift + Alt + R</property> </emphasis> under the chosen resource.</para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Renaming the folder</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/directory_structure/directory_structure_7.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> <para>Use <emphasis> <property moreinfo="none">Refactor > Move...</property> @@ -1056,13 +908,22 @@ </emphasis>), if you need to move <emphasis><project_name>/WebContent</emphasis> folder, <emphasis><project_name>/ejbModule</emphasis> folder or - <emphasis><project_name>/test-src</emphasis> folder in the other place - within the Project structure.</para> + <emphasis><project_name>/test-src</emphasis><diffmk:wrapper diffmk:change="changed"> folder in the other place + within the Project structure.</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Moving the folder</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/directory_structure/directory_structure_8.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> </chapter> - -<chapter id="menus_and_actions" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/seam_menus_and_actions.xml" xreflabel="menus_and_actions"> +<chapter id="menus_and_actions" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/seam_menus_and_actions.xml" xreflabel="menus_and_actions"> <?dbhtml filename="seam_menus_and_actions.html"?> <chapterinfo> <keywordset> @@ -1425,7 +1286,7 @@ </chapter> -<chapter id="seam_wizards" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/seam_wizards.xml" xreflabel="seam_wizards"> +<chapter id="seam_wizards" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/seam_wizards.xml" xreflabel="seam_wizards"> <?dbhtml filename="seam_wizards.html"?> <chapterinfo> <keywordset> @@ -1767,7 +1628,7 @@ </chapter> -<chapter id="generate_entities" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/generate_entities.xml" xreflabel="generate_entities"> +<chapter id="generate_entities" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/generate_entities.xml" xreflabel="generate_entities"> <?dbhtml filename="generate_entities.html"?> <chapterinfo> <keywordset> @@ -1807,9 +1668,9 @@ <note> <title>Note:</title> - <para>The entities are generated from a database based on the console configuration that is created automatically during a Seam project creation. - (Read more about <ulink url="../../hibernatetools/html_single/index.html#console_conf">console configuration</ulink>). The created console configuration is based on the - connection profile set on the <link linkend="seamFacet">Seam Facets wizard page</link> while creating a project. + <para><diffmk:wrapper diffmk:change="changed">The entities are generated from a database based on the console configuration that is created automatically during a Seam project creation. + (Read more about the console configuration in the Hibernate guides). The created console configuration is based on the + connection profile set on the </diffmk:wrapper><link linkend="seamFacet">Seam Facets wizard page</link> while creating a project. Configured connection profile settings are hold in the generated <literal moreinfo="none">hibernate-console.properties</literal>. To change the connection profile, double-click the console configuration. It could be found in the <property moreinfo="none">Hibernate Configurations</property> view (<emphasis><property moreinfo="none">Window > Show view > Other > Hibernate > Hibernate Configurations</property></emphasis> @@ -1823,7 +1684,7 @@ <para>Read the <link linkend="crud_database_application">Generate a CRUD Database Application</link> chapter in order to see how the <property moreinfo="none">Generate Seam Entities</property> wizard can be used.</para> </chapter> -<chapter id="seam_editors" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/seam_editors.xml" xreflabel="seam_editors"> +<chapter id="seam_editors" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/seam_editors.xml" xreflabel="seam_editors"> <?dbhtml filename="seam_editors.html"?> <chapterinfo> <keywordset> @@ -2283,6 +2144,21 @@ </figure> </section> + <section diffmk:change="added" id="named_beans_code_assist" role="new"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Content assist for @Named beans</diffmk:wrapper></title> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To the nice code completion you can also use Content assist for all occurrences where @Named beans are used. + </diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Content assist for @Named beans</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/seam_editors/seam_editors_1c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> </section> <section> @@ -2502,10 +2378,9 @@ </section> </section> -</chapter> - -<chapter id="seam_view" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/seam_view.xml" xreflabel="seam_view"> +</chapter> +<chapter id="seam_view" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/seam_view.xml" xreflabel="seam_view"> <?dbhtml filename="seam_view.html"?> <chapterinfo> <keywordset> @@ -2633,7 +2508,7 @@ </chapter> -<chapter id="seam_preferences" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/seam_preferences.xml" xreflabel="seam_preferences"> +<chapter id="seam_preferences" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/seam_preferences.xml" xreflabel="seam_preferences">  <?dbhtml filename="seam_preferences.html"?> <chapterinfo> @@ -2872,7 +2747,7 @@ </chapter> -<chapter id="seam_refactoring" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/seam_refactoring.xml" xreflabel="seam_refactoring"> +<chapter id="seam_refactoring" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/seam_refactoring.xml" xreflabel="seam_refactoring"> <?dbhtml filename="seam_refactoring.html"?> <chapterinfo> <keywordset> @@ -3104,7 +2979,7 @@ -<chapter id="adding_seam_support_to_ear_project" role="new" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/adding_seam_support_to_ear_project.xml" xreflabel="adding_seam_support_to _ear_project"> +<chapter id="adding_seam_support_to_ear_project" role="new" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/adding_seam_support_to_ear_project.xml" xreflabel="adding_seam_support_to _ear_project"> <?dbhtml filename="adding_seam_support_to _ear_project.html"?> <chapterinfo> <keywordset> @@ -3228,7 +3103,7 @@ </chapter> -<chapter id="crud_database_application" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/crud_database_application.xml" xreflabel="crud_database_application"> +<chapter id="crud_database_application" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/crud_database_application.xml" xreflabel="crud_database_application"> <?dbhtml filename="crud_database_application.html"?> <chapterinfo> <keywordset> @@ -3712,7 +3587,7 @@ </chapter> -<chapter id="crud_application_walkthrough" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/crud_application_walkthrough.xml" xreflabel="crud_application_walkthrough"> +<chapter id="crud_application_walkthrough" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/crud_application_walkthrough.xml" xreflabel="crud_application_walkthrough"> <?dbhtml filename="crud_application_walkthrough.html"?> <chapterinfo> <keywordset> @@ -3843,7 +3718,7 @@ </chapter> -<chapter id="testNG" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/testng.xml" xreflabel="testNG"> +<chapter id="testNG" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/testng.xml" xreflabel="testNG"> <?dbhtml filename="testNG.html"?> <chapterinfo> <keywordset> @@ -4092,7 +3967,7 @@ </chapter> -<chapter id="seam_faq" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/seam_faq.xml" xreflabel="seam_faq"> +<chapter id="seam_faq" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/seam_faq.xml" xreflabel="seam_faq"> <?dbhtml filename="vwt_faq.html"?> <title>FAQ</title> @@ -4154,11 +4029,13 @@ <property moreinfo="none">Edit</property></emphasis> to change their output location.</para> <para>In conclusion, the main goal of this document is to get you know with a full featureset - that <property moreinfo="none">JBoss Tools</property> provides to support Seam development. Thus if you have - some questions, comments or suggestions on the topic, please fell free to ask in the - <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss + that <property>JBoss Tools</property> provides to support Seam development. Thus if you have + some questions, comments or suggestions on the topic, please fell free to ask in the <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Forum</ulink>. You can also influence on how you want to see JBoss Tools docs in - future leaving your vote on the article <ulink url="http://wiki.jboss.org/wiki/JBossToolsDocsFuture">Overview of the improvements required by JBossTools/JBDS Docs users</ulink>. </para> + future leaving your vote on the article <ulink + url="http://wiki.jboss.org/wiki/JBossToolsDocsFuture" + >Overview of the improvements required by JBossTools/JBDS Docs users</ulink>. </para> <para>A set of movies on Seam tooling is available on <ulink url="http://docs.jboss.org/tools/movies">Seam movies page</ulink>.</para> </section> Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/seam_editors.xml =================================================================== --- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/seam_editors.xml 2010-06-09 00:21:45 UTC (rev 22660) +++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/seam_editors.xml 2010-06-09 00:28:36 UTC (rev 22661) @@ -1,682 +1,697 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="seam_editors" xreflabel="seam_editors" role="updated"> - <?dbhtml filename="seam_editors.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - </keywordset> - </chapterinfo> - - <title>Seam Editors</title> - - - <para>This chapter tells about Seam Editors and their features.</para> - - <section> - <title>Visual Page Editor</title> - <para>Visual Page Editor fits perfectly for authoring view Seam pages. The major features of VPE are listed in <link linkend="SeamEditors">Main Features of Seam Editors</link> </para> - <para>You can also read more about Visual Page Editor in <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.htm...">Visual Page Editor</ulink> chapter of "Visual Web Tools Reference Guide".</para> - </section> - - - - - <section> - <title>Seam Pages Editor</title> - - - <para> - <property>Seam Pages Editor</property> provides a handy way to edit the <property>pages.xml</property> file. - - </para> - - <para> - You can edit the pages.xml file in three modes: Graphical, Tree and Source. - - </para> - <para> - Seam Pages Editor supports synchronization with Package Explorer.This means that while renaming files in the Package Explorer all the changes immediately affect the pages.xml file. - - </para> - <section> - <title>Graphical Mode</title> - - - <para>Graphical mode provides you with a set of visual tools to organize your project pageflow, exception handling etc.</para> - <figure> - <title>Seam Pages Editor: Graphical View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_7.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The Graphical part of the editor has some visual elements. The table below shows graphical representation of the elements and explains their meanings. </para> - -<table> - <title>Pages Editor: Graphical View. Visual elements</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Element</entry> - - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/element_page.png"/> - </imageobject> - </mediaobject> - </entry> - <entry><para>A yellow box with a solid border represents a <code> - <page> - </code> element. - </para></entry> - </row> - <row> - <entry> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/element_param.png"/> - </imageobject> - </mediaobject></entry> - <entry> - <para>Pressing on the plus icon (<inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/icon_plus.png"/> - </imageobject> - </inlinemediaobject>) - - - on the <code> - <page> - </code> element reveals a box that lists the parameters for the page.</para> - </entry> - - </row> - - <row> - <entry> <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/element_page2.png"/> - </imageobject> - </mediaobject></entry> - <entry> - <para>A red cross in the upper left corner of the page box indicates that the view-id is not found in the project.</para> - </entry> - </row> - - <row> - <entry><mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/element_page1.png"/> - </imageobject> - </mediaobject></entry> - <entry> <para> - A gray box with a dashed border represents a page that has navigation - (navigation rule) to but the page is not defined in the page.xml file. - </para></entry> - </row> - - - <row> - <entry> <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/element_exception.png"/> - </imageobject> - </mediaobject></entry> - <entry> <para>An <code><exception></code> is represented by a blue box with a orange diamond.</para></entry> - </row> - - - - - - </tbody> - </tgroup> -</table> - - - <para>Pageflow relations are shown with gray arrows, when you select a relationship the arrow is changed to orange. </para> - - - - <para>On the lefthand side of the Graphical view of <property>Seam Page Editor</property> you can find a toolbar with a set of icons for the most frequently used commands. </para> - - <table> - <title>Pages Editor: Graphical View. Commands Icons</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Icon Image</entry> - - <entry>Command</entry> - </row> - </thead> - <tbody> - <row> - <entry> - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/icon_select.png"/> - </imageobject> - </inlinemediaobject> - - </entry> - <entry>Select a page element</entry> - - </row> - - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/icon_marquee.png"/> - </imageobject> - </inlinemediaobject></entry> - <entry>Marquee a page item</entry> - </row> - - - <row> - <entry> - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/icon_new_link.png"/> - </imageobject> - </inlinemediaobject> - - </entry> - <entry>Add a page relationship</entry> - </row> - - - <row> - <entry> - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/icon_exception.png"/> - </imageobject> - </inlinemediaobject> - - </entry> - <entry>Add an exception rule</entry> - </row> - - </tbody> - </tgroup> - </table> - - <para>Context menus are also available when you click either on an item or a blank space.</para> - - - <para>A context menu called on a blank space of the diagram provides the following options:</para> - <itemizedlist> - <listitem><para><emphasis role="bold">Page</emphasis> creates a new page element on the diagram</para></listitem> - <listitem><para><emphasis role="bold">Exception</emphasis> creates a new exception element on the diagram</para></listitem> - <listitem><para><emphasis role="bold">Auto Layout</emphasis> formats the layout of the diagram automatically</para></listitem> - <listitem><para><emphasis role="bold">Select Element</emphasis> calls the <property>Select Element Wizard</property> with a filter to perform a quick search through the <property>pages.xml</property> file </para></listitem> - </itemizedlist> - <para>Rightclicking on a selected - <code><page></code> - element calls a context menu where you can choose the following options if you click on the <emphasis role="bold">New</emphasis> menu item: </para> - - - - <itemizedlist> - <listitem><para><emphasis role="bold">Rule</emphasis> opens the <property>Add Navigation Rule</property> dialog in which you can browse your project for a view page to set the view-id in the navigation rule and specify <emphasis role="bold">render</emphasis> or <emphasis role="bold">redirect</emphasis> navigation options </para></listitem> - <listitem><para><emphasis role="bold">Param</emphasis> calls a dialog box where you can define a parameter (using the - <code><param></code> - tag) for the - <code><page></code> - element</para></listitem> - </itemizedlist> - - - <section> - <title>Seam Pages Diagram Preferences</title> - - - - <para>In order to customize the layout of Diagram you can go to - <property>Window > Preferences > JBoss Tools > Web > Seam > Editors > Seam Pages Diagram</property>. - </para> - - <figure> - <title>Preferences of Seam Pages Diagram</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_11.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - </section> - - - <section> - <title>Tree Mode</title> - - <para>Tree Mode provides a wider range of options and way to edit and modify the pages.xml file.</para> - - - - <figure> - <title>Seam Pages Editor: Tree View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_8.png"/> - </imageobject> - </mediaobject> - </figure> - - <para> - In this mode all elements and attributes of the page.xml - file can be viewed and edited in a visual, user friendly way. - </para> - - </section> - - - <section> - <title>Outline Support for Seam Pages Editor</title> - - - <para>Seam Pages Editor provides <property>Outline</property> view support. - You can explore the pages.xml using Outline view in two modes: <property>Tree</property> ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/outline_tree.png"/> - </imageobject> - </inlinemediaobject> ) and <property>Diagram Navigation</property> ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/outline_navigation.png"/> - </imageobject> - </inlinemediaobject> ).</para> - - <para> - The Diagram Navigation mode of Outline view gives a birds-view of the layout to allow quick navigation for large-scale applications. - </para> - - <figure> - <title>Outline view: Diagram Navigation mode</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_9.png"/> - </imageobject> - </mediaobject> - </figure> - - - <para>The Tree mode shows a tree for every element in the pages.xml file. You can get a quick overview of the whole file. When selecting an element in the Outline view the related element is highlighted in the Graphical, Tree or Source page of Seam Pages Editor.</para> - - - - <figure> - <title>Outline view: Tree mode</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_10.png"/> - </imageobject> - </mediaobject> - </figure> - - - - - </section> - - - - </section> - - - - - <section> - - - <title>Seam Components Editor</title> - - <para>When editing <property>components.xml</property> a structured tree editor is available - in addition to pure source editing. It has a graphical view (Tree tab) and source - (Source tab).</para> - - <figure> - <title>component.xml Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_4.png"/> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note:</title> - - <para>You can view and edit <property>components.xml</property> and other xml files - directly in the Project Explorer and Properties sheet without opening the - components.xml editor.</para> - </note> - <figure> - <title>component.xml Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_5.png"/> - </imageobject> - </mediaobject> - </figure> - - </section> - - - - <section id="SeamEditors"> - <title>Main Features of Seam Editors</title> - - <para>In this chapter you will know what Seam Editors features are and how to work with them. </para> - - <section id="ContentAssist"> - - <title>Content Assist</title> - - <para><property>Content Assist</property> (Ctrl + Space) is available when using EL expressions in the following file formats:</para> - <itemizedlist> - <listitem> - <para>JSP</para> - </listitem> - <listitem> - <para>XHTML</para> - </listitem> - <listitem> - <para>XML</para> - </listitem> - <listitem> - <para>JAVA</para> - </listitem> - </itemizedlist> - - <para>Notice, the code completion for the Seam components shows the proposals marked with Seam icon.</para> - - <figure> - <title>Content Assist</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_1.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - <para> Content Assist is also available for the <emphasis - role="italic"> - <property>"jsfc "</property> - </emphasis> attribute, it lets you select from a list of possible attribute values. Whereas, JSF components appear above all other components in the list.</para> - <figure> - <title>Content Assist for the "jsfc" attribute</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_12.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - <note> - <title>Note:</title> - - <para>To get Code Assist available for an externally generated and imported project, - don't forget to enable Seam features and configure Seam Settings in <link linkend="project_pref">Project Preferences</link>.</para> - </note> - - <section id="components_code_assist" role="new"> - <title>Content Assist for components.xml</title> - - <para>While you are editing a <emphasis> - <property>components.xml</property> - </emphasis> file you can make use of the Content Assist for inserting needed - elements.</para> - - <figure> - <title>Content Assist in the component.xml Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_1a.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The editor also makes code completion aware of methods/attributes for EntityQuery - component.</para> - - <figure> - <title>Content Assist for EntityQuery Component</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_1b.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - - - </section> - <section> - <title>Content Assist for Page Descriptors</title> - - <para>Content Assist ( CA ) is available for Page Descriptors, - <property>.page.xml</property> and <property>page.xml</property> files. - Content Assist lets you easily compose a Page Descriptor file by suggesting elements and attributes. The suggestions are context dependent, which means that CA provides only the elements, attributes and in some cases values for the attributes, suitable in a particular place of your Page Descriptor. - - </para> - <para> - Seam Pages Editor also supports code completion in EL-expressions suggesting you possible bean properties and methods. - </para> - </section> - <section id="OpenOn"> - <title>OpenOn</title> - - <para><property>OpenOn</property> lets you easily navigate through your project without - using the Package Explorer or Project Explorer. After pressing <emphasis> - <property>Ctrl + left click</property> - </emphasis> (or just F3) you will see a corresponding method or class.</para> - - <figure> - <title>OpenOn</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2.png"/> - </imageobject> - </mediaobject> - </figure> - <para>OpenOn is available for the following files:</para> - <itemizedlist> - <listitem> - <para> - <link linkend="xmlFiles">XML files</link> - </para> - </listitem> - <listitem> - <para> - <link linkend="xhtmlFiles">JSP/XHTML Pages</link> - </para> - </listitem> - <listitem> - <para> <link linkend="javaFiles">Java files</link></para> - </listitem> - </itemizedlist> - <note> - <title>Note:</title> - - <para>In this section were described only use cases special for Seam applications.For general information please read - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.htm...">OpenOn section in Visual Web Tools Reference Guide</ulink>.</para> - </note> - <itemizedlist> - <listitem id="xhtmlFiles"> <para>Using OpenOn in .xhtml files you can open:</para> - <itemizedlist> - <listitem><para>components or properties resolved using an EL expression;</para></listitem> - <listitem><para>all actions described in pages.xml;</para></listitem> - <listitem><para>other .xhtml files that paths are specified in a current file;</para></listitem> - <listitem><para>image files that paths are set in the <emphasis> - <property>value</property></emphasis> property.The files will be opened in the default system graphical editor.</para></listitem> - </itemizedlist> - </listitem> - <listitem id="xmlFiles"> - <para>OpenOn is also supported in Page Descriptors (<property>.page.xml</property> and <property>pages.xml</property>). OpenOn allows you to navigate to Java beans as well as to view pages. - You can <property>Ctrl + left click</property> on a bean or on view page file (e.g. XTML file) to navigate to the file you clicked on. </para> - - <figure> - <title>OpenOn in .page.xml file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2a.png"/> - </imageobject> - </mediaobject> - </figure> - <para>If you use Rule-based authorization with Drools in your Seam application you can apply OpenOn - in <emphasis> - <property>components.xml</property></emphasis> to open the files containing rule definitions in the <emphasis> - <property>"rule-files"</property></emphasis> tag. - </para> - <figure> - <title>OpenOn in components.xml file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2c.png"/> - </imageobject> - </mediaobject> - </figure> - <para>You can also use OpenOn to open jBPM components that are described in Seam component descriptor. - Two places where it works are available: </para> - <itemizedlist> - <listitem><para>inside <emphasis> - <property><component></property></emphasis> definition;</para> - <figure> - <title>OpenOn in components.xml file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2d.png"/> - </imageobject> - </mediaobject> - </figure></listitem> - <listitem><para>inside <emphasis> - <property>jbpm</property></emphasis> tags;</para> - <figure> - <title>OpenOn in components.xml file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2e.png"/> - </imageobject> - </mediaobject> - </figure></listitem> - </itemizedlist> - </listitem> - <listitem id="javaFiles"> - <para> - OpenOn is also supported in seam components where <property> In annotation</property> is presented. - After pressing <property>Ctrl + left click</property> on the seam component specified in <code>@In </code> you will get the possibility to open the file where the component is declarated as well as - all of the seam components where it is used in the next declarations:</para> - <itemizedlist> - <listitem><para>@Out</para></listitem> - <listitem><para>@DataModel</para></listitem> - <listitem><para>@Role</para></listitem> - <listitem><para>@Roles</para></listitem> - </itemizedlist> - - <figure> - <title>OpenOn in Seam Component</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2b.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - </section> - - <section id="SeamValidation"> - <title>Seam Validation</title> - - <para>Validation of various possible problematic definitions is implemented for Seam - applications.</para> - - <para>If an issue is found it will be shown in the standard <property>Problems - View</property>.</para> - - <figure> - <title>Seam Validation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_6.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note:</title> - <para>Please note, only files within source path and web content are validated, meaning temporary files or test files are not included.</para> - </note> - - <para>In the preferences page for Seam Validator you can see and modify the validator - behavior. Go to <emphasis> - <property>Window > Preferences > JBoss Tools > Web > Seam > Validator</property> - </emphasis> and select the severity level for the optional Seam Validator - problem.</para> - - <figure> - <title>Seam Validator Preferences</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_3.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>On WTP projects validation are enabled by default and thus executed automatically, but - on normal Java projects you will have to go and add the Validation builder of your - project . It is available in the properties of your project under - <emphasis><property>Validation</property>.</emphasis></para> - - <figure> - <title>Enabling the Validation Builder</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/validator1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The validations can be run manually by clicking - <emphasis><property>Validate</property></emphasis> via the context menu on your project (folder or file inside your project) which will - execute all the active WTP validations. Following to the project's preferences under <emphasis> - <property>Validation</property></emphasis> it's possible to enable/disable any validator. - </para> - - <para>It's also possible to turn off the validation for some resource (a file, folder) inside your project via the <emphasis> - <property>Exclude Validation</property></emphasis> context menu option.</para> - - <figure> - <title>Excluding Validation for the WebContent Folder</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/validator2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>As a result, if you've turned off the validation for a folder (or file), it is put to the excluded group of the Validation filters and be ignored during the validation.</para> - - <figure> - <title>Validation Filters</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/validator3.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - -</section> -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="seam_editors" xreflabel="seam_editors" role="updated"> + <?dbhtml filename="seam_editors.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Seam</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + + <title>Seam Editors</title> + + + <para>This chapter tells about Seam Editors and their features.</para> + + <section> + <title>Visual Page Editor</title> + <para>Visual Page Editor fits perfectly for authoring view Seam pages. The major features of VPE are listed in <link linkend="SeamEditors">Main Features of Seam Editors</link> </para> + <para>You can also read more about Visual Page Editor in <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.htm...">Visual Page Editor</ulink> chapter of "Visual Web Tools Reference Guide".</para> + </section> + + + + + <section> + <title>Seam Pages Editor</title> + + + <para> + <property>Seam Pages Editor</property> provides a handy way to edit the <property>pages.xml</property> file. + + </para> + + <para> + You can edit the pages.xml file in three modes: Graphical, Tree and Source. + + </para> + <para> + Seam Pages Editor supports synchronization with Package Explorer.This means that while renaming files in the Package Explorer all the changes immediately affect the pages.xml file. + + </para> + <section> + <title>Graphical Mode</title> + + + <para>Graphical mode provides you with a set of visual tools to organize your project pageflow, exception handling etc.</para> + <figure> + <title>Seam Pages Editor: Graphical View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The Graphical part of the editor has some visual elements. The table below shows graphical representation of the elements and explains their meanings. </para> + +<table> + <title>Pages Editor: Graphical View. Visual elements</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Element</entry> + + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/element_page.png"/> + </imageobject> + </mediaobject> + </entry> + <entry><para>A yellow box with a solid border represents a <code> + <page> + </code> element. + </para></entry> + </row> + <row> + <entry> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/element_param.png"/> + </imageobject> + </mediaobject></entry> + <entry> + <para>Pressing on the plus icon (<inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/icon_plus.png"/> + </imageobject> + </inlinemediaobject>) + + + on the <code> + <page> + </code> element reveals a box that lists the parameters for the page.</para> + </entry> + + </row> + + <row> + <entry> <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/element_page2.png"/> + </imageobject> + </mediaobject></entry> + <entry> + <para>A red cross in the upper left corner of the page box indicates that the view-id is not found in the project.</para> + </entry> + </row> + + <row> + <entry><mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/element_page1.png"/> + </imageobject> + </mediaobject></entry> + <entry> <para> + A gray box with a dashed border represents a page that has navigation + (navigation rule) to but the page is not defined in the page.xml file. + </para></entry> + </row> + + + <row> + <entry> <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/element_exception.png"/> + </imageobject> + </mediaobject></entry> + <entry> <para>An <code><exception></code> is represented by a blue box with a orange diamond.</para></entry> + </row> + + + + + + </tbody> + </tgroup> +</table> + + + <para>Pageflow relations are shown with gray arrows, when you select a relationship the arrow is changed to orange. </para> + + + + <para>On the lefthand side of the Graphical view of <property>Seam Page Editor</property> you can find a toolbar with a set of icons for the most frequently used commands. </para> + + <table> + <title>Pages Editor: Graphical View. Commands Icons</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Icon Image</entry> + + <entry>Command</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/icon_select.png"/> + </imageobject> + </inlinemediaobject> + + </entry> + <entry>Select a page element</entry> + + </row> + + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/icon_marquee.png"/> + </imageobject> + </inlinemediaobject></entry> + <entry>Marquee a page item</entry> + </row> + + + <row> + <entry> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/icon_new_link.png"/> + </imageobject> + </inlinemediaobject> + + </entry> + <entry>Add a page relationship</entry> + </row> + + + <row> + <entry> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/icon_exception.png"/> + </imageobject> + </inlinemediaobject> + + </entry> + <entry>Add an exception rule</entry> + </row> + + </tbody> + </tgroup> + </table> + + <para>Context menus are also available when you click either on an item or a blank space.</para> + + + <para>A context menu called on a blank space of the diagram provides the following options:</para> + <itemizedlist> + <listitem><para><emphasis role="bold">Page</emphasis> creates a new page element on the diagram</para></listitem> + <listitem><para><emphasis role="bold">Exception</emphasis> creates a new exception element on the diagram</para></listitem> + <listitem><para><emphasis role="bold">Auto Layout</emphasis> formats the layout of the diagram automatically</para></listitem> + <listitem><para><emphasis role="bold">Select Element</emphasis> calls the <property>Select Element Wizard</property> with a filter to perform a quick search through the <property>pages.xml</property> file </para></listitem> + </itemizedlist> + <para>Rightclicking on a selected + <code><page></code> + element calls a context menu where you can choose the following options if you click on the <emphasis role="bold">New</emphasis> menu item: </para> + + + + <itemizedlist> + <listitem><para><emphasis role="bold">Rule</emphasis> opens the <property>Add Navigation Rule</property> dialog in which you can browse your project for a view page to set the view-id in the navigation rule and specify <emphasis role="bold">render</emphasis> or <emphasis role="bold">redirect</emphasis> navigation options </para></listitem> + <listitem><para><emphasis role="bold">Param</emphasis> calls a dialog box where you can define a parameter (using the + <code><param></code> + tag) for the + <code><page></code> + element</para></listitem> + </itemizedlist> + + + <section> + <title>Seam Pages Diagram Preferences</title> + + + + <para>In order to customize the layout of Diagram you can go to + <property>Window > Preferences > JBoss Tools > Web > Seam > Editors > Seam Pages Diagram</property>. + </para> + + <figure> + <title>Preferences of Seam Pages Diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_11.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + + + <section> + <title>Tree Mode</title> + + <para>Tree Mode provides a wider range of options and way to edit and modify the pages.xml file.</para> + + + + <figure> + <title>Seam Pages Editor: Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + In this mode all elements and attributes of the page.xml + file can be viewed and edited in a visual, user friendly way. + </para> + + </section> + + + <section> + <title>Outline Support for Seam Pages Editor</title> + + + <para>Seam Pages Editor provides <property>Outline</property> view support. + You can explore the pages.xml using Outline view in two modes: <property>Tree</property> ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/outline_tree.png"/> + </imageobject> + </inlinemediaobject> ) and <property>Diagram Navigation</property> ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/outline_navigation.png"/> + </imageobject> + </inlinemediaobject> ).</para> + + <para> + The Diagram Navigation mode of Outline view gives a birds-view of the layout to allow quick navigation for large-scale applications. + </para> + + <figure> + <title>Outline view: Diagram Navigation mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_9.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para>The Tree mode shows a tree for every element in the pages.xml file. You can get a quick overview of the whole file. When selecting an element in the Outline view the related element is highlighted in the Graphical, Tree or Source page of Seam Pages Editor.</para> + + + + <figure> + <title>Outline view: Tree mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_10.png"/> + </imageobject> + </mediaobject> + </figure> + + + + + </section> + + + + </section> + + + + + <section> + + + <title>Seam Components Editor</title> + + <para>When editing <property>components.xml</property> a structured tree editor is available + in addition to pure source editing. It has a graphical view (Tree tab) and source + (Source tab).</para> + + <figure> + <title>component.xml Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>You can view and edit <property>components.xml</property> and other xml files + directly in the Project Explorer and Properties sheet without opening the + components.xml editor.</para> + </note> + <figure> + <title>component.xml Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_5.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + + + <section id="SeamEditors"> + <title>Main Features of Seam Editors</title> + + <para>In this chapter you will know what Seam Editors features are and how to work with them. </para> + + <section id="ContentAssist"> + + <title>Content Assist</title> + + <para><property>Content Assist</property> (Ctrl + Space) is available when using EL expressions in the following file formats:</para> + <itemizedlist> + <listitem> + <para>JSP</para> + </listitem> + <listitem> + <para>XHTML</para> + </listitem> + <listitem> + <para>XML</para> + </listitem> + <listitem> + <para>JAVA</para> + </listitem> + </itemizedlist> + + <para>Notice, the code completion for the Seam components shows the proposals marked with Seam icon.</para> + + <figure> + <title>Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_1.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + <para> Content Assist is also available for the <emphasis + role="italic"> + <property>"jsfc "</property> + </emphasis> attribute, it lets you select from a list of possible attribute values. Whereas, JSF components appear above all other components in the list.</para> + <figure> + <title>Content Assist for the "jsfc" attribute</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_12.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + + <para>To get Code Assist available for an externally generated and imported project, + don't forget to enable Seam features and configure Seam Settings in <link linkend="project_pref">Project Preferences</link>.</para> + </note> + + <section id="components_code_assist" role="new"> + <title>Content Assist for components.xml</title> + + <para>While you are editing a <emphasis> + <property>components.xml</property> + </emphasis> file you can make use of the Content Assist for inserting needed + elements.</para> + + <figure> + <title>Content Assist in the component.xml Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_1a.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The editor also makes code completion aware of methods/attributes for EntityQuery + component.</para> + + <figure> + <title>Content Assist for EntityQuery Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_1b.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="named_beans_code_assist" role="new"> + <title>Content assist for @Named beans</title> + + <para>To the nice code completion you can also use Content assist for all occurrences where @Named beans are used. + </para> + + <figure> + <title>Content assist for @Named beans</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_1c.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + </section> + <section> + <title>Content Assist for Page Descriptors</title> + + <para>Content Assist ( CA ) is available for Page Descriptors, + <property>.page.xml</property> and <property>page.xml</property> files. + Content Assist lets you easily compose a Page Descriptor file by suggesting elements and attributes. The suggestions are context dependent, which means that CA provides only the elements, attributes and in some cases values for the attributes, suitable in a particular place of your Page Descriptor. + + </para> + <para> + Seam Pages Editor also supports code completion in EL-expressions suggesting you possible bean properties and methods. + </para> + </section> + <section id="OpenOn"> + <title>OpenOn</title> + + <para><property>OpenOn</property> lets you easily navigate through your project without + using the Package Explorer or Project Explorer. After pressing <emphasis> + <property>Ctrl + left click</property> + </emphasis> (or just F3) you will see a corresponding method or class.</para> + + <figure> + <title>OpenOn</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>OpenOn is available for the following files:</para> + <itemizedlist> + <listitem> + <para> + <link linkend="xmlFiles">XML files</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="xhtmlFiles">JSP/XHTML Pages</link> + </para> + </listitem> + <listitem> + <para> <link linkend="javaFiles">Java files</link></para> + </listitem> + </itemizedlist> + <note> + <title>Note:</title> + + <para>In this section were described only use cases special for Seam applications.For general information please read + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.htm...">OpenOn section in Visual Web Tools Reference Guide</ulink>.</para> + </note> + <itemizedlist> + <listitem id="xhtmlFiles"> <para>Using OpenOn in .xhtml files you can open:</para> + <itemizedlist> + <listitem><para>components or properties resolved using an EL expression;</para></listitem> + <listitem><para>all actions described in pages.xml;</para></listitem> + <listitem><para>other .xhtml files that paths are specified in a current file;</para></listitem> + <listitem><para>image files that paths are set in the <emphasis> + <property>value</property></emphasis> property.The files will be opened in the default system graphical editor.</para></listitem> + </itemizedlist> + </listitem> + <listitem id="xmlFiles"> + <para>OpenOn is also supported in Page Descriptors (<property>.page.xml</property> and <property>pages.xml</property>). OpenOn allows you to navigate to Java beans as well as to view pages. + You can <property>Ctrl + left click</property> on a bean or on view page file (e.g. XTML file) to navigate to the file you clicked on. </para> + + <figure> + <title>OpenOn in .page.xml file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>If you use Rule-based authorization with Drools in your Seam application you can apply OpenOn + in <emphasis> + <property>components.xml</property></emphasis> to open the files containing rule definitions in the <emphasis> + <property>"rule-files"</property></emphasis> tag. + </para> + <figure> + <title>OpenOn in components.xml file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2c.png"/> + </imageobject> + </mediaobject> + </figure> + <para>You can also use OpenOn to open jBPM components that are described in Seam component descriptor. + Two places where it works are available: </para> + <itemizedlist> + <listitem><para>inside <emphasis> + <property><component></property></emphasis> definition;</para> + <figure> + <title>OpenOn in components.xml file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2d.png"/> + </imageobject> + </mediaobject> + </figure></listitem> + <listitem><para>inside <emphasis> + <property>jbpm</property></emphasis> tags;</para> + <figure> + <title>OpenOn in components.xml file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2e.png"/> + </imageobject> + </mediaobject> + </figure></listitem> + </itemizedlist> + </listitem> + <listitem id="javaFiles"> + <para> + OpenOn is also supported in seam components where <property> In annotation</property> is presented. + After pressing <property>Ctrl + left click</property> on the seam component specified in <code>@In </code> you will get the possibility to open the file where the component is declarated as well as + all of the seam components where it is used in the next declarations:</para> + <itemizedlist> + <listitem><para>@Out</para></listitem> + <listitem><para>@DataModel</para></listitem> + <listitem><para>@Role</para></listitem> + <listitem><para>@Roles</para></listitem> + </itemizedlist> + + <figure> + <title>OpenOn in Seam Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2b.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + </section> + + <section id="SeamValidation"> + <title>Seam Validation</title> + + <para>Validation of various possible problematic definitions is implemented for Seam + applications.</para> + + <para>If an issue is found it will be shown in the standard <property>Problems + View</property>.</para> + + <figure> + <title>Seam Validation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_6.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>Please note, only files within source path and web content are validated, meaning temporary files or test files are not included.</para> + </note> + + <para>In the preferences page for Seam Validator you can see and modify the validator + behavior. Go to <emphasis> + <property>Window > Preferences > JBoss Tools > Web > Seam > Validator</property> + </emphasis> and select the severity level for the optional Seam Validator + problem.</para> + + <figure> + <title>Seam Validator Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On WTP projects validation are enabled by default and thus executed automatically, but + on normal Java projects you will have to go and add the Validation builder of your + project . It is available in the properties of your project under + <emphasis><property>Validation</property>.</emphasis></para> + + <figure> + <title>Enabling the Validation Builder</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/validator1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The validations can be run manually by clicking + <emphasis><property>Validate</property></emphasis> via the context menu on your project (folder or file inside your project) which will + execute all the active WTP validations. Following to the project's preferences under <emphasis> + <property>Validation</property></emphasis> it's possible to enable/disable any validator. + </para> + + <para>It's also possible to turn off the validation for some resource (a file, folder) inside your project via the <emphasis> + <property>Exclude Validation</property></emphasis> context menu option.</para> + + <figure> + <title>Excluding Validation for the WebContent Folder</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/validator2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As a result, if you've turned off the validation for a folder (or file), it is put to the excluded group of the Validation filters and be ignored during the validation.</para> + + <figure> + <title>Validation Filters</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/validator3.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + +</section> +</chapter> \ No newline at end of file

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22659 - in tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US: images/jsf_application and 1 other directory.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 20:11:49 -0400 (Tue, 08 Jun 2010) New Revision: 22659 Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/adding_navigation.xml tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_5.png tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_6.png tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_8.png tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_9.png tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/master.xml tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/master_output.xml tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/running_application.xml Log: updated for 3.0.1 Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/adding_navigation.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/adding_navigation.xml 2010-06-09 00:10:24 UTC (rev 22658) +++ tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/adding_navigation.xml 2010-06-09 00:11:49 UTC (rev 22659) @@ -1,108 +1,108 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="adding_navigation" xreflabel="adding_navigation"> - <?dbhtml filename="adding_navigation.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>JSF application</keyword> - <keyword>Java</keyword> - </keywordset> - </chapterinfo> - - <title>Adding Navigation to the Application</title> - - <para>In our simple application, the flow is defined as a single navigation rule connecting - two views (presentation files). At this point, we will create the placeholders for the - two JSP presentation files and then the navigation rule to connect them as views. Later, - we will complete the coding for the JSP presentation files. We can do all of this in the - Diagram mode of the configuration file editor.</para> - <section id="AddingTwoViewsJSPPages"> - <?dbhtml filename="AddingTwoViewsJSPPages.html"?> - <title>Adding Two Views (JSP Pages)</title> - <itemizedlist> - <listitem> - <para>Right-click anywhere on the diagram and select <emphasis> - <property>New View...</property> - </emphasis> from the pop-up menu</para> - </listitem> - <listitem> - <para>In the dialog box, type <emphasis> - <property>pages/inputname</property> - </emphasis> as the value for From-view-id</para> - </listitem> - <listitem> - <para>Leave everything else as is</para> - </listitem> - <listitem> - <para>Click <emphasis> - <property>Finish</property> - </emphasis></para> - <para>If you look in the Package Explorer view you should see a <emphasis> - <property>pages</property> - </emphasis> folder under WebContent. Opening it will reveal the JSP file you - just created</para> - </listitem> - <listitem> - <para>Back on the diagram, right-click anywhere and select <emphasis> - <property>New View...</property> - </emphasis> from the pop-up menu</para> - </listitem> - <listitem> - <para>In the dialog box, type <emphasis> - <property>pages/greeting</property> - </emphasis> as the value for From-view-id</para> - </listitem> - <listitem> - <para>Leave everything else as is</para> - </listitem> - <listitem> - <para>Click <emphasis> - <property>Finish</property> - </emphasis></para> - </listitem> - </itemizedlist> - - </section> - <section id="CreatingTheTransitionNavigationRule"> - <?dbhtml filename="CreatingTheTransitionNavigationRule.html"?> - <title>Creating the Transition (Navigation Rule)</title> - <itemizedlist> - <listitem> - <para>In the diagram, select the connection icon third from the top along - the upper left side of the diagram (<inlinemediaobject> - <imageobject> - <imagedata fileref="images/jsf_application/jsf_application_3.png"/> - </imageobject> - </inlinemediaobject>) to get an arrow cursor with a two-pronged plug at the arrow's bottom.</para> - </listitem> - </itemizedlist> - - <itemizedlist> - <listitem> - <para>Click on the <emphasis> - <property>pages/inputname</property> - </emphasis> page icon and then click on the <emphasis> - <property>pages/greeting</property> - </emphasis> page icon</para> - </listitem> - - </itemizedlist> - <para>A transition should appear between the two icons.</para> - <figure> - <title>Transition Between Two Icons</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_application/jsf_application_4.png"/> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>Select <emphasis> - <property>File > Save</property> - </emphasis> from the menu bar</para> - </listitem> - </itemizedlist> - </section> - +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="adding_navigation" xreflabel="adding_navigation"> + <?dbhtml filename="adding_navigation.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>JSF application</keyword> + <keyword>Java</keyword> + </keywordset> + </chapterinfo> + + <title>Adding Navigation to the Application</title> + + <para>In our simple application, the flow is defined as a single navigation rule connecting + two views (presentation files). At this point, we will create the placeholders for the + two JSP presentation files and then the navigation rule to connect them as views. Later, + we will complete the coding for the JSP presentation files. We can do all of this in the + Diagram mode of the configuration file editor.</para> + <section id="AddingTwoViewsJSPPages"> + <?dbhtml filename="AddingTwoViewsJSPPages.html"?> + <title>Adding Two Views (JSP Pages)</title> + <itemizedlist> + <listitem> + <para>Right-click anywhere on the diagram and select <emphasis> + <property>Rule...</property> + </emphasis> from the pop-up menu</para> + </listitem> + <listitem> + <para>In the dialog box, type <emphasis> + <property>pages/inputname</property> + </emphasis> as the value for From View ID</para> + </listitem> + <listitem> + <para>Leave everything else as is</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property>Finish</property> + </emphasis></para> + <para>If you look in the Package Explorer view you should see a <emphasis> + <property>pages</property> + </emphasis> folder under WebContent. Opening it will reveal the JSP file you + just created</para> + </listitem> + <listitem> + <para>Back on the diagram, right-click anywhere and select <emphasis> + <property>Rule...</property> + </emphasis> from the pop-up menu</para> + </listitem> + <listitem> + <para>In the dialog box, type <emphasis> + <property>pages/greeting</property> + </emphasis> as the value for From View ID</para> + </listitem> + <listitem> + <para>Leave everything else as is</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property>Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + + </section> + <section id="CreatingTheTransitionNavigationRule"> + <?dbhtml filename="CreatingTheTransitionNavigationRule.html"?> + <title>Creating the Transition (Navigation Rule)</title> + <itemizedlist> + <listitem> + <para>In the diagram, select the connection icon third from the top along + the upper left side of the diagram (<inlinemediaobject> + <imageobject> + <imagedata fileref="images/jsf_application/jsf_application_3.png"/> + </imageobject> + </inlinemediaobject>) to get an arrow cursor with a two-pronged plug at the arrow's bottom.</para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>Click on the <emphasis> + <property>pages/inputname</property> + </emphasis> page icon and then click on the <emphasis> + <property>pages/greeting</property> + </emphasis> page icon</para> + </listitem> + + </itemizedlist> + <para>A transition should appear between the two icons.</para> + <figure> + <title>Transition Between Two Icons</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_application/jsf_application_4.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property>File > Save</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + </section> + </chapter> \ No newline at end of file Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_5.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_6.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_8.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/images/jsf_application/jsf_application_9.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/master.xml 2010-06-09 00:10:24 UTC (rev 22658) +++ tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/master.xml 2010-06-09 00:11:49 UTC (rev 22659) @@ -52,7 +52,7 @@ </copyright> <releaseinfo> - Version: 3.1.0.GA + Version: 3.1.1.GA </releaseinfo> Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/master_output.xml 2010-06-09 00:10:24 UTC (rev 22658) +++ tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/master_output.xml 2010-06-09 00:11:49 UTC (rev 22659) @@ -2,14 +2,14 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.docbook.org/xml/4.3/docbookx.dtd" -[<!ENTITY introduction SYSTEM "modules/introduction.xml"> -<!ENTITY jsf_application SYSTEM "modules/jsf_application.xml"> -<!ENTITY adding_navigation SYSTEM "modules/adding_navigation.xml"> -<!ENTITY adding_managed_bean SYSTEM "modules/adding_managed_bean.xml"> -<!ENTITY jsp_view_files SYSTEM "modules/jsp_view_files.xml"> -<!ENTITY start_page SYSTEM "modules/start_page.xml"> -<!ENTITY running_application SYSTEM "modules/running_application.xml"> -<!ENTITY relevant_resources SYSTEM "modules/relevant_resources.xml"> +[<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY jsf_application SYSTEM "jsf_application.xml"> +<!ENTITY adding_navigation SYSTEM "adding_navigation.xml"> +<!ENTITY adding_managed_bean SYSTEM "adding_managed_bean.xml"> +<!ENTITY jsp_view_files SYSTEM "jsp_view_files.xml"> +<!ENTITY start_page SYSTEM "start_page.xml"> +<!ENTITY running_application SYSTEM "running_application.xml"> +<!ENTITY relevant_resources SYSTEM "relevant_resources.xml"> <!ENTITY seamlink "../../seam/html_single/index.html"> <!ENTITY aslink "../../as/html_single/index.html"> @@ -50,7 +50,7 @@ </copyright> <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 3.1.0.GA + Version: 3.1.1.GA </diffmk:wrapper></releaseinfo> @@ -68,7 +68,7 @@ -<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en/modules/introduction.xml" xreflabel="introduction"> +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en-US/introduction.xml" xreflabel="introduction"> <?dbhtml filename="introduction.html"?> <chapterinfo> <keywordset> @@ -80,8 +80,8 @@ </chapterinfo> <title>Introduction</title> <para>The following chapters describe how to deal with classic/old style of JSF development. We - recommend users to use <ulink url="../../seam/html_single/index.html">JBoss - Seam</ulink> to simplify development, but until then you can read about classical JSF + recommend users to use JBoss + Seam to simplify development, but until then you can read about classical JSF usage here.</para> <para>Thus, in this document we are going to show you how to create a simple <property moreinfo="none">JSF application @@ -169,7 +169,7 @@ </chapter> -<chapter id="jsf_application" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en/modules/jsf_application.xml" xreflabel="jsf_application"> +<chapter id="jsf_application" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en-US/jsf_application.xml" xreflabel="jsf_application"> <?dbhtml filename="jsf_application.html"?> <chapterinfo> <keywordset> @@ -270,7 +270,7 @@ </chapter> -<chapter id="adding_navigation" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en/modules/adding_navigation.xml" xreflabel="adding_navigation"> +<chapter id="adding_navigation" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en-US/adding_navigation.xml" xreflabel="adding_navigation"> <?dbhtml filename="adding_navigation.html"?> <chapterinfo> <keywordset> @@ -293,13 +293,13 @@ <itemizedlist> <listitem> <para>Right-click anywhere on the diagram and select <emphasis> - <property moreinfo="none">New View...</property> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Rule...</diffmk:wrapper></property> </emphasis> from the pop-up menu</para> </listitem> <listitem> <para>In the dialog box, type <emphasis> <property moreinfo="none">pages/inputname</property> - </emphasis> as the value for From-view-id</para> + </emphasis><diffmk:wrapper diffmk:change="changed"> as the value for From View ID</diffmk:wrapper></para> </listitem> <listitem> <para>Leave everything else as is</para> @@ -315,13 +315,13 @@ </listitem> <listitem> <para>Back on the diagram, right-click anywhere and select <emphasis> - <property moreinfo="none">New View...</property> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Rule...</diffmk:wrapper></property> </emphasis> from the pop-up menu</para> </listitem> <listitem> <para>In the dialog box, type <emphasis> <property moreinfo="none">pages/greeting</property> - </emphasis> as the value for From-view-id</para> + </emphasis><diffmk:wrapper diffmk:change="changed"> as the value for From View ID</diffmk:wrapper></para> </listitem> <listitem> <para>Leave everything else as is</para> @@ -378,7 +378,7 @@ </chapter> -<chapter id="adding_managed_bean" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en/modules/adding_managed_bean.xml" xreflabel="adding_managed_bean"> +<chapter id="adding_managed_bean" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en-US/adding_managed_bean.xml" xreflabel="adding_managed_bean"> <?dbhtml filename="adding_managed_bean.html"?> <chapterinfo> <keywordset> @@ -468,7 +468,7 @@ </chapter> -<chapter id="jsp_view_files" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en/modules/jsp_view_files.xml" xreflabel="jsp_view_files"> +<chapter id="jsp_view_files" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en-US/jsp_view_files.xml" xreflabel="jsp_view_files"> <?dbhtml filename="jsp_view_files.html"?> <chapterinfo> <keywordset> @@ -722,7 +722,7 @@ </section> </chapter> -<chapter id="start_page" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en/modules/start_page.xml" xreflabel="start_page"> +<chapter id="start_page" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en-US/start_page.xml" xreflabel="start_page"> <?dbhtml filename="start_page.html"?> <chapterinfo> <keywordset> @@ -785,7 +785,7 @@ </itemizedlist> </chapter> -<chapter id="running_application" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en/modules/running_application.xml" xreflabel="running_application"> +<chapter id="running_application" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en-US/running_application.xml" xreflabel="running_application"> <?dbhtml filename="running_application.html"?> <chapterinfo> <keywordset> @@ -796,10 +796,10 @@ </chapterinfo> <title>Running the Application</title> - <para>Everything is now ready for running our application by using the JBoss engine. For - controlling JBoss server there is JBoss Server view:</para> + <para><diffmk:wrapper diffmk:change="changed">Everything is now ready for running our application by using the JBoss engine. For + controlling JBoss server there is Servers view:</diffmk:wrapper></para> <figure float="0"> - <title>JBoss Server View</title> + <title><diffmk:wrapper diffmk:change="changed">Servers view</diffmk:wrapper></title> <mediaobject> <imageobject> <imagedata fileref="images/jsf_application/jsf_application_9.png"></imagedata> @@ -808,11 +808,11 @@ </figure> <itemizedlist> <listitem> - <para>Start up JBoss by clicking on the icon in JBoss Server view. (If JBoss is + <para><diffmk:wrapper diffmk:change="changed">Start up JBoss by clicking on the icon in Servers view. (If JBoss is already running, stop it by clicking on the red icon and then start it again. Remember, the JSF run-time requires restarting the servlet engine when any changes have been made.) After the messages in the Console tabbed view stop - scrolling, JBoss is available</para> + scrolling, JBoss is available</diffmk:wrapper></para> </listitem> <listitem> @@ -832,7 +832,7 @@ appear.</para> </chapter> -<chapter id="relevant_resources" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en/modules/relevant_resources.xml" xreflabel="relevant_resources"> +<chapter id="relevant_resources" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_tutorial/en-US/relevant_resources.xml" xreflabel="relevant_resources"> <?dbhtml filename="relevant_resources.html"?> <chapterinfo> <keywordset> @@ -862,10 +862,9 @@ using the wizards provided by <property moreinfo="none">JBoss Tools</property>, configure its stuff and finally run it on the <property moreinfo="none">JBoss Server</property>.</para> - <para>Find out more features on JSF tooling in our <ulink url="../../jsf_tools_ref_guide/html_single/index.html">JSF Tools - Reference Guide</ulink>. - If you have questions and suggestions, please refer to - <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss + <para>Find out more features on JSF tooling in our JSF Tools + Reference Guide. If you have questions and suggestions, please refer to <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Forum</ulink>.</para> </chapter> Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/running_application.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/running_application.xml 2010-06-09 00:10:24 UTC (rev 22658) +++ tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_tutorial/en-US/running_application.xml 2010-06-09 00:11:49 UTC (rev 22659) @@ -11,9 +11,9 @@ <title>Running the Application</title> <para>Everything is now ready for running our application by using the JBoss engine. For - controlling JBoss server there is JBoss Server view:</para> + controlling JBoss server there is Servers view:</para> <figure> - <title>JBoss Server View</title> + <title>Servers view</title> <mediaobject> <imageobject> <imagedata fileref="images/jsf_application/jsf_application_9.png"/> @@ -22,7 +22,7 @@ </figure> <itemizedlist> <listitem> - <para>Start up JBoss by clicking on the icon in JBoss Server view. (If JBoss is + <para>Start up JBoss by clicking on the icon in Servers view. (If JBoss is already running, stop it by clicking on the red icon and then start it again. Remember, the JSF run-time requires restarting the servlet engine when any changes have been made.) After the messages in the Console tabbed view stop

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22658 - in tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US: images/jsf_support and 1 other directory.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 20:10:24 -0400 (Tue, 08 Jun 2010) New Revision: 22658 Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_23.png tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/jsf_config_file.xml tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/master.xml tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/master_output.xml tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/webxml_editor.xml Log: updated for 3.0.1 Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_23.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/jsf_config_file.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/jsf_config_file.xml 2010-06-09 00:08:25 UTC (rev 22657) +++ tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/jsf_config_file.xml 2010-06-09 00:10:24 UTC (rev 22658) @@ -1,436 +1,436 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="jsf_config_file" role="updated"> - <?dbhtml filename="jsf_config_file.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Eclipse</keyword> - <keyword>JSF Tools</keyword> - <keyword>Java</keyword> - <keyword>JBoss</keyword> - </keywordset> - </chapterinfo> - - <title>JSF Configuration File Editor</title> - - <para>First, we should mention that JSF configuration file (<emphasis> - <property>faces-config.xml</property> - </emphasis>) is intended for registering JSF application resources such as Converters, - Validators, Managed Beans and page-to-page navigation rules.</para> - <para>Now, let's look at how you can easily configure this file by means of a special - graphical editor for JSF configuration file. The editor has three main views:</para> - - <itemizedlist> - <listitem> - <para>Diagram</para> - </listitem> - <listitem> - <para>Tree</para> - </listitem> - <listitem> - <para>Source</para> - </listitem> - </itemizedlist> - - <para>They can be selected via the tabs at the bottom of the editor.</para> - - <section id="Diagram9553"> - - <title>Diagram view</title> - - <para>Here, we will show you how to work with JSF configuration file through the Diagram - view of the editor.</para> - <para>As you can see on the figure below, the Diagram view displays the navigation rules in - the faces-config.xml:</para> - <figure> - <title>Diagram View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_21.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>If your diagram is large, make use of the Outline view. Within it you can switch to a <emphasis> - <property>Diagram Navigator</property> - </emphasis> mode by selecting the middle icon at the top of the view window. It allows - you to easily move around the diagram. Just move the blue area in any direction, and the - diagram on the left will also move:</para> - <figure> - <title>Outline View for Diagram</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_32.png" scale="50"/> - </imageobject> - </mediaobject> - </figure> - - <para>To create a new page here, you should click the page icon (View Template) on the - toolbar from the left and then click anywhere on the diagram. A New Page Wizard will - appear.</para> - - <para>To create a transition for connecting pages:</para> - - <itemizedlist> - <listitem> - <para>Select the transition icon from the toolbar (New Connection).</para> - </listitem> - <listitem> - <para>Click the source page.</para> - </listitem> - <listitem> - <para>Click the target page.</para> - </listitem> - </itemizedlist> - - <para>A transition will appear between the two pages:</para> - <figure> - <title>Transition between JSP Pages</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_22.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>It is also possible to create a new page with context menu by right-clicking anywhere - on the diagram and selecting <emphasis> - <property>New View</property>. </emphasis></para> - <figure> - <title>Creating a New View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_23.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>To edit an existing transition, first select the transition line. Then, place the - mouse cursor over the last black dot (on the target page). The mouse cursor will change - to a big +. At this point, drag the line to a new target page:</para> - <figure> - <title>Editing Transition between Views</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_24.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="TreeView11123" role="updated"> - - <title>Tree View</title> - - <para>You can find it more convenient to edit your JSF Configuration file in the Tree view of - the <property>VPE</property>.</para> - - <para>The view displays all JSF application artifacts referenced in the configuration file - in a tree format. By selecting any node on the left, you can see and edit its properties - which will appear in the right-hand area. Let's look at the structure of this - tree more closely.</para> - - <itemizedlist> - <listitem> - <para>Under the <emphasis> - <property>Application</property> - </emphasis> node you can adjust JSF application specific settings such as - internationalization, possibility to set extensions, add property and variable - resolvers, etc.</para> - </listitem> - </itemizedlist> - - <figure> - <title>JSF Application Specific Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_24a.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>The <emphasis> - <property>Components</property> - </emphasis> node is for registering custom JSF components. Right-click and - choose <emphasis> - <property>New > Component</property> - </emphasis> or just press the <emphasis> - <property>Add</property> - </emphasis> button in the right-hand area to add a new component to the JSF - Configuration file.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Registering a New JSF Component</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_24b.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>In the <property>Add Component wizard</property> you should set a component - type and point to a component class by using the <emphasis> - <property>Browse</property> - </emphasis> button or create a new class for this component by using the <emphasis> - <property>Component-Class</property> - </emphasis> link.</para> - - <figure> - <title>Adding a New JSF Component to the JSF Configuration File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_24c.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Use the <emphasis> - <property>Render Kit</property> - </emphasis> node to create and register a set of related renderers for custom - JSF components.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Adding a New JSF Component to the JSF Configuration File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_24d.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Under the <emphasis> - <property>Converters</property> - </emphasis> node you can create a converter class for your JSF application - either with id or for a proper class. How to do that see the <link - linkend="CreateAndRegisterACustomConverter94230">Create and Register a - Custom Converter</link> section.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Creating a New Custom Converter</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_59.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>The <emphasis> - <property>Managed Bean</property> - </emphasis> node is meant for creating and registering Bean classes in your JSF - application. Read more on the topic in the <link linkend="managed_beans">Managed - Beans</link> chapter.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Managed Beans</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_26.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Use the <emphasis> - <property>Navigation Rules</property> - </emphasis> node to configure a navigation between the pages in your - application: create a new navigation rule and adjust necessary properties for it - in the right-hand area.</para> - </listitem> - </itemizedlist> - <tip> - <title>Tip:</title> - <para>The same you can do in the <link linkend="Diagram9553">Diagram view</link> of the - JSF Configuration file editor.</para> - </tip> - - <figure> - <title>Configuring Navigation Rules</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_26a.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Under the <emphasis> - <property>Referenced Beans</property> - </emphasis> node you can add a new Referenced Bean and configure various - properties for it. To learn more on this refer to the <link - linkend="referenced_beans">Create and Register Referenced Beans</link> - section.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Referenced Beans</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_26b.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>The <emphasis> - <property>Validators</property> - </emphasis> node is needed to create validator classes for organizing the - validation of your application data. You can read more on the topic in the <link - linkend="CreateAndRegisterACustomValidator5632">Create and Register a Custom - Validator</link> section.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Validators</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_26c.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>The <emphasis> - <property>Extensions</property> - </emphasis> node is for setting extensions for your <emphasis> - <property>faces-config.xml</property>.</emphasis></para> - </listitem> - </itemizedlist> - - <figure> - <title>Adding Extensions</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_26d.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>In the <property>Tree view</property> you can also edit the properties of the selected - element with the help of the <property>Properties view</property> as shown below:</para> - - <figure> - <title>Properties View </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_33.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - </section> - <section id="SourceView4643"> - - <title>Source View</title> - - <para>Here, we'll discuss how you can configure your faces-config.xml with the help - of Source View.</para> - <para>The Source view for the editor displays a text content of the JSF configuration file. - It is always synchronized with other two views, so any changes made in one of the views - will immediately appear in the other:</para> - <figure> - <title>Source View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_27.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - - <para>You can also work in the Source view with the help of the <emphasis> - <property>Outline view</property>.</emphasis> The Outline view shows a tree - structure of the JSF configuration file. Simply select any element in the Outline view, - and it will jump to the same place in the Source editor, so you can navigate through the - source code with Outline view.</para> - <figure> - <title>Outline View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_31.png" scale="50"/> - </imageobject> - </mediaobject> - </figure> - - </section> - - <section id="jsf_editor_features"> - <title>Editor Features</title> - <para>Here we'll discuss a very important features that JSF configuration file - editor provides for work with JSF resources.</para> - - <section id="jsf_openOn"> - <title>Open On</title> - <para>The JSF configuration file editor comes with a very useful OpenOn navigating - feature. More fully you can read about it in our Visual Web Tools - Guide.</para> - </section> - - <section id="ContentAssist976"> - - <title>Code Assist</title> - <para>Code Assist provides pop-up tip to help you complete your code statements. It - allows you to write your code faster and with more accuracy.</para> - <para>Code assist is always available in the Source mode:</para> - <figure> - <title>Code Assist in Source View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_28.png" scale="65"/> - </imageobject> - </mediaobject> - </figure> - - </section> - - <section id="ErrorReporting3324"> - - <title>Error Reporting</title> - <para>When you are developing your project, error checking is constantly provided. This - greatly reduces your development time as it allows you to catch many of the errors - during development.</para> - <para>Errors will be reported by <link linkend="jsf_project_verification"> - verification</link> facility:</para> - <figure> - <title>Error Reporting in Source View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_29.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <para>Other errors are also reported.</para> - <figure> - <title>Other Errors Reporting</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_30.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - </section> - </section> - -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="jsf_config_file" role="updated"> + <?dbhtml filename="jsf_config_file.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JSF Configuration File Editor</title> + + <para>First, we should mention that JSF configuration file (<emphasis> + <property>faces-config.xml</property> + </emphasis>) is intended for registering JSF application resources such as Converters, + Validators, Managed Beans and page-to-page navigation rules.</para> + <para>Now, let's look at how you can easily configure this file by means of a special + graphical editor for JSF configuration file. The editor has three main views:</para> + + <itemizedlist> + <listitem> + <para>Diagram</para> + </listitem> + <listitem> + <para>Tree</para> + </listitem> + <listitem> + <para>Source</para> + </listitem> + </itemizedlist> + + <para>They can be selected via the tabs at the bottom of the editor.</para> + + <section id="Diagram9553"> + + <title>Diagram view</title> + + <para>Here, we will show you how to work with JSF configuration file through the Diagram + view of the editor.</para> + <para>As you can see on the figure below, the Diagram view displays the navigation rules in + the faces-config.xml:</para> + <figure> + <title>Diagram View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_21.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>If your diagram is large, make use of the Outline view. Within it you can switch to a <emphasis> + <property>Diagram Navigator</property> + </emphasis> mode by selecting the middle icon at the top of the view window. It allows + you to easily move around the diagram. Just move the blue area in any direction, and the + diagram on the left will also move:</para> + <figure> + <title>Outline View for Diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_32.png" scale="50"/> + </imageobject> + </mediaobject> + </figure> + + <para>To create a new page here, you should click the page icon (View Template) on the + toolbar from the left and then click anywhere on the diagram. A New Page Wizard will + appear.</para> + + <para>To create a transition for connecting pages:</para> + + <itemizedlist> + <listitem> + <para>Select the transition icon from the toolbar (New Connection).</para> + </listitem> + <listitem> + <para>Click the source page.</para> + </listitem> + <listitem> + <para>Click the target page.</para> + </listitem> + </itemizedlist> + + <para>A transition will appear between the two pages:</para> + <figure> + <title>Transition between JSP Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_22.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>It is also possible to create a new page with context menu by right-clicking anywhere + on the diagram and selecting <emphasis> + <property>Rule...</property></emphasis></para> + <figure> + <title>Creating a New View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_23.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>To edit an existing transition, first select the transition line. Then, place the + mouse cursor over the last black dot (on the target page). The mouse cursor will change + to a big +. At this point, drag the line to a new target page:</para> + <figure> + <title>Editing Transition between Views</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="TreeView11123" role="updated"> + + <title>Tree View</title> + + <para>You can find it more convenient to edit your JSF Configuration file in the Tree view of + the <property>VPE</property>.</para> + + <para>The view displays all JSF application artifacts referenced in the configuration file + in a tree format. By selecting any node on the left, you can see and edit its properties + which will appear in the right-hand area. Let's look at the structure of this + tree more closely.</para> + + <itemizedlist> + <listitem> + <para>Under the <emphasis> + <property>Application</property> + </emphasis> node you can adjust JSF application specific settings such as + internationalization, possibility to set extensions, add property and variable + resolvers, etc.</para> + </listitem> + </itemizedlist> + + <figure> + <title>JSF Application Specific Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24a.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property>Components</property> + </emphasis> node is for registering custom JSF components. Right-click and + choose <emphasis> + <property>New > Component</property> + </emphasis> or just press the <emphasis> + <property>Add</property> + </emphasis> button in the right-hand area to add a new component to the JSF + Configuration file.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Registering a New JSF Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24b.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>In the <property>Add Component wizard</property> you should set a component + type and point to a component class by using the <emphasis> + <property>Browse</property> + </emphasis> button or create a new class for this component by using the <emphasis> + <property>Component-Class</property> + </emphasis> link.</para> + + <figure> + <title>Adding a New JSF Component to the JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24c.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Use the <emphasis> + <property>Render Kit</property> + </emphasis> node to create and register a set of related renderers for custom + JSF components.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Adding a New JSF Renderer Kit to the JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24d.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Under the <emphasis> + <property>Converters</property> + </emphasis> node you can create a converter class for your JSF application + either with id or for a proper class. How to do that see the <link + linkend="CreateAndRegisterACustomConverter94230">Create and Register a + Custom Converter</link> section.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Creating a New Custom Converter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_59.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property>Managed Bean</property> + </emphasis> node is meant for creating and registering Bean classes in your JSF + application. Read more on the topic in the <link linkend="managed_beans">Managed + Beans</link> chapter.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Managed Beans</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Use the <emphasis> + <property>Navigation Rules</property> + </emphasis> node to configure a navigation between the pages in your + application: create a new navigation rule and adjust necessary properties for it + in the right-hand area.</para> + </listitem> + </itemizedlist> + <tip> + <title>Tip:</title> + <para>The same you can do in the <link linkend="Diagram9553">Diagram view</link> of the + JSF Configuration file editor.</para> + </tip> + + <figure> + <title>Configuring Navigation Rules</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26a.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Under the <emphasis> + <property>Referenced Beans</property> + </emphasis> node you can add a new Referenced Bean and configure various + properties for it. To learn more on this refer to the <link + linkend="referenced_beans">Create and Register Referenced Beans</link> + section.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Referenced Beans</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26b.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property>Validators</property> + </emphasis> node is needed to create validator classes for organizing the + validation of your application data. You can read more on the topic in the <link + linkend="CreateAndRegisterACustomValidator5632">Create and Register a Custom + Validator</link> section.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Validators</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26c.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property>Extensions</property> + </emphasis> node is for setting extensions for your <emphasis> + <property>faces-config.xml</property>.</emphasis></para> + </listitem> + </itemizedlist> + + <figure> + <title>Adding Extensions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26d.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>In the <property>Tree view</property> you can also edit the properties of the selected + element with the help of the <property>Properties view</property> as shown below:</para> + + <figure> + <title>Properties View </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_33.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + </section> + <section id="SourceView4643"> + + <title>Source View</title> + + <para>Here, we'll discuss how you can configure your faces-config.xml with the help + of Source View.</para> + <para>The Source view for the editor displays a text content of the JSF configuration file. + It is always synchronized with other two views, so any changes made in one of the views + will immediately appear in the other:</para> + <figure> + <title>Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_27.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + + <para>You can also work in the Source view with the help of the <emphasis> + <property>Outline view</property>.</emphasis> The Outline view shows a tree + structure of the JSF configuration file. Simply select any element in the Outline view, + and it will jump to the same place in the Source editor, so you can navigate through the + source code with Outline view.</para> + <figure> + <title>Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_31.png" scale="50"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="jsf_editor_features"> + <title>Editor Features</title> + <para>Here we'll discuss a very important features that JSF configuration file + editor provides for work with JSF resources.</para> + + <section id="jsf_openOn"> + <title>Open On</title> + <para>The JSF configuration file editor comes with a very useful OpenOn navigating + feature. More fully you can read about it in our Visual Web Tools + Guide.</para> + </section> + + <section id="ContentAssist976"> + + <title>Code Assist</title> + <para>Code Assist provides pop-up tip to help you complete your code statements. It + allows you to write your code faster and with more accuracy.</para> + <para>Code assist is always available in the Source mode:</para> + <figure> + <title>Code Assist in Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_28.png" scale="65"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="ErrorReporting3324"> + + <title>Error Reporting</title> + <para>When you are developing your project, error checking is constantly provided. This + greatly reduces your development time as it allows you to catch many of the errors + during development.</para> + <para>Errors will be reported by <link linkend="jsf_project_verification"> + verification</link> facility:</para> + <figure> + <title>Error Reporting in Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_29.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>Other errors are also reported.</para> + <figure> + <title>Other Errors Reporting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_30.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + +</chapter> \ No newline at end of file Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/master.xml 2010-06-09 00:08:25 UTC (rev 22657) +++ tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/master.xml 2010-06-09 00:10:24 UTC (rev 22658) @@ -52,7 +52,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 3.1.0.GA + Version: 3.1.1.GA </releaseinfo> <abstract> Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/master_output.xml 2010-06-09 00:08:25 UTC (rev 22657) +++ tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/master_output.xml 2010-06-09 00:10:24 UTC (rev 22658) @@ -3,14 +3,14 @@ "http://www.docbook.org/xml/4.3/docbookx.dtd" [ -<!ENTITY introduction SYSTEM "modules/introduction.xml"> -<!ENTITY jsf_support SYSTEM "modules/jsf_support.xml"> -<!ENTITY projects SYSTEM "modules/projects.xml"> -<!ENTITY webxml_editor SYSTEM "modules/webxml_editor.xml"> -<!ENTITY jsf_config_file SYSTEM "modules/jsf_config_file.xml"> -<!ENTITY managed_beans SYSTEM "modules/managed_beans.xml"> -<!ENTITY creation_and_registration SYSTEM "modules/creation_and_registration.xml"> -<!ENTITY jsf_project_verification SYSTEM "modules/jsf_project_verification.xml"> +<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY jsf_support SYSTEM "jsf_support.xml"> +<!ENTITY projects SYSTEM "projects.xml"> +<!ENTITY webxml_editor SYSTEM "webxml_editor.xml"> +<!ENTITY jsf_config_file SYSTEM "jsf_config_file.xml"> +<!ENTITY managed_beans SYSTEM "managed_beans.xml"> +<!ENTITY creation_and_registration SYSTEM "creation_and_registration.xml"> +<!ENTITY jsf_project_verification SYSTEM "jsf_project_verification.xml"> <!ENTITY seamlink "../../seam/html_single/index.html"> <!ENTITY aslink "../../as/html_single/index.html"> @@ -51,7 +51,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 3.1.0.GA + Version: 3.1.1.GA </diffmk:wrapper></releaseinfo> <abstract> @@ -66,7 +66,7 @@ <toc></toc> -<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/introduction.xml"> +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en-US/introduction.xml"> <?dbhtml filename="introduction.html"?> <chapterinfo> @@ -178,7 +178,7 @@ </chapter> -<chapter id="jsf_support" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_support.xml"> +<chapter id="jsf_support" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en-US/jsf_support.xml"> <?dbhtml filename="jsf_support.html"?> <chapterinfo> <keywordset> @@ -335,8 +335,8 @@ <section> <title>Facelets components</title> - <para>The <ulink url="../../jsf/html_single/index.html#palette">JBoss Tools - Palette</ulink> comes with the Facelets components ready to + <para>The JBoss Tools + Palette comes with the Facelets components ready to use. A useful tip appears when you hover the mouse cursor over the tag, the tip includes a detailed description of the tag component, the syntax and available attributes.</para> @@ -478,7 +478,7 @@ </chapter> -<chapter id="projects" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/projects.xml"> +<chapter id="projects" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en-US/projects.xml"> <?dbhtml filename="projects.html"?> <chapterinfo> <keywordset> @@ -549,13 +549,13 @@ customizable. Thus you can pick a different template on which the projects Importing Existing should be based on. Almost all templates come in two variations: with jsf libraries and without ones.</para> - <figure float="0"> - <title>Choosing JSF Templates</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_12.png "></imagedata> - </imageobject> - </mediaobject> + <figure float="0"> + <title>Choosing JSF Templates</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_12.png"></imagedata> + </imageobject> + </mediaobject> </figure> <para>The table below provides description for each possible JSF template.</para> @@ -692,9 +692,8 @@ <title>Importing Existing JSF Projects with Any Structure</title> - <para>For detailed information on migration of JSF projects into a workspace see - <ulink url="../../Exadel-migration/html_single/index.html#jsf_struts">Migration - Guide</ulink>.</para> + <para>For detailed information on migration of JSF projects into a workspace see the Migration + Guide.</para> </section> <section id="add_jsf_capability"> @@ -875,12 +874,12 @@ <title>Relevant Resources Links</title> <para>You can find more in-depth explanation on how to work with special wizards, editors and views that can - be used in various scenarios while developing JSF applications in our <ulink url="../../jsf/html_single/index.html">Visual Web Tools guide</ulink>.</para> + be used in various scenarios while developing JSF applications in our Visual Web Tools Guide.</para> </section> </chapter> -<chapter id="webxml_editor" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/webxml_editor.xml" xreflabel="webxml_editor"> +<chapter id="webxml_editor" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en-US/webxml_editor.xml" xreflabel="webxml_editor"> <?dbhtml filename="webxml_editor.html"?> <chapterinfo> <keywordset> @@ -898,10 +897,10 @@ <para><property moreinfo="none">JBoss Tools</property> add the <emphasis> <property moreinfo="none">web.xml</property></emphasis> file to created JSF project automatically and provides a special editor for its editing. - See the Visual Web Tools guide that gives a descriptive information on the <ulink url="../../jsf/html_single/index.html#GraphicalWebApplicationFileEditor">web.xml editor</ulink>.</para> + See the Visual Web Tools guide that gives a descriptive information on the <filename moreinfo="none"><diffmk:wrapper diffmk:change="changed">web.xml editor</diffmk:wrapper></filename><diffmk:wrapper diffmk:change="changed">.</diffmk:wrapper></para> </chapter> -<chapter id="jsf_config_file" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_config_file.xml"> +<chapter id="jsf_config_file" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en-US/jsf_config_file.xml"> <?dbhtml filename="jsf_config_file.html"?> <chapterinfo> <keywordset> @@ -997,7 +996,7 @@ <para>It is also possible to create a new page with context menu by right-clicking anywhere on the diagram and selecting <emphasis> - <property moreinfo="none">New View</property>. </emphasis></para> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Rule...</diffmk:wrapper></property></emphasis></para> <figure float="0"> <title>Creating a New View</title> <mediaobject> @@ -1099,7 +1098,7 @@ </itemizedlist> <figure float="0"> - <title>Adding a New JSF Component to the JSF Configuration File</title> + <title><diffmk:wrapper diffmk:change="changed">Adding a New JSF Renderer Kit to the JSF Configuration File</diffmk:wrapper></title> <mediaobject> <imageobject> <imagedata fileref="images/jsf_support/jsf_support_24d.png"></imagedata> @@ -1281,8 +1280,8 @@ <section id="jsf_openOn"> <title>Open On</title> <para>The JSF configuration file editor comes with a very useful OpenOn navigating - feature. More fully you can read about it in our <ulink url="../../jsf/html_single/index.html#OpenOnSelection4Hyperlinknavigation">Visual Web Tools - Guide</ulink>.</para> + feature. More fully you can read about it in our Visual Web Tools + Guide.</para> </section> <section id="ContentAssist976"> @@ -1333,9 +1332,8 @@ </section> </chapter> - -<chapter id="managed_beans" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/managed_beans.xml"> +<chapter id="managed_beans" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en-US/managed_beans.xml"> <?dbhtml filename="managed_beans.html"?> <chapterinfo> <keywordset> @@ -1543,7 +1541,7 @@ </chapter> -<chapter id="creation_and_registration" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/creation_and_registration.xml"> +<chapter id="creation_and_registration" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en-US/creation_and_registration.xml"> <?dbhtml filename="creation_and_registration.html"?> <chapterinfo> <keywordset> @@ -1877,7 +1875,7 @@ </section> </chapter> -<chapter id="jsf_project_verification" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_project_verification.xml"> +<chapter id="jsf_project_verification" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en-US/jsf_project_verification.xml"> <?dbhtml filename="struts_project_verification.html"?> <chapterinfo> @@ -1979,9 +1977,8 @@ reference introduces you to wizards for creating and importing JSF projects, JSF Configuration File editor features, functionality for enabling JSF capabilities and etc.</para> - <para>If you have questions or good suggestions, please refer to - <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss - Tools Forum</ulink>.</para> + <para>If you have questions or good suggestions, please refer to <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss + Tools Forum</ulink>.</para> </chapter> - </book> Modified: tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/webxml_editor.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/webxml_editor.xml 2010-06-09 00:08:25 UTC (rev 22657) +++ tags/jbosstools-3.1.1.GA/jsf/docs/jsf_tools_ref_guide/en-US/webxml_editor.xml 2010-06-09 00:10:24 UTC (rev 22658) @@ -17,5 +17,5 @@ <para><property>JBoss Tools</property> add the <emphasis> <property>web.xml</property></emphasis> file to created JSF project automatically and provides a special editor for its editing. - See the Visual Web Tools guide that gives a descriptive information on the <filename>web.xml</filename> editor.</para> + See the Visual Web Tools guide that gives a descriptive information on the <filename>web.xml editor</filename>.</para> </chapter> \ No newline at end of file

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22657 - in tags/jbosstools-3.1.1.GA/jmx/docs: reference and 2 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 20:08:25 -0400 (Tue, 08 Jun 2010) New Revision: 22657 Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Author_Group.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Book_Info.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Feedback.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Preface.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Revision_History.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/connection.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/extensions.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/how_to.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/collaps_all.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/eclipse-jmx_0.2.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/equinox.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/favicon.ico tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/invokemethod.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/jbosstools_logo.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/link-with-editor_0.2.0.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor-horizontal-layout_0.2.0.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor-layout-buttons_0.2.0.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor_0.2.0.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-explorer-features.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-explorer-query.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbeans.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/new_connection_icon.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/notifications.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/introduction.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master_output.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_editor.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_explorer.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/references.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/summary.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/tasks.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/pom.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/publican.cfg Log: adding in new ref guide for 3.0.1 Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Author_Group.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Author_Group.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Author_Group.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup><author><firstname>JBoss Tools Team</firstname></author></authorgroup> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Book_Info.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Book_Info.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Book_Info.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<bookinfo><title>JMX Tools Reference Guide</title><subtitle>Provides information relating to the JMX Tools module.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The JMX Tools Reference Guide explains how to use the JMX Tools module to setup multiple JMX connections and explore the JMX tree and execute operations.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include><xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></bookinfo> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Feedback.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Feedback.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Feedback.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,20 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<section id="sect-Beginners_Guide-We_Need_Feedback" lang="en-US"> + <title>We Need Feedback!</title> + <indexterm> + <primary>feedback</primary> + <secondary>contact information for this manual</secondary> + </indexterm> + <para> + If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA against JBoss Developer Studio: <ulink url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...">https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...</ulink> + </para> + <para> + When submitting a bug report, be sure to mention the manual's name and to select the "documentation" component. + </para> + <para> + If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily. + </para> +</section> + + Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "JMX_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,19 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<book> +<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="references.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="summary.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + +<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +</book> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Preface.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Preface.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Preface.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<preface><title>Preface</title><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include><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:include></xi:fallback></xi:include></preface> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Revision_History.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Revision_History.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Revision_History.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<appendix><title>Revision History</title><simpara><revhistory><revision><revnumber>0</revnumber><date>Fri Nov 20 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/connection.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/connection.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/connection.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="connection" xreflabel="connection"> + <?dbhtml filename="connection.html"?> + + <title>Connections</title> + + <para>The <property>MBean Explorer</property> supports several different types of connections. + The tooling itself comes only with a default connection type, however other + adapters can provide additional connection types that may require additional + or non-spec behavior. Connections can be in either the connected state or + the disconnected state. Some connection types (such as the default connection type) + allow you to control the current state. Other connection types may not. </para> + + <para>Similarly, some connection types may be able to be created, and others may not. + The default connection type, for example, can be created and deleted by you + at will. The AS Tools connection type, which represents a JBoss server, does not + allow you this level of control. A JBoss JMX connection is created when a JBoss server is created + in the server's view, and deleted when the server is deleted. The JMX connection for + this server is in the connected state only when the server is started. </para> + + + <section><title>The Default Connection</title> + + <para> There are two ways to connect to an application with remote management enabled:</para> + <itemizedlist> + <listitem><para>Simple</para></listitem> + <listitem><para>Advanced</para></listitem> + </itemizedlist> + + <para> The first step is the same for both to connect to a MBean Server, click on the + <emphasis> + <property>New Connection</property></emphasis> icon + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/new_connection_icon.png"/> + </imageobject> + </inlinemediaobject> + + in the <property>MBean Explorer</property> menu bar.</para> + + <para>Then to follow the simple one you just need to specify host, port (and optionally user + name and password) and click <emphasis> + <property>OK</property>.</emphasis></para> + + <para>The default JMX URL is <emphasis> + <property>service:jmx:rmi:///jndi/rmi://localhost:3000/jmxrmi</property>.</emphasis></para> + + <para>In case you need to connect to an application which has not used the "standard" JMX URL + (e.g. Eclipse Equinox), you need chose more advance way, where it's necessary to specify + explicitly a JMX URL in the Advanced tab of the JMX Connection window.</para> + + <note> + <title>Note</title> + <para>Only JMX URL based on RMI are supported.</para> + </note> + </section> +</chapter> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/extensions.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/extensions.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/extensions.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="extensions" xreflabel="extensions"> + <?dbhtml filename="extensions"?> + <title>Extension API</title> + <para>This chapter will outline how to contribute your own Server type with some default + behavior.</para> + + <section> + <title>Why??</title> + + <para>You might be asking yourself why you'd need to extend this framework if JMX is + a standard. Perhaps you want a connection to be automatically created after some specific + action, or perhaps you want your connection wizard to do more than simply set a host and + port. JBoss, for example, requires setting some credentials on the client machine, but + using JBoss classes to do it. This requires that the connection have access to JBoss + jars.</para> + </section> + + <section> + <title>Core Extensions</title> + + <para>To create your own JMX Connection type, you must use the + org.jboss.tools.jmx.core.MBeanServerConnectionProvider extension point. This point takes + one child, a connectionProvider with a class that implements + org.jboss.tools.jmx.core.IConnectionProvider.</para> + + <para>An IConnectionProvider is responsible for creation and deletion of IConnectionWrapper + objects. It must also keep a list of listeners that it is expected to inform when a + connection is added or removed from its list. </para> + + <para>Each IConnectionWrapper is expected to handle running arbitrary JMX runnables or getting + a "Root" object representing all JMX nodes. There are some utility methods the + IConnectionWrapper can make use of.</para> + </section> + + + <section> + <title>UI Extensions</title> + <para>There are two extension points currently approved for use in the UI</para> + <itemizedlist> + <listitem> + <para>org.jboss.tools.jmx.ui.providerUI - provide an icon, id, displayable name, and + wizardPage class for creation of new connections</para> + </listitem> + <listitem> + <para>org.jboss.tools.jmx.ui.attribute.controls - allows you to map class types to some + Control to present them in the MBean Editor</para> + <para>We hope, this guide helped you to get started with the JBoss JMX Tools. Besides, for additional information you are welcome on <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> + </listitem> + </itemizedlist> + </section> + +</chapter> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/how_to.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/how_to.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/how_to.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,132 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="how_to" xreflabel="how_to"> + <?dbhtml filename="how_to.html"?> + <title>How to ...</title> + <para>This chapter will give you answers on most popular questions asked by <property>JMX + plugin</property> users.</para> + + <section> + <title>How to Manage Tomcat</title> + + <para>It's possible to manage Tomcat using <property>JMX Tools</property>.</para> + + <para>Currently, JMX Tooling is able to connect to Tomcat without authentication or with + password-based authentication.</para> + <para>Using SSL for authentication is not supported: you need to make sure that the System + property <emphasis> + <property>com.sun.management.jmxremote.ssl</property> + </emphasis> is set to false. </para> + <para>More information to manage Tomcat can be found in + <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/"> + Tomcat management</ulink> documentation.</para> + <para>Instructions to manage remotely Tomcat are available in + <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html.">Tomcat's monitoring</ulink> documentation.</para> + + </section> + + <section> + <title>How to manage Eclipse Equinox</title> + + <para>You can manage Equinox through the Equinox monitoring framework.</para> + <para>Once you have installed the Equinox monitoring framework and restarted Eclipse:</para> + + <itemizedlist> + <listitem> + <para>Go to <emphasis> + <property>Window > Open Perspective > Other</property> + </emphasis> and select the <property>JMX perspective</property></para> + </listitem> + + <listitem> + <para>Select <emphasis> + <property>JMX Server > Open Connection</property> + </emphasis> and click on <emphasis> + <property>OK</property> + </emphasis></para> + </listitem> + + <listitem> + <para>Switch to the <property>MBean Explorer</property> by going to <emphasis> + <property>Window > Show View > Other</property> + </emphasis> and selecting the MBean Explorer</para> + </listitem> + + <listitem> + <para>Click on the <emphasis> + <property>New Connection</property></emphasis> icon + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/new_connection_icon.png"/> + </imageobject> + </inlinemediaobject> + + in the <property>MBean Explorer</property> menu + bar </para> + </listitem> + + <listitem> + <para>Select the <emphasis> + <property>Advanced tab</property></emphasis> and set the JMX URL to <emphasis> + <property>service:jmx:rmi:///jndi/rmi://:8118/jmxserver</property> + </emphasis></para> + </listitem> + </itemizedlist> + + <para>You now have access to the MBeans exposed by Equinox.</para> + </section> + + + <section> + <title>Managing JBoss Instances</title> + + <para>Managing JBoss instances is not supported with the <property>JMX Tools</property> + alone. You must also download and install the <property>AS Tools</property> portion of + the <property>JBoss Tools</property> distribution. Even after installing the proper + tooling, you cannot create a JBoss JMX connection yourself or through the Connection + Wizard. The first step is to create a JBoss Server. The full instructions for this can + be found in the AS Tools section, however, the short summary is: </para> + <itemizedlist> + <listitem> + <para>Open the <property>Servers</property> view</para> + </listitem> + + <listitem> + <para>Right-click in the view and select <emphasis> + <property>New > Server</property> + </emphasis></para> + </listitem> + + <listitem> + <para>In the <emphasis> + <property>JBoss Enterprise Middleware</property> + </emphasis> or in <emphasis> + <property>JBoss Community</property> + </emphasis> section, select a server profile</para> + </listitem> + + <listitem> + <para>If a runtime has not yet been created, you'll be prompted for the + server's home directory, JDK, and configuration</para> + </listitem> + + <listitem> + <para>Finish the wizard and note that you have a new entry in both the + <property>Servers</property> view and the <property>MBean + Explorer</property></para> + </listitem> + + <listitem> + <para>Start the server by right-clicking it and selecting <emphasis> + <property>Start</property></emphasis></para> + </listitem> + <listitem> + <para>Note that once the server is started, the JMX connection can be + expanded</para> + </listitem> + </itemizedlist> + + <para>Now you can explore MBeans exposed by a JBoss instance.</para> + </section> + +</chapter> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/collaps_all.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/collaps_all.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/eclipse-jmx_0.2.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/eclipse-jmx_0.2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/equinox.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/equinox.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/invokemethod.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/invokemethod.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/link-with-editor_0.2.0.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/link-with-editor_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor-horizontal-layout_0.2.0.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor-horizontal-layout_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor-layout-buttons_0.2.0.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor-layout-buttons_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor_0.2.0.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-explorer-features.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-explorer-features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-explorer-query.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-explorer-query.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbeans.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbeans.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/new_connection_icon.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/new_connection_icon.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/notifications.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/notifications.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/introduction.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/introduction.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/introduction.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,135 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="intruduction" xreflabel="introduction"> + <?dbhtml filename="introduction.html"?> + + <title>Introduction</title> + <para><property>JBoss Tools</property>' JMX project is a fork of <ulink + url="http://code.google.com/p/eclipse-jmx/">eclipse-jmx</ulink>, a project by Jeff Mesnil. + It was forked with permission. </para> + + <section> + <title>What is JMX?</title> + <para> +The Java Management Extensions (JMX) technology is a standard part of the Java Platform, Standard Edition (Java SE platform). The JMX technology was added to the platform in the Java 2 Platform, Standard Edition (J2SE) 5.0 release. +</para> + <para> +The JMX technology provides a simple, standard way of managing resources such as applications, devices, and services. Because the JMX technology is dynamic, you can use it to monitor and manage resources as they are created, installed and implemented. You can also use the JMX technology to monitor and manage the Java Virtual Machine (Java VM). +</para> + <para> +The JMX specification defines the architecture, design patterns, APIs, and services in the Java programming language for management and monitoring of applications and networks. +</para> + <para> +Using the JMX technology, a given resource is instrumented by one or more Java objects known as Managed Beans, or MBeans. These MBeans are registered in a core-managed object server, known as an MBean server. The MBean server acts as a management agent and can run on most devices that have been enabled for the Java programming language. +</para> + + <para> +The specifications define JMX agents that you use to manage any resources that have been correctly configured for management. A JMX agent consists of an MBean server, in which MBeans are registered, and a set of services for handling the MBeans. In this way, JMX agents directly control resources and make them available to remote management applications. +</para> + <para> +The way in which resources are instrumented is completely independent from the management infrastructure. Resources can therefore be rendered manageable regardless of how their management applications are implemented. +</para> + <para> +The JMX technology defines standard connectors (known as JMX connectors) that enable you to access JMX agents from remote management applications. JMX connectors using different protocols provide the same management interface. Consequently, a management application can manage resources transparently, regardless of the communication protocol used. JMX agents can also be used by systems or applications that are not compliant with the JMX specification, as long as those systems or applications support JMX agents. +</para> +<para> +<ulink + url="http://java.sun.com/docs/books/tutorial/jmx/overview/index.html">Read more about JMX</ulink>. +</para> + </section> + + <section> + <title>What is JMX Tools?</title> + <para><property>JBoss JMX Tools</property> allow to setup multiple JMX connections and provide view + for exploring the JMX tree and execute operations directly from Eclipse.</para> + + <para>This chapter covers the basics of working with <property>JMX plugin</property>, which is + used to manage Java applications (with Managed Beans) through JMX and its RMI Connector.</para> + + <figure> + <title>JMX Tools</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/eclipse-jmx_0.2.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section><title>Key Features of JMX Tools</title> + <para>For a start, we propose you to look through the table of main features of JBoss JMX Tools:</para> + <table> + + <title>Key Functionality for JBoss JMX Tools</title> + <tgroup cols="3"> + + <colspec colnum="1" align="left" colwidth="2*"/> + <colspec colnum="2" colwidth="4*"/> + <colspec colnum="3" align="left" colwidth="2*"/> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry><para>MBean Explorer</para></entry> + <entry><para>MBean Explorer is a useful view with a text filter that displays domains, mbeans, attributes, and operations inside a connection.</para></entry> + <entry> + <link linkend="mbean_explorer">MBean Explorer</link> + </entry> + </row> + + <row> + <entry><para>MBean Editor</para></entry> + <entry><para>MBean Editor is a multi-page editor to manage MBeans.</para></entry> + <entry> + <link linkend="mbean_editor">MBean Editor</link> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Requirements and Installation</title> + <section> + <title> Requirements</title> + <para>Requirements to use <property>JBoss JMX Tools</property> are the following:</para> + + <itemizedlist> + <listitem> + <para><property>JBoss JMX Tools</property> is developed on Eclipse 3.4.x milestones</para> + </listitem> + <listitem> + <para><property>JBoss JMX Tools</property> requires that Eclipse is run on a JDK 1.5.0 or above + (due to dependencies on JMX packages which were introduced in Java 1.5.0)</para> + </listitem> + </itemizedlist> + </section> + <section> + <title>Installation</title> + <para>Here, we are going to explain how to install the <property>JMX plugin</property> into + Eclipse.</para> + + <para><property>JBoss JMX Tools</property> is one module of the <property>JBoss Tools</property> + project. <property> JBoss JMX Tools</property> has no dependency on any other part of <property>JBoss + Tools</property>, and can be downloaded as a standalone Eclipse plugin. Even though the <property>JMX + Tools</property> have no dependencies on other plugins, such as <property>AS Tools</property>, + <property>JBoss JMX Tools</property> do depend on the JMX Tooling and even extend it. </para> + + <para>You can find the <property>JBoss JBoss Tools</property> plugins over at the <ulink + url="http://labs.jboss.com/tools/download.html">download pages</ulink>. The only + package you'll need to get is the JBoss JMX Tooling, however the <property>AS + Tools</property> would give you a wider experience and more options when using JMX with JBoss Servers. + You can find further download and installation instructions on the JBoss Wiki in the <ulink + url="http://www.jboss.org/tools/download/installation">InstallingJBossTools</ulink> + section.</para> + </section> + </section> +</chapter> \ No newline at end of file Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY mbean_explorer SYSTEM "mbean_explorer.xml"> +<!ENTITY mbean_editor SYSTEM "mbean_editor.xml"> +<!ENTITY connection SYSTEM "connection.xml"> +<!ENTITY how_to SYSTEM "how_to.xml"> +<!ENTITY extensions SYSTEM "extensions.xml"> +<!ENTITY tasks SYSTEM "tasks.xml"> +<!ENTITY references SYSTEM "references.xml"> +<!ENTITY summary SYSTEM "summary.xml"> +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + + +]> + +<book> + + <bookinfo> + <title>JMX Tools Reference Guide</title> + + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 1.1.1.GA + </releaseinfo> +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jmx_ref_guide/pdf/JM...">PDF version</ulink> + </para> +</abstract> + </bookinfo> + + <toc/> + &introduction; + &tasks; + &references; + &summary; +  + +</book> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master_output.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master_output.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,813 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY mbean_explorer SYSTEM "mbean_explorer.xml"> +<!ENTITY mbean_editor SYSTEM "mbean_editor.xml"> +<!ENTITY connection SYSTEM "connection.xml"> +<!ENTITY how_to SYSTEM "how_to.xml"> +<!ENTITY extensions SYSTEM "extensions.xml"> +<!ENTITY tasks SYSTEM "tasks.xml"> +<!ENTITY references SYSTEM "references.xml"> +<!ENTITY summary SYSTEM "summary.xml"> +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + + +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>JMX Tools Reference Guide</title> + + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> + Version: 1.1.1.GA + </diffmk:wrapper></releaseinfo> +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jmx_ref_guide/pdf/JM...">PDF version</ulink> + </para> +</abstract> + </bookinfo> + + <toc></toc> + +<chapter id="intruduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jmx/docs/reference/en-US/introduction.xml" xreflabel="introduction"> + <?dbhtml filename="introduction.html"?> + + <title>Introduction</title> + <para><property moreinfo="none">JBoss Tools</property>' JMX project is a fork of <ulink url="http://code.google.com/p/eclipse-jmx/">eclipse-jmx</ulink>, a project by Jeff Mesnil. + It was forked with permission. </para> + + <section diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">What is JMX?</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> +The Java Management Extensions (JMX) technology is a standard part of the Java Platform, Standard Edition (Java SE platform). The JMX technology was added to the platform in the Java 2 Platform, Standard Edition (J2SE) 5.0 release. +</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> +The JMX technology provides a simple, standard way of managing resources such as applications, devices, and services. Because the JMX technology is dynamic, you can use it to monitor and manage resources as they are created, installed and implemented. You can also use the JMX technology to monitor and manage the Java Virtual Machine (Java VM). +</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> +The JMX specification defines the architecture, design patterns, APIs, and services in the Java programming language for management and monitoring of applications and networks. +</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> +Using the JMX technology, a given resource is instrumented by one or more Java objects known as Managed Beans, or MBeans. These MBeans are registered in a core-managed object server, known as an MBean server. The MBean server acts as a management agent and can run on most devices that have been enabled for the Java programming language. +</diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> +The specifications define JMX agents that you use to manage any resources that have been correctly configured for management. A JMX agent consists of an MBean server, in which MBeans are registered, and a set of services for handling the MBeans. In this way, JMX agents directly control resources and make them available to remote management applications. +</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> +The way in which resources are instrumented is completely independent from the management infrastructure. Resources can therefore be rendered manageable regardless of how their management applications are implemented. +</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> +The JMX technology defines standard connectors (known as JMX connectors) that enable you to access JMX agents from remote management applications. JMX connectors using different protocols provide the same management interface. Consequently, a management application can manage resources transparently, regardless of the communication protocol used. JMX agents can also be used by systems or applications that are not compliant with the JMX specification, as long as those systems or applications support JMX agents. +</diffmk:wrapper></para> +<ulink diffmk:change="added" url="http://java.sun.com/docs/books/tutorial/jmx/overview/index.html"><diffmk:wrapper diffmk:change="added">Read more about JMX</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. + </diffmk:wrapper></section> + + <section> + <title>What is JMX Tools?</title> + <para><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JMX Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> allow to setup multiple JMX connections and provide view + for exploring the JMX tree and execute operations directly from Eclipse.</diffmk:wrapper></para> + + <para>This chapter covers the basics of working with <property moreinfo="none">JMX plugin</property><diffmk:wrapper diffmk:change="changed">, which is + used to manage Java applications (with Managed Beans) through JMX and its RMI Connector.</diffmk:wrapper></para> + + <figure float="0"> + <title>JMX Tools</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/eclipse-jmx_0.2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section><title>Key Features of JMX Tools</title> + <para><diffmk:wrapper diffmk:change="changed">For a start, we propose you to look through the table of main features of JBoss JMX Tools:</diffmk:wrapper></para> + <table> + + <title><diffmk:wrapper diffmk:change="changed">Key Functionality for JBoss JMX Tools</diffmk:wrapper></title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <colspec align="left" colnum="3" colwidth="2*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry><para>MBean Explorer</para></entry> + <entry><para>MBean Explorer is a useful view with a text filter that displays domains, mbeans, attributes, and operations inside a connection.</para></entry> + <entry> + <link linkend="mbean_explorer">MBean Explorer</link> + </entry> + </row> + + <row> + <entry><para>MBean Editor</para></entry> + <entry><para>MBean Editor is a multi-page editor to manage MBeans.</para></entry> + <entry> + <link linkend="mbean_editor">MBean Editor</link> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Requirements and Installation</title> + <section> + <title> Requirements</title> + <para>Requirements to use <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JMX Tools</diffmk:wrapper></property> are the following:</para> + + <itemizedlist> + <listitem> + <para><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JMX Tools</diffmk:wrapper></property> is developed on Eclipse 3.4.x milestones</para> + </listitem> + <listitem> + <para><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JMX Tools</diffmk:wrapper></property> requires that Eclipse is run on a JDK 1.5.0 or above + (due to dependencies on JMX packages which were introduced in Java 1.5.0)</para> + </listitem> + </itemizedlist> + </section> + <section> + <title>Installation</title> + <para>Here, we are going to explain how to install the <property moreinfo="none">JMX plugin</property> into + Eclipse.</para> + + <para><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JMX Tools</diffmk:wrapper></property> is one module of the <property moreinfo="none">JBoss Tools</property> + project. <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"> JBoss JMX Tools</diffmk:wrapper></property> has no dependency on any other part of <property moreinfo="none">JBoss + Tools</property><diffmk:wrapper diffmk:change="changed">, and can be downloaded as a standalone Eclipse plugin. Even though the </diffmk:wrapper><property moreinfo="none">JMX + Tools</property><diffmk:wrapper diffmk:change="changed"> have no dependencies on other plugins, such as </diffmk:wrapper><property moreinfo="none">AS Tools</property><diffmk:wrapper diffmk:change="added">, + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss JMX Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> do depend on the JMX Tooling and even extend it. </diffmk:wrapper></para> + + <para>You can find the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JBoss Tools</diffmk:wrapper></property> plugins over at the <ulink url="http://labs.jboss.com/tools/download.html">download pages</ulink><diffmk:wrapper diffmk:change="changed">. The only + package you'll need to get is the JBoss JMX Tooling, however the </diffmk:wrapper><property moreinfo="none">AS + Tools</property><diffmk:wrapper diffmk:change="changed"> would give you a wider experience and more options when using JMX with JBoss Servers. + You can find further download and installation instructions on the JBoss Wiki in the </diffmk:wrapper><ulink url="http://www.jboss.org/tools/download/installation">InstallingJBossTools</ulink> + section.</para> + </section> + </section> + +</chapter> +<chapter id="tasks" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jmx/docs/reference/en-US/tasks.xml" xreflabel="tasks"> + <?dbhtml filename="tasks.html"?> + <title>JMX Tools Tasks</title> + <para>This chapter will give you answers on most popular questions asked by <property moreinfo="none">JMX + plugin</property> users.</para> + <section> + <title>Quick Start</title> + + <para>To start using the <property moreinfo="none">JMX Tools</property><diffmk:wrapper diffmk:change="changed"> it's necessary to open + </diffmk:wrapper><property moreinfo="none">MBean Explorer</property>. Go to <emphasis><property moreinfo="none">Window > Show View > Other</property></emphasis> and then select + <property moreinfo="none">MBean Explorer</property> and click <emphasis><property moreinfo="none">OK</property>.</emphasis></para> + + <para>The <property moreinfo="none">MBean Explorer</property><diffmk:wrapper diffmk:change="changed"> lists all the domains, mbeans, attributes, and operations inside a + connection. When you double-click a MBean in the </diffmk:wrapper><emphasis><property moreinfo="none">MBean Explorer</property>,</emphasis> it opens a multi-page + editor to manage the MBean. The <property moreinfo="none">MBean Editor</property> is composed of these pages:</para> + + <itemizedlist> + <listitem> + <para><emphasis><property moreinfo="none">Attributes page</property>,</emphasis> to get/set the attributes of the MBean</para> + </listitem> + <listitem> + <para><emphasis><property moreinfo="none">Operations page</property>,</emphasis> to invoke operations on the MBean</para> + </listitem> + <listitem> + <para><emphasis><property moreinfo="none">Notifications page</property>,</emphasis> to receive notifications from the MBean</para> + </listitem> + <listitem> + <para><emphasis><property moreinfo="none">Info page</property>,</emphasis> which displays general information about the MBean </para> + </listitem> + </itemizedlist> + + </section> + + <section diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Managing Application</diffmk:wrapper></title> + + + +<para diffmk:change="added"><diffmk:wrapper diffmk:change="added">As it's been said earlier in the guide the JMX technology allows to monitor and manage Java applications. In this section we will show you how to get connected to +a sample Java application and run the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">sayHello()</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> method remotely from inside of the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> +<orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"><diffmk:wrapper diffmk:change="added"> + +http://java.sun.com/docs/books/tutorial/jmx/examples/jmx_examples.zip + +</diffmk:wrapper><listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Save the bundle of JMX API sample classes, </diffmk:wrapper><ulink diffmk:change="added" url="http://java.sun.com/docs/books/tutorial/jmx/examples/jmx_examples.zip"><diffmk:wrapper diffmk:change="added">jmx_examples.zip</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">, to your working directory</diffmk:wrapper></para></listitem> +<listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Unzip the bundle of sample classes.</diffmk:wrapper></para></listitem> +<listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Compile the example Java classes from within where you unpacked the files directory.</diffmk:wrapper></para> + + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ + javac com/example/*.java + ]]></diffmk:wrapper></programlisting> + +</listitem> +<listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Start the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Main</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> application, specifying the properties that expose Main for remote management:</diffmk:wrapper></para> + + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ +java -Dcom.sun.management.jmxremote.port=9999 \ +-Dcom.sun.management.jmxremote.authenticate=false \ +-Dcom.sun.management.jmxremote.ssl=false \ +com.example.Main + ]]></diffmk:wrapper></programlisting> + +<para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If everything was done correctly you will see the "Waiting for incoming requests..." message on the screen.</diffmk:wrapper></para> + + + </listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Now launch the Eclipse IDE, in Eclipse open the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. Go to </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Window > Show View > Other</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and then select + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and click </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">OK</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">)</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New Connection</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> icon + + </diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/new_connection_icon.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> + + in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> menu + bar.</diffmk:wrapper></para> + </listitem> + + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Create JMX Connection</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> dialog, hit </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and then click the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Advanced</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> tab. </diffmk:wrapper></para></listitem> + + + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JMX URL</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> input field enter the following URL:</diffmk:wrapper></para> + + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ + service:jmx:rmi:///jndi/rmi://:9999/jmxrmi + ]]></diffmk:wrapper></programlisting> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">JMX Connection</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/mbeans.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Press </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> to esteblish the connection with the application.</diffmk:wrapper></para> + </listitem> + + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Now expand the connection you have just created, then open the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">com.example</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> package and click </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">sayHello()</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> method. </diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Once the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">sayHello()</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> method is clicked the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is activated. </diffmk:wrapper></para> + + </listitem> + + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> go to the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Operation Details</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> section and hit the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">sayHello()</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button.</diffmk:wrapper></para><para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> You will get the "Operation inoked successfully" message. </diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Ivoking Method via JMX</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/invokemethod.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The final step is to make sure the application worked as it was expected. Open the terminal where you launched the application in step 3. Now you see the "hello, world" message on the screen. </diffmk:wrapper></para> + </listitem> +</orderedlist> + + + + </section> + <section> + <title>Tomcat Managing</title> + + <para>It's possible to manage Tomcat using <property moreinfo="none">JMX Tools</property>.</para> + + <para>Currently, JMX Tooling is able to connect to Tomcat without authentication or with + password-based authentication.</para> + <para>Using SSL for authentication is not supported: you need to make sure that the System + property <emphasis> + <property moreinfo="none">com.sun.management.jmxremote.ssl</property> + </emphasis> is set to false. </para> + <para><diffmk:wrapper diffmk:change="added">More information to manage Tomcat can be found in </diffmk:wrapper><ulink diffmk:change="added" url="http://tomcat.apache.org/tomcat-6.0-doc/"><diffmk:wrapper diffmk:change="added">Tomcat management documentation</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="added">Instructions to manage remotely Tomcat are available in </diffmk:wrapper><ulink diffmk:change="added" url="http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html"><diffmk:wrapper diffmk:change="added">Tomcat's monitoring documentation</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + + + </section> + + <section> + <title>Eclipse Equinox Managing</title> + + <para>You can manage Equinox through the Equinox monitoring framework.</para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In this section we will show you how to connect to an Equinox server via JBoss JMX tools. First off, you need to make for example a simple servlet and run it on a server. This guide is not intended to teach you how to build application and run them on the server, you can read for example </diffmk:wrapper><ulink diffmk:change="added" url="http://www.eclipse.org/equinox-portal/tutorials/server-side/"><diffmk:wrapper diffmk:change="added"> this tutorial </diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> to get a better idea of how to build server-based applications with Eclipse Equinox. </diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="changed">Once you have run an application on the server you can connect to it using JBoss JMX tools.</diffmk:wrapper></para> + + <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> + <listitem> + <para>Go to <emphasis> + <property moreinfo="none">Window > Open Perspective > Other</property> + </emphasis> and select the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JMX perspective.</diffmk:wrapper></property></para> + </listitem> + +  + + <listitem> + <para>Switch to the <property moreinfo="none">MBean Explorer</property> by going to <emphasis> + <property moreinfo="none">Window > Show View > Other</property> + </emphasis><diffmk:wrapper diffmk:change="changed"> and selecting the MBean Explorer.</diffmk:wrapper></para> + </listitem> + + <listitem> + <para><diffmk:wrapper diffmk:change="changed">Click the </diffmk:wrapper><emphasis> + <property moreinfo="none">New Connection</property></emphasis> icon + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/new_connection_icon.png"></imagedata> + </imageobject> + </inlinemediaobject> + + in the <property moreinfo="none">MBean Explorer</property><diffmk:wrapper diffmk:change="changed"> menu + bar.</diffmk:wrapper></para> + </listitem> + + <listitem> + <para>Select the <emphasis> + <property moreinfo="none">Advanced tab</property></emphasis> and set the JMX URL to <emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">service:jmx:rmi:///jndi/rmi://:8118/jmxserver.</diffmk:wrapper></property> + </emphasis></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Using JMX Tools to Access Equinox Server</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/equinox.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </listitem> + </orderedlist> + + <para>You now have access to the MBeans exposed by Equinox.</para> + </section> + + + <section> + <title><diffmk:wrapper diffmk:change="changed">Managing JBoss AS</diffmk:wrapper></title> + + <para>Managing JBoss instances is not supported with the <property moreinfo="none">JMX Tools</property> + alone. You must also download and install the <property moreinfo="none">AS Tools</property> portion of + the <property moreinfo="none">JBoss Tools</property> distribution. Even after installing the proper + tooling, you cannot create a JBoss JMX connection yourself or through the Connection + Wizard. The first step is to create a JBoss Server. The full instructions for this can + be found in the AS Tools section, however, the short summary is: </para> + <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> + <listitem> + <para>Open the <property moreinfo="none"><diffmk:wrapper diffmk:change="added">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> view.</diffmk:wrapper></para> + </listitem> + + <listitem> + <para>Right-click in the view and select <emphasis> + <property moreinfo="none">New > Server</property> + </emphasis><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </listitem> + + <listitem> + <para>In the <emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Enterprise Middleware</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> or in </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none">JBoss Community</property> + </emphasis><diffmk:wrapper diffmk:change="changed"> section, select a server version.</diffmk:wrapper></para> + </listitem> + + <listitem> + <para><diffmk:wrapper diffmk:change="changed">If a runtime has not yet been created, you'll be prompted for the + server's home directory, JDK, and configuration.</diffmk:wrapper></para> + </listitem> + + <listitem> + <para>Finish the wizard and note that you have a new entry in both the + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view and the </diffmk:wrapper><property moreinfo="none">MBean + Explorer</property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </listitem> + + <listitem> + <para>Start the server by right-clicking it and selecting <emphasis> + <property moreinfo="none">Start</property></emphasis><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </listitem> + <listitem> + <para><diffmk:wrapper diffmk:change="changed">Note that once the server is started, the JMX connection can be + expanded.</diffmk:wrapper></para> + </listitem> + </orderedlist> + + <para>Now you can explore MBeans exposed by a JBoss instance.</para> + </section> + + <section diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Managing JBoss AS Remotely</diffmk:wrapper></title> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss JMX Tool allow you to easily get access and mangane JBoss AS server remotely. + In order to get connected to the instance of JBoss AS remotely you need to run the server or make sure the server is lauched. + </diffmk:wrapper></para> + <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Go to </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Window > Open Perspective > Other</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> and select the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JMX perspective.</diffmk:wrapper></property></para> + </listitem> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Switch to the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> by going to </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Window > Show View > Other</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> and selecting the MBean Explorer.</diffmk:wrapper></para> + </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New Connection</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> icon + + </diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/new_connection_icon.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> + + in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> menu + bar.</diffmk:wrapper></para> + </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Select the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Advanced tab</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and set the JMX URL to: </diffmk:wrapper></para> + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ +service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector + ]]></diffmk:wrapper></programlisting> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Please, note that in this example we connected to the local host. </diffmk:wrapper></para> + </listitem> + </orderedlist> + </section> + <section id="extensions" xreflabel="extensions"> + <title>Extension Task</title> + <para>This section will outline how to contribute your own Server type with some default + behavior.</para> + + <section> + <title>Why we should do that?</title> + + <para>You might be asking yourself why you'd need to extend this framework if JMX is + a standard. Perhaps you want a connection to be automatically created after some specific + action, or perhaps you want your connection wizard to do more than simply set a host and + port. JBoss, for example, requires setting some credentials on the client machine, but + using JBoss classes to do it. This requires that the connection have access to JBoss + jars.</para> + </section> + + <section> + <title>Core Extensions</title> + + <para>To create your own JMX Connection type, you must use the + org.jboss.tools.jmx.core.MBeanServerConnectionProvider extension point. This point takes + one child, a connectionProvider with a class that implements + org.jboss.tools.jmx.core.IConnectionProvider.</para> + + <para>An IConnectionProvider is responsible for creation and deletion of IConnectionWrapper + objects. It must also keep a list of listeners that it is expected to inform when a + connection is added or removed from its list. </para> + + <para>Each IConnectionWrapper is expected to handle running arbitrary JMX runnables or getting + a "Root" object representing all JMX nodes. There are some utility methods the + IConnectionWrapper can make use of.</para> + </section> + + <section> + <title>UI Extensions</title> + <para>There are two extension points currently approved for use in the UI</para> + <itemizedlist> + <listitem> + <para>org.jboss.tools.jmx.ui.providerUI - provide an icon, id, displayable name, and + wizardPage class for creation of new connections</para> + </listitem> + <listitem> + <para>org.jboss.tools.jmx.ui.attribute.controls - allows you to map class types to some + Control to present them in the MBean Editor</para> + <para>We hope, this guide helped you to get started with the JBoss JMX Tools. Besides, for additional information you are welcome on <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> + </listitem> + </itemizedlist> + </section> + + </section> + <section id="connection" xreflabel="connection"> + + <title>Connections Creation Task</title> + + <para>The <property moreinfo="none">MBean Explorer</property> supports several different types of connections. + The tooling itself comes only with a default connection type, however other + adopters can provide additional connection types that may require additional + or non-spec behavior. Connections can be in either the connected state or + the disconnected state. Some connection types (such as the default connection type) + allow you to control the current state. Other connection types may not. </para> + + <para>Similarly, some connection types may be able to be created, and others may not. + The default connection type, for example, can be created and deleted by you + at will. The AS Tools connection type, which represents a JBoss server, does not + allow you this level of control. A JBoss JMX connection is created when a JBoss server is created + in the server's view, and deleted when said server is deleted. The JMX connection for + this server is in the connected state only when the server is started. </para> + + + <section><title><diffmk:wrapper diffmk:change="changed">Establishing Connection</diffmk:wrapper></title> + + <para> There are two ways to connect to an application with remote management enabled:</para> + + <para><diffmk:wrapper diffmk:change="changed"> The first step is the same for both - to connect to a MBean Server, click the + </diffmk:wrapper><emphasis> + <property moreinfo="none">New Connection</property></emphasis> icon + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/new_connection_icon.png"></imagedata> + </imageobject> + </inlinemediaobject> + + in the <property moreinfo="none">MBean Explorer</property> menu bar.</para> + + <para>Then to follow the simple one you just need to specify host, port (and optionally user + name and password) and click <emphasis> + <property moreinfo="none">OK</property>.</emphasis></para> + <para><diffmk:wrapper diffmk:change="added">On the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Advanced</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> tab you can set the sever name (it will be displayed in </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">), a url to the remote server. + For example, to connect to JBoss AS you need to set the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JMX URL</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> to + </diffmk:wrapper></para> + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ +service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector + ]]></diffmk:wrapper></programlisting> + <para><diffmk:wrapper diffmk:change="changed">If it is required you can enter user name and password for the server connection. + </diffmk:wrapper></para> + + + <note> + <title>Note</title> + <para>Only JMX URL based on RMI are supported.</para> + </note> + </section> + </section> +</chapter> + + + +<chapter id="references" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jmx/docs/reference/en-US/references.xml" xreflabel="references"> + <?dbhtml filename="references.html"?> + <title>References</title> + + <section id="mbean_explorer" xreflabel="mbean_explorer"> + <?dbhtml filename="mbean_explorer.html"?> + + <title>MBean Explorer</title> + <para>The <property moreinfo="none">MBean Explorer</property> displays the MBean features (both attributes and operations) in its + hierarchy. Double-clicking on a feature will open a <property moreinfo="none">MBean Editor</property>, display the page + corresponding to the feature type and select the feature.</para> + + <figure float="0"> + <title>MBean Explorer Features</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-features.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Since it's possible to have many MBean Editors opened at the same time, the <property moreinfo="none">MBean Explorer</property> + has the Link With Editor button + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/link-with-editor_0.2.0.png"></imagedata> + </imageobject> + </inlinemediaobject> + + to synchronize selections between the active <property moreinfo="none">MBean Editor</property> and + the <property moreinfo="none">MBean Explorer</property> (and vice versa).</para> + + <para>The <property moreinfo="none">MBean Explorer</property> has also a filter text that can be used to filter among all the MBeans + the few ones, which interest you.</para> + + <para>For example, if you are only interested by MBeans related to memory, typing memo will show + any node (domain, mbean, attribute, or operation) that matches that text, as well as + that node's parents and children. So if an MBean matches, all attributes and operations from + that bean will show. If, however, an attribute or operation name (a leaf node) matches, + only that node and its parents in the tree will show.</para> + + <figure float="0"> + <title>Query Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-query.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>The <emphasis> + <property moreinfo="none">Collapse All</property></emphasis> button + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/collaps_all.png"></imagedata> + </imageobject> + </inlinemediaobject> + + on the <property moreinfo="none">MBean Explorer</property> toolbar is used to collapse all the MBeans and + display only the domains. It is also possible to double click on a node to expand/collapse it. </para> + + </section> + <section id="mbean_editor" xreflabel="mbean_editor"> + <?dbhtml filename="mbean_editor.html"?> + + <title>MBean Editor</title> + + <figure float="0"> + <title>MBean Editor Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor_0.2.0.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <property moreinfo="none">MBean Editor</property> is composed of several pages:</para> + + <itemizedlist> + <listitem> + <para>the <emphasis> + <property moreinfo="none">Attributes</property></emphasis> page</para> + </listitem> + <listitem> + <para>the <emphasis> + <property moreinfo="none">Operations</property></emphasis> page</para> + </listitem> + <listitem> + <para>the <emphasis> + <property moreinfo="none">Notifications</property></emphasis> page </para> + </listitem> + <listitem> + <para>the <emphasis> + <property moreinfo="none">Info</property></emphasis> page </para> + </listitem> + </itemizedlist> + + <para> The <emphasis> + <property moreinfo="none">Attributes</property> + </emphasis> and <emphasis> + <property moreinfo="none">Operations</property> + </emphasis> pages display a list for either the MBean attributes or operations as well as + details for the selection.</para> + + <para> It is possible to toggle the layout between the list and the details either vertically + (by default) or horizontally with the help of the special icons + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-layout-buttons_0.2.0.png"></imagedata> + </imageobject> + </inlinemediaobject> + + in the right top corner of the editor.</para> + + <figure float="0"> + <title>MBean Editor Horizontal Layout</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <figure float="0" id="figu-Beginners_Guide-Visual_Web_Tools-Visual_Page_Editor"> + <title>Visual Page Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png" format="PNG" width="444"></imagedata> + </imageobject> + <textobject> + <phrase> + The Visual Page Editor, showing both the source and a visual preview simultaneously. + </phrase> + </textobject> + </mediaobject> + </figure> + <section> + <title>Notifications Page</title> + <para>One more page in the <property moreinfo="none">MBean Editor</property> is the <emphasis> + <property moreinfo="none">Notifications</property></emphasis> page, which gives the possibility to + subscribe (resp. unsubscribe) to a MBean to receive its notifications by checking (resp. + unchecking) the <emphasis> + <property moreinfo="none">Subscribe</property></emphasis> button in the right top corner. </para> + <para>The list of notifications is refreshed every time a new notification is + received:</para> + + <figure float="0"> + <title>MBean Editor Notifications Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/notifications.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note</title> + <para>It is only possible to subscribe to MBean, which emits notifications (they must be + NotificationBroadcaster).</para> + </note> + + </section> + + </section> + + </chapter> + + +<chapter xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jmx/docs/reference/en-US/summary.xml"> + <?dbhtml filename="summary.html"?> + <title>Summary</title> + <para>In conclusion, with this document you could easily start with JXM Tools. + The chapters above walked you through the steps on how to do Tomcat,Eclipse Equinox or JBoss Instances managing and how to create new JMX connections. + The document also includes the reference of JMX Tools features. + + 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/tools</ulink> in the corresponding release directory. + </para> + <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs">http://download.jboss.org/jbosstools/nightly-docs</ulink>. </para> + <para>You can find a set of benefits and other extra information on:</para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.jboss.org/community/wiki/JBossMX">JBoss Wiki</ulink> + </para> + </listitem> + <listitem><para>For more information about JMX technology please visit + <ulink url="http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/"> + JMX Technology Home Page</ulink></para> + </listitem> + </itemizedlist> + </section> +</chapter> +  + +</book> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_editor.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_editor.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_editor.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="mbean_editor" xreflabel="mbean_editor"> + <?dbhtml filename="mbean_editor.html"?> + + <title>MBean Editor</title> + + <figure> + <title>MBean Editor Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor_0.2.0.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>MBean Editor</property> is composed of several pages:</para> + + <itemizedlist> + <listitem> + <para>the <emphasis> + <property>Attributes</property></emphasis> page</para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Operations</property></emphasis> page</para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Notifications</property></emphasis> page </para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Info</property></emphasis> page </para> + </listitem> + </itemizedlist> + + <para> The <emphasis> + <property>Attributes</property> + </emphasis> and <emphasis> + <property>Operations</property> + </emphasis> pages display a list for either the MBean attributes or operations as well as + details for the selection.</para> + + <para> It is possible to toggle the layout between the list and the details either vertically + (by default) or horizontally with the help of the special icons + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-layout-buttons_0.2.0.png"/> + </imageobject> + </inlinemediaobject> + + in the right top corner of the editor.</para> + + <figure> + <title>MBean Editor Horizontal Layout</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png"/> + </imageobject> + </mediaobject> + </figure> + + <section> + <title>Notifications Page</title> + <para>One more page in the <property>MBean Editor</property> is the <emphasis> + <property>Notifications</property></emphasis> page, which gives the possibility to + subscribe (resp. unsubscribe) to a MBean to receive its notifications by checking (resp. + unchecking) the <emphasis> + <property>Subscribe</property></emphasis> button in the right top corner. </para> + <para>The list of notifications is refreshed every time a new notification is + received:</para> + + <figure> + <title>MBean Editor Notifications Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/notifications.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note</title> + <para>It is only possible to subscribe to MBean, which emits notifications (they must be + NotificationBroadcaster).</para> + </note> + + </section> + +</chapter> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_explorer.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_explorer.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_explorer.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="mbean_explorer" xreflabel="mbean_explorer"> + <?dbhtml filename="mbean_explorer.html"?> + + <title>MBean Explorer</title> + <para>The <property>MBean Explorer</property> displays the MBean features (both attributes and operations) in its + hierarchy. Double-clicking on a feature will open a <property>MBean Editor</property>, display the page + corresponding to the feature type and select the feature.</para> + + <figure> + <title>MBean Explorer Features</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-features.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Since it's possible to have many MBean Editors opened at the same time, the <property>MBean Explorer</property> + has the Link With Editor button + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/link-with-editor_0.2.0.png"/> + </imageobject> + </inlinemediaobject> + + to synchronize selections between the active <property>MBean Editor</property> and + the <property>MBean Explorer</property> (and vice versa).</para> + + <para>The <property>MBean Explorer</property> has also a filter text that can be used to filter among all the MBeans + the few ones, which interest you.</para> + + <para>For example, if you are only interested by MBeans related to memory, typing memo will show + any node (domain, mbean, attribute, or operation) that matches that text, as well as + that node's parents and children. So if an MBean matches, all attributes and operations from + that bean will show. If, however, an attribute or operation name (a leaf node) matches, + only that node and its parents in the tree will show.</para> + + <figure> + <title>Query Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-query.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para>The <emphasis> + <property>Collapse All</property></emphasis> button + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/collaps_all.png"/> + </imageobject> + </inlinemediaobject> + + on the <property>MBean Explorer</property> toolbar is used to collapse all the MBeans and + display only the domains. It is also possible to double click on a node to expand/collapse it. </para> + +</chapter> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/references.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/references.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/references.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,170 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="references" xreflabel="references"> + <?dbhtml filename="references.html"?> + <title>References</title> + + <section id="mbean_explorer" xreflabel="mbean_explorer"> + <?dbhtml filename="mbean_explorer.html"?> + + <title>MBean Explorer</title> + <para>The <property>MBean Explorer</property> displays the MBean features (both attributes and operations) in its + hierarchy. Double-clicking on a feature will open a <property>MBean Editor</property>, display the page + corresponding to the feature type and select the feature.</para> + + <figure> + <title>MBean Explorer Features</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-features.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Since it's possible to have many MBean Editors opened at the same time, the <property>MBean Explorer</property> + has the Link With Editor button + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/link-with-editor_0.2.0.png"/> + </imageobject> + </inlinemediaobject> + + to synchronize selections between the active <property>MBean Editor</property> and + the <property>MBean Explorer</property> (and vice versa).</para> + + <para>The <property>MBean Explorer</property> has also a filter text that can be used to filter among all the MBeans + the few ones, which interest you.</para> + + <para>For example, if you are only interested by MBeans related to memory, typing memo will show + any node (domain, mbean, attribute, or operation) that matches that text, as well as + that node's parents and children. So if an MBean matches, all attributes and operations from + that bean will show. If, however, an attribute or operation name (a leaf node) matches, + only that node and its parents in the tree will show.</para> + + <figure> + <title>Query Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-query.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para>The <emphasis> + <property>Collapse All</property></emphasis> button + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/collaps_all.png"/> + </imageobject> + </inlinemediaobject> + + on the <property>MBean Explorer</property> toolbar is used to collapse all the MBeans and + display only the domains. It is also possible to double click on a node to expand/collapse it. </para> + + </section> + <section id="mbean_editor" xreflabel="mbean_editor"> + <?dbhtml filename="mbean_editor.html"?> + + <title>MBean Editor</title> + + <figure> + <title>MBean Editor Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor_0.2.0.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>MBean Editor</property> is composed of several pages:</para> + + <itemizedlist> + <listitem> + <para>the <emphasis> + <property>Attributes</property></emphasis> page</para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Operations</property></emphasis> page</para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Notifications</property></emphasis> page </para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Info</property></emphasis> page </para> + </listitem> + </itemizedlist> + + <para> The <emphasis> + <property>Attributes</property> + </emphasis> and <emphasis> + <property>Operations</property> + </emphasis> pages display a list for either the MBean attributes or operations as well as + details for the selection.</para> + + <para> It is possible to toggle the layout between the list and the details either vertically + (by default) or horizontally with the help of the special icons + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-layout-buttons_0.2.0.png"/> + </imageobject> + </inlinemediaobject> + + in the right top corner of the editor.</para> + + <figure> + <title>MBean Editor Horizontal Layout</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png"/> + </imageobject> + </mediaobject> + </figure> + <figure id="figu-Beginners_Guide-Visual_Web_Tools-Visual_Page_Editor"> + <title>Visual Page Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <phrase> + The Visual Page Editor, showing both the source and a visual preview simultaneously. + </phrase> + </textobject> + </mediaobject> + </figure> + <section> + <title>Notifications Page</title> + <para>One more page in the <property>MBean Editor</property> is the <emphasis> + <property>Notifications</property></emphasis> page, which gives the possibility to + subscribe (resp. unsubscribe) to a MBean to receive its notifications by checking (resp. + unchecking) the <emphasis> + <property>Subscribe</property></emphasis> button in the right top corner. </para> + <para>The list of notifications is refreshed every time a new notification is + received:</para> + + <figure> + <title>MBean Editor Notifications Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/notifications.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note</title> + <para>It is only possible to subscribe to MBean, which emits notifications (they must be + NotificationBroadcaster).</para> + </note> + + </section> + + </section> + + </chapter> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/summary.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/summary.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/summary.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter> + <?dbhtml filename="summary.html"?> + <title>Summary</title> + <para>In conclusion, with this document you could easily start with JXM Tools. + The chapters above walked you through the steps on how to do Tomcat,Eclipse Equinox or JBoss Instances managing and how to create new JMX connections. + The document also includes the reference of JMX Tools features. + + 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/tools</ulink> in the corresponding release directory. + </para> + <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs">http://download.jboss.org/jbosstools/nightly-docs</ulink>. </para> + <para>You can find a set of benefits and other extra information on:</para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.jboss.org/community/wiki/JBossMX">JBoss Wiki</ulink> + </para> + </listitem> + <listitem><para>For more information about JMX technology please visit + <ulink url="http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/"> + JMX Technology Home Page</ulink></para> + </listitem> + </itemizedlist> + </section> +</chapter> \ No newline at end of file Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/tasks.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/tasks.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/tasks.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,412 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="tasks" xreflabel="tasks"> + <?dbhtml filename="tasks.html"?> + <title>JMX Tools Tasks</title> + <para>This chapter will give you answers on most popular questions asked by <property>JMX + plugin</property> users.</para> + <section> + <title>Quick Start</title> + + <para>To start using the <property>JMX Tools</property> it's necessary to open + <property>MBean Explorer</property>. Go to <emphasis><property>Window > Show View > Other</property></emphasis> and then select + <property>MBean Explorer</property> and click <emphasis><property>OK</property>.</emphasis></para> + + <para>The <property>MBean Explorer</property> lists all the domains, mbeans, attributes, and operations inside a + connection. When you double-click a MBean in the <emphasis><property>MBean Explorer</property>,</emphasis> it opens a multi-page + editor to manage the MBean. The <property>MBean Editor</property> is composed of these pages:</para> + + <itemizedlist> + <listitem> + <para><emphasis><property>Attributes page</property>,</emphasis> to get/set the attributes of the MBean</para> + </listitem> + <listitem> + <para><emphasis><property>Operations page</property>,</emphasis> to invoke operations on the MBean</para> + </listitem> + <listitem> + <para><emphasis><property>Notifications page</property>,</emphasis> to receive notifications from the MBean</para> + </listitem> + <listitem> + <para><emphasis><property>Info page</property>,</emphasis> which displays general information about the MBean </para> + </listitem> + </itemizedlist> + + </section> + + <section> + <title>Managing Application</title> + + + +<para>As it's been said earlier in the guide the JMX technology allows to monitor and manage Java applications. In this section we will show you how to get connected to +a sample Java application and run the <property>sayHello()</property> method remotely from inside of the <property>MBean Explorer</property>.</para> +<orderedlist> + + + +<listitem><para>Save the bundle of JMX API sample classes, <ulink url="http://java.sun.com/docs/books/tutorial/jmx/examples/jmx_examples.zip">jmx_examples.zip</ulink>, to your working directory</para></listitem> +<listitem><para>Unzip the bundle of sample classes.</para></listitem> +<listitem><para>Compile the example Java classes from within where you unpacked the files directory.</para> + + <programlisting role="XML"><![CDATA[ + javac com/example/*.java + ]]></programlisting> + +</listitem> +<listitem><para>Start the <property>Main</property> application, specifying the properties that expose Main for remote management:</para> + + <programlisting role="XML"><![CDATA[ +java -Dcom.sun.management.jmxremote.port=9999 \ +-Dcom.sun.management.jmxremote.authenticate=false \ +-Dcom.sun.management.jmxremote.ssl=false \ +com.example.Main + ]]></programlisting> + +<para>If everything was done correctly you will see the "Waiting for incoming requests..." message on the screen.</para> + + + </listitem> + <listitem><para>Now launch the Eclipse IDE, in Eclipse open the <property>MBean Explorer</property>. Go to <emphasis><property>Window > Show View > Other</property></emphasis> and then select + <property>MBean Explorer</property> and click <emphasis><property>OK</property></emphasis>)</para></listitem> + <listitem> + <para>Click the <emphasis> + <property>New Connection</property></emphasis> icon + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/new_connection_icon.png"/> + </imageobject> + </inlinemediaobject> + + in the <property>MBean Explorer</property> menu + bar.</para> + </listitem> + + <listitem><para>In the <property>Create JMX Connection</property> dialog, hit <property>Next</property> and then click the <property>Advanced</property> tab. </para></listitem> + + + <listitem><para>In the <property>JMX URL</property> input field enter the following URL:</para> + + <programlisting role="XML"><![CDATA[ + service:jmx:rmi:///jndi/rmi://:9999/jmxrmi + ]]></programlisting> + + <figure> + <title>JMX Connection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbeans.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem><para>Press <property>Finish</property> to esteblish the connection with the application.</para> + </listitem> + + <listitem><para>Now expand the connection you have just created, then open the <property>com.example</property> package and click <property>sayHello()</property> method. </para> + <para>Once the <property>sayHello()</property> method is clicked the <property>MBean Editor</property> is activated. </para> + + </listitem> + + <listitem><para>In the <property>MBean Editor</property> go to the <property>Operation Details</property> section and hit the <property>sayHello()</property> button.</para><para> You will get the "Operation inoked successfully" message. </para> + + <figure> + <title>Ivoking Method via JMX</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/invokemethod.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem><para>The final step is to make sure the application worked as it was expected. Open the terminal where you launched the application in step 3. Now you see the "hello, world" message on the screen. </para> + </listitem> +</orderedlist> + + + + </section> + <section> + <title>Tomcat Managing</title> + + <para>It's possible to manage Tomcat using <property>JMX Tools</property>.</para> + + <para>Currently, JMX Tooling is able to connect to Tomcat without authentication or with + password-based authentication.</para> + <para>Using SSL for authentication is not supported: you need to make sure that the System + property <emphasis> + <property>com.sun.management.jmxremote.ssl</property> + </emphasis> is set to false. </para> + <para>More information to manage Tomcat can be found in <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/">Tomcat management documentation</ulink>.</para> + <para>Instructions to manage remotely Tomcat are available in <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html">Tomcat's monitoring documentation</ulink>.</para> + + + </section> + + <section> + <title>Eclipse Equinox Managing</title> + + <para>You can manage Equinox through the Equinox monitoring framework.</para> + <para>In this section we will show you how to connect to an Equinox server via JBoss JMX tools. First off, you need to make for example a simple servlet and run it on a server. This guide is not intended to teach you how to build application and run them on the server, you can read for example <ulink url="http://www.eclipse.org/equinox-portal/tutorials/server-side/"> this tutorial </ulink> to get a better idea of how to build server-based applications with Eclipse Equinox. </para> + <para>Once you have run an application on the server you can connect to it using JBoss JMX tools.</para> + + <orderedlist> + <listitem> + <para>Go to <emphasis> + <property>Window > Open Perspective > Other</property> + </emphasis> and select the <property>JMX perspective.</property></para> + </listitem> + +  + + <listitem> + <para>Switch to the <property>MBean Explorer</property> by going to <emphasis> + <property>Window > Show View > Other</property> + </emphasis> and selecting the MBean Explorer.</para> + </listitem> + + <listitem> + <para>Click the <emphasis> + <property>New Connection</property></emphasis> icon + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/new_connection_icon.png"/> + </imageobject> + </inlinemediaobject> + + in the <property>MBean Explorer</property> menu + bar.</para> + </listitem> + + <listitem> + <para>Select the <emphasis> + <property>Advanced tab</property></emphasis> and set the JMX URL to <emphasis> + <property>service:jmx:rmi:///jndi/rmi://:8118/jmxserver.</property> + </emphasis></para> + + <figure> + <title>Using JMX Tools to Access Equinox Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/equinox.png"/> + </imageobject> + </mediaobject> + </figure> + + </listitem> + </orderedlist> + + <para>You now have access to the MBeans exposed by Equinox.</para> + </section> + + + <section> + <title>Managing JBoss AS</title> + + <para>Managing JBoss instances is not supported with the <property>JMX Tools</property> + alone. You must also download and install the <property>AS Tools</property> portion of + the <property>JBoss Tools</property> distribution. Even after installing the proper + tooling, you cannot create a JBoss JMX connection yourself or through the Connection + Wizard. The first step is to create a JBoss Server. The full instructions for this can + be found in the AS Tools section, however, the short summary is: </para> + <orderedlist> + <listitem> + <para>Open the <property>Servers</property> view.</para> + </listitem> + + <listitem> + <para>Right-click in the view and select <emphasis> + <property>New > Server</property> + </emphasis>.</para> + </listitem> + + <listitem> + <para>In the <emphasis> + <property>JBoss Enterprise Middleware</property> + </emphasis> or in <emphasis> + <property>JBoss Community</property> + </emphasis> section, select a server version.</para> + </listitem> + + <listitem> + <para>If a runtime has not yet been created, you'll be prompted for the + server's home directory, JDK, and configuration.</para> + </listitem> + + <listitem> + <para>Finish the wizard and note that you have a new entry in both the + <property>Servers</property> view and the <property>MBean + Explorer</property>.</para> + </listitem> + + <listitem> + <para>Start the server by right-clicking it and selecting <emphasis> + <property>Start</property></emphasis>.</para> + </listitem> + <listitem> + <para>Note that once the server is started, the JMX connection can be + expanded.</para> + </listitem> + </orderedlist> + + <para>Now you can explore MBeans exposed by a JBoss instance.</para> + </section> + + <section> + <title>Managing JBoss AS Remotely</title> + + <para>JBoss JMX Tool allow you to easily get access and mangane JBoss AS server remotely. + In order to get connected to the instance of JBoss AS remotely you need to run the server or make sure the server is lauched. + </para> + <orderedlist> + <listitem> + <para>Go to <emphasis> + <property>Window > Open Perspective > Other</property> + </emphasis> and select the <property>JMX perspective.</property></para> + </listitem> + <listitem> + <para>Switch to the <property>MBean Explorer</property> by going to <emphasis> + <property>Window > Show View > Other</property> + </emphasis> and selecting the MBean Explorer.</para> + </listitem> + + <listitem> + <para>Click the <emphasis> + <property>New Connection</property></emphasis> icon + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/new_connection_icon.png"/> + </imageobject> + </inlinemediaobject> + + in the <property>MBean Explorer</property> menu + bar.</para> + </listitem> + + <listitem> + <para>Select the <emphasis> + <property>Advanced tab</property></emphasis> and set the JMX URL to: </para> + <programlisting role="XML"><![CDATA[ +service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector + ]]></programlisting> + + <para>Please, note that in this example we connected to the local host. </para> + </listitem> + </orderedlist> + </section> + <section id="extensions" xreflabel="extensions"> + <title>Extension Task</title> + <para>This section will outline how to contribute your own Server type with some default + behavior.</para> + + <section> + <title>Why we should do that?</title> + + <para>You might be asking yourself why you'd need to extend this framework if JMX is + a standard. Perhaps you want a connection to be automatically created after some specific + action, or perhaps you want your connection wizard to do more than simply set a host and + port. JBoss, for example, requires setting some credentials on the client machine, but + using JBoss classes to do it. This requires that the connection have access to JBoss + jars.</para> + </section> + + <section> + <title>Core Extensions</title> + + <para>To create your own JMX Connection type, you must use the + org.jboss.tools.jmx.core.MBeanServerConnectionProvider extension point. This point takes + one child, a connectionProvider with a class that implements + org.jboss.tools.jmx.core.IConnectionProvider.</para> + + <para>An IConnectionProvider is responsible for creation and deletion of IConnectionWrapper + objects. It must also keep a list of listeners that it is expected to inform when a + connection is added or removed from its list. </para> + + <para>Each IConnectionWrapper is expected to handle running arbitrary JMX runnables or getting + a "Root" object representing all JMX nodes. There are some utility methods the + IConnectionWrapper can make use of.</para> + </section> + + <section> + <title>UI Extensions</title> + <para>There are two extension points currently approved for use in the UI</para> + <itemizedlist> + <listitem> + <para>org.jboss.tools.jmx.ui.providerUI - provide an icon, id, displayable name, and + wizardPage class for creation of new connections</para> + </listitem> + <listitem> + <para>org.jboss.tools.jmx.ui.attribute.controls - allows you to map class types to some + Control to present them in the MBean Editor</para> + <para>We hope, this guide helped you to get started with the JBoss JMX Tools. Besides, for additional information you are welcome on <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> + </listitem> + </itemizedlist> + </section> + + </section> + <section id="connection" xreflabel="connection"> + + <title>Connections Creation Task</title> + + <para>The <property>MBean Explorer</property> supports several different types of connections. + The tooling itself comes only with a default connection type, however other + adopters can provide additional connection types that may require additional + or non-spec behavior. Connections can be in either the connected state or + the disconnected state. Some connection types (such as the default connection type) + allow you to control the current state. Other connection types may not. </para> + + <para>Similarly, some connection types may be able to be created, and others may not. + The default connection type, for example, can be created and deleted by you + at will. The AS Tools connection type, which represents a JBoss server, does not + allow you this level of control. A JBoss JMX connection is created when a JBoss server is created + in the server's view, and deleted when said server is deleted. The JMX connection for + this server is in the connected state only when the server is started. </para> + + + <section><title>Establishing Connection</title> + + <para> There are two ways to connect to an application with remote management enabled:</para> + + <para> The first step is the same for both - to connect to a MBean Server, click the + <emphasis> + <property>New Connection</property></emphasis> icon + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/new_connection_icon.png"/> + </imageobject> + </inlinemediaobject> + + in the <property>MBean Explorer</property> menu bar.</para> + + <para>Then to follow the simple one you just need to specify host, port (and optionally user + name and password) and click <emphasis> + <property>OK</property>.</emphasis></para> + <para>On the <property>Advanced</property> tab you can set the sever name (it will be displayed in <property>MBean Explorer</property>), a url to the remote server. + For example, to connect to JBoss AS you need to set the <property>JMX URL</property> to + </para> + <programlisting role="XML"><![CDATA[ +service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector + ]]></programlisting> + <para>If it is required you can enter user name and password for the server connection. + </para> + + + <note> + <title>Note</title> + <para>Only JMX URL based on RMI are supported.</para> + </note> + </section> + </section> +</chapter> + Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/pom.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/pom.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/pom.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,179 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <groupId>org.jboss.tools</groupId> + <artifactId>jmx-tools-ref-guide-en-US</artifactId> + <version>1.0-SNAPSHOT</version> + <packaging>jdocbook</packaging> + <name>JMX_Tools_Reference_Guide</name> + + <profiles> + <profile> + <id>release</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseTest</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release-nomarker.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release-nomarker.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseJBDS</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> + <cssdir>${pom.basedir}/target/docbook/staging/css/com/css</cssdir> + </properties> + </profile> + <profile> + <id>diffmk</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-diff.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-diff.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf-diff.xsl</xsl-pdf> + </properties> + </profile> + </profiles> + + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.2.1</version> + <extensions>true</extensions> + + <dependencies> + <dependency> + <groupId>org.jboss.tools</groupId> + <artifactId>jbosstools-jdocbook-style</artifactId> + <type>jdocbook-style</type> + <version>1.0.0-SNAPSHOT</version> + </dependency> + <dependency> + <groupId>org.jboss.tools</groupId> + <artifactId>jbosstools-docbook-xslt</artifactId> + <version>1.0.0-SNAPSHOT</version> + </dependency> + + + </dependencies> + + <configuration> + <sourceDocumentName>${master}</sourceDocumentName> + <sourceDirectory>${pom.basedir}</sourceDirectory> + <imageResource> + <directory>${pom.basedir}/en-US</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + <cssResource> + <directory>${cssdir}</directory> + </cssResource> + + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>${xsl-pdf}</stylesheetResource> + <finalName>${project.name}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>${xsl-chunked}</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>${xsl-single}</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/tools/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> +  +  + <docbookVersion>1.72.0</docbookVersion> + </options> + + </configuration> + </plugin> + <plugin> + <artifactId>maven-clean-plugin</artifactId> + <version>2.4</version> + <executions> + <execution> + <id>clean</id> + <phase>package</phase> + <goals> + <goal>clean</goal> + </goals> + </execution> + </executions> + <configuration> + <excludeDefaultDirectories>true</excludeDefaultDirectories> + <filesets> + <fileset> + <directory>${pom.basedir}/target/docbook/publish/en-US/</directory> + <includes> + <include>html/org/</include> + <include>html/org/</include> + <include>html_single/org/</include> + <include>html_single/org/</include> + <include>eclipse/org/</include> + <include>eclipse/org/</include> + </includes> + <followSymlinks>false</followSymlinks> + </fileset> + </filesets> + </configuration> + </plugin> + </plugins> + </build> + + <distributionManagement> + <repository> +  +  +  + <id>repository.jboss.org</id> + <url>file://${maven.repository.root}</url> + </repository> + <snapshotRepository> + <id>snapshots.jboss.org</id> + <name>JBoss Snapshot Repository</name> + <url>dav:https://snapshots.jboss.org/maven2</url> + </snapshotRepository> + </distributionManagement> + + <properties> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + <stylesdir>classpath:/xslt</stylesdir> + <cssdir>${pom.basedir}/target/docbook/staging/css/org/css</cssdir> + <master>master.xml</master> + </properties> +</project> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/publican.cfg =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/publican.cfg (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/publican.cfg 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22656 - tags/jbosstools-3.1.1.GA/jmx/docs.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 20:06:35 -0400 (Tue, 08 Jun 2010) New Revision: 22656 Removed: tags/jbosstools-3.1.1.GA/jmx/docs/reference/ Log: removing to add in new JMX reference guide

14 years, 7 months

1
0
0 / 0

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

jbosstools-commits June 2010