Made setting of text themes more flexible.

git-svn-id: path/gapdoc/trunk@315

Author: GAP

init.g

@@ -2,7 +2,7 @@
 ##
 #A  init.g                  GAPDoc              Frank Lübeck / Max Neunhöffer
 ##
-#H  @(#)$Id: init.g,v 1.18 2011-07-04 14:56:25 gap Exp $
+#H  @(#)$Id: init.g,v 1.19 2011-07-13 16:04:37 gap Exp $
 ##
 #Y  Copyright (C)  2000,  Frank Lübeck and Max Neunhöffer,  
 #Y  Lehrstuhl D für Mathematik,  RWTH Aachen
@@ -22,8 +22,6 @@ ReadPackage("GAPDoc", "lib/GAPDoc2HTML.gd");
 ReadPackage("GAPDoc", "lib/Make.g");
 ReadPackage("GAPDoc", "lib/Examples.gd");
 
-# The handler functions for GAP's help system are read now:
-ReadPackage("GAPDoc", "lib/HelpBookHandler.g");
 
 # try to find terminal encoding
 GAPInfo.tmpfunc := function()

lib/HelpBookHandler.g

@@ -2,7 +2,7 @@
 ##
 #W  HelpBookHandler.g                GAPDoc                      Frank Lübeck
 ##
-#H  @(#)$Id: HelpBookHandler.g,v 1.13 2011-07-04 14:55:13 gap Exp $
+#H  @(#)$Id: HelpBookHandler.g,v 1.14 2011-07-13 16:04:38 gap Exp $
 ##
 #Y  Copyright (C)  2000,  Frank Lübeck,  Lehrstuhl D für Mathematik,  
 #Y  RWTH Aachen
@@ -42,6 +42,7 @@ HELP_BOOK_HANDLER.GapDocGAP.setTextTheme := function()
     SetGAPDocTextTheme(GAPInfo.UserPreferences.TextTheme);
   fi;
 end;
+HELP_BOOK_HANDLER.GapDocGAP.setTextTheme();
 
 # helper function for showing matches in current text theme
 HELP_BOOK_HANDLER.GapDocGAP.apptheme := function(res, theme)
@@ -69,7 +70,7 @@ HELP_BOOK_HANDLER.GapDocGAP.ReadSix := function(stream)
   for a in res.entries do
     a[8] := a[1];
   od;
-  HELP_BOOK_HANDLER.GapDocGAP.setTextTheme();
+##    HELP_BOOK_HANDLER.GapDocGAP.setTextTheme();
   HELP_BOOK_HANDLER.GapDocGAP.apptheme(res, GAPDocTextTheme);
 
   # in position 6 of each entry we put the corresponding search string
@@ -157,7 +158,7 @@ HELP_BOOK_HANDLER.GapDocGAP.SearchMatches := function (book, topic, frombegin)
       fi;
     fi;
   od;
-  HELP_BOOK_HANDLER.GapDocGAP.setTextTheme();
+##    HELP_BOOK_HANDLER.GapDocGAP.setTextTheme();
   HELP_BOOK_HANDLER.GapDocGAP.apptheme(info, GAPDocTextTheme);
 
   return [exact, match];
@@ -223,7 +224,7 @@ HELP_BOOK_HANDLER.GapDocGAP.HelpData := function(book, entrynr, type)
     fi;
     sline := a[4];
     # set the text theme
-    HELP_BOOK_HANDLER.GapDocGAP.setTextTheme();
+##      HELP_BOOK_HANDLER.GapDocGAP.setTextTheme();
     # substitute pseudo escape sequences via GAPDocTextTheme
     # split into two pieces to find new start line
     pos := PositionLinenumber(str, sline);

lib/TextThemes.g

@@ -8,6 +8,7 @@ GAPDoc2TextProcs.OtherThemes := rec();
 # - a string a starting with TextAttr.CSI for [a, TextAttr.reset]
 # - another string a for [a, a]
 GAPDoc2TextProcs.OtherThemes.classic := rec(
+  info := "similar to GAPDoc default until GAP 4.4",
   reset := TextAttr.reset,
   Heading := Concatenation(TextAttr.bold, TextAttr.underscore, TextAttr.1),
   Func := Concatenation(TextAttr.bold, TextAttr.4),
@@ -32,7 +33,7 @@ GAPDoc2TextProcs.OtherThemes.classic := rec(
   Q := ["\"","\""],
   M := ["",""],
   Math := ["$","$"],
-  Display := ["$$","$$"],
+  Display := ["",""],
   Prompt := Concatenation(TextAttr.bold,TextAttr.4),
   BrkPrompt := Concatenation(TextAttr.bold,TextAttr.1),
   GAPInput := TextAttr.1,
@@ -48,8 +49,9 @@ GAPDoc2TextProcs.OtherThemes.classic := rec(
 );
 
 GAPDoc2TextProcs.OtherThemes.default := rec(
+  info := "the default theme",
   reset := TextAttr.reset,
-  Heading := Concatenation(TextAttr.bold, TextAttr.underscore),
+  Heading := Concatenation(TextAttr.normal, TextAttr.underscore),
   Func := Concatenation(TextAttr.normal, TextAttr.4),
   Arg := Concatenation(TextAttr.normal, TextAttr.2),
   Example := Concatenation(TextAttr.normal, TextAttr.0),
@@ -87,7 +89,8 @@ GAPDoc2TextProcs.OtherThemes.default := rec(
   flush := "both",
 );
 
-GAPDoc2TextProcs.OtherThemes.gap3 := rec(
+GAPDoc2TextProcs.OtherThemes.old := rec(
+  info := "similar to old style manuals in GAP 3 and GAP 4.4",
   reset := "", 
   Heading := ["",""],
   Func := ["`","'"],
@@ -126,7 +129,13 @@ GAPDoc2TextProcs.OtherThemes.gap3 := rec(
   format := "",
   flush := "both"
 );
-
+GAPDoc2TextProcs.OtherThemes.equalquotes := rec(
+  info := "(together with \"old\") uses '...' instead of `...'", 
+  C := "'",
+  F := "'",
+  K := "'",
+  Func := "'"
+);
 
 
 GAPDoc2TextProcs.OtherThemes.none := rec();
@@ -140,61 +149,55 @@ GAPDoc2TextProcs.f := function()
   for a in ["Q", "DefLineMarker", "ListBullet", "FillString", "EnumMarks"] do
     GAPDoc2TextProcs.OtherThemes.none.(a) := dt.(a);
   od;
+  GAPDoc2TextProcs.OtherThemes.none.info := "plain text without markup";
 end;
 GAPDoc2TextProcs.f();
 Unbind(GAPDoc2TextProcs.f);
 
+GAPDoc2TextProcs.OtherThemes.ColorPrompt := rec(
+  info := "show examples in ColorPrompt(true) style",
+  Prompt := Concatenation(TextAttr.bold,TextAttr.4),
+  BrkPrompt := Concatenation(TextAttr.bold,TextAttr.1),
+  GAPInput := TextAttr.1,
+  GAPOutput := TextAttr.reset
+);
+
+GAPDoc2TextProcs.OtherThemes.noColorPrompt := rec(
+  info := "show examples in ColorPrompt(false) style",
+  Prompt := "",
+  BrkPrompt := "",
+  GAPInput := "",
+  GAPOutput := ""
+);
+
 InstallValue(GAPDocTextTheme, rec());
 
 # argument doesn't need all component, the missing ones are taken from default
 InstallGlobalFunction(SetGAPDocTextTheme, function(arg)
-  local r, len, res, h, af, v, i, f;
+  local r, res, h, af, v, a, nam, f, i;
 
-  if Length(arg) = 0 then
-    r := rec();
-  else
-    r := arg[1];
-  fi;
-  if IsString(r) then
-    if not IsBound(GAPDoc2TextProcs.OtherThemes.(r)) then
-      Print("Only the following named text themes are available:\n     ",
-            RecFields(GAPDoc2TextProcs.OtherThemes), "\n");
-      return;
-    else
-      r := GAPDoc2TextProcs.OtherThemes.(r);
-    fi;
-  fi;
-  len := function(s) return WidthUTF8String(StripEscapeSequences(s)); end;
-  # normalize ListBullet and EnumMarks
-  if IsBound(r.ListBullet) then
-    if not IsString(r.ListBullet) then
-      r.ListBullet := r.ListBullet[1];
-    fi;
-    while len(r.ListBullet) < 2 do
-      Add(r.ListBullet, ' ');
-    od;
-    if len(r.ListBullet) > 2 then
-      r.ListBullet := r.ListBullet{[1..2]};
-    fi;
-  fi;
-  if IsBound(r.EnumMarks) then
-    if IsString(r.EnumMarks) then
-      r.EnumMarks := [r.EnumMarks, r.EnumMarks];
-    fi;
-    if Sum(r.EnumMarks, len) > 2 then
-      if len(r.EnumMarks[1]) = 0 then
-        r.EnumMarks[2] := r.EnumMarks[2]{[1,2]};
-      elif len(r.EnumMarks[2]) = 0 then
-        r.EnumMarks[1] := r.EnumMarks[1]{[1,2]};
+  r := rec();
+  for a in arg do
+    if IsString(a) then
+      if not IsBound(GAPDoc2TextProcs.OtherThemes.(a)) then
+        Print("Only the following named text themes are available \
+(choose one or several):\n");
+        for nam in RecFields(GAPDoc2TextProcs.OtherThemes) do
+          Print("  ",String(Concatenation("\"",nam,"\""), -25),
+                GAPDoc2TextProcs.OtherThemes.(nam).info, "\n");
+        od;
+        return;
       else
-        r.EnumMarks[1] := r.EnumMarks[1]{[1]};
-        r.EnumMarks[2] := r.EnumMarks[2]{[1]};
+        for f in RecFields(GAPDoc2TextProcs.OtherThemes.(a)) do
+          r.(f) := GAPDoc2TextProcs.OtherThemes.(a).(f);
+        od;
       fi;
+    else
+      for f in RecFields(a) do
+        r.(f) := a.(f);
+      od;
     fi;
-    while Sum(r.EnumMarks, len) < 2 do
-      Add(r.EnumMarks[2], ' ');
-    od;
-  fi;
+  od;
 
   res := rec(hash := [[], []]);
   h := res.hash;

read.g

@@ -2,7 +2,7 @@
 ##
 #A  read.g                  GAPDoc              Frank Lübeck / Max Neunhöffer
 ##
-#H  @(#)$Id: read.g,v 1.7 2011-07-04 14:58:18 gap Exp $
+#H  @(#)$Id: read.g,v 1.8 2011-07-13 16:04:38 gap Exp $
 ##
 #Y  Copyright (C)  2000,  Frank Lübeck and Max Neunhöffer,  
 #Y  Lehrstuhl D für Mathematik,  RWTH Aachen
@@ -24,3 +24,5 @@ ReadPackage("GAPDoc", "lib/TextThemes.g");
 ReadPackage("GAPDoc", "lib/GAPDoc2HTML.gi");
 ReadPackage("GAPDoc", "lib/Examples.gi");
 
+# Finally the handler functions for GAP's help system:
+ReadPackage("GAPDoc", "lib/HelpBookHandler.g");