[jbpm-commits] JBoss JBPM SVN: r3503 - in projects/spec/trunk: modules and 4 other directories.

do-not-reply at jboss.org do-not-reply at jboss.org
Mon Dec 22 10:36:59 EST 2008


Author: thomas.diesler at jboss.com
Date: 2008-12-22 10:36:59 -0500 (Mon, 22 Dec 2008)
New Revision: 3503

Added:
   projects/spec/trunk/modules/docs/
   projects/spec/trunk/modules/docs/pom.xml
   projects/spec/trunk/modules/docs/spec-requirements/
   projects/spec/trunk/modules/docs/spec-requirements/en/
   projects/spec/trunk/modules/docs/spec-requirements/en/images/
   projects/spec/trunk/modules/docs/spec-requirements/en/master.xml
   projects/spec/trunk/modules/docs/spec-requirements/en/modules/
   projects/spec/trunk/modules/docs/spec-requirements/en/modules/introduction.xml
   projects/spec/trunk/modules/docs/spec-requirements/pom.xml
Modified:
   projects/spec/trunk/pom.xml
Log:
Add docs

Added: projects/spec/trunk/modules/docs/pom.xml
===================================================================
--- projects/spec/trunk/modules/docs/pom.xml	                        (rev 0)
+++ projects/spec/trunk/modules/docs/pom.xml	2008-12-22 15:36:59 UTC (rev 3503)
@@ -0,0 +1,101 @@
+<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>
+
+  <name>JBoss BPM Spec - Documentation</name>
+  <groupId>org.jboss.bpm</groupId>
+  <artifactId>bpm-spec-docs</artifactId>
+  <packaging>pom</packaging>
+
+  <version>1.0.0-SNAPSHOT</version>
+
+  <parent>
+    <groupId>org.jboss.bpm</groupId>
+    <artifactId>bpm-spec</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+    <relativePath>../../pom.xml</relativePath>
+  </parent>
+
+  <!-- Modules -->
+  <modules>
+    <module>spec-requirements</module>
+  </modules>
+
+  <!-- Properties -->
+  <properties>
+    <translation>en-US</translation>
+  </properties>
+
+  <!-- Build -->  
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.jboss.maven.plugins</groupId>
+        <artifactId>maven-jdocbook-plugin</artifactId>
+        <version>2.0.0</version>
+        <extensions>true</extensions>
+        <dependencies>
+          <dependency>
+            <groupId>org.jboss</groupId>
+            <artifactId>jbossorg-docbook-xslt</artifactId>
+            <version>1.0.0</version>
+          </dependency>
+          <dependency>
+            <groupId>org.jboss</groupId>
+            <artifactId>jbossorg-jdocbook-style</artifactId>
+            <version>1.0.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>src/main/css</directory>
+          </cssResource -->
+          <formats>
+            <format>
+              <formatName>pdf</formatName>
+              <stylesheetResource>classpath:/xslt/org/jboss/main-pdf.xsl
+              </stylesheetResource>
+              <finalName>${pom.name}.pdf</finalName>
+            </format>
+            <format>
+              <formatName>html</formatName>
+              <stylesheetResource>classpath:/xslt/org/jboss/main-html.xsl
+              </stylesheetResource>
+              <finalName>index.html</finalName>
+            </format>
+            <format>
+              <formatName>html_single</formatName>
+              <stylesheetResource>classpath:/xslt/org/jboss/nochunk-html.xsl
+              </stylesheetResource>
+              <finalName>index.html</finalName>
+            </format>
+            <format>
+              <formatName>eclipse</formatName>
+              <stylesheetResource>classpath:/xslt/org/jboss/main-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>
+
+</project>
\ No newline at end of file


Property changes on: projects/spec/trunk/modules/docs/pom.xml
___________________________________________________________________
Name: svn:executable
   + *
Name: svn:keywords
   + Id Revision
Name: svn:eol-style
   + LF


Property changes on: projects/spec/trunk/modules/docs/spec-requirements
___________________________________________________________________
Name: svn:ignore
   + target


Added: projects/spec/trunk/modules/docs/spec-requirements/en/master.xml
===================================================================
--- projects/spec/trunk/modules/docs/spec-requirements/en/master.xml	                        (rev 0)
+++ projects/spec/trunk/modules/docs/spec-requirements/en/master.xml	2008-12-22 15:36:59 UTC (rev 3503)
@@ -0,0 +1,42 @@
+<?xml version='1.0' encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" "../../../../docbook-support/support/docbook-dtd/docbookx.dtd" [
+<!ENTITY introduction          SYSTEM "modules/introduction.xml">
+]>
+<book lang="en">
+  <bookinfo>
+    <title>JBoss BPM Specification</title>
+    <subtitle>A guide for BPM engine developers</subtitle>
+    <releaseinfo>1.0.0-Alpha2</releaseinfo>
+  </bookinfo>
+  <toc/>
+  <preface id="target" revision="1">
+    <title>Target Audience</title>
+    <para>JBoss.org BPM project leads who target the SOA Platform with their engine.</para>
+  </preface>
+  <preface id="preface" revision="1">
+    <title>Preface</title>
+    <para>This document introduces the  unified DocBook system for JBoss.org
+            documentation based on Maven2. Using this system provides the following benefits:</para>
+    <itemizedlist>
+      <listitem>
+        <para>The DocBook libraries and all other dependencies are stored in Maven plugins located in the <ulink url="http://repository.jboss.org/maven2">JBoss public maven repository</ulink>. This allows the entire build environment to be automatically downloaded and configured  from just a single <literal>pom.xml</literal> file stored in a project&apos;s <literal>docs</literal> directory.</para>
+      </listitem>
+      <listitem>
+        <para>Styles  are also stored in Maven plugins so that they can be managed from a central location. This allows updates to be automatically downloaded when new designs are created or bugs are fixed.</para>
+      </listitem>
+      <listitem>
+        <para>It provides a default style based on the JBoss.org community-driven theme that looks clean, fresh and modern.</para>
+      </listitem>
+      <listitem>
+        <para>Custom styles can easily be created for individual projects, or groups of related projects, to cater for different requirements.  For example some projects may have their own logos or wish to have collapsable menus at the start of each chapter. </para>
+      </listitem>
+      <listitem>
+        <para>The build process is simplified and standardized. Just
+                follow the instructions in this guide to setup your <literal>docs</literal>
+                directory and copy a very simple  <literal>pom.xml</literal> file. </para>
+      </listitem>
+    </itemizedlist>
+    <para>If you have any questions, please feel free to contact <ulink url="mailto:thomas.diesler at jboss.org">Thomas Diesler</ulink> (BPM Procuct Manager) for more information.</para>
+  </preface>
+&introduction;
+</book>


Property changes on: projects/spec/trunk/modules/docs/spec-requirements/en/master.xml
___________________________________________________________________
Name: svn:keywords
   + Id Revision
Name: svn:eol-style
   + LF

Added: projects/spec/trunk/modules/docs/spec-requirements/en/modules/introduction.xml
===================================================================
--- projects/spec/trunk/modules/docs/spec-requirements/en/modules/introduction.xml	                        (rev 0)
+++ projects/spec/trunk/modules/docs/spec-requirements/en/modules/introduction.xml	2008-12-22 15:36:59 UTC (rev 3503)
@@ -0,0 +1,25 @@
+<?xml version='1.0' encoding='UTF-8'?><chapter id="introduction">
+  <title>Introduction to DocBook processing</title>
+  <para>DocBook is an XML format for writing documents. It allows the author to
+        focus on the content itself during the writing process instead of
+        worrying about the presentation. </para>
+  <para>Using standard DocBook tags, we can tag the content according to
+        its syntatic structure. The DocBook document is then processed using
+        XSL stylesheets so that each tagged DocBook element is transformed to a
+        corresponding element in the target output format. For example each &lt;para&gt;&lt;/para&gt; element in DocBook could be transformed into a &lt;p&gt;&lt;/p&gt; element in XHTML. </para>
+  <para>Using different XSL stylesheets, we can generate different
+        output formats. For example, we can generate both XHTML and PDF outputs from
+        a single DocBook source. We can also generate multiple versions of XHTML
+        (or PDF) files each with a different  style if necessary.</para>
+  <para>In the JBoss DocBook system, we provide XSL stylesheets to build XHTML, PDF and Eclipse Help output formats from the DocBook source. The build process is
+        illustrated in <xref linkend="build.fig"/>. </para>
+  <figure id="build.fig">
+    <title>The DocBook build process </title>
+    <mediaobject>
+      <imageobject>
+        <imagedata align="center" fileref="images/build.png"/>
+      </imageobject>
+    </mediaobject>
+  </figure>
+  <para>XHTML is used  instead of HTML as it ensures  that the content is completely separated from  its style using Cascading Style Sheets (CSS) and image files.</para>
+</chapter>
\ No newline at end of file


Property changes on: projects/spec/trunk/modules/docs/spec-requirements/en/modules/introduction.xml
___________________________________________________________________
Name: svn:keywords
   + Id Revision
Name: svn:eol-style
   + LF

Added: projects/spec/trunk/modules/docs/spec-requirements/pom.xml
===================================================================
--- projects/spec/trunk/modules/docs/spec-requirements/pom.xml	                        (rev 0)
+++ projects/spec/trunk/modules/docs/spec-requirements/pom.xml	2008-12-22 15:36:59 UTC (rev 3503)
@@ -0,0 +1,17 @@
+<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>
+
+  <name>JBoss BPM Spec - Documentation Requirements</name>
+  <groupId>org.jboss.bpm</groupId>
+  <artifactId>bpm-spec-docs-requirements</artifactId>
+  <packaging>jdocbook</packaging>
+
+  <parent>
+    <groupId>org.jboss.bpm</groupId>
+    <artifactId>bpm-spec-docs</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+  </parent>
+
+</project>


Property changes on: projects/spec/trunk/modules/docs/spec-requirements/pom.xml
___________________________________________________________________
Name: svn:keywords
   + Id Revision
Name: svn:eol-style
   + LF

Modified: projects/spec/trunk/pom.xml
===================================================================
--- projects/spec/trunk/pom.xml	2008-12-22 15:32:37 UTC (rev 3502)
+++ projects/spec/trunk/pom.xml	2008-12-22 15:36:59 UTC (rev 3503)
@@ -1,29 +1,28 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<!-- ====================================================================== -->
-<!--                                                                        -->
-<!--  JBoss, the OpenSource J2EE webOS                                      -->
-<!--                                                                        -->
-<!--  Distributable under LGPL license.                                     -->
-<!--  See terms of license at http://www.gnu.org.                           -->
-<!--                                                                        -->
-<!-- ====================================================================== -->
+  <!-- ====================================================================== -->
+  <!--                                                                        -->
+  <!--  JBoss, the OpenSource J2EE webOS                                      -->
+  <!--                                                                        -->
+  <!--  Distributable under LGPL license.                                     -->
+  <!--  See terms of license at http://www.gnu.org.                           -->
+  <!--                                                                        -->
+  <!-- ====================================================================== -->
 
-<!-- $Id$ -->
+  <!-- $Id$ -->
 
-<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/maven-v4_0_0.xsd">
-         
+<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/maven-v4_0_0.xsd">
+
   <modelVersion>4.0.0</modelVersion>
 
   <name>JBoss BPM Spec</name>
   <groupId>org.jboss.bpm</groupId>
   <artifactId>bpm-spec</artifactId>
   <packaging>pom</packaging>
-  
+
   <version>1.0.0-SNAPSHOT</version>
-  
+
   <!-- Parent -->
   <parent>
     <groupId>org.jbpm</groupId>
@@ -37,18 +36,18 @@
     <module>modules/integration</module>
     <module>modules/cts</module>
   </modules>
-  
+
   <!-- Properties -->
   <properties>
     <log4j.version>1.2.14</log4j.version>
     <jbpm3.version>3.3.1-SNAPSHOT</jbpm3.version>
     <slf4j.version>1.5.3</slf4j.version>
   </properties>
-  
+
   <!-- DependencyManagement -->
   <dependencyManagement>
     <dependencies>
-      <!-- Please sort by groupid -->      
+      <!-- Please sort by groupid -->
       <dependency>
         <groupId>org.slf4j</groupId>
         <artifactId>slf4j-api</artifactId>
@@ -81,19 +80,22 @@
       <scope>test</scope>
     </dependency>
   </dependencies>
-  
+
   <scm>
-    <connection>scm:svn:http://anonsvn.jboss.org/repos/jbpm/projects/spec</connection>
-    <developerConnection>scm:svn:https://svn.jboss.org/repos/jbpm/projects/spec</developerConnection>
-    <url>http://fisheye.jboss.com/browse/JbpmSvn/projects/spec</url>
+    <connection>scm:svn:http://anonsvn.jboss.org/repos/jbpm/projects/spec
+    </connection>
+    <developerConnection>scm:svn:https://svn.jboss.org/repos/jbpm/projects/spec
+    </developerConnection>
+    <url>http://fisheye.jboss.com/browse/JbpmSvn/projects/spec
+    </url>
   </scm>
-  
+
   <!-- IssueManagement -->
   <issueManagement>
     <system>jira</system>
     <url>http://jira.jboss.org/jira/browse/JBPM</url>
   </issueManagement>
-  
+
   <!-- Licenses -->
   <licenses>
     <license>
@@ -101,24 +103,13 @@
       <url>http://repository.jboss.com/licenses/lgpl.txt</url>
     </license>
   </licenses>
-  
+
   <!-- DistributionManagement -->
   <distributionManagement>
     <!--
-      Add this to your ~/.m2/settings.xml 
-      <servers> 
-       <server> 
-        <id>jbpm.dyndns.org</id> 
-        <username>yourname</username>
-        <privateKey>/home/yourname/.ssh/id_rsa</privateKey> 
-        <passphrase>yourpass</passphrase> 
-       </server> 
-       <server> 
-        <id>snapshots.jboss.org</id> 
-        <username>yourname</username>
-        <password>yourpass</password> 
-       </server> 
-      </servers>
+      Add this to your ~/.m2/settings.xml <servers> <server> <id>jbpm.dyndns.org</id> <username>yourname</username>
+      <privateKey>/home/yourname/.ssh/id_rsa</privateKey> <passphrase>yourpass</passphrase> </server> <server>
+      <id>snapshots.jboss.org</id> <username>yourname</username> <password>yourpass</password> </server> </servers>
     -->
     <site>
       <id>jbpm.dyndns.org</id>
@@ -143,5 +134,19 @@
       </snapshots>
     </repository>
   </repositories>
-  
+
+  <!-- Profiles -->
+  <profiles>
+
+    <!--
+    Name:  release
+    Descr: Include release modules
+    -->
+    <profile>
+      <id>release</id>
+      <modules>
+        <module>modules/docs</module>
+      </modules>
+    </profile>
+  </profiles>
 </project>




More information about the jbpm-commits mailing list