| 1 | + Schreibweise von Singular: |
|---|
| 2 | im Text: @sc{Singular} |
|---|
| 3 | in Singular-Kommentaren von Singular-Beispielen: SINGULAR |
|---|
| 4 | in Ueberschriften: SINGULAR |
|---|
| 5 | |
|---|
| 6 | + Alle Singular-Befehle und -Variablen werden im Style @code |
|---|
| 7 | geschrieben: |
|---|
| 8 | @code{std}, @code{TRACE} |
|---|
| 9 | |
|---|
| 10 | + Singular-Typen werden NICHT im Style @code geschrieben: |
|---|
| 11 | int, intmat |
|---|
| 12 | |
|---|
| 13 | + Das Argument von @cindex, @chapter, @section und @subsection darf |
|---|
| 14 | nicht in geschweiften Klammern stehen, auch wenn es Leerzeichen |
|---|
| 15 | enthaelt. (Das Argument geht bis zum Ende der Zeile.) |
|---|
| 16 | @cindex Procedures |
|---|
| 17 | @section Getting started |
|---|
| 18 | |
|---|
| 19 | + Gross/Kleinschreibung von Ueberschriften: Das erste Wort wird gross |
|---|
| 20 | geschrieben, alle anderen klein. Ausnahme: Wenn das erste Wort ein |
|---|
| 21 | reserviertes Wort von Singular ist, wird es so geschrieben, wie man |
|---|
| 22 | es in Singular schreibt: |
|---|
| 23 | Functions and system variables |
|---|
| 24 | int related functions |
|---|
| 25 | TRACE |
|---|
| 26 | |
|---|
| 27 | + Die Zeichen @ und { und } muessen in texinfo mit @ "gequoted" |
|---|
| 28 | werden (nicht mit Backslash!). |
|---|
| 29 | Der Backslash muss nicht gequoted werden: |
|---|
| 30 | @ muss als @@ geschrieben werden |
|---|
| 31 | { muss als @{ geschrieben werden |
|---|
| 32 | } muss als @} geschrieben werden |
|---|
| 33 | \ wird als \ geschrieben |
|---|
| 34 | |
|---|
| 35 | + Tasten, die man druecken muss, werden im Style @code geschrieben. |
|---|
| 36 | Die Control-Taste wird als CTRL abgekuerzt: |
|---|
| 37 | @code{CTRL-A} |
|---|
| 38 | |
|---|
| 39 | + der basering heisst "basering" und nicht "base ring". |
|---|
| 40 | |
|---|
| 41 | + mit der neuen Version von doc2tex kann (soll) man Cross-Referenzen |
|---|
| 42 | wie folgt schreiben: |
|---|
| 43 | @c ref |
|---|
| 44 | See |
|---|
| 45 | @ref{std}; |
|---|
| 46 | @ref{stdfac}; |
|---|
| 47 | @ref{stdhilbert}. |
|---|
| 48 | @c ref |
|---|
| 49 | Daraus wird dann automatisch ein Menue fuer die info-Files erzeugt. |
|---|
| 50 | (Man kann sich also das "@menu * std:: ... @end menu" sparen.) |
|---|
| 51 | Bitte pro Zeile nur *eine* Referenz notieren und das `See' |
|---|
| 52 | in eine eigene Zeile packen. Das macht die Sache |
|---|
| 53 | uebersichtlicher. Ausserdem kann man die Referenzen dann |
|---|
| 54 | leichter im Editor handhaben (loeschen, alphabetisch |
|---|
| 55 | sortieren). |
|---|
| 56 | Die Referenzen bitte alphabetisch sortieren. |
|---|
| 57 | |
|---|
| 58 | + Referenzen immer mit einem Komma oder Punkt abschliessen (z.B. |
|---|
| 59 | @xref{foo}, for a description of foo. |
|---|
| 60 | |
|---|
| 61 | + Eher @xref als @ref verwenden, da @ref im Info-file nicht so toll |
|---|
| 62 | aussieht. Folgendes ist aber ok: |
|---|
| 63 | blah blah blah (@ref{blahblahblah}). |
|---|
| 64 | |
|---|
| 65 | + Beim Schreiben von Singular-Beispielen (insbesondere von |
|---|
| 66 | Kommentaren) bitte darauf achten, dass die Zeilen nicht zu breit |
|---|
| 67 | werden. (Sonst bekommt man "overfull hbox"-Meldungen um die Ohren |
|---|
| 68 | geschmissen.) |
|---|
| 69 | |
|---|
| 70 | + Zum Englischen (Dank an Olaf): |
|---|
| 71 | "i.e.", "e.g.", "for example", "that is" usw. werden immer in Kommas |
|---|
| 72 | eingebettet: |
|---|
| 73 | @sc{Singular}, for example, has the ... |
|---|
| 74 | Nach einem Doppelpunkt schreiben wir klein weiter: |
|---|
| 75 | Purpose: computes the dimension. |
|---|
| 76 | |
|---|
| 77 | * Hilfe-Texte in Libraries: keine TAB's verwenden |
|---|
| 78 | ------------------------------------------------------------ |
|---|
| 79 | $Id: STYLEGUIDE,v 1.3 1998-05-15 12:00:41 schmidt Exp $ |
|---|
| 80 | ------------------------------------------------------------ |
|---|
