[4d9437f] | 1 | * texinfo * |
---|
| 2 | =========== |
---|
| 3 | |
---|
| 4 | + nach einer @table muss eine Leerzeile kommen, sonst steht im info-File |
---|
| 5 | die nachfolgende Zeile in der letzten Tabellenzeile mit drin. |
---|
| 6 | |
---|
| 7 | + Das Argument von @cindex, @chapter, @section und @subsection darf |
---|
| 8 | nicht in geschweiften Klammern stehen, auch wenn es Leerzeichen |
---|
| 9 | enthaelt. (Das Argument geht bis zum Ende der Zeile.) |
---|
| 10 | @cindex Procedures |
---|
| 11 | @section Getting started |
---|
| 12 | |
---|
| 13 | + Taucht ein Punkt innerhalb eines Satzes auf (z.B. als Ende einer |
---|
| 14 | Abkuerzung), so sollte darauf ein @: folgen. Sonst erscheint im |
---|
| 15 | Ausdruch ein zu grosser Abstand zum nachfolgenden Wort: |
---|
| 16 | compute w.r.t.@: a wellordering |
---|
| 17 | a Groebner resp.@: standard basis |
---|
| 18 | |
---|
[e331a7a] | 19 | + Fuer Aestheten: anstatt der Quotes "..." die TeX Quotes verwenden |
---|
| 20 | ``...''. |
---|
| 21 | |
---|
[4d9437f] | 22 | + Die Zeichen @ und { und } muessen in texinfo mit @ "gequoted" |
---|
| 23 | werden (nicht mit Backslash!). |
---|
| 24 | Der Backslash muss nicht gequoted werden: |
---|
| 25 | @ muss als @@ geschrieben werden |
---|
| 26 | { muss als @{ geschrieben werden |
---|
| 27 | } muss als @} geschrieben werden |
---|
| 28 | \ wird als \ geschrieben |
---|
| 29 | ACHTUNG: Dies gilt natuerlich nicht in Beispielen, die von doc2tex |
---|
| 30 | gelesen und in Singular verarbeitet werden! Dort duerfen die Zeichen |
---|
| 31 | nicht gequoted werden, das macht doc2tex alleine. Dies gilt insbesondere |
---|
| 32 | auch fuer Dateien, die ueber @c include eingelesen werden. |
---|
| 33 | |
---|
| 34 | + Bei Aenderung von @node-Namen daran denken, dass der entsprechende Name |
---|
| 35 | auch im vorherigen und naechsten @node geaendert werden muss. |
---|
| 36 | Bei Aenderung von (Sub)sections daran denken, die Menues auf den neuen |
---|
| 37 | Stand zu bringen. |
---|
| 38 | Fehlerhafte @node- und @menu-Strukturen sieht man, wenn man singular.hlp |
---|
| 39 | erzeugt. |
---|
| 40 | |
---|
| 41 | + bislang wurde von texinfo nach einem @tex Kommando zu viel space |
---|
| 42 | eingesetzt. Der Fehler ist im texinfo behoben. Man kann nun also auch |
---|
| 43 | mitten in einem Satz auf @tex umschalten, ohne etwas wie \noindent |
---|
| 44 | einsetzen zu muessen. |
---|
| 45 | |
---|
[e331a7a] | 46 | + fuer Ellipsen (...) das Kommando @dots{} verwenden. Eine Ellipse am Ende |
---|
| 47 | eines Satzes mit @enddots{} schreiben. |
---|
| 48 | |
---|
| 49 | + Email Adressen in @email{...} notieren, URL's in @url{...} |
---|
| 50 | |
---|
[00ae33] | 51 | |
---|
[4d9437f] | 52 | * Notationen * |
---|
| 53 | ============== |
---|
| 54 | |
---|
[da9f2e3] | 55 | + Schreibweise von Singular: |
---|
| 56 | im Text: @sc{Singular} |
---|
| 57 | in Singular-Kommentaren von Singular-Beispielen: SINGULAR |
---|
| 58 | in Ueberschriften: SINGULAR |
---|
| 59 | |
---|
| 60 | + Alle Singular-Befehle und -Variablen werden im Style @code |
---|
| 61 | geschrieben: |
---|
| 62 | @code{std}, @code{TRACE} |
---|
| 63 | |
---|
| 64 | + Singular-Typen werden NICHT im Style @code geschrieben: |
---|
| 65 | int, intmat |
---|
| 66 | |
---|
[4d9437f] | 67 | + Tasten, die man druecken muss, werden im Style @code geschrieben. |
---|
| 68 | Die Control-Taste wird als CTRL abgekuerzt: |
---|
| 69 | @code{CTRL-A} |
---|
[da9f2e3] | 70 | |
---|
| 71 | + Gross/Kleinschreibung von Ueberschriften: Das erste Wort wird gross |
---|
| 72 | geschrieben, alle anderen klein. Ausnahme: Wenn das erste Wort ein |
---|
| 73 | reserviertes Wort von Singular ist, wird es so geschrieben, wie man |
---|
| 74 | es in Singular schreibt: |
---|
| 75 | Functions and system variables |
---|
| 76 | int related functions |
---|
| 77 | TRACE |
---|
| 78 | |
---|
[00ae33] | 79 | + Die Funktionsweise von Funktionen (vor allem im Kapitel "Functions", aber |
---|
| 80 | auch z.B. Kommandozeilen-Optionen, etc.) wird in der dritten Person |
---|
| 81 | beschrieben. Sie fangen mit einem Kleinbuchstaben an und schliessen mit |
---|
| 82 | einem Punkt. Bitte vollstaendige Saetze formulieren. |
---|
| 83 | |
---|
| 84 | npars: returns the number of ring parameters. |
---|
| 85 | |
---|
| 86 | Statt "will be" wird "is" verwendet: |
---|
| 87 | |
---|
[4d9437f] | 88 | the result is a standard basis (statt will be a standard basis) |
---|
[da9f2e3] | 89 | |
---|
[00ae33] | 90 | |
---|
[4d9437f] | 91 | * Schreibweisen * |
---|
| 92 | ================= |
---|
| 93 | |
---|
| 94 | + "standard basis" statt "standardbasis" |
---|
| 95 | |
---|
| 96 | + "basering" statt "base ring" |
---|
| 97 | |
---|
| 98 | + "Groebner" (ohne Umlaut) |
---|
| 99 | |
---|
| 100 | + "I/O" statt "i/o" |
---|
| 101 | |
---|
| 102 | + Meistens verwenden wir den Begriff "monomial ordering". |
---|
| 103 | |
---|
[e331a7a] | 104 | + "Computer Algebra" statt "computer algebra" |
---|
| 105 | |
---|
[4d9437f] | 106 | + Konstrukte wie "the ideal/module is..." vermeiden. Stattdessen etwa |
---|
| 107 | "the ideal resp.@: module is..." schreiben. |
---|
| 108 | |
---|
[0f0c151] | 109 | + Zum Englischen: |
---|
[4d9437f] | 110 | "i.e.", "e.g.", "for example", "that is" usw. werden immer in Kommas |
---|
| 111 | eingebettet: |
---|
| 112 | @sc{Singular}, for example, has the ... |
---|
| 113 | Nach einem Doppelpunkt schreiben wir klein weiter: |
---|
| 114 | Purpose: computes the dimension. |
---|
| 115 | |
---|
[e331a7a] | 116 | + Die pers"onliche Anrede des Lesers vermeiden. Insbesondere die Worte |
---|
| 117 | `you', `your', etc. vermeiden. |
---|
| 118 | |
---|
[4d9437f] | 119 | * Singular Beispiele und libraries * |
---|
| 120 | ==================================== |
---|
[da9f2e3] | 121 | |
---|
[7af4737] | 122 | * Die Kommandozeilen in einem Beispiel, das nicht von doc2tex |
---|
| 123 | gerechnet wird, beginnen NICHT MEHR mit zwei Leerzeichen: |
---|
[4d9437f] | 124 | @example |
---|
[0f0c151] | 125 | ring r; |
---|
| 126 | ideal i=x,y; |
---|
[4d9437f] | 127 | @end example |
---|
| 128 | |
---|
[7af4737] | 129 | * Beispiele, die von doc2tex gerechnet werden, muessen weiterhin mit |
---|
| 130 | zwei Leerzeichen beginnen. Diese beiden Leerzeichen werden auto- |
---|
| 131 | matisch von doc2tex gestrichen. |
---|
| 132 | Dieses Verhalten wird sich nach Mittwoch aendern. Ab dann darf kein |
---|
| 133 | Beispiel mit Leerzeichen beginnen. Aus Zeitgruenden verwenden wir |
---|
| 134 | im Moment den "hack" mit doc2tex. |
---|
| 135 | |
---|
[4d9437f] | 136 | + Ist der Kommentar zu einem Kommando in einem Beispiel, das von Singular |
---|
| 137 | gerechnet werden soll, laenger als eine Zeile, muss das Kommando in der |
---|
| 138 | untersten Zeile des Kommentars stehen (sonst wird in spaeter die |
---|
| 139 | Singular-Ausgabe zwischen den Kommentar und das Kommando geschoben): |
---|
[0f0c151] | 140 | @example |
---|
| 141 | @c example |
---|
[7af4737] | 142 | ring r; |
---|
| 143 | // the following option leads to some useful output |
---|
| 144 | option(prot); // during the Groebner basis computation. |
---|
[0f0c151] | 145 | @c example |
---|
| 146 | @end example |
---|
[4d9437f] | 147 | |
---|
| 148 | + Bei Beispielen, die nicht wirklich von doc2tex gerechnet, muss nach dem |
---|
| 149 | @expansion ein Leerzeichen kommen: |
---|
[0f0c151] | 150 | @example |
---|
[7af4737] | 151 | int i=3; |
---|
| 152 | // Kommentare ueber mehere Zeilen duerfen natuerlich |
---|
| 153 | i; // mit Leerzeichen beginnen. |
---|
[0f0c151] | 154 | @expansion{} 3 |
---|
| 155 | @end example |
---|
[4d9437f] | 156 | |
---|
| 157 | + Beim Schreiben von Singular-Beispielen (insbesondere von |
---|
| 158 | Kommentaren) bitte darauf achten, dass die Zeilen nicht zu breit |
---|
| 159 | werden. (Sonst bekommt man "overfull hbox"-Meldungen um die Ohren |
---|
| 160 | geschmissen.) |
---|
| 161 | |
---|
| 162 | + Hilfe-Texte in Libraries: keine TAB's verwenden |
---|
| 163 | |
---|
| 164 | * Cross-Referenzen * |
---|
| 165 | ==================== |
---|
[da9f2e3] | 166 | |
---|
[e331a7a] | 167 | + es gibt drei Type von Cross-Referenzen (erste Zeile - Beispiel, |
---|
| 168 | zweite Zeile - Resultat in Info, dritte Zeile - Resultat in TeX): |
---|
| 169 | |
---|
| 170 | |
---|
| 171 | @xref fuer den Anfang eines Satzes |
---|
| 172 | |
---|
| 173 | @xref{Tropical Storms}, for more info. |
---|
| 174 | *Note Tropical Storms::, for more info. |
---|
| 175 | See Section 3.1 [Tropical Storms], page 24, for more info. |
---|
| 176 | |
---|
| 177 | @ref fuer den Ende eines Satzes |
---|
| 178 | |
---|
| 179 | For more information, see @ref{Hurricanes}. |
---|
| 180 | For more information, see *Note Hurricanes::. |
---|
| 181 | For more information, see Section 8.2 [Hurricanes], page 123. |
---|
| 182 | |
---|
| 183 | @pxref fuer geklammerte Referenzen |
---|
| 184 | |
---|
| 185 | ... storms cause flooding (@pxref{Hurricanes}) ... |
---|
| 186 | ... storms cause flooding (*Note Hurricanes::) ... |
---|
| 187 | ... storms cause flooding (see Section 6.7 [Hurricanes], page 72) ... |
---|
| 188 | |
---|
| 189 | + @xref und @ref *muessen* immer von einem Komma oder einem Punkt |
---|
| 190 | oder einem Semikolon abgeschlossen werden. Wie oben aufgefuehrt, sollte |
---|
| 191 | @xref immer am Satzanfang stehen, @ref dagegen immer am Satzende. |
---|
| 192 | Ausnahmen sind Listen von @ref's, wie unten beschrieben. |
---|
| 193 | |
---|
| 194 | + @pxref darf nur innerhalb einer Klammer auftauchen. Und zwar nur ein |
---|
| 195 | einzelnes, keine Liste von @pxref's. |
---|
| 196 | |
---|
| 197 | + mit der neuen Version von doc2tex kann (soll) man Listen von |
---|
| 198 | Cross-Referenzen wie folgt schreiben: |
---|
[da9f2e3] | 199 | @c ref |
---|
| 200 | See |
---|
| 201 | @ref{std}; |
---|
| 202 | @ref{stdfac}; |
---|
| 203 | @ref{stdhilbert}. |
---|
| 204 | @c ref |
---|
| 205 | Daraus wird dann automatisch ein Menue fuer die info-Files erzeugt. |
---|
| 206 | (Man kann sich also das "@menu * std:: ... @end menu" sparen.) |
---|
| 207 | Bitte pro Zeile nur *eine* Referenz notieren und das `See' |
---|
| 208 | in eine eigene Zeile packen. Das macht die Sache |
---|
| 209 | uebersichtlicher. Ausserdem kann man die Referenzen dann |
---|
| 210 | leichter im Editor handhaben (loeschen, alphabetisch |
---|
| 211 | sortieren). |
---|
[4d9437f] | 212 | Die Referenzen bitte alphabetisch sortieren und mit einem Semikolon |
---|
| 213 | trennen. |
---|
[da9f2e3] | 214 | |
---|
[0f0c151] | 215 | * allgemeines * |
---|
| 216 | =============== |
---|
| 217 | |
---|
| 218 | + Die Funktionalitaet von doc2tex ist im sourcecode ausfuehrlich |
---|
| 219 | domkumentiert. Siehe doc2tex.c. |
---|
| 220 | |
---|
[da9f2e3] | 221 | ------------------------------------------------------------ |
---|
[7af4737] | 222 | $Id: STYLEGUIDE,v 1.8 1998-05-18 19:59:07 wichmann Exp $ |
---|
[da9f2e3] | 223 | ------------------------------------------------------------ |
---|