[jbosstools-commits] JBoss Tools SVN: r11138 - in trunk/jbpm/docs: converter_ref and 3 other directories.

Author: Grid.Qian Date: 2008-10-24 04:41:43 -0400 (Fri, 24 Oct 2008) New Revision: 11138 Added: trunk/jbpm/docs/converter_ref/ trunk/jbpm/docs/converter_ref/en/ trunk/jbpm/docs/converter_ref/en/images/ trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_1.png trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_2.png trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_3.png trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_4.png trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_5.png trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_6.png trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_7.png trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_8.png trunk/jbpm/docs/converter_ref/en/master.xml trunk/jbpm/docs/converter_ref/en/modules/ trunk/jbpm/docs/converter_ref/en/modules/bpmn2jpdl.xml trunk/jbpm/docs/converter_ref/en/modules/overview.xml trunk/jbpm/docs/converter_ref/pom.xml Log: JBIDE-2982:add doc for bpmn ->jpdl Added: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_1.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_2.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_3.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_4.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_5.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_6.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_7.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_8.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/converter_ref/en/master.xml =================================================================== --- trunk/jbpm/docs/converter_ref/en/master.xml (rev 0) +++ trunk/jbpm/docs/converter_ref/en/master.xml 2008-10-24 08:41:43 UTC (rev 11138) @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" +"http://www.oasis-open.org/docbook/xml/4.3CR3/docbookx.dtd" + +[<!ENTITY overview SYSTEM "modules/overview.xml"> +<!ENTITY bpmn2jpdl SYSTEM "modules/bpmn2jpdl.xml"> +]> + +<book> + + <bookinfo> + <title>BPMN Convert User Guide</title> + <author&gt;&lt;firstname&gt;Grid&lt;/firstname&gt;&lt;surname&gt;Qian&lt;/surname&gt;&lt;email&gt;fqian(a)redhat.com&lt;/email&gt;&lt;/author&gt; + <pubdate>October 2008</pubdate> + <copyright> + <year>2008</year> + <holder>JBoss, a division of Red Hat Inc.</holder> + </copyright> + <releaseinfo> + Version: 3.0.0.beta1 + </releaseinfo> +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/bpmn_conve... version</ulink> + </para> +</abstract> + + + </bookinfo> + + <toc/> + &overview; + &bpmn2jpdl; +</book> Added: trunk/jbpm/docs/converter_ref/en/modules/bpmn2jpdl.xml =================================================================== --- trunk/jbpm/docs/converter_ref/en/modules/bpmn2jpdl.xml (rev 0) +++ trunk/jbpm/docs/converter_ref/en/modules/bpmn2jpdl.xml 2008-10-24 08:41:43 UTC (rev 11138) @@ -0,0 +1,143 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="bpmn2jpdl" > + <title>Translate a BPMN file to a JPDL file</title> + <para>In this chapter we provide you with the necessary steps to translate a BPMN file to a JPDL file.</para> + + <section id="createproject"> + <title>Creating a project</title> + <para>Before creating a bpmn file, you should have a Project created.</para> + <para>Create a project by + <emphasis><property>New > Project... > Project</property></emphasis> + . Enter the following information: + </para> + <itemizedlist> + <listitem> + <para>Project Name: test</para> + </listitem> + </itemizedlist> + <figure> + <title>A Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/bpmnconvert_bpmn2jpdl_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on the <property>Finish</property> button.</para> + </section> + + <section id="createbpmnfile"> + <title>Creating a bpmn file by STP BPMN editor</title> + <para>Create a bpmn diagram file by + <emphasis><property>New > Others... > Bpmn Diagram</property></emphasis> + . Enter the following information: + </para> + <itemizedlist> + <listitem> + <para>File Name: test</para> + </listitem> + </itemizedlist> + <figure> + <title>Create BPMN Diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/bpmnconvert_bpmn2jpdl_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on the <property>Finish</property> button.</para> + <para>Open the test.bpmn_diagram file by double-click it.</para> + <para>Draw the bpmn diagram using STP BPMN editor. If you do not know how to use STP BPMN editor, please go to web site: www.eclipse.org/stp to get the information about STP BPMN editor.</para> + </section> + + <section id="bpmntojpdl"> + <title>Exporting a bpmn file to some jpdl files</title> + <para>A BPMN file may include more than one pool. Every pool can be mapped to a corresponding JPDL file.</para> + <itemizedlist> + <listitem> + <para>Select 'test.bpmn' file and right-click it. Open the export wizard by + <emphasis><property>Export... > BPMN Export > BPMN -> JPDL</property></emphasis> + . + </para> + <figure> + <title>BPMN Export</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/bpmnconvert_bpmn2jpdl_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on the <property>Next</property> button.</para> + </listitem> + <listitem> + <para>Select the BPMN file that you want to translate. + </para> + <figure> + <title>Choose a BPMN file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/bpmnconvert_bpmn2jpdl_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on the <property>Next</property> button.</para> + </listitem> + <listitem> + <para>Select the Pools of BPMN that you want to translate. + </para> + <figure> + <title>Choose BPMN Pools</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/bpmnconvert_bpmn2jpdl_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on the <property>Next</property> button.</para> + </listitem> + <listitem> + <para>In this page, You may get error messages or warning messages that occured during the conversion. If no any messages, this page will be skipped. + </para> + <figure> + <title>Show Messages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/bpmnconvert_bpmn2jpdl_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on the <property>Next</property> button.</para> + </listitem> + <listitem> + <para>Select the target location to save the generated JPDL files. + </para> + <figure> + <title>Target Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/bpmnconvert_bpmn2jpdl_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Overwrite existing resources: if you don't want to overwrite existing resources, please keep uncheck this checkbox.</para> + </listitem> + </itemizedlist> + <para>Click on the <property>Finish</property> button.</para> + <para>Then the JPDL files are generated to the target location.</para> + </listitem> + </itemizedlist> + <para>The generated files look like this: </para> + <figure> + <title>The Generated JPDL Files</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/bpmnconvert_bpmn2jpdl_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + +</chapter> \ No newline at end of file Added: trunk/jbpm/docs/converter_ref/en/modules/overview.xml =================================================================== --- trunk/jbpm/docs/converter_ref/en/modules/overview.xml (rev 0) +++ trunk/jbpm/docs/converter_ref/en/modules/overview.xml 2008-10-24 08:41:43 UTC (rev 11138) @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="overview" revisionflag="overview"> + <title>BPMN Convert Overview</title> + + <para>JBoss BPMN Convert module is a tool. Users can use it to translate a BPMN file to something else.</para> + <para>The BPMN file may be written by hands or by some editors. In this guide, we use STP BPMN editor to draw a BPMN file.</para> + <para>As a part of JBoss tools, this module realizes BPMN -> JPDL translation. Users can get a basic JPDL file from a BPMN file by using this module.</para> + +</chapter> \ No newline at end of file Added: trunk/jbpm/docs/converter_ref/pom.xml =================================================================== --- trunk/jbpm/docs/converter_ref/pom.xml (rev 0) +++ trunk/jbpm/docs/converter_ref/pom.xml 2008-10-24 08:41:43 UTC (rev 11138) @@ -0,0 +1,102 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <groupId>org.jboss.tools</groupId> + <artifactId>converter-ref-guide${translation}</artifactId> + <version>1.0-SNAPSHOT</version> + <packaging>jdocbook</packaging> + <name>Converter_Reference_Guide</name> + + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.1.0-200803311251UTC-MPJDOCBOOK-8</version> + <extensions>true</extensions> + <dependencies> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-docbook-xslt</artifactId> + <version>1.1.0</version> + </dependency> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-jdocbook-style</artifactId> + <version>1.1.0</version> + <type>jdocbook-style</type> + </dependency> + </dependencies> + <configuration> + <sourceDocumentName>master.xml</sourceDocumentName> + <sourceDirectory>${pom.basedir}/en</sourceDirectory> + <imageResource> + <directory>${pom.basedir}/en</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + <cssResource> + <directory>${pom.basedir}/${cssdir}</directory> + </cssResource> + + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/pdf.xsl</stylesheetResource> + <finalName>${pom.name}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <!-- needed for uri-resolvers; can be ommitted if using 'current' uri scheme --> + <!-- could also locate the docbook dependency and inspect its version... --> + <docbookVersion>1.72.0</docbookVersion> + </options> + </configuration> + </plugin> + </plugins> + </build> + + <distributionManagement> + <repository> + <!-- Copy the dist to the local checkout of the JBoss maven2 repo ${maven.repository.root} --> + <!-- It is anticipated that ${maven.repository.root} be set in user's settings.xml --> + <!-- todo : replace this with direct svn access once the svnkit providers are available --> + <id>repository.jboss.org</id> + <url>file://${maven.repository.root}</url> + </repository> + <snapshotRepository> + <id>snapshots.jboss.org</id> + <name>JBoss Snapshot Repository</name> + <url>dav:https://snapshots.jboss.org/maven2</url> + </snapshotRepository> + </distributionManagement> + + <properties> + <stylesdir>../../../documentation/jbosstools-docbook-xslt/src/main/resources/</stylesdir> + <cssdir>../../../documentation/jbosstools-jdocbook-style/src/main/org/css/</cssdir> + <translation>en-US</translation> + </properties> + +</project>