Projekt

Allgemein

Profil

« Zurück | Weiter » 

Revision 3adb0cb7

Von Moritz Bunkus vor fast 13 Jahren hinzugefügt

  • ID 3adb0cb772af4bcdbd867b5688b3e02356a2e613
  • Vorgänger c4184d54
  • Nachfolger 1c103b3a

doc/skr04-update-3804 nach DocBook gewandelt

Unterschiede anzeigen:

doc/html/ch04s06.html
1 1 
<html><head>
2 2 
      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 
   <title>4.6. Dokumentation erstellen</title><link rel="stylesheet" type="text/css" href="style.css"><meta name="generator" content="DocBook XSL Stylesheets V1.76.1-RC2"><link rel="home" href="index.html" title="Lx-Office: Installation, Konfiguration, Entwicklung"><link rel="up" href="ch04.html" title="Kapitel 4. Entwicklerdokumentation"><link rel="prev" href="ch04s05.html" title="4.5. Stil-Richtlinien"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.6. Dokumentation erstellen</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch04s05.html">Zur?ck</a>&nbsp;</td><th width="60%" align="center">Kapitel 4. Entwicklerdokumentation</th><td width="20%" align="right">&nbsp;</td></tr></table><hr></div><div class="sect1" title="4.6. Dokumentation erstellen"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="devel.build-doc"></a>4.6. Dokumentation erstellen</h2></div></div></div><div class="sect2" title="4.6.1. Einf?hrung"><div class="titlepage"><div><div><h3 class="title"><a name="devel.build-doc.introduction"></a>4.6.1. Einf?hrung</h3></div></div></div><p>
4 
       Diese Dokumentation ist in <span class="productname">DocBook</span>&#8482; XML geschrieben. Zum Bearbeiten reicht grunds?tzlich ein
5 
       Text-Editor. Mehr Komfort bekommt man, wenn man einen dedizierten XML-f?higen Editor nutzt, der spezielle Unterst?tzung f?r
6 
       <span class="productname">DocBook</span>&#8482; mitbringt. Wir empfehlen daf?r den <a class="ulink" href="http://www.xmlmind.com/xmleditor/" target="_top">XMLmind XML
7 
       Editor</a>, der bei nicht kommerzieller Nutzung kostenlos ist.
8 
      </p></div><div class="sect2" title="4.6.2. Ben?tigte Software"><div class="titlepage"><div><div><h3 class="title"><a name="devel.build-doc.required-software"></a>4.6.2. Ben?tigte Software</h3></div></div></div><p>
9 
       Bei <span class="productname">DocBook</span>&#8482; ist Prinzip, dass ausschlie?lich die XML-Quelldatei bearbeitet wird. Aus dieser werden dann
10 
       mit entsprechenden Stylesheets andere Formate wie PDF oder HTML erzeugt. Bei Lx-Office ?bernimmt diese Aufgabe das Shell-Script
11 
       <span class="command"><strong>scripts/build_doc.sh</strong></span>.
12 
      </p><p>
13 
       Das Script ben?tigt zur Konvertierung verschiedene Softwarekomponenten, die im normalen Lx-Office-Betrieb nicht ben?tigt werden:
14 
      </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
15
16 
                     <a class="ulink" href="http://www.oracle.com/technetwork/java/index.html" target="_top">Java</a> in einer halbwegs aktuellen Version
17 
        </p></li><li class="listitem"><p>
18 
         Das Java-Build-System <a class="ulink" href="http://ant.apache.org/" target="_top">Apache Ant</a>
19
20 
                  </p></li><li class="listitem"><p>
21 
         Das Dokumentations-System Dobudish f?r <span class="productname">DocBook</span>&#8482; 4.5, eine Zusammenstellung diverser Stylesheets und
22 
         Grafiken zur Konvertierung von <span class="productname">DocBook</span>&#8482; XML in andere Formate. Das Paket, das ben?tigt wird, ist zum
23 
         Zeitpunkt der Dokumentationserstellung <code class="filename">dobudish-nojre-1.1.4.zip</code>, aus auf <a class="ulink" href="http://code.google.com/p/dobudish/downloads/list" target="_top">code.google.com</a> bereitsteht.
24 
        </p></li></ul></div><p>
25 
       Apache Ant sowie ein dazu passendes Java Runtime Environment sind auf allen g?ngigen Plattformen verf?gbar. Beispiel f?r
26 
       Debian/Ubuntu:
27 
      </p><pre class="programlisting">apt-get install ant openjdk-7-jre</pre><p>
28 
       Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis <code class="filename">doc/build</code> entpackt werden. Beispiel unter der
29 
       Annahme, das <span class="productname">Dobudish</span>&#8482; in <code class="filename">$HOME/Downloads</code> heruntergeladen wurde:
30 
      </p><pre class="programlisting">cd doc/build
31 
unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</pre></div><div class="sect2" title="4.6.3. PDFs und HTML-Seiten erstellen"><div class="titlepage"><div><div><h3 class="title"><a name="devel.build-doc.build"></a>4.6.3. PDFs und HTML-Seiten erstellen</h3></div></div></div><p>
32 
       Die eigentliche Konvertierung erfolgt nach Installation der ben?tigten Software mit einem einfachen Aufruf direkt aus dem
33 
       Lx-Office-Installationsverzeichnis heraus:
34 
      </p><pre class="programlisting">./scripts/build_doc.sh</pre></div><div class="sect2" title="4.6.4. Einchecken in das Git-Repository"><div class="titlepage"><div><div><h3 class="title"><a name="devel.build-doc.repository"></a>4.6.4. Einchecken in das Git-Repository</h3></div></div></div><p>
35 
       Sowohl die XML-Datei als auch die erzeugten PDF- und HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass nach
36 
       ?nderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut und alles zusammen in einem Commit eingecheckt werden sollten.
37 
      </p><p>
38 
       Die "<code class="filename">dobudish</code>"-Verzeichnisse bzw. symbolischen Links geh?ren hingegen nicht in das Repository.
39 
      </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch04s05.html">Zur?ck</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch04.html">Nach oben</a></td><td width="40%" align="right">&nbsp;</td></tr><tr><td width="40%" align="left" valign="top">4.5. Stil-Richtlinien&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Zum Anfang</a></td><td width="40%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html>
3 
   <title>4.6. Dokumentation erstellen</title><link rel="stylesheet" type="text/css" href="style.css"><meta name="generator" content="DocBook XSL Stylesheets V1.76.1-RC2"><link rel="home" href="index.html" title="Lx-Office: Installation, Konfiguration, Entwicklung"><link rel="up" href="ch04.html" title="Kapitel 4. Entwicklerdokumentation"><link rel="prev" href="ch04s05.html" title="4.5. Stil-Richtlinien"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.6. Dokumentation erstellen</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch04s05.html">Zur?ck</a>&nbsp;</td><th width="60%" align="center">Kapitel 4. Entwicklerdokumentation</th><td width="20%" align="right">&nbsp;</td></tr></table><hr></div><div class="sect1" title="4.6. Dokumentation erstellen"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="devel.build-doc"></a>4.6. Dokumentation erstellen</h2></div></div></div><div class="sect2" title="4.6.1. Einf?hrung"><div class="titlepage"><div><div><h3 class="title"><a name="devel.build-doc.introduction"></a>4.6.1. Einf?hrung</h3></div></div></div><p>Diese Dokumentation ist in <span class="productname">DocBook</span>&#8482;
4 
        XML geschrieben. Zum Bearbeiten reicht grunds?tzlich ein Text-Editor.
5 
        Mehr Komfort bekommt man, wenn man einen dedizierten XML-f?higen
6 
        Editor nutzt, der spezielle Unterst?tzung f?r
7 
        <span class="productname">DocBook</span>&#8482; mitbringt. Wir empfehlen daf?r den
8 
        <a class="ulink" href="http://www.xmlmind.com/xmleditor/" target="_top">XMLmind XML
9 
        Editor</a>, der bei nicht kommerzieller Nutzung kostenlos
10 
        ist.</p></div><div class="sect2" title="4.6.2. Ben?tigte Software"><div class="titlepage"><div><div><h3 class="title"><a name="devel.build-doc.required-software"></a>4.6.2. Ben?tigte Software</h3></div></div></div><p>Bei <span class="productname">DocBook</span>&#8482; ist Prinzip, dass
11 
        ausschlie?lich die XML-Quelldatei bearbeitet wird. Aus dieser werden
12 
        dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
13 
        erzeugt. Bei Lx-Office ?bernimmt diese Aufgabe das Shell-Script
14 
        <span class="command"><strong>scripts/build_doc.sh</strong></span>.</p><p>Das Script ben?tigt zur Konvertierung verschiedene
15 
        Softwarekomponenten, die im normalen Lx-Office-Betrieb nicht ben?tigt
16 
        werden:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
17 
                     <a class="ulink" href="http://www.oracle.com/technetwork/java/index.html" target="_top">Java</a>
18 
            in einer halbwegs aktuellen Version</p></li><li class="listitem"><p>Das Java-Build-System <a class="ulink" href="http://ant.apache.org/" target="_top">Apache Ant</a>
19 
                  </p></li><li class="listitem"><p>Das Dokumentations-System Dobudish f?r
20 
            <span class="productname">DocBook</span>&#8482; 4.5, eine Zusammenstellung
21 
            diverser Stylesheets und Grafiken zur Konvertierung von
22 
            <span class="productname">DocBook</span>&#8482; XML in andere Formate. Das
23 
            Paket, das ben?tigt wird, ist zum Zeitpunkt der
24 
            Dokumentationserstellung
25 
            <code class="filename">dobudish-nojre-1.1.4.zip</code>, aus auf <a class="ulink" href="http://code.google.com/p/dobudish/downloads/list" target="_top">code.google.com</a>
26 
            bereitsteht.</p></li></ul></div><p>Apache Ant sowie ein dazu passendes Java Runtime Environment
27 
        sind auf allen g?ngigen Plattformen verf?gbar. Beispiel f?r
28 
        Debian/Ubuntu:</p><pre class="programlisting">apt-get install ant openjdk-7-jre</pre><p>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
29 
        <code class="filename">doc/build</code> entpackt werden. Beispiel unter der
30 
        Annahme, das <span class="productname">Dobudish</span>&#8482; in
31 
        <code class="filename">$HOME/Downloads</code> heruntergeladen wurde:</p><pre class="programlisting">cd doc/build
32 
unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</pre></div><div class="sect2" title="4.6.3. PDFs und HTML-Seiten erstellen"><div class="titlepage"><div><div><h3 class="title"><a name="devel.build-doc.build"></a>4.6.3. PDFs und HTML-Seiten erstellen</h3></div></div></div><p>Die eigentliche Konvertierung erfolgt nach Installation der
33 
        ben?tigten Software mit einem einfachen Aufruf direkt aus dem
34 
        Lx-Office-Installationsverzeichnis heraus:</p><pre class="programlisting">./scripts/build_doc.sh</pre></div><div class="sect2" title="4.6.4. Einchecken in das Git-Repository"><div class="titlepage"><div><div><h3 class="title"><a name="devel.build-doc.repository"></a>4.6.4. Einchecken in das Git-Repository</h3></div></div></div><p>Sowohl die XML-Datei als auch die erzeugten PDF- und
35 
        HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
36 
        nach ?nderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
37 
        und alles zusammen in einem Commit eingecheckt werden sollten.</p><p>Die "<code class="filename">dobudish</code>"-Verzeichnisse bzw.
38 
        symbolischen Links geh?ren hingegen nicht in das Repository.</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch04s05.html">Zur?ck</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch04.html">Nach oben</a></td><td width="40%" align="right">&nbsp;</td></tr><tr><td width="40%" align="left" valign="top">4.5. Stil-Richtlinien&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Zum Anfang</a></td><td width="40%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html>

Auch abrufbar als: Unified diff