Index: freexp/doc/snapshot.dq
===================================================================
RCS file: /server/cvs/freexp/doc/snapshot.dq,v
retrieving revision 1.56
retrieving revision 1.57
diff -u -r1.56 -r1.57
--- freexp/doc/snapshot.dq 1 Nov 2005 07:14:21 -0000 1.56
+++ freexp/doc/snapshot.dq 11 Nov 2005 14:36:17 -0000 1.57
@@ -1,29 +1,54 @@
>>% Aufruf: Docform snapshot.dq snapshot.txt 71 3 -p -t### -kSnapshot
------
- - Die Breite 71 wirkt sich praktisch nur auf das Inhaltsverzeichnis und einen
- kurzen formatierten Textteil zu Supportadressen am Anfang aus.
- - Einzeilenkommentare sind in diesem Text für die Kurzversion der Einträge
- reserviert und können zum Beispiel mit xgrep und sed extrahiert werden:
- Bsp: xgrep "^%" snapshot.dq | sed s/%// > Extrakt.Txt
- Denselben Zweck erfüllt das kleine Pascal-Programm SNAPX.EXE, daß
Einzeilen-
- Kommentare - mit vorangestellten "%" aus der Snapshot.DQ filtert.
- - ALLE Kommentare, die bei späterer Formatierung unsichtbare Kommentare
bleiben,
- (wie dieser hier) sind daher immer als Mehrzeilen-Kommentare zu markieren.
- - Der formatierte Textteil zu Anfang wird nur im Flattersatz formatiert
- (s. Textauszeichnung ">>0").
- - Nach der Teilnehmerliste ist der Text *manuell* zu formatieren, da er als
- eine endlose und vor Formatierung geschützte Tabelle verstanden wird
- (s. nicht geschlossen Tabellentag "<<T" vor Entwickler und aktiv
Mitwirkende)
- - Zudem gibt es kein Tabellenverzeichnis am Ende, weil - derzeit- keine
benamten
- Tabellen in diesem Text vorkommen.
- - Querverweise in Kommentaren sind nicht möglich (wäre zudem sinnlos,
- da SNAPX keine Seitenformatierung bei seiner Ausgabe erzeugt).
- - Querverweise in Tabellen mit ">>T" sind ebenfalls generell ausgeschlossen.
- Querverweis-Einträge in solcher Tabelle erfordern daher eine Unterbrechung
+
+ Hinweise zur Formatierung
+ -------------------------
+ * Die gewählte Breite 71 wirkt sich praktisch nur auf das Inhaltsverzeichnis
+ und einen kurzen formatierten Textteil zu Supportadressen am Anfang aus.
+ Der formatierte Textteil zu Anfang wird automatisch und aus optischen
+ Gründen nur im Flattersatz formatiert (s. Textauszeichnung ">>0").
+ * Nach der Teilnehmerliste ist der Text *manuell* zu formatieren. Spätestens
+ ab Spalte 72 wird ein manueller Umbruch empfohlen.
+ (Dieser Textteil wird von DocForm als eine endlose und vor Formatierung
+ geschützte Tabelle behandelt, wegen des nicht geschlossen Tabellentags
+ "<<T" vor Entwickler und aktiv Mitwirkende).
+ * Die Abstände von Überschriften zum vorhergehenden Text sind frei zu wählen!
+ (Den Abstand danach zum folgenden Text legt DocForm selbst fest, eine
+ Leerzeile nach der Überschrift dient lediglich der Lesbarkeit der .DQ.)
+ - Vor Hauptüberschriften wurden hier 4 Leerzeilen Abstand gewählt,
+ bei deren Beginn - also schon vor dem "%" oder vor dem "■" der
+ Kapitelüberschriften.
+ - Abschnitte wurden sonst nur mit 1 Leerzeile abgegrenzt. Außer direkt
+ nach Überschriften können aber weitere Leerzeilen eingefügt werden,
+ um etwa bei Seitenwechseln getrennte Absätze zusammenzufügen o.ä.
+
+ Allgemeine Hinweise
+ -------------------
+ * Einzeilenkommentare hinter "%" in der ersten Spalte einer Zeile sind in
+ diesem Dokument hier *nur* für die Kurzversion der Einträge - als Auszug
+ für eine Versionsgeschichte - reserviert.
+ - Sie existierend daher doppelt zu den vorhandenen Einträgen (!) und werden
+ in einer Snapshot.Txt durch DocForm ausgefiltert.
+ - Sie können zum Beispiel mit xgrep und sed extrahiert werden:
+ xgrep "^%" snapshot.dq | sed s/%// > Extrakt.Txt
+ Denselben Zweck erfüllt das kleine Pascal-Programm SNAPX.EXE, daß
+ Einzeilen-Kommentare - mit vorangestellten "%" aus der .DQ filtert.
+ * ALLE Kommentare, die bei späterer Formatierung unsichtbare Kommentare
+ bleiben, (wie auch dieser Teil) sind daher immer als Mehrzeilen-Kommentare
+ zu markieren.
+ * Querverweise in Kommentaren sind nicht möglich (wäre zudem sinnlos, da
+ SNAPX keine Seitenformatierung bei seiner Ausgabe erzeugt, worauf
+ Querverweise hinweisen könnten).
+ * Querverweise in Tabellen mit ">>T" sind ebenfalls generell ausgeschlossen.
+ Querverweis-Einträge in solcher Tabelle erfordern daher eine Unterbrechung
sowohl bei der Quelle als auch dem Ziel "<<T" und danach kann der fixe
- Tabellenmodus mit ">>T" wieder eingeschaltet werden. Der Aufruf von Docform
- erhält dann noch einen zusätzlichen Schalter "-x".
- Aufruf: Docform snapshot.dq snapshot.txt 71 3 -p -x -t### -kSnapshot
+ Tabellenmodus mit ">>T" wieder eingeschaltet werden.
+ Der Aufruf von Docform erhält dann noch einen zusätzlichen Schalter "-x"
+ wie im Aufruf:
+ Docform snapshot.dq snapshot.txt 71 3 -p -x -t### -kSnapshot
+ * Zudem gibt es kein Tabellenverzeichnis am Ende, weil - derzeit- keine
+ benamten Tabellen in diesem Text vorkommen.
+
<<%
╔═ SNAPSHOT.TXT ════════════════════════════════════════╗
@@ -209,6 +234,8 @@
MK: Markus Kämmerer ([OpenXP/32] Gelegentliche Bugfixes)
CL: Claus Färber ([OpenXP/32] Gelegentliche Bugfixes)
+
+
%
%
%Änderungen ab November 2005 (zeitlich gegliedert)
@@ -236,6 +263,9 @@
%+ = neues Feature ! = Bugfix
%* = Änderung # = interne Änderung
%- = Wegfall
+
+
+
%
%
%Snapshot vom xx.xx.200x, xx:xx Uhr
------------------------------------------------------------------------
FreeXP CVS-Mailingliste
CVS-List@freexp.de
http://www.freexp.de/cgi-bin/mailman/listinfo/cvs-list
