Author: tromanovich Date: 2008-04-23 08:12:50 -0400 (Wed, 23 Apr 2008) New Revision: 7705 Modified: trunk/esb/docs/esb_ref_guide/en/images/esb_editor/02_esb_source_view.png trunk/esb/docs/esb_ref_guide/en/images/esb_editor/03_esb_outline_view.png trunk/esb/docs/esb_ref_guide/en/images/esb_support/02_create_esb.png trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml trunk/esb/docs/esb_ref_guide/en/modules/introduction.xml Log: http://jira.jboss.com/jira/browse/JBDS-307 Sketch of ref guide Updating of a ref guide. Modified: trunk/esb/docs/esb_ref_guide/en/images/esb_editor/02_esb_source_view.png =================================================================== (Binary files differ) Modified: trunk/esb/docs/esb_ref_guide/en/images/esb_editor/03_esb_outline_view.png =================================================================== (Binary files differ) Modified: trunk/esb/docs/esb_ref_guide/en/images/esb_support/02_create_esb.png =================================================================== (Binary files differ) Modified: trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml 2008-04-23 11:28:04 UTC (rev 7704) +++ trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml 2008-04-23 12:12:50 UTC (rev 7705) @@ -13,9 +13,9 @@ <title>ESB Editor</title> <para> - ESB editor have <!--<link linkend="OpenOnSelection"><property>OpenOn</property></link> and - <link linkend="CodeAssistAndDynamicCodeAssist42BasedOnProjectData"><property>Content Assist</property></link>--> some features, - they are described more detail in this chapter. In addition you get to know a <link linkend="esb_filee">ESB Editor</link> for combined visual and source editing + 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> <section id="esb_file"> @@ -24,9 +24,10 @@ <para>JBoss Developer Studio comes with a powerful and customizable <property>ESB File Editor</property>. You can use the ESB File Editor to develop an application using ESB technology.</para> - <para>ESB file editor has two tabs: Tree and Source.</para> + <para>ESB file editor has two tabs: Tree and Source.</para> - <para>You can switch to Tree:</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> @@ -36,7 +37,8 @@ </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 Source view.</para> + <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> + <figure id="sourceView"> <title>Source View</title> <mediaobject> @@ -45,9 +47,14 @@ </imageobject> </mediaobject> </figure> - <para>No matter what view you select, you get full integration with <!--Properties and -->Outline view<!-- views -->:</para> + <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> <figure> - <title>Properties and Outline Views</title> + <title>Outline View</title> <mediaobject> <imageobject> <imagedata fileref="images/esb_editor/03_esb_outline_view.png"/> @@ -55,7 +62,8 @@ </mediaobject> </figure> - <para>You can add any new elements right in the <property>Tree viewer</property>. You can easily add a new provider:</para> + <para>Addition, 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> <figure> <title>Add new provider</title> @@ -65,6 +73,7 @@ </imageobject> </mediaobject> </figure> + <para>You can easily add a new service too:</para> <figure> <title>Add new service</title> @@ -75,7 +84,7 @@ </mediaobject> </figure> - <para>You can add a new listener for service and other elements of ESB file too:</para> + <para>The same way you can create a listener for service and other elements of ESB:</para> <figure> <title>Add new listener for service</title> <mediaobject> @@ -84,7 +93,10 @@ </imageobject> </mediaobject> </figure> - </section> + </section> + + <para>The same actions can be done in the right part of <property>Tree</property> view tab + using <property>Add</property>, <property>Edit</property>, <property>Remove</property> buttons.</para> <section id="esb_editors_features"> @@ -102,7 +114,7 @@ <title>Support for XML Schema</title> <para>JBoss Developer Studio fully - <link ulinend="sourceView">supports XML files based on schemas as well as DTDs</link>.</para> + <link linkend="sourceView">supports XML files based on schemas as well as DTDs</link>.</para> </section> <!--<section id="OpenOnSelection"> @@ -124,25 +136,13 @@ --> <section id="ESBContentAssist"> - - <!-- <title>Content Assist</title> - <para><property>Content assist</property> is available when working with ESB file.</para> - - <para>When working with ESB file in JBoss Developer Studio, you can use - various <property>Content Assist features</property> while developing:</para> - <itemizedlist> - <listitem> - <para>Content Assist for XML file</para> - </listitem> - <listitem> - <para>Content Assist with Tree View editor</para> - </listitem> - </itemizedlist> - <section id="ContentAssistForESBXML">--> <title>Content Assist for ESB XML file</title> - <para>When you work with any ESB XML file Content Assist is available to help you. Simply type <emphasis> + <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> @@ -193,12 +193,11 @@ <para>JBoss Developer Studio offers the flexibility to edit ESB file in either source or extra visual modes at the same time.</para> - <para>JBoss Developer Studio provides you two different editors to speed your development. At the same + <para>JBoss Developer Studio provides 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.</para> + 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>The ESB file editor has has a graphical view (<property>Tree</property>) and source - (<property>Source</property>). Both views are synchronized, you can edit the file in any view.</para> <figure> <title>Two Views are Synchronized</title> <mediaobject> @@ -209,5 +208,10 @@ </figure> </section> + + <para>The last chapter covers a 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> </section> </chapter> Modified: trunk/esb/docs/esb_ref_guide/en/modules/introduction.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en/modules/introduction.xml 2008-04-23 11:28:04 UTC (rev 7704) +++ trunk/esb/docs/esb_ref_guide/en/modules/introduction.xml 2008-04-23 12:12:50 UTC (rev 7705) @@ -44,15 +44,9 @@ <para>You can find a set of benefits and other extra information on:</para> <itemizedlist> - <listitem> - <para><ulink url="http://www.jboss.org/jbossesb">JBoss ESB</ulink></para> - </listitem> - <listitem> - <para><ulink url="http://wiki.jboss.org/wiki/JBossESB">JBoss Wiki</ulink></para> - </listitem> - <listitem> - <para><ulink url="http://www.jboss.org/jbossesb/docs/index.html">JBoss ESB Documentation Library</ulink></para> - </listitem> + <listitem><ulink url="http://www.jboss.org/jbossesb">JBoss ESB</ulink></listitem> + <listitem><ulink url="http://wiki.jboss.org/wiki/JBossESB">JBoss Wiki</ulink></listitem> + <listitem><ulink url="http://www.jboss.org/jbossesb/docs/index.html">JBoss ESB Documentation Library</ulink></listitem> </itemizedlist> </section>