diff --git a/FAQ/doc/make.README b/FAQ/doc/make.README new file mode 100644 index 00000000..5a594a50 --- /dev/null +++ b/FAQ/doc/make.README @@ -0,0 +1,58 @@ +Die Handhabung mit dem Makefile ist einfach: +"make 7bit" erzeugt die 7bit-Version der deutschen FAQ im + Unterverzeichnis "out". +"make 7bit.zip" erzeugt die mit zip gepackte 7bit-Version der + deutschen FAQ im Unterverzeichnis "out". +"make 7bit.gz" erzeugt die mit gzip gepackte 7bit-Version der + deutschen FAQ im Unterverzeichnis "out". + +"make html" erzeugt die html-Version der deutschen FAQ im + Unterverzeichnis "out". +"make html.zip" erzeugt die mit zip gepackte html-Version der + deutschen FAQ im Unterverzeichnis "out". +"make html.gz" erzeugt die mit gzip gepackte html-Version der + deutschen FAQ im Unterverzeichnis "out". + +"make e7bit" erzeugt die 7bit-Version der englischen FAQ im + Unterverzeichnis "out". +"make e7bit.zip" erzeugt die mit zip gepackte 7bit-Version der + englischen FAQ im Unterverzeichnis "out". +"make e7bit.gz" erzeugt die mit gzip gepackte 7bit-Version der + englischen FAQ im Unterverzeichnis "out". + +"make ehtml" erzeugt die html-Version der englischen FAQ im + Unterverzeichnis "out". +"make ehtml.zip" erzeugt die mit zip gepackte html-Version der + englischen FAQ im Unterverzeichnis "out". +"make ehtml.gz" erzeugt die mit gzip gepackte html-Version der + englischen FAQ im Unterverzeichnis "out". + + +"make install" kopiert alles in "out" in ein Zielverzeichnis (kann im + Makefile auf z.B. /home/dl4mhk/www/i4l-faq gesetzt werden) + +"make all" oder einfach nur "make" macht alles bisher erwaehnte. + + +"make dif" erzeugt ein diff der deutschen FAQ (verglichen wird mit der + ".old" Datei). + +"make pat" spielt einen neuen diff fuer die deutsche FAQ ein (der muss + als ".diff" vorliegen) + +"make new" markiert alle Fragen der deutschen FAQ als neu. + +"make old" markiert alle Fragen der deutschen FAQ als alt. + + +"make edif" erzeugt ein diff der englischen FAQ (verglichen wird mit + der ".old" Datei). + +"make epat" spielt einen neuen diff fuer die englische FAQ ein (der + muss als ".diff" vorliegen) + +"make enew" markiert alle Fragen der englischen FAQ als neu. + +"make eold" markiert alle Fragen der englischen FAQ als alt. + +"make clean" raeumt das "out"-Verzeichnis auf. diff --git a/FAQ/doc/syntax.txt b/FAQ/doc/syntax.txt new file mode 100644 index 00000000..3550a87c --- /dev/null +++ b/FAQ/doc/syntax.txt @@ -0,0 +1,48 @@ +Anmerkungen zur Syntax der FAQ +============================== + +Die FAQ wird mit einem Perlscript weiterverarbeitet, daher ist eine gewisse Syntax einzuhalten. + +* Formate: + Entwicklungsdatei: ISO-8859-1 (Latin-1) mit allen Umlauten. + Ausgabedateien: HTML und ASCII 7 bit (werden von Perlscripten generiert). + +* Trennungen: Aehnlich wie bei TeX sind Trennungen nicht erlaubt. Zwar kann + HTML nicht selber trennen, aber ein erscheinendes "Trenn- zeichen" im + Text sieht nicht gut aus. + +* Ueberschriften: mit abnehmender Hierarchie !1, !2 oder !3 voranstellen. + !1 darf nur *einmal* vorkommen und muss vor der FAQ-Hauptueberschrift + stehen. + +* Fragen: Fragen muessen mit einem "Q: " am *Anfang* der Zeile beginnen. + (Auch die deutsche Version!) + +* Antworten: Antworten muessen mit einem "A: " am *Anfang* der Zeile beginnen. + +* Es duerfen keine Leerzeilen innerhalb einer Frage oder innerhalb einer + Antwort stehen, aber es muss eine Leerzeile zwischen zwei Fragen/Antworten + stehen. Ist insbesondere wichtig fuer die korrekte Erzeugung der Aenderungs- + striche. + +* Hervorhebungen: man kann !b1fett!b0, !i1kursiv!i0 und !u1unterstrichen!u0 + schreiben. + +* Links auf ftp- oder www-Server werden in der folgenden Form angegeben: + !link http://www.lrz-muenchen.de/~ui161ab/www/isdn/; + bzw. + !link ftp://ftp.franken.de/pub/isdn4linux/FAQ; + Das Semikolon am Ende darf nicht vergessen werden! Ein Link kann uebrigens + wie !br, !b1, !b0, !i1, !i0, !u1, !u0 ueberall im Text stehen - auch in + Kommentaren. + +* Scripten: Wenn bestimmte Abschnitte in den Ausgabedateien *genauso* + erscheinen sollen wie in der Entwicklungsdatei, dann setzt man in die Zeile + davor in der ersten Spalte "!verbon", in die Zeile danach in der ersten + Spalte "!verboff". Diese beiden Zeilen duerfen sonst nichts enthalten. + +* Kommentare: Kommentare zwischen einer Frage/Antwort-Kombination werden mit + !commenton eingeleitet und !commentoff beendet. + +Bernhard Hailer , +Matthias Hessler