File: daps_user_deploy.xml

package info (click to toggle)
daps 3.3.2%2Bcleaned1-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,540 kB
  • sloc: xml: 9,773; sh: 3,059; python: 1,322; lisp: 380; makefile: 239
file content (103 lines) | stat: -rw-r--r-- 3,265 bytes parent folder | download | duplicates (3)
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
103
<?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.deploy">
 <title>Packaging and Deploying Your Documentation</title>
 <abstract>
  <para>
   This chapter covers the following topics:
   <itemizedlist>
    <listitem>
     <para>
      Creating TAR archives with all source files, including graphics
     </para>
    </listitem>
    <listitem>
     <para>
      Generating distributable HTML archives
     </para>
    </listitem>
    <listitem>
     <para>
      Generating page, desktop, or document files to integrate 
      your documentation in KDE and GNOME desktop environments.
     </para>
    </listitem>
   </itemizedlist>
  </para>
 </abstract>
 <para> For distributing your output formats in a convenient way, &dapsacr;
  can automatically create TAR archives of the XML sources (including graphics)
  and various output formats. &dapsacr; uses
   <literal>bz2</literal> for high compression of the archives and keeps the
  directory structure when generating the TAR archives. </para>
 
 <para>
  Create source packages, HTML or PDF TAR archives with
  the <command>daps package-*</command> commands. By adding the respective
  options, you can additionally create page files, document files or desktop
  files for GNOME or KDE desktop environments.
 </para>

 
 <sect1 id="sec.daps.user.deploy.src">
  <title>Creating a TAR Archive with All Sources (Including Graphics)</title>

  <para>
   Use the following command to create a distributable TAR archive containing
   the sources of the complete set, including the graphics:
  </para>

<screen>&prompt.user;&dapscmd; -d&nbsp;<replaceable>PATH_TO_&dc;_FILE</replaceable> package-src</screen>
 </sect1>
 <sect1 id="sec.daps.user.deploy.html">
  <title>Generating a Distributable HTML Archive</title>

  <para>
   To generate HTML output and to automatically pack the HTML files, any
   graphics, and your CSS file into a TAR archive, use the following command:
  </para>

<screen>&prompt.user;&dapscmd; -d <replaceable>PATH_TO_DC_FILE</replaceable> package-html</screen>
  </sect1>

  <sect1 id="sec.daps.user.deploy.desktops">
  <title>Generating Desktop, Document, or Page Files</title>

  <para>
   To create files that you can use for the help system of the GNOME and KDE
   desktop environments, use one of the following options:
  </para>

  <itemizedlist>
   <listitem>
    <para>
     For the GNOME help system Yelp: <option> --pagefiles</option>
    </para>
   </listitem>
   <listitem>
    <para>
     For former Yelp versions: <option> --documentfiles</option>
    </para>
   </listitem>
   <listitem>
    <para>
     For the KDE3 help system: <option> --desktopfiles</option>
    </para>
   </listitem>
  </itemizedlist>

  <para>
   For example, to create a distributable HTML archive plus the files for
   GNOME yelp, use the following command:
  </para>

<screen>&prompt.user;&dapscmd; -d <replaceable>PATH_TO_DC_FILE</replaceable> package-html --pagefiles</screen>
 </sect1>
</chapter>