Author: ochikvina Date: 2008-08-22 10:10:39 -0400 (Fri, 22 Aug 2008) New Revision: 9870 Modified: trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml Log: https://jira.jboss.org/jira/browse/JBDS-386 - adding info on ESB editor Modified: trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml 2008-08-22 14:09:11 UTC (rev 9869) +++ trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml 2008-08-22 14:10:39 UTC (rev 9870) @@ -11,22 +11,21 @@ <title>ESB Editor</title> - <para> - ESB editor has <!--<link linkend="OpenOnSelection"><property>OpenOn</property></link> and - <link linkend="CodeAssistAndDynamicCodeAssist42BasedOnProjectData"><property>Content Assist</property></link>--> lots of useful features, - they are described in details in this chapter. In addition you get to know <link linkend="esb_file">ESB Editor</link> uses combined visual and source editing - of esb files.</para> + <para> ESB editor has lots of useful features, they are described in details in this chapter. In + addition you&apos;ll get to know with how <property>ESB Editor</property> uses combined + visual and source editing of esb files.</para> - <section id="esb_file"> - + <section id="esb_file" role="updated"> + <title>ESB File Editor</title> - <para><property>ESB File Editor</property> is a powerful and customizable tool. ESB File Editor allows developing an - application using ESB technology.</para> - - <para>ESB file editor has two tabs: Tree and Source.</para> - - <para>You can switch to Tree. The Tree view for the editor displays all ESB artifacts in a tree format. - By selecting any node you can see and edit its properties which will appear in the right-hand area. For example, a Provider:</para> + <para><property>ESB File Editor</property> is a powerful and customizable tool. ESB File + Editor allows developing an application using ESB technology.</para> + + <para>ESB file editor has two tabs: Tree and Source.</para> + + <para>You can switch to Tree. The Tree view for the editor displays all ESB artifacts in a + tree format. By selecting any node you can see and edit its properties which will appear + in the right-hand area. For example, a Provider:</para> <figure> <title>Tree View</title> <mediaobject> @@ -35,9 +34,10 @@ </imageobject> </mediaobject> </figure> - - <para>You can easily switch from Tree to Source by selecting the Source tab at the bottom of the editor and work in <link linkend="sourceView">Source view</link>.</para> - + + <para>You can easily switch from Tree to Source by selecting the Source tab at the bottom of + the editor and work in <property>Source view</property>.</para> + <figure id="sourceView"> <title>Source View</title> <mediaobject> @@ -46,12 +46,16 @@ </imageobject> </mediaobject> </figure> - <para>The Source view for the editor displays a text content of the ESB file. It is always synchronized with tree view, - so any changes made in one of the views will immediately appear in the other.</para> - <para>No matter what view you select, you get full integration with <!--Properties and -->Outline view<!-- views -->. - For example, you can work in the Source view with the help of the Outline view. The Outline view shows a tree structure of the ESB 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> + + <para>The Source view for the editor displays a text content of the ESB file. It is always + synchronized with <property>Tree view</property>, so any changes made in one of the + views will immediately appear in the other.</para> + + <para>No matter what view you select, you get full integration with <property>Outline + view</property>. For example, you can work in the Source view with the help of the + Outline view. The Outline view shows a tree structure of the ESB file. Simply select any + element in the <property>Outline view</property> 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> @@ -60,64 +64,126 @@ </imageobject> </mediaobject> </figure> - - <para>Adding, editing or deleting of some artifacts operations are available right in the <property>Tree</property> view. Right-click any node and select one of the available actions in the context menu. - For example, you can easily add a new provider:</para> - <para></para> + + <para>Adding, editing or deleting of some artifacts operations are available right in the + <property>Tree view</property> . Right-click any node and select one of the + available actions in the context menu. For example, you can easily add a new Provider:</para> + <para/> <figure> - <title>Adding new provider</title> + <title>Adding New Provider</title> <mediaobject> <imageobject> <imagedata fileref="images/esb_editor/04_esb_add_provider.png"/> </imageobject> </mediaobject> </figure> - - <para>You can easily add a new service too:</para> + + <para>You can easily add a new Service too:</para> <figure> - <title>Adding new service</title> + <title>Adding New Service</title> <mediaobject> <imageobject> <imagedata fileref="images/esb_editor/05_esb_add_service.png"/> </imageobject> </mediaobject> </figure> - + <para>The same way you can create a listener for service and other elements of ESB:</para> <figure> - <title>Adding new listener for service</title> + <title>Adding New Listener for Service</title> <mediaobject> <imageobject> <imagedata fileref="images/esb_editor/06_esb_add_listener.png"/> </imageobject> </mediaobject> </figure> - <para>The same actions can be done in the right part of <property>Tree</property> view tab - using <property>Add</property>, <property>Edit</property> and <property>Remove</property> buttons.</para> + <para>The same actions can be done in the right part of <property>Tree view</property> tab + (Form editor) using <property>Add</property>, <property>Edit</property> and + <property>Remove</property> buttons.</para> + + + <para>In order to add a new generic Action to your ESB XML file you should select the + Actions node under the Services, then right-click and choose <emphasis> + <property>New > Generic Action</property> + </emphasis> or instead make use of <emphasis> + <property>Add...</property> + </emphasis> button in the <property>Form editor</property> on the left.</para> + + <figure> + <title>Adding New Action in the Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/11_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + + <figure> + <title>Adding New Action in the Form Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/12_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As you can see on the bath figures above, the context menu will also prompt you to + insert one of the Actions that are supplied out-of-the-box with <property>JBoss + ESB</property>. After choosing one an appeared <property>New Action wizard</property> + will ask you to fill out a name field and others specific for each Action property + fields. For example, for converter Action <emphasis> + <property>ObjectToCSVString</property> + </emphasis> the wizard looks as follows:</para> + + <figure> + <title>New Action Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/13_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + +<!-- + <para>In the <property>Form editor</property> on the left it&apos;s possible to edit + properties for any created Action.</para> + + <figure> + <title>Form Editor for Chosen Action</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/14_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + +--> + </section> - - - + <section id="esb_editors_features"> - + <title>ESB Editors Features</title> - <para>JBoss ESB tooling has powerful editor features that help you easily make use of content and code assist.</para> - + <para>JBoss ESB tooling has powerful editor features that help you easily make use of + content and code assist.</para> + <section id="ESBsyntaxvalidation84"> - + <title>ESB syntax validation</title> - <para>When working in JBoss ESB editor you are constantly provided with feedback - and contextual error checking as you type. In the Source viewer, if at any point a tag is incorrect or incomplete, an error will be indicated next to the line and also in the Problems view below.</para> + <para>When working in JBoss ESB editor you are constantly provided with feedback and + contextual error checking as you type. In the Source viewer, if at any point a tag + is incorrect or incomplete, an error will be indicated next to the line and also in + the Problems view below.</para> </section> - - <section id="ESBSupportXMLSchema"> + + <section id="ESBSupportXMLSchema"> <title>Support for XML Schema</title> - - <para>JBoss ESB Framework fully - <link linkend="sourceView">supports XML files based on schemas as well as DTDs</link>.</para> - </section> - - <!--<section id="OpenOnSelection"> + + <para>JBoss ESB Framework fully <link linkend="sourceView">supports XML files based on + schemas as well as DTDs</link>.</para> + </section> + + <!--<section id="OpenOnSelection"> <title>OpenOn</title> @@ -135,37 +201,36 @@ </section> --> - <section id="ESBContentAssist"> - - <title>Content Assist for ESB XML file</title> + <section id="ESBContentAssist"> - <para>When you work with any ESB XML file <property>Content Assist</property> is available to help you. - It provides pop-up tip to help you complete your code statements. - It allows you to write your code faster and with more accuracy. - Content assist is always available in the Source mode. Simply type <emphasis> - <property>Ctrl-Space</property></emphasis> to see what is available.</para> + <title>Content Assist for ESB XML file</title> - <para>Content Assist for ESB XML file:</para> - <figure> - <title>Content Assist for ESB XML file</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/esb_editor/08_esb_features.png" scale="80"/> - </imageobject> - </mediaobject> - </figure> - - <para>Content Assist for attributes:</para> - <figure> - <title>Content Assist for attributes:</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/esb_editor/09_esb_features.png" scale="80"/> - </imageobject> - </mediaobject> - </figure> + <para>When you work with any ESB XML file <property>Content Assist</property> is + available to help you. It provides pop-up tip to help you complete your code + statements. It allows you to write your code faster and with more accuracy. Content + assist is always available in the Source mode. Simply type <emphasis> + <property>Ctrl-Space</property> + </emphasis> to see what is available.</para> + + <para>Content Assist for ESB XML file:</para> + <figure> + <title>Content Assist for ESB XML file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/08_esb_features.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>Content Assist for attributes:</para> + <figure> + <title>Content Assist for attributes:</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/09_esb_features.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> <!-- </section> <section id="ContentAssistWithinTreeEditor"> @@ -183,19 +248,20 @@ </imageobject> </mediaobject> </figure> - </section> --> - </section> - + </section> --> + </section> + <section id="FullControlOverSourceFiles-SynchronizedSourcAndVisualEditing"> - + <title>Synchronized Source and Visual Editing</title> - <para>ESB file can be edited in either source - or extra visual modes at the same time.</para> + <para>ESB file can be edited in either source or extra visual modes at the same time.</para> - <para>JBoss Tools provide you two different editors to speed your development: a graphical view (<property>Tree</property>) and source - (<property>Source</property>). At the same time, you always have full control over esb source file. Any changes you - make in the source view will immediately appear in the tree view. Both views are synchronized, you can edit the file in any view.</para> + <para>JBoss Tools provide you two different editors to speed your development: a + graphical view (<property>Tree</property>) and source (<property>Source</property>). + At the same time, you always have full control over esb source file. Any changes you + make in the source view will immediately appear in the tree view. Both views are + synchronized, you can edit the file in any view.</para> <figure> <title>Two Views are Synchronized</title> @@ -205,12 +271,12 @@ </imageobject> </mediaobject> </figure> - + </section> - + <para>The last chapter covers capabilities on how you can use ESB editor.</para> - - <para>In summary, this reference supplies you with all necessary information on the functionality - that JBoss ESB Editor provides for work with JBoss ESB.</para> + + <para>In summary, this reference supplies you with all necessary information on the + functionality that JBoss ESB Editor provides for work with JBoss ESB.</para> </section> </chapter>