[jbpm-commits] JBoss JBPM SVN: r3326 - jbpm4/trunk/modules/userguide/src/main/docbook/en/modules.
do-not-reply at jboss.org
do-not-reply at jboss.org
Wed Dec 10 20:10:40 EST 2008
Author: koen.aers at jboss.com
Date: 2008-12-10 20:10:40 -0500 (Wed, 10 Dec 2008)
New Revision: 3326
Modified:
jbpm4/trunk/modules/userguide/src/main/docbook/en/modules/ch01-Introduction.xml
jbpm4/trunk/modules/userguide/src/main/docbook/en/modules/ch02-Installation.xml
Log:
Add gpd specifics to chapter 1 and 2 of the docs
Modified: jbpm4/trunk/modules/userguide/src/main/docbook/en/modules/ch01-Introduction.xml
===================================================================
--- jbpm4/trunk/modules/userguide/src/main/docbook/en/modules/ch01-Introduction.xml 2008-12-10 20:44:50 UTC (rev 3325)
+++ jbpm4/trunk/modules/userguide/src/main/docbook/en/modules/ch01-Introduction.xml 2008-12-11 01:10:40 UTC (rev 3326)
@@ -52,6 +52,10 @@
The developers guide explains more advanced customization options that
are not supported.
</para>
+ <para>TODO ?Explain what is meant by supported? Shouldn't it be clear to user's that it is more
+ geared towards extenders? That they can use it but that there is no guarantee of infinite stability?
+ END TODO
+ </para>
</section>
<section id="processdefinitionprocessinstanceandexecutions">
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-10 20:44:50 UTC (rev 3325)
+++ jbpm4/trunk/modules/userguide/src/main/docbook/en/modules/ch02-Installation.xml 2008-12-11 01:10:40 UTC (rev 3326)
@@ -56,29 +56,115 @@
</section>
<section id="eclipse">
- <title>Eclipse</title>
- <para>TODO</para>
+ <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
+ the GPD.</para>
<section>
- <title>Graphical Process Designer (GPD)</title>
- <para>TODO</para>
+ <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>
</section>
<section>
- <title>In an existing eclipse</title>
- <para>TODO</para>
+ <title>GPD Installation</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.
</section>
<section>
- <title>Let the installer download eclipse</title>
- <para>TODO</para>
- </section>
- <section>
<title>Workspace</title>
- <para>TODO: Koen, can we make an existing workspace
- part of the distro and then put some examples in there ?
- Then users just have to point their eclipse to the
- workspace in our distro and they have the examples with
- the projects and classpaths ready to go.
- We would have to put some workspace in our svn...
- </para>
+ <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>
</section>
</section>
More information about the jbpm-commits
mailing list