source: git/doc/README @ 33471f8

spielwiese
Last change on this file since 33471f8 was 540479, checked in by Tim Wichmann <wichmann@…>, 26 years ago
* wichmann: + updated file layout description. + added documentation of doc2tex. git-svn-id: file:///usr/local/Singular/svn/trunk@1692 2c84dea3-7e68-4137-9b89-c4e89433aadc
  • Property mode set to 100644
File size: 2.4 KB
Line 
11.) Die allgemeine Datei-Struktur des Handbuchs:
2================================================
3
4* singular.doc :
5    Die grobe Struktur das Handbuches und einige kleine Kapitel (z.B. Preface)
6
7* copyright.tex:
8    Copyright-Notice
9
10* start.doc:
11    Kapitel 2 (Introduction)
12
13* general.doc:
14    Kapitel 3 (General concepts)
15    Kapitel 3.4 (Libraries), 3.5 (Procedures) und 3.6 (Debugging tools) (ehemals
16      in der eigenen Datei libraries.doc)
17
18* types.doc:
19    Kapitel 4 (Data types)
20
21* reference.doc
22    Kapitel 5 (Functions and system variables)
23
24* examples.doc
25    Kapitel 7 (Examples)
26
27* math.doc
28    Kapitel 8 (Mathematical background)
29
30In den Dateien old_***.doc stehen die Abschnitte, die noch nicht (vollstaendig)
31in die neuen Version gewandert sind. Von hier aus kann man also mit
32"cut and paste" Texte in das neue Handbuch schieben - sie sollten dann
33aus den old_* -Dateien gestrichen werden.
34
352.) Schluesselworte, die von doc2tex gesucht werden:
36====================================================
37@c lib <libname>
38 *    -> is substituted by:
39 *       @c computed lib >libname<
40 *       @example
41 *       <output of "Singular -qc 'help %s; quit;'", modified for texinfo>
42 *       @end example
43 *       modification for texinfo: @ -> @@, { -> @{, } -> @}
44 *       each line "[<spaces>]<text>(..." is followed by
45 *       @findex <text>
46 * @c example
47 *    -> the text till the next @c example is feed into "Singular -qe",
48 *       the text is then substituted by
49 *       @c computed example %d
50 *       <text from the input>
51 *       @expansion{} <corresponding output>
52 *       ....
53 *       in this text, @,{ and } will be substituted by @@, @{ resp. @}
54 * @c ref
55 *    -> the text till the next "@c ref" must have the following
56 *       syntax:
57 *       See @ref{<name1>} [; @ref{<name2>} [; @ref{<name3>} etc.]] .
58 *       It will be substituted by:
59 *       @menu
60 *       *name1::
61 *       ....
62 *       @end menu
63 *       @iftex
64 *       See @ref{<name1>} [; @ref{<name2>} [; @ref{<name3>} etc.]] .
65 *       @end iftex
66 * @c include <filename>
67 *    -> is substituted by:
68 *       @c computed include >filename<
69 *       <copy the the file mentioned>
70 *       modification for texinfo: @ -> @@, { -> @{, } -> @}
71
72------------------------------------------------------------
73$Id: README,v 1.2 1998-05-11 13:17:45 wichmann Exp $
74------------------------------------------------------------
Note: See TracBrowser for help on using the repository browser.