[savara-commits] savara SVN: r144 - in tools/eclipse/trunk/docs/gettingstartedguide/src/main: module and 1 other directory.

Author: objectiser Date: 2009-12-11 16:11:04 -0500 (Fri, 11 Dec 2009) New Revision: 144 Added: tools/eclipse/trunk/docs/gettingstartedguide/src/main/images/ExportHTMLDialog.png tools/eclipse/trunk/docs/gettingstartedguide/src/main/images/ExportHTMLMenu.png tools/eclipse/trunk/docs/gettingstartedguide/src/main/images/ExportedHTML.png Modified: tools/eclipse/trunk/docs/gettingstartedguide/src/main/module/architecture.xml tools/eclipse/trunk/docs/gettingstartedguide/src/main/module/installation.xml Log: Added HTML doc generation images and text. Added: tools/eclipse/trunk/docs/gettingstartedguide/src/main/images/ExportHTMLDialog.png =================================================================== (Binary files differ) Property changes on: tools/eclipse/trunk/docs/gettingstartedguide/src/main/images/ExportHTMLDialog.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tools/eclipse/trunk/docs/gettingstartedguide/src/main/images/ExportHTMLMenu.png =================================================================== (Binary files differ) Property changes on: tools/eclipse/trunk/docs/gettingstartedguide/src/main/images/ExportHTMLMenu.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tools/eclipse/trunk/docs/gettingstartedguide/src/main/images/ExportedHTML.png =================================================================== (Binary files differ) Property changes on: tools/eclipse/trunk/docs/gettingstartedguide/src/main/images/ExportedHTML.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: tools/eclipse/trunk/docs/gettingstartedguide/src/main/module/architecture.xml =================================================================== --- tools/eclipse/trunk/docs/gettingstartedguide/src/main/module/architecture.xml 2009-12-11 20:24:38 UTC (rev 143) +++ tools/eclipse/trunk/docs/gettingstartedguide/src/main/module/architecture.xml 2009-12-11 21:11:04 UTC (rev 144) @@ -156,9 +156,39 @@ Once the choreography description has been successfully tested against the scenarios, the next step may be to obtain approval to proceed to the analysis/design phase. To help support this effort, the pi4soa tools provide the means to export the choreography description to -a range of representations (e.g. BPMN, UML or HTML documentation -<emphasis>TO BE CONFIRMED</emphasis>). +a range of representations. HTML documentation generated is discussed below, and BPMN +diagram generation is discussed in the Service Oriented Analysis and Design section. </para> + + <para> + To generate HTML documentation, select the <emphasis>Export->Other->HTML</emphasis> + menu item associated with the choreography description file. + </para> + + <imageobject> + <imagedata fileref="images/ExportHTMLMenu.png" align="center" width="4in" /> + </imageobject> + + <para> + The next step is to provide the location and name of the HTML file to be + generated. + </para> + + <imageobject> + <imagedata fileref="images/ExportHTMLDialog.png" align="center" width="4in" /> + </imageobject> + + <para> + If the HTML has been generated within the scope of Eclipse project, then refresh + the relevant folder to show the file and open the file with the Eclipse web + browser (as shown below). If outside the Eclipse project, then use a normal + web browser to view the file. + </para> + + <imageobject> + <imagedata fileref="images/ExportedHTML.png" align="center" width="6in" /> + </imageobject> + </section> </section> Modified: tools/eclipse/trunk/docs/gettingstartedguide/src/main/module/installation.xml =================================================================== --- tools/eclipse/trunk/docs/gettingstartedguide/src/main/module/installation.xml 2009-12-11 20:24:38 UTC (rev 143) +++ tools/eclipse/trunk/docs/gettingstartedguide/src/main/module/installation.xml 2009-12-11 21:11:04 UTC (rev 144) @@ -42,7 +42,9 @@ page, and enter it into the top text field in the dialog window, and press the <emphasis>Add</emphasis> button. Once the contents of the update site is available, then select the appropriate components and follow the instructions to install - them within your Eclipse environment. + them within your Eclipse environment. The minimum requirement is to select the + <emphasis>pi4soa core</emphasis> feature in the <emphasis>JBoss Tools</emphasis> + category. </para> </listitem> @@ -57,6 +59,17 @@ distribution: <filename>${SAVARA-Tools}/eclipse</filename>. Again, as with the previous step, follow the instructions provided by the Eclipse update manager to complete the installation. + + <note> + <para> + Version 1.1 of the BPMN editor in Galileo does not correctly display links in the + diagram. Therefore we have included an early access release of version 1.2 + with the SAVARA plugins. When version 1.2 of the Eclipse BPMN editor is + available in the Galileo update site, select the plugins from the SOA + Development category. Until then, use the plugins provided in the SAVARA + local update site. + </para> + </note> </para> </listitem>