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 | |
---|
19 | + Fuer Aestheten: anstatt der Quotes "..." die TeX Quotes verwenden |
---|
20 | ``...''. |
---|
21 | |
---|
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 | |
---|
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 | |
---|
51 | |
---|
52 | * Notationen * |
---|
53 | ============== |
---|
54 | |
---|
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 | |
---|
67 | + Tasten, die man druecken muss, werden im Style @code geschrieben. |
---|
68 | Die Control-Taste wird als CTRL abgekuerzt: |
---|
69 | @code{CTRL-A} |
---|
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 | |
---|
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 | |
---|
88 | the result is a standard basis (statt will be a standard basis) |
---|
89 | |
---|
90 | |
---|
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 | |
---|
104 | + "Computer Algebra" statt "computer algebra" |
---|
105 | |
---|
106 | + Konstrukte wie "the ideal/module is..." vermeiden. Stattdessen etwa |
---|
107 | "the ideal resp.@: module is..." schreiben. |
---|
108 | |
---|
109 | + Zum Englischen: |
---|
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 | |
---|
116 | + Die pers"onliche Anrede des Lesers vermeiden. Insbesondere die Worte |
---|
117 | `you', `your', etc. vermeiden. |
---|
118 | |
---|
119 | * Singular Beispiele und libraries * |
---|
120 | ==================================== |
---|
121 | |
---|
122 | + Die Kommandozeilen in einem Beispiel beginnen NICHT MEHR mit |
---|
123 | zwei Leerzeichen: |
---|
124 | @example |
---|
125 | ring r; |
---|
126 | ideal i=x,y; |
---|
127 | @end example |
---|
128 | |
---|
129 | + Ist der Kommentar zu einem Kommando in einem Beispiel, das von Singular |
---|
130 | gerechnet werden soll, laenger als eine Zeile, muss das Kommando in der |
---|
131 | untersten Zeile des Kommentars stehen (sonst wird in spaeter die |
---|
132 | Singular-Ausgabe zwischen den Kommentar und das Kommando geschoben): |
---|
133 | @example |
---|
134 | @c example |
---|
135 | ring r; |
---|
136 | // the following option leads to some usefule output |
---|
137 | option(prot); // during the Groebner basis computation. |
---|
138 | @c example |
---|
139 | @end example |
---|
140 | |
---|
141 | + Bei Beispielen, die nicht wirklich von doc2tex gerechnet, muss nach dem |
---|
142 | @expansion ein Leerzeichen kommen: |
---|
143 | @example |
---|
144 | int i=3; i; |
---|
145 | @expansion{} 3 |
---|
146 | @end example |
---|
147 | Beachte, dass auch hier beide Zeilen nicht mit zwei Leerzeichen |
---|
148 | beginnen! |
---|
149 | |
---|
150 | + Beim Schreiben von Singular-Beispielen (insbesondere von |
---|
151 | Kommentaren) bitte darauf achten, dass die Zeilen nicht zu breit |
---|
152 | werden. (Sonst bekommt man "overfull hbox"-Meldungen um die Ohren |
---|
153 | geschmissen.) |
---|
154 | |
---|
155 | + Hilfe-Texte in Libraries: keine TAB's verwenden |
---|
156 | |
---|
157 | * Cross-Referenzen * |
---|
158 | ==================== |
---|
159 | |
---|
160 | + es gibt drei Type von Cross-Referenzen (erste Zeile - Beispiel, |
---|
161 | zweite Zeile - Resultat in Info, dritte Zeile - Resultat in TeX): |
---|
162 | |
---|
163 | |
---|
164 | @xref fuer den Anfang eines Satzes |
---|
165 | |
---|
166 | @xref{Tropical Storms}, for more info. |
---|
167 | *Note Tropical Storms::, for more info. |
---|
168 | See Section 3.1 [Tropical Storms], page 24, for more info. |
---|
169 | |
---|
170 | @ref fuer den Ende eines Satzes |
---|
171 | |
---|
172 | For more information, see @ref{Hurricanes}. |
---|
173 | For more information, see *Note Hurricanes::. |
---|
174 | For more information, see Section 8.2 [Hurricanes], page 123. |
---|
175 | |
---|
176 | @pxref fuer geklammerte Referenzen |
---|
177 | |
---|
178 | ... storms cause flooding (@pxref{Hurricanes}) ... |
---|
179 | ... storms cause flooding (*Note Hurricanes::) ... |
---|
180 | ... storms cause flooding (see Section 6.7 [Hurricanes], page 72) ... |
---|
181 | |
---|
182 | + @xref und @ref *muessen* immer von einem Komma oder einem Punkt |
---|
183 | oder einem Semikolon abgeschlossen werden. Wie oben aufgefuehrt, sollte |
---|
184 | @xref immer am Satzanfang stehen, @ref dagegen immer am Satzende. |
---|
185 | Ausnahmen sind Listen von @ref's, wie unten beschrieben. |
---|
186 | |
---|
187 | + @pxref darf nur innerhalb einer Klammer auftauchen. Und zwar nur ein |
---|
188 | einzelnes, keine Liste von @pxref's. |
---|
189 | |
---|
190 | + mit der neuen Version von doc2tex kann (soll) man Listen von |
---|
191 | Cross-Referenzen wie folgt schreiben: |
---|
192 | @c ref |
---|
193 | See |
---|
194 | @ref{std}; |
---|
195 | @ref{stdfac}; |
---|
196 | @ref{stdhilbert}. |
---|
197 | @c ref |
---|
198 | Daraus wird dann automatisch ein Menue fuer die info-Files erzeugt. |
---|
199 | (Man kann sich also das "@menu * std:: ... @end menu" sparen.) |
---|
200 | Bitte pro Zeile nur *eine* Referenz notieren und das `See' |
---|
201 | in eine eigene Zeile packen. Das macht die Sache |
---|
202 | uebersichtlicher. Ausserdem kann man die Referenzen dann |
---|
203 | leichter im Editor handhaben (loeschen, alphabetisch |
---|
204 | sortieren). |
---|
205 | Die Referenzen bitte alphabetisch sortieren und mit einem Semikolon |
---|
206 | trennen. |
---|
207 | |
---|
208 | * allgemeines * |
---|
209 | =============== |
---|
210 | |
---|
211 | + Die Funktionalitaet von doc2tex ist im sourcecode ausfuehrlich |
---|
212 | domkumentiert. Siehe doc2tex.c. |
---|
213 | |
---|
214 | ------------------------------------------------------------ |
---|
215 | $Id: STYLEGUIDE,v 1.7 1998-05-18 19:36:51 wichmann Exp $ |
---|
216 | ------------------------------------------------------------ |
---|