Chapter 4. Hello World-Project

The standard directory structure is as follows:

The Common directory: contains all libraries and tools required for the project. The contents is always the same and independent of the project contents.


	This is not fully right as the layout of the documents with XSL style sheet is defined here.

The Build directory: contains the batch file for calling Ant: make.bat (or their UNIX variant make.sh), the file build.xml, which controls the building and the directory with the source documents: xml.

The XML directory: contains all XML files which make up the actual document or book. For „Hello World“ one file is sufficient.

The build file for ant looks like follows:

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE project [
         <!ENTITY common "../common">
         <!ENTITY buildcommon SYSTEM "../common/build_common.xml">
]>
<project name="HelloWorld" default="html" basedir="."> 
         <property name="lang" value="de"/>
         <target name="postprocess"/>
         <property name="project" value="HelloWorld"/>
         <property name="javahome" value="..."/>
         <property name="fileversion" value="1.0"/> 
&buildcommon;
</project>

This file only determines the project name and which document types will be generated as a standard.

	Defines project name and standard target (here html).
	Defines the project properties. Here the project name which is required as a variable in the shared control file for Ant `build_common.xml`.

Only missing is the contents; here the file HelloWorld.xml which is saved in the XML directory.

For the simplest HelloWorld this is only:

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"../../common/docbook/dtd/docbookx.dtd">
<article lang="de">
 <articleinfo>
     <title>Hello World</title>
     <author>
       <firstname>Stefan</firstname>
       <surname>Rinke</surname>
     </author>
 </articleinfo>
 <section>
     <title>Hello World</title>
     <para>That's all.</para>
 </section>
</article>

Now we have everything we need for the first test. After having installed all tools, it should not be a problem to structure your fist project. If the following is returned:

make all
 BUILD SUCCESSFUL
Total time: 11 seconds

the dist directory under build should now contain all formats of the Hello World document created just now.

DocBook Publishing

Chapter 4. Hello World-Project