Some small changes following hints by Stefan Kohl.

- handle '^' correctly in TeX.
- allow HTML markup in <Alt .. for HTML.
- use the above changes in Example.
- throw out {}'s in BibTeX titles for HTML.




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

Author: GAP

example/example.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 
-<!-- $Id: example.xml,v 1.5 2001-11-16 15:20:47 gap Exp $ -->
+<!-- $Id: example.xml,v 1.6 2002-04-21 22:42:30 gap Exp $ -->
 
 <!DOCTYPE Book SYSTEM "gapdoc.dtd"
  [ <!ENTITY see '<Alt Only="LaTeX">$\to$</Alt><Alt Not="LaTeX">--&tgt;</Alt>'>]>
@@ -77,7 +77,7 @@
   </ManSection>
 
   <ManSection>
-   <Meth Name="\A_b" Arg="c" Label="for nothing" Comm="tricky name"/>
+   <Meth Name="\^" Arg="c" Label="for nothing" Comm="tricky name"/>
    <Description>
     This method is for an operation with a tricky name.
    </Description>
@@ -200,7 +200,8 @@ that are possible in &GAPDoc;:
 
 <Alt Only="LaTeX">This is &LaTeX; output.</Alt>
 <Alt Not="LaTeX">This is other than &LaTeX; output, namely:
-<Alt Only="HTML">HTML</Alt><Alt Only="Text">Text</Alt> output.</Alt>
+<Alt Only="HTML"><![CDATA[<b>HTML</b>]]></Alt>
+<Alt Only="Text">Text</Alt> output.</Alt>
 
 <P/>
 
@@ -311,7 +312,7 @@ Here is a reference to chapter <Ref Chap="First"/>, to appendix
 
 We distinguish among others references 
  to functions (see <Ref Func="f"/>), 
- to methods with tricky name (see <Ref Meth="\A_b" Label="for nothing"/>),
+ to methods with tricky name (see <Ref Meth="\^" Label="for nothing"/>),
  to operations (see <Ref Oper="MyOperation"/>), 
  to methods (see <Ref Meth="MyOperation" Label="First"/> or 
                  <Ref Meth="MyOperation" Label="for bla"/>), 
@@ -560,7 +561,7 @@ This is an appendix.
   </ManSection>
 
   <ManSection>
-   <Meth Name="\A_b" Arg="c" Label="for nothing" Comm="tricky name"/>
+   <Meth Name="\^" Arg="c" Label="for nothing" Comm="tricky name"/>
    <Description>
     This method is for an operation with a tricky name.
    </Description>
@@ -686,7 +687,8 @@ that are possible in &GAPDoc;:
 
 <Alt Only="LaTeX">This is &LaTeX; output.</Alt>
 <Alt Not="LaTeX">This is other than &LaTeX; output, namely:
-<Alt Only="HTML">HTML</Alt><Alt Only="Text">Text</Alt> output.</Alt>
+<Alt Only="HTML"><![CDATA[<b>HTML</b>]]>]<![CDATA[]></Alt>
+<Alt Only="Text">Text</Alt> output.</Alt>
 
 <P/>]]>
 </Listing>
@@ -815,7 +817,7 @@ Here is a reference to chapter <Ref Chap="First"/>, to appendix
 
 We distinguish among others references 
  to functions (see <Ref Func="f"/>), 
- to methods with tricky name (see <Ref Meth="\A_b" Label="for nothing"/>),
+ to methods with tricky name (see <Ref Meth="\^" Label="for nothing"/>),
  to operations (see <Ref Oper="MyOperation"/>), 
  to methods (see <Ref Meth="MyOperation" Label="First"/> or 
                  <Ref Meth="MyOperation" Label="for bla"/>), 

init.g

@@ -2,7 +2,7 @@
 ##
 #A  init.g                  GAPDoc              Frank Lübeck / Max Neunhöffer
 ##
-#H  @(#)$Id: init.g,v 1.5 2001-11-28 15:07:04 gap Exp $
+#H  @(#)$Id: init.g,v 1.6 2002-04-21 22:42:30 gap Exp $
 ##
 #Y  Copyright (C)  2000,  Frank Lübeck and Max Neunhöffer,  
 #Y  Lehrstuhl D für Mathematik,  RWTH Aachen
@@ -14,8 +14,6 @@ DeclarePackageAutoDocumentation("GAPDoc", "doc", "GAPDoc",
 DeclarePackageAutoDocumentation("GAPDoc", "example", "GAPDoc Example",
 "Extensive Example for GAPDoc");
 
-#DeclarePackage("gapdoc", "0.9", ReturnTrue);
-#DeclarePackageDocumentation("gapdoc", "doc");
 
 ReadPkg("GAPDoc", "banner.g");
 

lib/BibTeX.gi

@@ -2,7 +2,7 @@
 ##
 #W  BibTeX.gi                    GAPDoc                          Frank Lübeck
 ##
-#H  @(#)$Id: BibTeX.gi,v 1.7 2001-11-26 13:57:32 gap Exp $
+#H  @(#)$Id: BibTeX.gi,v 1.8 2002-04-21 22:42:30 gap Exp $
 ##
 #Y  Copyright (C)  2000,  Frank Lübeck,  Lehrstuhl D für Mathematik,  
 #Y  RWTH Aachen
@@ -513,16 +513,17 @@ InstallGlobalFunction(PrintBibAsHTML, function(arg)
     Print("(", r.editor, ",Ed.)");
   fi;
   if IsBound(r.title) then
-    Print(",\n <i>", r.title, "</i>");
+    # throw out {}'s
+    Print(",\n <i>", Filtered(r.title, x -> not x in "{}"), "</i>");
   fi;
   if IsBound(r.booktitle) then
     if r.Type in ["inproceedings", "incollection"] then
       Print(" in ");
     fi;
-    Print(",\n <i>", r.booktitle, "</i>");
+    Print(",\n <i>", Filtered(r.booktitle, x -> not x in "{}"), "</i>");
   fi;
   if IsBound(r.subtitle) then
-    Print(",\n <i> -- ", r.subtitle, "</i>");
+    Print(",\n <i> -- ",Filtered(r.subtitle, x -> not x in "{}"), "</i>");
   fi;
   if IsBound(r.journal) then
     Print(",\n ", r.journal);

lib/GAPDoc2HTML.gi

@@ -2,7 +2,7 @@
 ##
 #W  GAPDoc2HTML.gi                 GAPDoc                        Frank Lübeck
 ##
-#H  @(#)$Id: GAPDoc2HTML.gi,v 1.10 2001-11-28 14:20:49 gap Exp $
+#H  @(#)$Id: GAPDoc2HTML.gi,v 1.11 2002-04-21 22:42:30 gap Exp $
 ##
 #Y  Copyright (C)  2000,  Frank Lübeck,  Lehrstuhl D für Mathematik,  
 #Y  RWTH Aachen
@@ -787,8 +787,8 @@ end;
 GAPDoc2HTMLProcs.PCDATAFILTER := function(r, str)
   local s, a;
   s := r.content;
-  if Position(s, '<') <> fail or Position(s, '&') <> fail or 
-     Position(s, '>') <> fail then
+  if not IsBound(r.HTML) and (Position(s, '<') <> fail or 
+       Position(s, '&') <> fail or Position(s, '>') <> fail) then
     for a in s do 
       if a='<' then
         Append(str, "&lt;");
@@ -1304,11 +1304,24 @@ GAPDoc2HTMLProcs.TheIndex := function(r, par)
 end;
 
 GAPDoc2HTMLProcs.AltYes := function(r)
+  local mark;
+  # recursively mark text as HTML code (no excaping of HTML markup)
+  mark := function(r)
+    local a;
+    if IsString(r.content) then
+      r.HTML := true;
+    elif IsList(r.content) then
+      for a in r.content do
+        mark(a);
+      od;
+    fi;
+  end;
   if (not IsBound(r.attributes.Only) and not IsBound(r.attributes.Not)) or
      (IsBound(r.attributes.Only) and 
       "HTML" in SplitString(r.attributes.Only, "", " ,"))  or
      (IsBound(r.attributes.Not) and 
      not "HTML" in SplitString(r.attributes.Not, "", " ,")) then
+    mark(r);
     return true;
   else
     return false;

lib/GAPDoc2LaTeX.gi

@@ -2,7 +2,7 @@
 ##
 #W  GAPDoc2LaTeX.gi                GAPDoc                        Frank Lübeck
 ##
-#H  @(#)$Id: GAPDoc2LaTeX.gi,v 1.3 2001-01-24 14:05:12 gap Exp $
+#H  @(#)$Id: GAPDoc2LaTeX.gi,v 1.4 2002-04-21 22:42:30 gap Exp $
 ##
 #Y  Copyright (C)  2000,  Frank Lübeck,  Lehrstuhl D für Mathematik,  
 #Y  RWTH Aachen
@@ -120,6 +120,7 @@ end);
 GAPDoc2LaTeXProcs.EscapeUsBs := function(str)
   str := SubstitutionSublist(str, "\\", "\\texttt{\\symbol{92}}");
   str := SubstitutionSublist(str, "_", "{\\_}");
+  str := SubstitutionSublist(str, "^", "{\\^{}}");
   return str;
 end;