extracting test files from the manual

doc/algebra.xml

@@ -2,7 +2,7 @@
 <!--                                                                     -->
 <!--  algebra.xml           XModAlg documentation             Z. Arvasi  -->
 <!--                                                        & A. Odabas  -->
-<!--  Copyright (C) 2014-2025, Z. Arvasi & A. Odabas,                    -->
+<!--  Copyright (C) 2014-2026, Z. Arvasi & A. Odabas,                    -->
 <!--  Osmangazi University, Eskisehir, Turkey                            --> 
 <!--                                                                     -->
 <!-- ------------------------------------------------------------------- -->
@@ -110,7 +110,7 @@ form an algebra with product <M>\mu_b \circ \mu_{b'} = \mu_{bb'}</M>.
 <Example><![CDATA[
 gap> u1 := BA1[3];
 (Z(5)^0)*(1,3,5)(2,4,6)
-gap> S1 := Subalgebra( A3, [ u1 ] );; 
+gap> S1 := Subalgebra( A1, [ u1 ] );; 
 gap> SetName( S1, "S1" );
 gap> MS1 := MultiplierAlgebraOfIdealBySubalgebra( A1, I1, S1 );
 <algebra of dimension 1 over GF(5)>
@@ -136,8 +136,7 @@ gap> MA1 := MultiplierAlgebra( A1 );
 <algebra of dimension 6 over GF(5)>
 gap> BMA1 := BasisVectors( Basis( MA1 ) );; 
 gap> BMA1[3];
-<linear mapping by matrix, <algebra-with-one of dimension 
-6 over GF(5)> -> <algebra-with-one of dimension 6 over GF(5)>>
+<linear mapping by matrix, A1 -> A1>
 ]]></Example>
 
 <ManSection>
@@ -277,7 +276,9 @@ gap> theta1 := NaturalHomomorphismByIdeal( A1, I1 );
 gap> List( BA1, v -> ImageElm( theta1, v ) ); 
 [ v.1, v.2, v.3, v.4, (Z(5)^2)*v.1+(Z(5)^2)*v.3, (Z(5)^2)*v.2+(Z(5)^2)*v.4 ]
 gap> AlgebraActionBySurjection( theta1 );
+!!!
 kernel of hom is not in the annihilator of A
+!!!
 fail
 gap> ## an example which does not fail: 
 gap> m2 := [ [0,1,2,3], [0,0,1,2], [0,0,0,1], [0,0,0,0] ];; 

doc/intro.xml

@@ -56,7 +56,7 @@ We have included here functions for all homomorphisms of algebras.
 <P/>
 The package is loaded with the command
 <Example><![CDATA[
-gap> LoadPackage( "xmodalg" ); 
+gap> LoadPackage( "xmodalg" );; 
 ]]></Example>
 <P/>
 
@@ -71,22 +71,11 @@ The package also has a GitHub repository at:
 Once the package is loaded, the manual <Code>doc/manual.pdf</Code> 
 can be found in the documentation folder. 
 The <Code>html</Code> versions, with or without MathJax, 
-may be rebuilt as follows: 
+may be rebuilt by running the command
+<C> ReadPackage("xmodalg","makedoc.g"); </C>. 
 <P/>
-<Example><![CDATA[
-gap> ReadPackage( "xmodalg", "makedoc.g" ); 
-]]></Example>
-<P/>
-
-It is possible to check that the package has been installed correctly
-by running the test files (this terminates the &GAP; session): 
-<P/>
-<Example><![CDATA[
-gap> TestPackage( "xmodalg" );
-Architecture: . . . . . 
-testing: . . . . . 
-. . . 
-#I  No errors detected while testing
-]]></Example>
+Once the package is loaded, it is possible to check the installation
+has proceeded correctly by running the test suite of the package with 
+the command  <C> ReadPackage("xmodalg","tst/testall.g"); </C>. 
 
 </Chapter>

doc/xmod.xml

@@ -2,7 +2,7 @@
 <!--                                                                     -->
 <!--  xmod.xml            XModAlg documentation               Z. Arvasi  -->
 <!--                                                        & A. Odabas  -->
-<!--  Copyright (C) 2014-2025, Z. Arvasi & A. Odabas,                    --> 
+<!--  Copyright (C) 2014-2026, Z. Arvasi & A. Odabas,                    --> 
 <!--  Osmangazi University, Eskisehir, Turkey                            --> 
 <!--                                                                     -->
 <!-- ------------------------------------------------------------------- -->
@@ -196,13 +196,13 @@ We also show usage of the attributes listed above.
 <Example><![CDATA[
 gap> RepresentationsOfObject( XIAk4 );
 [ "IsComponentObjectRep", "IsAttributeStoringRep", "IsPreXModAlgebraObj" ]
-gap> KnownPropertiesOfObject( XIAk4 );
-[ "CanEasilyCompareElements", "CanEasilySortElements", "IsDuplicateFree", 
-  "IsLeftActedOnByDivisionRing", "IsAdditivelyCommutative", "IsLDistributive",
-  "IsRDistributive", "IsPreXModDomain", "Is2dAlgebraObject", 
-  "IsPreXModAlgebra", "IsXModAlgebra" ]
-gap> KnownAttributesOfObject( XIAk4 );
-[ "Name", "LeftActingDomain", "Range", "Source", "Boundary", "Size2d", 
+gap> Set( KnownPropertiesOfObject( XIAk4 ) );
+[ "CanEasilyCompareElements", "CanEasilySortElements", "Is2dAlgebraObject", 
+  "IsAdditivelyCommutative", "IsDuplicateFree", "IsLDistributive", 
+  "IsLeftActedOnByDivisionRing", "IsPreXModAlgebra", "IsPreXModDomain", 
+  "IsRDistributive", "IsXModAlgebra" ]
+gap> Set( KnownAttributesOfObject( XIAk4 ) );
+[ "Boundary", "LeftActingDomain", "Name", "Range", "Size2d", "Source", 
   "XModAlgebraAction" ]
 ]]></Example>
 

lib/module.gd

@@ -2,7 +2,7 @@
 ##
 #W  module.gd                 The XMODALG package              Chris Wensley
 #W                                                             
-#Y  Copyright (C) 2014-2025, Zekeriya Arvasi & Alper Odabas,  
+#Y  Copyright (C) 2014-2026, Zekeriya Arvasi & Alper Odabas,  
 ##
 ############################  algebra actions  ############################# 
 
@@ -182,10 +182,10 @@ DeclareProperty( "IsModuleAsAlgebra", IsAlgebra );
 ## </ManSection>
 ## <Example>
 ## <![CDATA[
-## gap> KnownAttributesOfObject( B3 );
-## [ "Name", "ZeroImmutable", "LeftActingDomain", "Dimension",
-##   "GeneratorsOfLeftOperatorAdditiveGroup", "GeneratorsOfLeftOperatorRing",
-##   "ModuleToAlgebraIsomorphism", "AlgebraToModuleIsomorphism" ]
+## gap> Set( KnownAttributesOfObject( B3 ) );
+## [ "AlgebraToModuleIsomorphism", "Dimension", 
+##   "GeneratorsOfLeftOperatorAdditiveGroup", "GeneratorsOfLeftOperatorRing", 
+##   "LeftActingDomain", "ModuleToAlgebraIsomorphism", "Name", "ZeroImmutable" ]
 ## gap> M2B3 := ModuleToAlgebraIsomorphism( B3 );
 ## [ [ 1, 0, 0 ], [ 0, 1, 0 ], [ 0, 0, 1 ] ] -> [ [[ 1, 0, 0 ]], [[ 0, 1, 0 ]], 
 ##   [[ 0, 0, 1 ]] ]

makedoc.g

@@ -7,6 +7,9 @@ LoadPackage( "GAPDoc" );
 LoadPackage( "AutoDoc" ); 
 
 AutoDoc( rec( 
+    extract_examples := rec(
+        subdir := "tst",
+    ),
     gapdoc := rec( 
         LaTeXOptions := rec( EarlyExtraPreamble := """
             \usepackage[all]{xy} 

tst/manual.g

@@ -0,0 +1,8 @@
+##  manual.g 
+LoadPackage("xmodalg");
+Print( "running xmodalg02.tst\n" );
+Test( "tst/xmodalg02.tst", rec(compareFunction := "uptowhitespace") ); 
+Print( "running xmodalg03.tst\n" );
+Test( "tst/xmodalg03.tst", rec(compareFunction := "uptowhitespace") ); 
+Print( "running xmodalg04.tst\n" );
+Test( "tst/xmodalg04.tst", rec(compareFunction := "uptowhitespace") ); 

tst/xmodalg01.tst

@@ -0,0 +1,17 @@
+# XModAlg, chapter 1
+#
+# DO NOT EDIT THIS FILE - EDIT EXAMPLES IN THE SOURCE INSTEAD!
+#
+# This file has been generated by AutoDoc. It contains examples extracted from
+# the package documentation. Each example is preceded by a comment which gives
+# the name of a GAPDoc XML file and a line range from which the example were
+# taken. Note that the XML file in turn may have been generated by AutoDoc
+# from some other input.
+#
+gap> START_TEST("xmodalg01.tst");
+
+# doc/intro.xml:58-60
+gap> LoadPackage( "xmodalg" );; 
+
+#
+gap> STOP_TEST("xmodalg01.tst", 1);