Build jbpm User Guide documents

Build jbpm user guide document jbpm User Guide docbook build instructions

Directory

1. Build a jbpm user guide document

1.1. Build. xml file in the jbpm User Guide

1.2. Where can I obtain docbook-support/support. xml?

1.3. Why did the PDF version fail to be generated?

1.4. compile other language versions

1.5. Appendix: Glossary

1.5.1. html

1.5.2. xml

1.5.3. DTD

1.5.4. docbook

1.5.5. XSL

1.5.6. PDF

Chapter 5 build a jbpm user guide document 1st. Build. xml file of the jbpm User Guide

The contents of the jbpm.3/src/userguide/build. xml file are as follows:

<project name="jbpm.3.documentation" default="all.doc" basedir=".">

  <property name="build.dir" value="${basedir}/../../build/userguide"/>
  <property name="pdf.name"  value="jboss-jbpm.pdf" />
  <import file="../../../docbook-support/support.xml" />

  <target name="all.doc" depends="clean">
    <mkdir dir="en/images" /> 
    <antcall target="lang.all"><param name="lang" value="en"/></antcall>
  </target>

  <target name="html.doc" description="creates the html docs only and opens a browser">
    <mkdir dir="en/images" /> 
    <antcall target="lang.dochtml"><param name="lang" value="en"/></antcall>
    <exec executable="C:/Program Files/Internet Explorer/IEXPLORE.EXE" os="Windows XP,Windows 2000,Windows 98">
      <arg value="file://${basedir}/../../build/userguide/en/html/index.html" />
    </exec>
  </target>

</project>

In the eclipse environment, right-click it and select run mode/ant build. ../Docbook-support/support. XML is not found.

1.2. Where can I obtain docbook-support/support. xml?

Connecting to the JBoss CVS server:

:pserver:anonymous@anoncvs.forge.jboss.com:/cvsroot/jboss

Select head/docbook-support (Note: An error will be reported if I have obtained the/docbook-support jboss_4_0_4_rc2), right-click and select Check-out as, and set the directory to the same level as jbpm.3.

After checking out, select jbpm.3/src/userguide/build. XML, right-click the menu and choose run mode/ant build. After the build, you can find the compiled documents in jbpm.3/build/userguide. The compiled documents include the HTML paging version, single-page version, and PDF version, but the PDF version is not successfully generated.

1.3. Why did the PDF version fail to be generated?

We can see in the eclipse console:

     [java] Making portrait pages on USletter paper (8.5inx11in)
     [java] Error: no ID for constraint linkend: processcompositioningop.

This indicates that the link processcompositioningop is not found in the document.

Open jbpm.3/src/userguide/en/modules/Gop. XML, search for processcomposition of row 497th, change processcompositioningop, and build again. After the build, you can view the newly generated jboss-jbpm.pdf in the jbpm.3/build/userguide/en/pdf directory.

1.4. compile other language versions

In the jbpm.3/src/userguide directory, you can also see a directory de, German version. Now we are building a German version.

Modify the content in jbpm.3/src/userguide/build. XML as follows:

<project name="jbpm.3.documentation" default="all.doc" basedir=".">

  <property name="build.dir" value="${basedir}/../../build/userguide"/>
  <property name="pdf.name"  value="jboss-jbpm.pdf" />
  <import file="../../../docbook-support/support.xml" />

  <target name="all.doc" depends="clean">
    <mkdir dir="en/images" /> 
    <antcall target="lang.all"><param name="lang" value="en"/></antcall>
    <mkdir dir="de/images" /> 
    <antcall target="lang.all"><param name="lang" value="de"/></antcall>
  </target>

  <target name="html.doc" description="creates the html docs only and opens a browser">
    <mkdir dir="en/images" /> 
    <antcall target="lang.dochtml"><param name="lang" value="en"/></antcall>
<!--     <exec executable="C:/Program Files/Internet Explorer/IEXPLORE.EXE" os="Windows XP,Windows 2000,Windows 98">
      <arg value="file://${basedir}/../../build/userguide/en/html/index.html" />
    </exec>-->
    <mkdir dir="de/images" /> 
    <antcall target="lang.dochtml"><param name="lang" value="de"/></antcall>
  </target>

</project>

Build error. The error message in the console is:

E:/java/workspace/docbook-support/support.xml:159: E:/java/workspace/docbook-support/styles/de not found.

The style file is not found.

Open docbook-support/styles. Only the EN (English version) is displayed. Copy the en and rename it to the De to the docbook-support/styles directory. Rebuild.

Build error. The error message in the console is:

     [java] Error on line 33 column 4 of file:/E:/java/workspace/jbpm.3/src/userguide/de/master.xml:
     [java] Error reported by XML parser: Cannot read from file:/E:/java/workspace/jbpm.3/src/userguide/de/modules/Konfiguration.xml (E:/java/workspace/jbpm.3/src/userguide/de/modules/Konfiguration.xml (The system cannot find the file specified))

Konfiguration. xml cannot be found, and the konfiguration. XML in jbpm.3/src/userguide/DE/master. XML is removed as follows:

<!--
<!ENTITY Konfiguration SYSTEM "modules/Konfiguration.xml">
-->
<!-- &Konfiguration; -->

Rebuild. After the build, you can see the compiled document in the jbpm.3/build/userguide/DE/directory, which includes the HTML paging version, single-page version, and PDF version respectively.

1.5. Appendix: Glossary 1.5.1. html

Hyper Text Markup Language ). Is the standard format of web pages. In fact, an HTML file is a plain text file that contains many HTML tags and enclosed texts, such as "& lt; BR & gt;" & lt; HR & gt; "" & lt; Table & gt ;... & lt;/table & gt; "" & lt; font & gt ;... & lt;/font & gt; ", the Web browser displays the text marked in HTML in different formats based on these tags.

1.5.2. xml

Extensible Markup Language ). It is the next generation Internet standard that people expect. On the surface, XML is like HTML, and there are many tags and tag pairs. The difference is:

• More Strict and unified syntax

• In the end, we need to define how tags are embedded and organized.

• What is the meaning of the mark and how the software should handle the mark need to be defined separately

The last two points are the reason why XML is "extensible.

1.5.3. DTD

Document Type Definition ). It is a file format that defines the content of an XML document, such as "containing tags, how to nest tags, and how to organize tags.

1.5.4. docbook

A set of XML-based specifications, that is, a set of defined XML tags. It includes a DTD and a document docbook: the definitive guide. The DTD defines the structure of this format, that is, "How to embed tags and how to organize tags ". Docbook: the definitive guide explains what the meaning of the tag is defined in the DTD, and how the software processes the tag. You can find the tag at http://www.docbook.org/tdg/en.

1.5.5. XSL

Extensible Stylesheet Language ). It consists of two parts: XSLT (XSL transformation) and fo (formatting object), which are also XML-based standards. The extension name of An XSLT file is generally XSL, which describes how to convert a set of labeled XML files to generate other formats of documents, such as HTML and XML files with another set of tags. The suffix of an FO file is generally fo, which describes how to display text. It is similar to an HTML file, but its description format is richer.

1.5.6. PDF

Portable Document Format ). The release of Adobe features that any printable document can be converted to this file format. Is the de facto standard for transferring documents on the Internet.