Interne Dokumentation

Nutzerdokumentation - oder wo finde ich was?

Die einzelnen Pakete werden jeweils in den Formaten PostScript, PDF und HTML freigegeben. Die Pakete sind jeweils mit gzip gepackt, die HTML Variante zus�tzlich mit tar. So k�nnen sie ausgepackt werden:
PostScript/PDF: gunzip paketname-0.1.ps.gz
HTML: gunzip <paketname-html-0.1.tar.gz | tar -xvf -

Die jeweils neuesten Pakete finden sich auf http://sourceforge.net/project/showfiles.php?group_id=17898 .

Zus�tzlich liegt dort auch immer eine Variante im original LaTeX-Format (paketname-source-x.y.tar.gz). Einige dieser Pakete ben�tigen zus�tzlich das Meta-Paket, das einige Makros enth�lt, die sich alle Pakete teilen. Mit dem Kommando make kann man aus den Quellen die unterschiedlichen Varianten erstellen.

Alles weitere in unserer FAQ.

Autorendoku - wie hier was funktioniert

Dies ist die Dokumentation f�r alle neu hinzugekommenen Autoren, damit sie nicht die ganze Arbeit, die wir schon gemacht haben wiederholen m�ssen...

Auch f�r andere Leute, die mit Texten (speziell LaTeX-Dokumenten) zu tun haben k�nnte hier einiges stehen...

Das Meta-Paket

Im Meta-Paket (CVS-Repository meta) befinden sich einige Text-Dateien und Makros, die sich als recht n�tzlich erweisen k�nnen.

Hier eine kurze Auflistung:

COPYING: die GNU FDL im Textformat

fdl.tex: die GNU FDL als TeX-Datei

make.template: ein fast vollst�ndiges Makefile, es enth�lt Regeln, mit denen beliebige TeX-Dateien �bersetzt werden k�nnen (mehr dazu in Geteilte B�cher). Man kann diese Datei via "include" in eigene Makefile's einbinden.

book.tcl: TCL/TK Script, mit dem mehrere Kapitel zu einem Buch zusammengefasst werden (siehe Geteilte B�cher).

addrem.sh: einfaches Shell-Script, das je nach Namen anders reagiert. Es ist f�r die Arbeit mit CVS gedacht, wenn keine st�ndige Verbindung zum Internet/CVS-Server besteht. Als add.sh merkt es Dateien f�r das Hinzuf�gen vor. Als remove.sh werden Dateien zum L�schen vorgemerkt. Als addrem.sh wird cvs aufgerufen und die add bzw. remove Operationen werden durchgef�hrt. Das hat den Vorteil, dass man sich nicht alle neuen oder gel�schten Dateien merken muss. make.template enth�lt eine Regel link, die die Links add.sh und remove.sh auf addrem.sh anlegt, und die Regel addrem, die addrem.sh aufruft. replace.tcl: liest eine Datei an standard in ein und gibt sie auf standard out wieder aus, jedoch werden alle �'s, �'s, �'s und �'s durch die entsprechenden LaTeX-Makros aus dem german-Paket ersetzt ("a, "o, "u und "s).

Geteilte B�cher

Mit Hilfe der Dateien des Meta-Paketes ist es m�glich eine Reihe von Artikeln sowohl als zusammenh�ngendes Buch, als auch als einzelne Artikel zu erzeugen. Dazu ist nicht allzu viel n�tig.

TeX-Quelltext der einzelnen Kapitel/Artikel:
Ein Artikel ist nach Definition der Makros dieses Pakets gleich einer .tex-Datei. Als eine der ersten Zeilen sollte jeder Artikel eine Zeile \title{Artikel"uberschrift} enthalten. Je nach Modus wird diese unterschiedlich interpretiert. Nehmen wir an die Artikel-Datei heisst beispiel.tex.

Um aus beispiel.tex einen �bersetzten Artikel zu machen wird einfach make beispiel.ps (oder .pdf oder .html) aufgerufen. Als Zwischenschritt erzeugt das Makefile eine Datei _beispiel.tex, in der die \title-Zeile in den Header gewandert ist und als Dokumentenklasse article angegeben wurde.

Um das komplette Buch zu erstellen wird make book.ps (oder...) aufgerufen. in diesem Fall wird \title durch \chapter ersetzt.

Eine Erweiterung auf das Kommando \author ist geplant, die ist jedoch etwas komplizierter...

book.list:
Ein Buch wird durch eine Beschreibungsdatei zusammengesetzt. Diese Datei ist eigentlich nichts weiter, als ein Tcl-Skript, dass �ber Umwege von book.tcl aufgerufen wird, es gelten also die Syntax-Regeln von Tcl. Man kann es sich hier recht einfach machen, wenn man sich merkt: jede Zeile ist ein Befehl und Text-Argumente werden durch geschweifte Klammern { } umschlossen. Beispiel:

pass {\mainmatter}
part Shell
load bash.tex
load cmd1.tex
load cmd2.tex
 
pass {\backmatter}
part Anh\"ange
load literatur.tex
load ../meta/fdl.tex

Dies ist die Version aus shell (Stand: 20.1.2001). Der Befehl pass gibt den enthaltenen Text so wie er ist aus. part erzeugt eine Part-�berschrift (TeX: \part{...}). load l�dt die angegebene Datei und ersetzt \title durch \chapter. F�r jeden Autor enthalten diese Dateien ein eigenes \author-Tag (im Gegensatz zu normalem LaTeX, wo alle Autoren in einem Tag aufgef�hrt werden), das Script setzt diese \author-tags dann zusammen.

Makefile:
Das Makefile des jeweiligen Buches braucht nichts weiter zu tun, als per include make.template einzubinden (Achtung: es wird davon ausgegangen, dass meta in der selben Verzeichnishierarchie liegt, wie das Verzeichnis des Buches). Beispiel:

all: ps
 
include ../meta/make.template

Standardm��ig wird hier also book.ps erzeugt...

Prolog:
(Nein, nicht die Sprache.) Man kann zus�tzliche Informationen in den Header von Artikeln oder B�chern schreiben, da Makefile nach prolog-Dateinen sucht und diese einbindet. Die Datei prolog wird in beiden F�llen einbezogen, prolog.book nur in das Buch und prolog.article nur in Artikel. Auf diese Art lassen sich zum Beispiel zus�tziche Pakete einbinden oder Schriftgr��en �ndern.

Start:
In den Dateien start, start.book und start.article k�nnen Befehle und Text gespeichert werden, die unmittelbar nach dem \begin{document} stehen sollen.

Ja wo laufen sie denn? - Wie hier alles abl�uft.

Wie im FAQ schon steht werden Bug- und Patch-Manager verwendet, um Fehler und Korrekturen zu organsieren. Also schaut bitte ab und zu dort vorbei und bearbeitet Eure Fehler...

Bug-Manager
Patch-Manager

Themenvorschl�ge k�nnen im Task-Manager gemacht werden, tragt dort bitte auch ein was Ihr gerade bearbeitet. So wird doppelte Arbeit vermieden: Task Manager: Themen.

Bitte sprecht die �bernahme von Themen aber vorher in der Mailliste (lugddlect-main) ab.