DLHP Autor HOWTO: Grundlagen

2. Grundlagen

2.1 Wie kann ich mich am DLHP beteiligen?

Wenn Sie selbst eine HOWTO übersetzen oder eine eigene schreiben möchten, erreichen Sie den Koordinator des DLHP unter:

Internet: Budde@tu-harburg.de
Fido: Marco Budde@2:240/6298.5

Um sicherzustellen, daß nicht eine HOWTO von mehreren Leuten bearbeitet wird, müssen Sie dem Koordinator unbedingt zuerst mitteilen, welche HOWTO Sie bearbeiten wollen, bevor Sie anfangen.

Wenn Sie eine englische HOWTO übersetzen möchten, können Sie sich selbst eine aussuchen, die Sie bearbeiten möchten. Gehen Sie dabei folgendermaßen vor:

Suchen Sie sich eine interessante HOWTO von folgendem Server aus:
metalab.unc.edu:/pub/Linux/docs/howto
Schauen Sie in DE-HOWTO nach, ob diese HOWTO nicht bereits übersetzt wurde oder sich gerade in Arbeit befindet.
Teilen Sie dem Koordinator die ausgesuchte HOWTO mit.

Nach einiger Zeit sollte Ihre HOWTO dann auch in DE-HOWTO auftauchen. Falls dieses nicht der Fall ist, der Koordinator kann ja auch mal was vergessen :), weisen Sie den Koordinator unbedingt darauf hin.

2.2 Was tun nach der Übersetzung?

Fertige HOWTOs schicken Sie dem Koordinator bitte per E-Mail an seine E-Mail-Adresse. Schicken Sie bitte nur den SGML-Source, den sie vorher mit gzip komprimiert haben, im MIME base64 Format. Bitte achten Sie unbedingt auf die Komprimierung.

Bedenken Sie bitte, daß auch die Zeit des Koordinators begrenzt ist und er nicht die Zeit hat, bei jeder HOWTO Formatierungs- und SGML-Fehler zu beseitigen. Lesen Sie am besten, bevor Sie den Source abschicken, noch einmal diese HOWTO vollständig durch und überprüfen Sie, ob Sie nichts vergessen haben.

Testen Sie also unbedingt vorher, ob sich Ihr Source in alle verwendeten Format ohne Fehler übersetzen läßt und ob die Formatierung der hier beschriebenen entspricht. Zum Test können Sie folgenden Makefile benutzen:

http://www.tu-harburg.de/FTP/tools/Makefile

Denken Sie bitte an die Klärung des Copyrights; siehe Copyright der HOWTOs.

Nachdem Sie Ihre HOWTO abgeschickt habe, schreiben Sie bitte zuerst keine weiteren Updates. Der DLHP-Maintainer wird die eingehenden Versionen überprüfen und eventuelle Fehler beseitigen. Dieser Prozeß kann - gerade bei der ersten Version - einige Zeit dauern. Sie können diesen Prozeß dadurch beschleunigen, daß Sie sich von Anfang an möglichst genau an die Ratschläge in dieser HOWTO halten.

Nachdem die HOWTO vom DLHP-Maintainer bearbeitet worden ist, wird sie auf unserer Homepage veröffentlicht. Benutzen Sie dann bitte den auf der Homepage gespeicherten SGML-Source Ihrer HOWTO für spätere Updates. Und schauen Sie sich mal mit


diff -u <ihre version.sgml> <fertige version.sgml>

die Änderungen an, die der DLHP-Maintainer an Ihrem Text vorgenommen hat. Dieses kann hilfreich sein, um die gleichen Fehler bei späteren Updates nicht wieder einzubauen.

2.3 sgml-tools

Zur Formatierung der HOWTOs wird das Programmpaket sgml-tools verwendet. Dieses Paket erlaubt es, mittels einer SGML-Quelldatei die Formate HTML, ASCII, LaTeX (DVI), Postscript und Adobe Acrobat (PDF) zu erzeugen.

Die Verwendung der sgml-tools bietet sich an, da man so leicht verschiedene Formate erzeugen kann und alle HOWTOs dadurch ähnlich aussehen.

Die verwendete Version 1.0.9 der sgml-tools liegt den meisten Linux Distributionen als Paket bei. Ansonsten ist das Programm hier zu bekommen:

http://www.sgmltools.org

Auf keinen Fall kann die Version 2.x benutzt werden, da diese völlig inkompatibel zur alten ist und noch nicht ausgereift ist.

Speziell für das DLHP gibt es einen Patch für die sgml-tools, der hier zu finden ist:

http://www.tu-harburg.de/dlhp/tools/

Diese Version enthält einige Bugfixes, ein verbessertes Aussehen der formatierten Dokumente und PDF-Support. Damit der PDF-Support fehlerfrei funktioniert, muß Ghostscript in mindestens Version 4.x und teTeX in mindestens der Version 0.9 auf dem Rechner installiert sein.

2.4 Vorlagen

Für die Übersetzung einer HOWTO empfiehlt es sich, den SGML Source der entsprechenden HOWTO von

metalab.unc.edu:/pub/Linux/docs/howto/other-formats/sgml/

zu beziehen und als Grundlage für die Übersetzung zu verwenden.

Hierbei sollte man jedoch unbedingt beachten, daß die LDP HOWTOs auf einer anderen Formatierungsrichtlinie beruhen. Man kann also nicht einfach die bestehende Formatierung übernehmen, sondern muß diese eventuell an die in diesem Dokument beschriebene anpassen.

2.5 Copyright der HOWTOs

Wenn Sie eine englische HOWTO übersetzen, überprüfen Sie bitte das Copyright der englischen HOWTO. Die HOWTOs des DLHP sollen möglichst alle der GNU General Public License unterliegen.

Falls das beim Original nicht der Fall sein sollte, fragen Sie bitte beim Autor nach, ob wir die deutsche Version unter der GPL verbreiten können. Und fragen Sie den Autor wirklich und ändern Sie nicht einfach nur die Lizenz. Bei Urheberrechtsverstössen haftet der Übersetzer und nicht das DLHP! Leiten Sie bitte eine Kopie der Erlaubnis an der Koordinator weiter.

Die HOWTO sollte irgendwo in der Einleitung - meistens das erste Kapitel - einen Copyright Hinweis wie den folgenden enthalten:


<sect1>Copyright
<p>

Dieses Dokument ist urheberrechtlich geschützt. Das Copyright für 
die englische <em/AX25 HOWTO/, auf der dieses Dokument basiert, 
liegt bei Terry Dawson. Das Copyright für die deutsche Version 
liegt bei Gerd Röthig und Marco Budde.

Das Dokument darf gemäß der GNU <em><htmlurl url="DE-GPL.html"
name="General Public License"></em> verbreitet werden. 
Insbesondere bedeutet dieses, daß der Text sowohl über
elektronische wie auch physikalische Medien ohne die Zahlung von 
Lizenzgebühren verbreitet werden darf, solange dieser 
Copyright-Hinweis nicht entfernt wird. Eine kommerzielle Verbreitung 
ist erlaubt und ausdrücklich erwünscht. Bei einer Publikation in 
Papierform ist das Deutsche Linux HOWTO Projekt hierüber zu 
informieren.

Hierbei sollten alle Leute, die mehr als einen Satz zu dem Dokument beigetragen haben, erwähnt werden.

Sollten Sie keine HOWTO übersetzen, sondern eine eigene schreiben, so verwenden Sie bitte auch die GNU GPL. Denn zu einem freien Betriebssystem gehört auch eine freie Dokumentation.

2.6 SGML Header

Jedes SGML Dokument beginnt mit einem Header wie dem folgendem:


<!--
  Dieser SGML Source kann mit dem Programmpaket sgml-tools 1.0.x in
  die Formate TXT, HTML, DVI, Postscript und PDF umgewandelt werden.
  Bei allen Konvertern muß die Option "-c latin -l de" 
  verwendet werden.

  Deutsches Linux HOWTO Projekt
     http://www.tu-harburg.de/dlhp/
-->

<!doctype linuxdoc system>

<article>

<title>Linux foo HOWTO
<author>Name1 (<tt>name1@foo.org</tt>) und
        Name2 (<tt>name2@foo.org</tt>)
<date>v1.0, 1. April 1998
<abstract>
kurze Inhaltsangabe, hoechstens drei Zeilen
</abstract>

<toc>

[ ... ]

</article>

Als Autor sollte der Autor der englischen HOWTO (Name1) und der Übersetzer (Name2) angegeben werden. Unter <date> wird die Versionsnummer gefolgt vom Datum angegeben. Falls es sich um eine reine Übersetzung handelt, kann die Versionsnummer des Originals verwendet werden. Als Datum wird nicht das Datum des Originals verwendet, sondern das der Erstellung der Übersetzung.

2.7 Umlaute

Die Umlaute sollen in den formatierten Dokumenten in der Form »ü« und nicht in der Form »ue« erscheinen. Die sgml-tools bieten zwei Möglichkeiten, die Umlaute einzugeben:

Latin-1 Zeichensatz (8 Bit): ü
HTML Form (7 Bit): ü

Wenn möglich, sollte die erste Möglichkeit gewählt werden.

2.8 SGML-Sourcen

Achten Sie bitte darauf, daß Ihr SGML-Source vernünftig lesbar ist.

Dazu gehört es z.B., daß die Zeilen nach spätestens 80 Zeichen umgebrochen werden. Bei langen URLs oder ähnlichen Dinge kann natürlich eine Ausnahme gemacht werden. Fließtext wird nicht akzeptiert, da sich dieser nicht vernünftig lesen und bearbeiten läßt.

Fügen Sie zwischen den einzelnen Abschnitten ruhig ein paar Leerzeilen ein. Auch ansonsten schaden Leerzeilen der Lesbarkeit nicht.