Weiter Inhalt

3. Formatierung

3.1 FTP Adressen

Eine FTP Adresse soll im Dokument immer in der Form

sunsite.unc.edu:/pub
auftauchen. Die Form
ftp://sunsite.unc.edu/pub
findet keine Verwendung.

Meistens soll die FTP Adresse im HTML Dokument auch anklickbar sein. Im SGML Source würde man also folgendes verwenden:

<tscreen><htmlurl url="ftp://sunsite.unc.edu/pub"
                  name="sunsite.unc.edu:/pub"></tscreen>

Das <tscreen> sorgt dafür, daß die Zeile in Typewriter Schrift und in einer seperaten Zeile dargestellt wird. Dieses ist sinnvoll, da es ansonsten zu Umbruchproblemen in der LaTeX Version kommen kann. Falls es sich um eine sehr kurze Adresse handelt, kann statt dessen auch <tt> benutzt werden.

3.2 HTTP Adressen

HTTP Adressen sehen fast genauso wie die FTP Adressen aus. Auch hier findet meistens <tscreen> statt <tt> Verwendung:

<tscreen><htmlurl url="http://www.foo.de/foo/"
          name="http://www.foo.de/foo/"></tscreen>

Falls Sie wie in diesem Beispiel nur das Verzeichnis und nicht auch den Dateinamen (z.B. index.html) angeben, achten Sie bitte darauf, daß das letzte Zeichen ein Slash ist. Hierdurch wird unnötiger HTTP Verkehr vermieden.

3.3 Mailadressen

Eine EMail Adresse wird meistens in folgender Form gesetzt:

Thomas Mustermann (<tt><htmlurl url="mailto:tm@entenhausen.de"
                   name="tm@entenhausen.de"></tt>)

3.4 Dokumente

Falls Sie im Text auf andere Dokumente verweisen, schließen Sie den Titel bitte in <em> ein.

Verweise auf andere HOWTOs sollten auf jeden Fall anklickbar sein. Falls es sich bei der anderen HOWTO um eine HOWTO handelt, die bereits als deutsche Übersetzung existiert, wird ein relativer Link benutzt. Ein Link auf die PPP HOWTO würde also z.B. so aussehen:

<em><htmlurl url="DE-PPP-HOWTO.html" name="PPP HOWTO"></em>

Beachten Sie bitte, daß PPP HOWTO ohne Bindestrich geschrieben wird!

Falls der Link auf eine englische HOWTO gehen soll, benutzt man einen Link auf die sunsite:

<em><htmlurl url="http://sunsite.unc.edu/LDP/HOWTO/PPP-HOWTO.html"
             name="PPP HOWTO"></em>

3.5 Listings, Kommandozeile

Listings und Beispiele für die Eingabe werden mit <tscreen><verb> formatiert. Die <code> Umgebung wird nicht benutzt.

Bei Listings sollten unbedingt auch die Kommentare im Listing ins Deutsche übersetzt werden. Gehen Sie immer davon aus, daß der Leser kein Wort Englisch versteht :).

Da die sgml-tools Probleme mit Umlauten in der obigen Umgebung haben, muß auf diese hier verzichtet werden. Achten Sie unbedingt auf die Zeilenlänge. Mehr als 60-70 Zeichen sollte eine Zeile auf keinen Fall enthalten. Sonst gibt es in der ASCII und der Druckversion Probleme.

3.6 Referenzen im Dokumenten

Bei Verwendung des <label>-Befehls, sorgen Sie bitte dafür, daß Ihre Labels nicht mit den in anderen DLHP-Dokumenten kollidieren. Am einfachsten wird dieses dadurch erreicht, daß jedes Label mit dem Dateinamen des Dokumentes beginnt. Das kann dann z.B. so aussehen:

<label id="DE-Autor-HOWTO-label1">

3.7 Indexbefehle

Die Befehle zur Erstellung eines Indexes <idx>, <cdx>, <nidx> und <ncdx> dürfen nur in Absprache mit dem Koordinator verwendet werden. In den meisten Fällen brauchen Sie sich um diese Befehle garnicht kümmern, da der Koordinator Ihrem Dokument an sinnvollen Stellen diese Befehle hinzufügen wird, wenn das Dokument veröffentlicht wird.

3.8 Fachbegriffe übersetzen?

Fachbegriffe werden nur dann übersetzt, wenn eine deutsche Übersetzung existiert, die sich wirklich durchgesetzt hat. So kann z.B. user gut mit Benutzer oder floppy mit Diskette übersetzt werden.

Es geht jedoch auf keinen Fall darum, neue übersetzte Fachbegriffe mit einer Übersetzung zu schaffen! Als Leser möchte ich nicht zuerst jeden Fachbegriff ins Englische zurückübersetzen, um zu verstehen, was überhaupt gemeint war. Sowas wie Laufzeitbinder für linker oder Kellerspeicher für stack sollte auf keinen Fall verwendet werden.


Weiter Inhalt