Changeset 609ba11 in git

Timestamp:

Jul 9, 1999, 4:12:59 PM (24 years ago)

Author:

Olaf Bachmann <obachman@…>

Branches:

(u'jengelh-datetime', 'ceac47cbc86fe4a15902392bdbb9bd2ae0ea02c6')(u'spielwiese', '0604212ebb110535022efecad887940825b97c3f')

Children:

34fbd934a748fec8c0dcc9325052eddde20bd10e

Parents:

63374c2a45ce7f0660de1047f95a58b4d23d5055

Message:

* use smallexample for examples


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

Location:

doc

Files:

• STYLEGUIDE (modified) (5 diffs)
• doc2tex.pl (modified) (8 diffs)
• examples.doc (modified) (previous)
• general.doc (modified) (previous)
• math.doc (modified) (previous)
• old_singular.doc (modified) (previous)
• pdata.doc (modified) (previous)
• reference.doc (modified) (previous)
• singular.doc (modified) (previous)
• start.doc (modified) (previous)
• types.doc (modified) (previous)

doc/STYLEGUIDE

@@ -145 +145 @@
 ====================================
 
+* generally use @samllexample for (code) examples
+
 * Die Kommandozeilen in einem Beispiel, das nicht von doc2tex
   gerechnet wird, beginnen NICHT MEHR mit zwei Leerzeichen:
-@example
+@smallexample
 ring r;
 ideal i=x,y;
-@end example
+@end smallexample
 
 * Beispiele, die von doc2tex gerechnet werden, muessen weiterhin mit
@@ -163 +165 @@
   untersten Zeile des Kommentars stehen (sonst wird in spaeter die 
   Singular-Ausgabe zwischen den Kommentar und das Kommando geschoben):
-@example
+@smallexample
 @c example
   ring r;
@@ -169 +171 @@
   option(prot);  // during the Groebner basis computation.
 @c example
-@end example
+@end smallexample
 
 + Bei Beispielen, die nicht wirklich von doc2tex gerechnet, muss nach dem
   @expansion ein Leerzeichen kommen, und geschweifte Klammern muessen
   gequoted werden mit @:
-@example
+@smallexample
 int i=3; 
     // Kommentare ueber mehere Zeilen duerfen natuerlich
@@ -180 +182 @@
 @{@} // quote von geschweiften Klammern
 @expansion{} 3
-@end example
+@end smallexample
 
 + Beim Schreiben von Singular-Beispielen (insbesondere von
@@ -248 +250 @@
 
 ------------------------------------------------------------
-$Id: STYLEGUIDE,v 1.10 1999-07-01 12:47:59 obachman Exp $
+$Id: STYLEGUIDE,v 1.11 1999-07-09 14:12:46 obachman Exp $

doc/doc2tex.pl

@@ -1 +1 @@
 #!/usr/local/bin/perl
-# $Id: doc2tex.pl,v 1.4 1999-07-07 16:38:34 obachman Exp $
+# $Id: doc2tex.pl,v 1.5 1999-07-09 14:12:47 obachman Exp $
 ###################################################################
 #  Computer Algebra System SINGULAR
@@ -292 +292 @@
         # break after $ex_length characters
         $to_do = $_;
-        while (length($to_do) > $ex_length)
+        while (length($to_do) > $ex_length && $to_do =~ /\w/)
         {
           $done .= substr($to_do, 0, $ex_length)."\\\n   ";
@@ -570 +570 @@
         {
           print LDOC "\@strong{Example:}\n";
-          print LDOC "\@example\n\@c example\n";
+          print LDOC "\@smallexample\n\@c example\n";
           print LDOC $example;
-          print LDOC "\n\@c example\n\@end example\n";
+          print LDOC "\n\@c example\n\@end smallexample\n";
         }
         OutRef(\*LDOC, $ref) if $ref;
@@ -639 +639 @@
 sub FormatInfoText
 {
-  s/^\s*//; # remove whitespaces from beginning and end
-  s/\s*$//;
-  s/ +/ /g;  # replace double whitespeces by one
-  &protect_texi; # protect texinfo special chars
-  s/\n/\n\@*/g; # replace newline by forced newline
+  my $length = shift;
+  $length = 0 unless $length;
+  # insert @* infront of all lines whose previous line is shorter than
+  # 60 characters
+  $_ = ' ' x $length . $_;
+  if (/^(.*)\n/)
+  {
+    $_ .= "\n";
+    my $pline;
+    my $line;
+    my $ptext = $_;
+    my $text = '';
+    while ($ptext =~ /(.*)\n/g)
+    {
+      $line = $1;
+      $text .= '@*' 
+        if ($line =~ /\w/ && $pline =~ /\w/ && 
+            ((length($pline) < 60) || $line =~ /^\s*\w\(.*?\)/));
+      $line =~ s/\s*$//;
+      $text .= "$line\n";
+      $pline = $line;
+    }
+    $_ = $text;
+  }
+  s/\t/ /g;
+  s/\n +/\n/g;
+  s/\s*$//g;
+  s/ +/ /g;  # replace double whitespaces by one
+  s/\@\*\s*/\@\*/g;
+  s/(\@[^\*])/\@$1/g; # escape @ signs, except @*
+  s/{/\@{/g;
+  s/}/\@}/g;
 }
 
@@ -678 +705 @@
     if ($l_fun)
     {
-      print $FH "\@strong{$item}\n\@menu\n";
+      print $FH "\@strong{$item:}\n\@menu\n";
     }
     else
     {
-      print $FH "\@item \@strong{$item}\n\@table \@asis\n";
+      print $FH "\@item \@strong{$item:}\n\@table \@asis\n";
     }
     while ($text =~ /(.*\n)/g)
@@ -725 +752 @@
   {
     # just print the text
-    &FormatInfoText;
+    FormatInfoText(length($item) + 1);
     # if functions are in text, then make it in code
     s/(\w+\(.*?\))/\@code{$1}/g
@@ -741 +768 @@
   s/^[;\s]*//;
   s/\n/ /g;
-  &FormatInfoText;
+  FormatInfoText();
   
   if ($l_fun)
@@ -790 +817 @@
   # erase EXAMPLE, echo and pause statements
   $example =~ s/"EXAMPLE.*"[^;]*;//g;
-  $example =~ s/echo[^;\n]*;//g; 
-  $example =~ s/pause\(.*?\)[^;]*;//g;
+  $example .= "\n";
+  my ($mexample, $line);
+  while ($example =~ m/(.*)\n/g)
+  {
+    $line = $1;
+    $line =~ s|echo[^;]*;||g if $line !~ m|(.*)//(.*)echo[^;]*;|;
+    $line =~ s|pause\(.*?\)[^;]*;||g if $line !~ m|(.*)//(.*)pause\(.*?\)[^;]*;|;
+    $mexample .= "$line\n";
+  }
+  $example = $mexample;
   
   # prepend LIB command