Changeset e331a7a in git

Timestamp:

May 18, 1998, 3:36:31 PM (25 years ago)

Author:

Jens Schmidt <schmidt@…>

Branches:

(u'spielwiese', '0d6b7fcd9813a1ca1ed4220cfa2b104b97a0a003')

Children:

37897bddb725ebe55f45042bf267b1af7a635663

Parents:

78388a7d694d422448913d501e6d141d133e3175

Message:

	* STYLEGUIDE: some new guide-lines added


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

File:

• doc/STYLEGUIDE (modified) (7 diffs)

doc/STYLEGUIDE

@@ -16 +16 @@
     compute w.r.t.@: a wellordering
     a Groebner resp.@: standard basis
+
++ Fuer Aestheten: anstatt der Quotes "..." die TeX Quotes verwenden
+  ``...''.
 
 + Die Zeichen @ und { und } muessen in texinfo mit @ "gequoted"
@@ -41 +44 @@
   einsetzen zu muessen.
 
++ fuer Ellipsen (...) das Kommando @dots{} verwenden.  Eine Ellipse am Ende
+  eines Satzes mit @enddots{} schreiben.
+
++ Email Adressen in @email{...} notieren, URL's in @url{...}
+
 * Notationen *
 ==============
@@ -87 +95 @@
 + Meistens verwenden wir den Begriff "monomial ordering".
 
++ "Computer Algebra" statt "computer algebra"
+
 + Konstrukte wie "the ideal/module is..." vermeiden. Stattdessen etwa
   "the ideal resp.@: module is..." schreiben.
@@ -96 +106 @@
   Nach einem Doppelpunkt schreiben wir klein weiter:
     Purpose: computes the dimension.
+
++ Die pers"onliche Anrede des Lesers vermeiden.  Insbesondere die Worte
+  `you', `your', etc. vermeiden.
 
 * Singular Beispiele und libraries *
@@ -130 +143 @@
   geschmissen.)
 
++ Kommando-Beschreibungen (Purpose:) fangen mit einem Kleinbuchstaben an,
+  sind in der dritten Person Singular gehalten und schliessen mit einem
+  Punkt.  Vollstaendige Saetze formulieren.  Beispiel:
+
+  Purpose:  returns the number of ring parameters.
+
 + Hilfe-Texte in Libraries: keine TAB's verwenden
 
@@ -135 +154 @@
 ====================
 
-+ mit der neuen Version von doc2tex kann (soll) man Cross-Referenzen
-  wie folgt schreiben:
++ es gibt drei Type von Cross-Referenzen (erste Zeile - Beispiel,
+  zweite Zeile - Resultat in Info, dritte Zeile - Resultat in TeX):
+
+
+  @xref      fuer den Anfang eines Satzes
+
+             @xref{Tropical Storms}, for more info.
+             *Note Tropical Storms::, for more info.
+             See Section 3.1 [Tropical Storms], page 24, for more info.
+
+  @ref       fuer den Ende eines Satzes
+
+             For more information, see @ref{Hurricanes}.
+             For more information, see *Note Hurricanes::.
+             For more information, see Section 8.2 [Hurricanes], page 123.
+
+  @pxref     fuer geklammerte Referenzen
+
+             ... storms cause flooding (@pxref{Hurricanes}) ...
+             ... storms cause flooding (*Note Hurricanes::) ...
+             ... storms cause flooding (see Section 6.7 [Hurricanes], page 72) ...
+
++ @xref und @ref *muessen* immer von einem Komma oder einem Punkt
+  oder einem Semikolon abgeschlossen werden.  Wie oben aufgefuehrt, sollte
+  @xref immer am Satzanfang stehen, @ref dagegen immer am Satzende.
+  Ausnahmen sind Listen von @ref's, wie unten beschrieben.
+
++ @pxref darf nur innerhalb einer Klammer auftauchen.  Und zwar nur ein
+  einzelnes, keine Liste von @pxref's.
+
++ mit der neuen Version von doc2tex kann (soll) man Listen von 
+  Cross-Referenzen wie folgt schreiben:
     @c ref
     See
@@ -153 +202 @@
   trennen.
 
-+ Referenzen immer mit einem Komma oder Punkt abschliessen:
-    @xref{foo}, for a description of foo.
-
-+ Eher @xref als @ref verwenden, da @ref im Info-file nicht so toll
-  aussieht.  Folgendes ist aber ok:
-    blah blah blah (@ref{blahblahblah}).
-  
 ------------------------------------------------------------
-$Id: STYLEGUIDE,v 1.4 1998-05-18 12:53:39 wichmann Exp $
+$Id: STYLEGUIDE,v 1.5 1998-05-18 13:36:31 schmidt Exp $
 ------------------------------------------------------------