Changeset 339cf3 in git for doc/STYLEGUIDE

Timestamp:

Jan 28, 2000, 6:53:18 PM (24 years ago)

Author:

Olaf Bachmann <obachman@…>

Branches:

(u'spielwiese', 'fe61d9c35bf7c61f2b6cbf1b56e25e2f08d536cc')

Children:

3928412bbcd29b768772bef3ca4561cd27895868

Parents:

526f34914e53401cb13d2d75c1f4cf26cbb4b7e8

Message:

* use of @anchor


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

File:

• doc/STYLEGUIDE (modified) (3 diffs)

doc/STYLEGUIDE

@@ -148 +148 @@
 ====================================
 
-* generally use @samllexample for (code) examples
-
-* Die Kommandozeilen in einem Beispiel, das nicht von doc2tex
-  gerechnet wird, beginnen NICHT MEHR mit zwei Leerzeichen:
-@smallexample
-ring r;
-ideal i=x,y;
-@end smallexample
-
-* Beispiele, die von doc2tex gerechnet werden, muessen weiterhin mit
-  zwei Leerzeichen beginnen. Diese beiden Leerzeichen werden auto-
-  matisch von doc2tex gestrichen. 
-  Dieses Verhalten wird sich nach Mittwoch aendern. Ab dann darf kein
-  Beispiel mit Leerzeichen beginnen. Aus Zeitgruenden verwenden wir
-  im Moment den "hack" mit doc2tex.
+* generally, use @samllexample for (code) examples
 
 + Ist der Kommentar zu einem Kommando in einem Beispiel, das von Singular
@@ -244 +230 @@
   Die Referenzen bitte alphabetisch sortieren und mit einem Semikolon
   trennen.
+
+* Index, Anchors*
+==================
++ Do not hesitate to insert many index entires. Each index entiresneeds
+  to be written on one line. For one topic, insert different
+  formulation of the index entries. For example:
+@cindex The online help system
+@cindex online help
+@cindex help, online help system
+  Generally, if an index topic needs to be specified further, mention
+  the general topic first, separated by komma, and followed by
+  specialization (like "help, online help system").
+
++ Use the @anchor{label} construct, to set arbitraty labels, to which
+  you can refer to with @ref{label}. For example:
+@anchor{option(prot);}
+  Put the @anchor before the explained topic, otherwise the html
+  display might cut the first line(s) of the explained topic.
+
+
 
 * Umlaute *
@@ -271 +277 @@
 
 ------------------------------------------------------------
-$Id: STYLEGUIDE,v 1.14 1999-08-23 17:09:45 Singular Exp $
+$Id: STYLEGUIDE,v 1.15 2000-01-28 17:53:17 obachman Exp $