[jbpm-commits] JBoss JBPM SVN: r3351 - jbpm4/trunk/modules/userguide/src/main/docbook/en/modules.

do-not-reply at jboss.org do-not-reply at jboss.org
Thu Dec 11 19:20:40 EST 2008


Author: tom.baeyens at jboss.com
Date: 2008-12-11 19:20:39 -0500 (Thu, 11 Dec 2008)
New Revision: 3351

Modified:
   jbpm4/trunk/modules/userguide/src/main/docbook/en/modules/ch02-Installation.xml
Log:
fixed gpd installation docs

Modified: jbpm4/trunk/modules/userguide/src/main/docbook/en/modules/ch02-Installation.xml
===================================================================
--- jbpm4/trunk/modules/userguide/src/main/docbook/en/modules/ch02-Installation.xml	2008-12-11 22:02:01 UTC (rev 3350)
+++ jbpm4/trunk/modules/userguide/src/main/docbook/en/modules/ch02-Installation.xml	2008-12-12 00:20:39 UTC (rev 3351)
@@ -55,117 +55,91 @@
     </section>
   </section>
 
-  <section id="eclipse">
+  <section id="graphicalprocessdesigner">
     <title>Graphical Process Designer (GPD)</title>
     <para>Eclipse is used as the platform to host the jPDL graphical process
-    designer. This section will describe how to obtain Eclipse and install
+    designer. This section will describe how to obtain Eclipse, install it
     the GPD.</para>
     <section>
-      <title>Obtaining Eclipse</title>
-      <para>If you have already an Eclipse installation and you want to 
-      install the GPD in that one, please first make sure that your installation 
-      includes an XML editor. An XML editor comes in handy if you want to add 
-      technical details to the process files that are produced by the GPD.
-      If you have one of those you can safely skip the rest of this section and 
-      directly proceed with the GPD installation. If you don't have one
-      yet, there are two ways of getting it.</para>
-        <section>
-          <title>Use the jBPM Installer</title>
-          <para>TODO</para>
-        </section>
-        <section>
-          <title>Download Eclipse</title>
-          <para>You can download Eclipse from http://www.eclipse.org/downloads/.
-          We recommend to download either the Eclipse IDE for Java EE Developers
-          or the Eclipse IDE for Java Developers over the Eclipse Classic as the 
-          former two contain an XML editor while the latter doesn't.</para>
+      <title>Download Eclipse</title>
+      <para>You'll need Eclipse 3.4.1.
+      </para>
+      <para>Download the    
+      <ulink url="http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/ganymede/SR1/eclipse-java-ganymede-SR1-win32.zip">Eclipse IDE for Java Developers (85 MB)</ulink> or
+      <ulink url="http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/ganymede/SR1/eclipse-jee-ganymede-SR1-win32.zip">Eclipse IDE for Java EE Developers (163 MB)</ulink>.
+      </para>
+      <para>The classic version of eclipse will not be sufficient as it does 
+      not have an XML editor.
+      </para>
     </section>
     <section>
-      <title>GPD Installation</title>
+      <title>Add the update site <literal>gpd/jbpm-gpd-site.zip</literal></title>
       <para>The installation of the GPD uses the Eclipse Software Update 
-      mechanism and is pretty straightforward. An archived update site 
-      containing the different Eclipse plugins that you need is shipped 
-      with the jBPM download. You will find it in the gpd subfolder of the
-      distribution. The site is called jbpm-gpd-site.zip.</para>
-      <para>To do the installation, fire up Eclipse and choose 
-      'Help->Software Updates'. On the following dialog, select the 
-      'Available Software' tab and push the 'Add Site...' button. In the 
-      'Add Site' dialog, push the 'Archive...' button. Then, navigate to the
-      jbpm-gpd-site.zip file mentioned above and select it. Push 'OK' to 
-      come back to the 'Software Updates and Add-ons' dialog. Select the 
-      'jPDL 4 GPD Update Site' that has appeared and push the 'Install...' 
-      button. Eclipse will calculate the needed dependencies and open the 
-      'Install' dialog. Make sure both the 'Flow Common Feature' and the 
-      'jPDL 4 Feature' are selected and push the 'Next' button. On the 
-      next screen, select the 'Accept...' radio button and push 'Finish'
-      to complete the installation. Restart your Eclipse and you are all set.
+      mechanism and is pretty straightforward. There is an archived update 
+      site included in the runtime installation of jBPM when you unzip it 
+      at <literal>gpd/jbpm-gpd-site.zip</literal> 
+      </para>
+      <para>To add the update site to eclipse:
+      </para>
+      <itemizedlist>
+        <listitem><literal>Help</literal> --> <literal>Software Updates</literal></listitem> 
+        <listitem>Select tab <literal>Available Software</literal></listitem>
+        <listitem>Click <literal>Add Site...</literal> </listitem>
+        <listitem>In dialog <literal>Add Site</literal> dialog, click <literal>Archive...</literal></listitem>
+        <listitem>Navigate to <literal>gpd/jbpm-gpd-site.zip</literal></listitem>
+        <listitem>Clicking <literal>OK</literal> will bring you back to the dialog 'Software Updates and Add-ons'</listitem>
+        <listitem>Select the <literal>jPDL 4 GPD Update Site</literal> that has appeared</listitem>
+        <listitem>Click <literal>Install...</literal> </listitem>
+        <listitem>In dialog <literal>Install</literal>, select <literal>Flow Common Feature</literal> 
+          and <literal>jPDL 4 Feature</literal></listitem>
+        <listitem>Click <literal>Next</literal></listitem>
+        <listitem>Select <literal>Accept</literal> and click <literal>Finish</literal></listitem>
+        <listitem>Restart eclipse</listitem>
+      </itemizedlist>
     </section>
     <section>
-      <title>Workspace</title>
-      <para>In this section we will show you a possible setup of your 
-      workspace. This includes the definition of a user library containing
-      the dependencies that you might need while developing jPDL applications
-      and importing the examples from the distribution in a newly created 
-      project.</para>
-        <section>
-          <title>Define the jBPM User Library</title>
-          <para>This section shows how to define a library for your workspace
-          that contains the jBPM classes as well as its dependencies. If you
-          create a new Java project, it will be sufficient to add this user 
-          library to the build path of your project for things to compile 
-          smoothly.</para>
-          <para>Open the Eclipse preferences dialog and navigate to the
-          'Java->Build Path->User Libraries' page. Push the 'New...' button 
-          and choose a name e.g. 'jBPM Libraries'. Push the 'Add JARs...' 
-          button and navigate to the 'lib' folder within your jBPM installation.
-          Select all the jar files in this folder and push the 'Open' button 
-          to include them.</para>
-          <para>So far we have added all the jBPM dependencies.
-          Now let's add the jBPM classes themselves and attach the sources so 
-          we can easily navigate to them when we are debugging. Select the 
-          'jBPM Libraries' entry and push the 'Add JARs...' button again. 
-          This time select the jbpm.jar file in the root of your jBPM installation
-          and push the 'Open' button again. Next, select the 'Source attachment' 
-          entry under the jbpm.jar file that we just added and push the 'Edit...' 
-          button. The 'Source Attachment Configuration' dialog opens. Select the
-          'External Folder...' button and navigate to the 'src' folder in your
-          jBPM installation. Select 'Choose' and twice 'OK' to close all the open
-          dialogs.</para>
-          <para>Now that we have done all these steps we are ready to create 
-          projects and add this newly created user library to the build path of
-          these projects. Let's start doing this in the next section while 
-          importing the examples.</para>
-        </section>
-        <section>
-          <title>Importing the Examples</title>
-          <para>In this section we will create a Java project in our Eclipse 
-          workspace and import the jBPM examples that came with the distribution.</para>
-          <para>Bring up the 'New Java Project' wizard by selecting 
-          'File->New->Java Project'. Choose a name for your project, 
-          e.g. jbpm-examples and push the 'Finish' button. Next bring up the 
-          properties dialog for the newly created project by selecting it and 
-          choosing 'File->Properties...'. In this properties dialog, select the
-          'Java Build Path' page, then the tab 'Libraries' and push the
-          'Add Library...' button. The 'Add Library' wizard opens. Select  
-          'User Library' and push the 'Next >' button. On the following page
-          select the 'jBPM Libraries' entry and push finish. Push the 'OK' button
-          to close the properties dialog. We have successfully added the jBPM classes
-          and their dependencies to our newly created Java project. Next, let's 
-          import the examples.
-          <para>Select the 'src' folder in the jbpm-examples project and then the 
-          'File->Import...' menu. The 'Import' wizard opens. Select 
-          'General->File System' and push the 'Next >' button. 
-          On the following page, push the 'Browse...' button next to
-          the 'From directory' text field and navigate to the 'examples/src' folder
-          of your jBPM installation. Push the 'Choose' button to select it. Check
-          the checkbox next to the 'src' entry that appears. Also, make sure that the 
-          'Into folder' text field refers to the 'src' folder of the jbpm-examples 
-          project. Push the 'Finish' button to complete the import.
-          </para>
-          <para>That's it. Now you are ready to look at the examples and take it 
-          from there.</para>
-        </section>
+      <title>Define the jBPM User Library</title>
+      <para>This section shows how to define a user library for your workspace
+      that is a placeholder for the jBPM library as well as its dependencies. 
+      If you create a new Java project, it will be sufficient to add this user 
+      library to the build path.
+      </para>
+      <itemizedlist>
+        <listitem>Click <literal>Window</literal> --> <literal>Preferences</literal> </listitem>
+        <listitem>Select <literal>Java</literal> --> <literal>Build Path</literal> --> <literal>User Libraries</literal> </listitem>
+        <listitem>Click <literal>New...</literal> </listitem>
+        <listitem>Type name <literal>jBPM Libraries</literal> </listitem>
+        <listitem>Click <literal>Add JARs...</literal> </listitem>
+        <listitem>Navigate to the 'lib' folder of your jBPM installation</listitem>
+        <listitem>Select all jar files and click <literal>Open</literal> </listitem>
+        <listitem>Select the <literal>jBPM Libraries</literal> entry</listitem>
+        <listitem>Click <literal>Add JARs...</literal> again</listitem>
+        <listitem>Select the <literal>jbpm.jar</literal> file in the root of your jBPM installation</listitem>
+        <listitem>Click <literal>Open</literal> </listitem>
+        <listitem>Select entry <literal>Source attachment</literal> under <literal>jbpm.jar</literal> </listitem>
+        <listitem>Click <literal>Edit</literal> </listitem>
+        <listitem>In dialog <literal>Source Attachment Configuration</literal>, click <literal>External Folder...</literal> </listitem>
+        <listitem>Navigate to the <literal>src</literal> folder in your jBPM installation</listitem>
+        <listitem>Click <literal>Choose</literal> </listitem>
+        <listitem>Click <literal>OK</literal> twice to close all the open dialogs</listitem>
+      </itemizedlist>
     </section>
+    <section>
+      <title>Importing the Examples</title>
+      <para>In this section we will import the examples project in the 
+      installation in Eclipse
+      </para>
+      <itemizedlist>
+        <listitem>Select <literal>File</literal> --> <literal>Import...</literal> </listitem>
+        <listitem>Select <literal>General</literal> --> <literal>Existing Projects into Workspace</literal> </listitem>
+        <listitem>Click <literal>Next</literal></listitem>
+        <listitem>Click <literal>Browse...</literal> to select a root directory</listitem>
+        <listitem>Navigate to the jBPM root installation directory</listitem>
+        <listitem>Click <literal>OK</literal> </listitem>
+        <listitem>The <literal>examples</literal> project is automatically found and selected</listitem>
+        <listitem>Click <literal>Finish</literal> </listitem>
+      </itemizedlist>
+      <para>You're all set to start playing with the coolest Java process technology!</para>
+    </section>
   </section>
-
 </chapter>
\ No newline at end of file




More information about the jbpm-commits mailing list