Changeset 540479 in git for doc/README

Timestamp:

May 11, 1998, 3:17:45 PM (26 years ago)

Author:

Tim Wichmann <wichmann@…>

Branches:

(u'spielwiese', '17f1d200f27c5bd38f5dfc6e8a0879242279d1d8')

Children:

62aecde1fe6d8fefe45a10435c8a1e54aa320a5e

Parents:

e3d30525447fe3b4bb4fa4aa3980cd374818db8b

Message:

* wichmann: + updated file layout description.
            + added documentation of doc2tex.


git-svn-id: file:///usr/local/Singular/svn/trunk@1692 2c84dea3-7e68-4137-9b89-c4e89433aadc

File:

• doc/README (modified) (3 diffs)

doc/README

@@ -1 @@
-Die allgemeine Datei-Struktur des Handbuchs:
+1.) Die allgemeine Datei-Struktur des Handbuchs:
+================================================
 
 * singular.doc : 
@@ -12 +13 @@
 * general.doc:
     Kapitel 3 (General concepts)
-
-* libraries.doc:
-    Kapitel 3.4 (Libraries), 3.5 (Procedures) und 3.6 (Debugging tools)
-    (wird evtl. mit general.doc zusammengefuehrt)
+    Kapitel 3.4 (Libraries), 3.5 (Procedures) und 3.6 (Debugging tools) (ehemals
+      in der eigenen Datei libraries.doc)
 
 * types.doc:
@@ -34 +33 @@
 aus den old_* -Dateien gestrichen werden.
 
+2.) Schluesselworte, die von doc2tex gesucht werden:
+====================================================
+@c lib <libname>
+ *    -> is substituted by:
+ *       @c computed lib >libname<
+ *       @example
+ *       <output of "Singular -qc 'help %s; quit;'", modified for texinfo>
+ *       @end example
+ *       modification for texinfo: @ -> @@, { -> @{, } -> @}
+ *       each line "[<spaces>]<text>(..." is followed by
+ *       @findex <text>
+ * @c example
+ *    -> the text till the next @c example is feed into "Singular -qe",
+ *       the text is then substituted by
+ *       @c computed example %d
+ *       <text from the input>
+ *       @expansion{} <corresponding output>
+ *       ....
+ *       in this text, @,{ and } will be substituted by @@, @{ resp. @}
+ * @c ref
+ *    -> the text till the next "@c ref" must have the following
+ *       syntax:
+ *       See @ref{<name1>} [; @ref{<name2>} [; @ref{<name3>} etc.]] .
+ *       It will be substituted by:
+ *       @menu
+ *       *name1::
+ *       ....
+ *       @end menu
+ *       @iftex
+ *       See @ref{<name1>} [; @ref{<name2>} [; @ref{<name3>} etc.]] .
+ *       @end iftex
+ * @c include <filename>
+ *    -> is substituted by:
+ *       @c computed include >filename<
+ *       <copy the the file mentioned>
+ *       modification for texinfo: @ -> @@, { -> @{, } -> @}
+
 ------------------------------------------------------------
-$Id: README,v 1.1 1998-04-30 07:00:48 Singular Exp $
+$Id: README,v 1.2 1998-05-11 13:17:45 wichmann Exp $
 ------------------------------------------------------------