cvs commit: de-www/de-bsd-www dokubau.sgml

From: Johann Kois <jkois(at)doc.bsdgroup.de>
Date: Fri, 8 Jan 2010 20:09:15 GMT

jkois 2010-01-08 20:09:15 UTC

FreeBSD German Documentation Repository

  Modified files:
    de-bsd-www dokubau.sgml
  Log:
  Komplette Neufassung der Seite "Die Dokumentation bauen".

  Revision Changes Path
  1.5 +111 -41 de-www/de-bsd-www/dokubau.sgml

  Index: dokubau.sgml
  ===================================================================
  RCS file: /home/cvs/de-www/de-bsd-www/dokubau.sgml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -I$FreeBSDde.*$ -r1.4 -r1.5
  --- dokubau.sgml 29 Aug 2007 04:49:19 -0000 1.4
  +++ dokubau.sgml 8 Jan 2010 20:09:15 -0000 1.5
  @@ -24,47 +24,117 @@
         englischen Baum ab, da sich nur dort die notwendigen
         Bilder befinden.</p>

  - <p>Damit die Bauwerkzeuge die notwendigen Verzeichnisse
  - finden, müssen Variablen wie <em>DOC_PREFIX</em>
  - gesetzt werden. Ein anderer Weg ist es, in dem oben
  - erstellen Verzeichnisbaum symbolische Links auf
  - die Verzeichnisse des offiziellen Baums zu erstellen.
  - Anschließend lässt sich die Dokumentation
  - mit dem Kommando <em>make</em> bauen.</p>
  -
  - <p>Im Dokumentationsbaum wird nur das Verzeichnis
  - <tt class="FILENAME">share</tt> benötigt:</p>
  -
  -
  - <pre>% cd de-repo/doc
  -% ln -s ~/texte/doc/share
  -% cd de_DE.ISO8859-1
  -% make</pre>
  -
  - <p>Die Website benötigt unter anderem noch das
  - englische Verzeichnis:</p>
  -
  - <pre>% cd de-repo/www
  -% ln -s ~/texte/www/share
  -% ln -s ~/texte/www/tools
  -% ln -s ~/texte/www/en
  -% ln -s ~/texte/www/Makefile
  -% ln -s ~/texte/www/Makefile.inc
  -% cd de
  -% make</pre>
  -
  - <p>Dieses Beispiel setzt voraus, dass sich der
  - Dokumentationsbaum im Verzeichnis
  - <tt class="FILENAME">~/texte/doc</tt> und die
  - Website im Verzeichnis
  - <tt class="FILENAME">~/texte/www</tt> befinden.</p>
  -
  - <p>Die deutschen Release-Notes befinden sich unterhalb
  - des Dokumentationsverzeichnisses im Verzeichnis
  - <tt class="FILENAME">relnotes</tt>.
  - Die darin enthaltene Datei
  - <tt class="FILENAME">LIESMICH</tt>
  - erklärt den Bau der Release-Notes.</p>
  + <h3>Installation des Metaports docproj</h3>
  +
  + <p>Damit die Dokumentation/die Website gebaut werden kann,
  + muss zuerst der Metaport
  + <tt class="FILENAME">textproc/docproj</tt>
  + installiert werden. Diesen Port gibt es in zwei Varianten,
  + <tt class="FILENAME">docproj-nojadetex</tt> sowie
  + <tt class="FILENAME">docproj-jadetex</tt> (Die zweite
  + Variante benötigen Sie nur dann, wenn Sie die
  + Dokumentation auch als Postscript- bzw. PDF-Version
  + bauen wollen.):</p>
  +
  + <pre># cd /usr/ports/textproc/docproj-nojadetex
  +# make install clean</pre>
  +
  + <p>Durch die Installation dieses Metaports werden
  + automatisch alle zum Bau der Dokumentation/der
  + Website benötigten Programme installiert.</p>
  +
  + <h3>Anlegen der zum Bau nötigen Verzeichnisse</h3>
  +
  + <p>Die folgenden Anweisungen setzen voraus, dass sich die Inhalte
  + des deutschen Repository im Verzeichnis
  + <tt class="FILENAME">~/texte/de-repo</tt>, das ausgecheckte
  + FreeBSD.org-doc-Repository im Verzeichnis
  + <tt class="FILENAME">~/texte/doc</tt> und das ausgecheckte
  + FreeBSD.org-www-Repository im Verzeichnis
  + <tt class="FILENAME">~/texte/www</tt> befinden:</p>
  +
  + <pre>$ mkdir -p ~/texte/de-repo/doc
  +$ mkdir ~/texte/de-repo/www
  +$ mkdir ~/texte/doc
  +$ mkdir ~/texte/www</pre>
  +
  + <h3>Auschecken der Module des deutschen Repository</h3>
  +
  + <p>Im deutschen Repository finden sich zwei Module,
  + <tt class="FILENAME">de-docproj</tt> sowie
  + <tt class="FILENAME">de-www</tt>. Diese müssen zuerst
  + ausgecheckt werden, da die Arbeit an der deutschen Dokumentation
  + bzw. den deutschen Webseiten in einem separaten
  + CVS-Repository erfolgt.
  + Dazu in das Verzeichnis
  + <tt class="FILENAME">~/texte/de-repo</tt> wechseln und die
  + beiden Module auschecken. Wie das funktioniert, ist
  + ebenfalls auf der Seite <a
  + href="./repo.html">CVS-Repository</a> beschrieben.</p>
  +
  + <h3>Auschecken der Module aus dem FreeBSD.org-Repository</h3>
  +
  + <p>Es macht Sinn, die zum Bau der Dokumentation/der Website
  + nötigen Sourcen in einem seperatem lokalen Repository
  + vorzuhalten. Dazu müssen über cvsup (das im
  + Basissystem enthaltene csup ist dafür nicht geeignet)
  + die Module <tt class="FILENAME">doc-all</tt> sowie
  + <tt class="FILENAME">www</tt> von einem FreeBSD-cvsup-Server
  + synchronisiert werden.</p>
  +
  + <p>Diese Module müssen danach noch lokal ausgecheckt werden,
  + um die Dokumentation/die Website bauen zu können (es wird
  + dabei davon ausgegangen, dass diese Module nach
  + <tt class="FILENAME">/home/cvsup</tt> synchronisiert
  + wurden):</p>
  +
  + <pre>$ cd ~/texte/
  +$ cvs -d /home/cvsup/ checkout doc
  +$ cvs -d /home/cvsup/ checkout www</pre>
  +
  + <p>Eine Anleitung zur Benutzung von cvsup findet sich im
  + Kapitel <a
  + href="https://doc.bsdgroup.de/doc/de_DE.ISO8859-1/books/handbook/cvsup.html">Benutzen von CVSup</a>
  + des &os;-Handbuchs. Zur Konfiguration von cvsup werden zwei
  + Dateien benötigt, eine <tt
  + class="filename">supfile</tt>-Datei (die festlegt, welche
  + Dateien wohin heruntergeladen werden sollen) sowie
  + eine <tt class="filename">refuse</tt>-Datei (die festlegt,
  + welche Dateien NICHT heruntergeladen werden sollen). Der
  + Einsatz einer refuse-Datei macht Sinn, da ohne diese die
  + Quelldateien für alle verfügbaren Sprachen
  + heruntergeladen werden, obwohl für die Arbeit an der
  + deutschen Dokumentation nur die englischen und deutschen
  + Quelldateien benötigt werden.</p>
  +
  + <p>Um die Quelldateien für die Module <tt
  + class="FILENAME">doc-all</tt> sowie <tt
  + class="FILENAME">www</tt> wie weiter oben beschrieben zu
  + synchronisieren, sollte die supfile-Datei beispielweise
  + den folgenden Inhalt haben:</p>
  +
  + <pre>*default host=cvsup.de.FreeBSD.org
  +*default base=/home/cvslog/
  +*default prefix=/home/cvsup/
  +*default release=cvs delete use-rel-suffix
  +*default umask=0002
  +*default compress
  +
  +www
  +doc-all</pre>
  +
  + <h3>Die Dokumentation bauen</h3>
  +
  + <p>Der Bau der Dokumentation kann nur im ausgecheckten
  + FreeBSD.org-Repository gestartet werden, da das deutsche
  + Repository nicht alle dazu nötigen Dateien enthält.
  + Um beispielweise die komplette deutsche Dokumentation zu bauen
  + (und nach <tt class="FILENAME">/usr/share/doc</tt> zu installieren),
  + geben Sie die folgenden Befehle ein:</p>
  +
  + <pre># cd ~/texte/doc/de_DE.ISO8859-1
  +# make clean && make && make lint && make install</pre>
  +
   &footer;
   </body>
   </html>

To Unsubscribe: send mail to majordomo(at)de.FreeBSD.org
with "unsubscribe de-cvs-doc" in the body of the message
Received on Fri 08 Jan 2010 - 21:09:31 CET