1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet
href="urn:x-daps:xslt:profiling:docbook45-profile.xsl"
type="text/xml"
title="Profiling step"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd"
[<!ENTITY % entities SYSTEM "entity-decl.ent">
%entities;
]>
<chapter id="cha.daps.user.create">
<title>Creating a Project From Scratch</title>
<abstract>
<para>
The easiest way to set up a new documentation project from scratch is to
use <command>daps-init</command>. This initialization script
automatically creates the key files and directory structure you need to
get started with &dapsacr;.
</para>
</abstract>
<para>
It generates:
</para>
<itemizedlist>
<listitem>
<para>
the
<xref linkend="sec.daps.user.oview.dirstruct" xrefstyle="select:title"/>
required by &dapsacr;,
</para>
</listitem>
<listitem>
<para>
an example
<xref linkend="sec.daps.user.oview.docproject.dc" xrefstyle="select:title"/>,
and
</para>
</listitem>
<listitem>
<para>
an example
<xref linkend="sec.daps.user.oview.docproject.main" xrefstyle="select:title"/>
that you can use as a starting point for your documentation.
</para>
</listitem>
</itemizedlist>
<para>
By default, the initialization script creates a <sgmltag>article</sgmltag> as
example document. With the <option>--rootelement</option> option, you can also set
another root element, such as an <sgmltag>book</sgmltag> or a <sgmltag>set</sgmltag>, for example.
</para>
<procedure>
<step>
<para>
To create the default directory structure (containing an example
<sgmltag>book</sgmltag>), enter the following on a command line:
</para>
<screen>daps-init -d <replaceable>PATH_TO_DIRECTORY</replaceable></screen>
<para>
Alternatively, enter the following to create the default directory
structure with an <sgmltag>article</sgmltag> example:
</para>
<screen>daps-init -d <replaceable>PATH_TO_DIRECTORY</replaceable> -r article</screen>
</step>
<step>
<para>
If the specified directory does not exists, &dapsacr; asks if to create
it. Proceed by pressing <keycap>y</keycap>.
</para>
</step>
<step>
<para>
Check your working directory for the new files: The text file
<filename>DC-daps-example</filename> is annotated and gives you a rough
idea which options can be defined in a <filename>DC</filename> file. For
having a look at the XML source code of the <sgmltag>book</sgmltag> or
<sgmltag>article</sgmltag>, change to the <filename>xml</filename>
subdirectory and open the file
<filename>MAIN-DC-daps-example.xml</filename> in a text or XML editor.
</para>
</step>
<step>
<para>
To see what the output of the XML example file looks like, follow the
instructions printed by the initialization script. For example, enter:
</para>
<screen>daps -d <replaceable>PATH_TO_DIRECTORY</replaceable>/DC-daps-example color-pdf</screen>
<para>
This command specifies the <filename>DC*</filename> file to use for the
document and the output format to create. For creation of the PDF,
&dapsacr; uses FOP by default (if no other formatter is specified) and
applies the default DocBook stylesheets (if no custom layout options are
defined). Find the generated PDF in your documentation directory in
<filename>/build/daps-example/daps-example_en.pdf</filename>.
</para>
</step>
</procedure>
<para>
This was only a brief introduction to the most basic &dapsacr; features.
In the following chapters, learn how &dapsacr; can support you in editing,
managing images and creating more output formats than just PDF or HTML.
</para>
</chapter>
|
