Author: ochikvina Date: 2007-12-21 08:05:00 -0500 (Fri, 21 Dec 2007) New Revision: 5422 Modified: trunk/jbpm/docs/reference/en/modules/Introduction.xml trunk/jbpm/docs/reference/en/modules/the_views.xml Log: http://jira.jboss.com/jira/browse/JBDS-233 - updating according to the Svetlana Mukhina remarks Modified: trunk/jbpm/docs/reference/en/modules/Introduction.xml =================================================================== --- trunk/jbpm/docs/reference/en/modules/Introduction.xml 2007-12-21 13:04:11 UTC (rev 5421) +++ trunk/jbpm/docs/reference/en/modules/Introduction.xml 2007-12-21 13:05:00 UTC (rev 5422) @@ -98,7 +98,7 @@ <row> <entry> - <link linkend="the_source_view">Support of XML code view</link> + <link linkend="source_mode">Support of XML code view</link> </entry> <entry>Shows the corresponding XML that&apos;s generated automatically in the Source view of the process definition editor when developing the process.</entry> Modified: trunk/jbpm/docs/reference/en/modules/the_views.xml =================================================================== --- trunk/jbpm/docs/reference/en/modules/the_views.xml 2007-12-21 13:04:11 UTC (rev 5421) +++ trunk/jbpm/docs/reference/en/modules/the_views.xml 2007-12-21 13:05:00 UTC (rev 5422) @@ -6,131 +6,210 @@ <keyword>jBPM</keyword> </keywordset> </chapterinfo> - + <title>The views</title> - + <para>Here, it will be explained how to work with views and editors provided by JBDS.</para> - + <para>The views are used for representation and navigation the resources you are working on at + the moment. One of the advantages of all the views is that all modifications made in the + currant- active file are immediately displayed in them. Let’s get acquainted more closely + with those that the jPDL perspective provides. </para> + <section id="the_outline_view"> <?dbhtml filename="the_outline_view.html"?> <title>The Outline View</title> - <para>To have a way to quickly see an outline of the process use the JBDS Outline view. If it is not - visible select <emphasis> + <para>To have a way to quickly see an outline of the process use the JBDS Outline view that + is presented as the classical tree. If it is not visible select <emphasis> <property>Window &gt; Show view &gt; Outline</property> - </emphasis>. It is presented as the classical tree view. Also you can use <emphasis> - <property>Overview</property> - </emphasis> that comes as a scrollable thumbnail.</para> + </emphasis>.</para> + <figure> - <title>The Outline and Overview Views</title> + <title>The Overview View</title> <mediaobject> <imageobject> - <imagedata fileref="images/the_views/the_views1.png" - scale="75"/> + <imagedata fileref="images/the_views/the_views1.png" scale="75"/> </imageobject> </mediaobject> </figure> </section> - <section id="the_properties_view"> - <?dbhtml filename="the_properties_view.html"?> - <title>The Properties View</title> - <para> Here, we dwell on the JBDS <property>Properties view</property>.</para> - <para>Notice if it&apos;s not visible you can access it by navigating <emphasis> - <property>Window &gt; Show view &gt; Properties</property> - </emphasis>. The view shows the relevant properties of the selected item. Some of these - properties may be directly editable in the properties view. An example of a directly - editable property is the name property of the process definition. As you can see in the - next figure, the name property of the process definition can be changed to <emphasis> - <property>jbay</property> - </emphasis>. You can also write a description for this property.</para> + + <section id="the_overview"> + <?dbhtml filename="the_outline_view.html"?> + <title>The Overview</title> + <para>The main advantage of this view is that it gives visual representation of the whole + currant-developing process. Besides, Overview comes as a scrollable thumbnail, which + enables a better navigation of the process structure if it&apos;s too large.</para> + <figure> - <title>The Properties of a Process Definition</title> + <title>The Overview</title> <mediaobject> <imageobject> - <imagedata fileref="images/the_views/the_views2.png"/> + <imagedata fileref="images/the_views/the_views2.png" scale="75"/> </imageobject> </mediaobject> </figure> - <para>Let&apos;s change the name of the first transition to <emphasis> - <property>to_auction</property> - </emphasis>. We repeat this name change for the second transition and name it <emphasis> - <property>to_end</property> - </emphasis>.</para> + </section> + + <section id="the_properties_view"> + <?dbhtml filename="the_properties_view.html"?> + <title>The Properties View</title> + <para> Here, we dwell on the JBDS <property>Properties view</property>.</para> + <para>Notice if it&apos;s not visible you can access it by navigating <emphasis> + <property>Window &gt; Show view &gt; Properties</property> + </emphasis>.</para> + <para>The view shows the relevant properties of the selected item in the tabbed form. Every + item has its own set of properties, which can be directly editable in the Properties + view or by brining up the context menu.</para> + <figure> - <title>Transitions Names</title> + <title>The Properties View of selected Transition</title> <mediaobject> <imageobject> <imagedata fileref="images/the_views/the_views3.png"/> </imageobject> </mediaobject> </figure> - </section> - - - <section id="direct_editing"> - <?dbhtml filename="direct_editing.html"?> - <title>Direct Editing</title> - <para>Besides, some properties can be directly edited in the graphical editor. One example of this is - the <emphasis> - <property>Name</property> - </emphasis> property of nodes. You can edit this directly by selecting the node of which - you want to change the name and then click once inside this node. This enables an editor - in the node. We change the name of the node to <emphasis> - <property>auction</property> + + <para>For example, on the picture above the Properties view displays all the properties for + a selected transition. Its name has been changed to <emphasis> + <property>to_auction</property> + </emphasis>. We&apos;ve done it directly in active General tab of the view. The same + way let&apos;s change the name for the second transition to <emphasis> + <property>to_end</property> </emphasis>.</para> + <para>If no one item is selected, the view represents the properties of the whole process + definition. </para> + <figure> - <title>Directly Editing the Node Name</title> + <title>The Properties View of Process Definition</title> <mediaobject> <imageobject> <imagedata fileref="images/the_views/the_views4.png"/> </imageobject> </mediaobject> </figure> + + <para>In this case, it contains six tabs. The first one is the General. It allows to specify + a process name and add necessary description.</para> </section> - <section id="the_source_view"> - <?dbhtml filename="the_source_view.html"?> - <title>The Source View</title> - <para>Now that we have defined a simple process definition, we can have a look at the xml - that is being generated under the covers. To see this xml, click on the source tab of - the process definition editor.</para> - <figure> - <title>The Source View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/the_views/the_views5.png"/> - </imageobject> - </mediaobject> - </figure> - <para>This source tab is editable, so if you know your way around in jPDL, you can create or - tweak your process definitions directly in the xml source.</para> + + <section id="jbpm_gpd_editor"> + <?dbhtml filename="direct_editing.html"?> + <title>The jBPM Graphical Process Designer editor.</title> + <para>The jBPM GPD editor includes four modes: Diagram, Deployment, Design and Source, which + are available as switchable tabs at the bottom of the editor. Let&apos;s dwell on + each of them.</para> + + <section id="the_diagram_mode"> + <title>The Diagram mode</title> + <para> In this mode we define the process in the form of a diagram by means of tools + provided on the left-hens side of the jBPM GPD. </para> + + <figure> + <title>The Diagram mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Besides, some properties can be directly edited in the Diagram mode of the + graphical editor. One example of this is the <emphasis> + <property>name</property> + </emphasis> property of nodes. You can edit this directly by selecting the node of + which you want to change the name and then click once inside this node. This enables + an editor in the node. We change the name of the node to <emphasis> + <property>auction</property> + </emphasis>.</para> + </section> + + <section id="source_mode"> + <?dbhtml filename="the_source_view.html"?> + <title>The Source Mode</title> + <para>Now, that we have defined a simple process definition, we can have a look at the + XML that is being generated under the covers. To see this XML, click on the Source + tab of the graphical process designer editor.</para> + + <figure> + <title>The Source Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views6.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The Source mode enables to easily manipulate our XML. That is manually inserting + and editing necessary elements or attributes. In addition, here you can take + advantage of content assist.</para> + </section> + + <section id="design_mode"> + <?dbhtml filename="the_design_view.html"?> + <title>The Design Mode</title> + <para>One more way to edit your file is to use <property>Design mode</property>. You can + see it in the next picture:</para> + <figure> + <title>The Design Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As you can see above, this mode looks like a table in the first column of which + the process structure is performed. Here, you can also insert, remove and edit + elements or attributes, moreover add comments and instructions. Their values can be + directly edited in the second column of the Design mode table.</para> + <para>For instance, let’s add a comment on the second transition. For that, you should + bring up the context menu for it and choose <emphasis> + <property>Add Before > Comment</property> + </emphasis>.</para> + + <figure> + <title>Adding a Comment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views8.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Then, as its value in the right column we can put the text <emphasis>This + transition leads to the end state</emphasis>. </para> + + <figure> + <title>Comment is added</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views9.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="deployment_mode"> + <?dbhtml filename="the_deployment_view.html"?> + <title>The Deployment Mode</title> + <para>Finally, to adjust the deployment settings of the project you should switch on to + the tab that opens the Deployment mode. On the picture below the Deployment mode is + performed with default settings. Here, you can easily modify them or, if the + settings won&apos;t match your needs, to reset defaults. </para> + <figure> + <title>The Deployment Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views10.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The button <emphasis><property>Test Connections</property></emphasis> is necessary to make sure whether all your settings + are valid before deploying the process.</para> + </section> + </section> - <section id="the_design_view"> - <?dbhtml filename="the_design_view.html"?> - <title>The Design View</title> - <para>One more way to edit your file is to use <property>Design view</property> that&apos;s available at the bottom of the file editor. - You can see it in the next picture:</para> - <figure> - <title>The Design View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/the_views/the_views6.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="the_deployment_view"> - <?dbhtml filename="the_deployment_view.html"?> - <title>The Deployment View</title> - <para>To adjust the deployment settings of the project you should switch to the next tab that opens the - <property>Deployment view</property>.</para> - <figure> - <title>The Deployment View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/the_views/the_views7.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <para>As we have already arranged the project, let's pass on to the next step.</para> -</chapter> \ No newline at end of file + <para></para> +</chapter>