Changeset 0f0c15 in git for doc/STYLEGUIDE

Timestamp:

May 18, 1998, 9:36:51 PM (25 years ago)

Author:

Tim Wichmann <wichmann@…>

Branches:

(u'spielwiese', '8e0ad00ce244dfd0756200662572aef8402f13d5')

Children:

36813ad2cc281d399202d01f8d5f58e327a1e8da

Parents:

0cb8c86c4bb5b6fb6b107c140c525d7aeab1ee2e

Message:

* wichmann: + added new doc2tex-example style.


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

File:

• doc/STYLEGUIDE (modified) (4 diffs)

doc/STYLEGUIDE

@@ -107 +107 @@
   "the ideal resp.@: module is..." schreiben.
 
-+ Zum Englischen (Dank an Olaf und Christian):
++ Zum Englischen:
   "i.e.", "e.g.", "for example", "that is" usw. werden immer in Kommas
   eingebettet:
@@ -120 +120 @@
 ====================================
 
-+ Die Kommandozeilen in einem Beispiel beginnen mit zwei Leerzeichen:
++ Die Kommandozeilen in einem Beispiel beginnen NICHT MEHR mit 
+  zwei Leerzeichen:
 @example
-  ring r;
-  ideal i=x,y;
+ring r;
+ideal i=x,y;
 @end example
 
@@ -130 +131 @@
   untersten Zeile des Kommentars stehen (sonst wird in spaeter die 
   Singular-Ausgabe zwischen den Kommentar und das Kommando geschoben):
-  @example
-  @c example
-    ring r;
-                   // the following option leads to some usefule output     
-    option(prot);  // during the Groebner basis computation.
-  @c example
-  @end example
+@example
+@c example
+ring r;
+               // the following option leads to some usefule output     
+option(prot);  // during the Groebner basis computation.
+@c example
+@end example
 
 + Bei Beispielen, die nicht wirklich von doc2tex gerechnet, muss nach dem
   @expansion ein Leerzeichen kommen:
-  @example
-    int i=3; i;
-    @expansion{} 3
-  @end example
+@example
+int i=3; i;
+@expansion{} 3
+@end example
+  Beachte, dass auch hier beide Zeilen nicht mit zwei Leerzeichen
+  beginnen!
 
 + Beim Schreiben von Singular-Beispielen (insbesondere von
@@ -203 +206 @@
   trennen.
 
+* allgemeines *
+===============
+
++ Die Funktionalitaet von doc2tex ist im sourcecode ausfuehrlich 
+  domkumentiert. Siehe doc2tex.c.
+
 ------------------------------------------------------------
-$Id: STYLEGUIDE,v 1.6 1998-05-18 13:53:36 schmidt Exp $
+$Id: STYLEGUIDE,v 1.7 1998-05-18 19:36:51 wichmann Exp $
 ------------------------------------------------------------