Extract and test manual examples

lib/local.gd

@@ -135,7 +135,7 @@ DeclareAttribute( "UnitsOfNearRing", IsNearRing  );
 #!  (f1*f3*f4*f5), (f1*f2), (f1*f2*f5), (f1*f2*f4), (f1*f2*f4*f5), (f1*f2*f3), 
 #!  (f1*f2*f3*f5), (f1*f2*f3*f4), (f1*f2*f3*f4*f5) ]
 #! gap> Un:=NearRingUnits(N);;
-#! U=Un;
+#! gap> U=Un;
 #! true
 #! @EndExample
 
@@ -208,7 +208,7 @@ DeclareAttribute( "NearRingNonUnits", IsNearRing );
 #! gap> R:=LibraryNearRing(SmallGroup(8,4),3);
 #! #I  using isomorphic copy of the group
 #! LibraryNearRing(8/5, 3)
-#! gap> N:=NearRingNonUnits(R); 
+#! gap> N:=SortedList(NearRingNonUnits(R)); 
 #! [ (()), ((1,2,3,4)(5,6,7,8)), ((1,3)(2,4)(5,7)(6,8)), ((1,4,3,2)(5,8,7,6)), 
 #!   ((1,5,3,7)(2,8,4,6)), ((1,6,3,8)(2,5,4,7)), ((1,7,3,5)(2,6,4,8)), 
 #!   ((1,8,3,6)(2,7,4,5)) ]
@@ -582,8 +582,7 @@ DeclareOperation( "IsSubNearRing",[ IsNearRing, IsGroup ] );
 #! true
 #! gap> IsSubNearRing(T,S[9]); 
 #! false
-#! gap> D:=SmallGroup(7,1);
-#! <pc group of size 7 with 1 generators>
+#! gap> D:=SmallGroup(7,1);;
 #! gap> IsSubNearRing(T,D);   
 #! false
 #! @EndExample

makedoc.g

@@ -2,6 +2,7 @@ LoadPackage("AutoDoc");
 
 AutoDoc(rec(
     scaffold := true,
+    extract_examples := true,
     autodoc := rec(
         scan_dirs := [ "lib" ],
     ),

tst/chapter1.tst → tst/localnr01.tst

@@ -1,23 +1,21 @@
-##  To create a test file, place GAP prompts, input and output exactly as
-##  they must appear in the GAP session. Do not remove lines containing 
-##  START_TEST and STOP_TEST statements.
-##
-##  The first line starts the test. START_TEST reinitializes the caches and 
-##  the global random number generator, in order to be independent of the 
-##  reading order of several test files. Furthermore, the assertion level 
-##  is set to 2 by START_TEST and set back to the previous value in the 
-##  subsequent STOP_TEST call.
-##
-##  The argument of STOP_TEST may be an arbitrary identifier string.
-## 
-gap> START_TEST("LocalNR package: man-examples.tst");
-
-# Note that you may use comments in the test file
-# and also separate parts of the test by empty lines
+# LocalNR, 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("localnr01.tst");
 
+# doc/_Chapter_Local_nearrings.xml:56-60
 gap> List(TheAdditiveGroupsOfLibraryOfLNRsOfOrder(81),IdGroup);
 [ [ 81, 1 ], [ 81, 2 ], [ 81, 3 ], [ 81, 5 ], [ 81, 6 ], [ 81, 11 ], 
   [ 81, 12 ], [ 81, 13 ], [ 81, 15 ] ]
+
+# doc/_Chapter_Local_nearrings.xml:76-85
 gap> G:=SmallGroup(81,2);
 <pc group of size 81 with 4 generators>
 gap> TheLibraryOfLNRsOnGroup(G);
@@ -26,6 +24,26 @@ gap> TheLibraryOfLNRsOnGroup(G);
   "AllLocalNearRings(81,2,54,11)", "AllLocalNearRings(81,2,54,15)", 
   "AllLocalNearRings(81,2,72,14)", "AllLocalNearRings(81,2,72,19)", 
   "AllLocalNearRings(81,2,72,24)", "AllLocalNearRings(81,2,72,26)" ]
+
+# doc/_Chapter_Local_nearrings.xml:101-105
+gap> L:=LocalNearRing(81,12,54,8,3);
+ExplicitMultiplicationNearRing ( <pc group of size 81 with 
+4 generators> , multiplication )
+
+# doc/_Chapter_Local_nearrings.xml:120-124
+gap> L:=AllLocalNearRings(81,12,54,8);;
+gap> Size(L);
+30
+
+# doc/_Chapter_Local_nearrings.xml:140-147
+gap> G:=SmallGroup(25,2);
+<pc group of size 25 with 2 generators>
+gap> IsAdditiveGroupOfLibraryOfLNRs(G);
+true
+gap> IsAdditiveGroupOfLibraryOfLNRs(SmallGroup(81,14));
+false
+
+# doc/_Chapter_Local_nearrings.xml:162-171
 gap> InfoLocalNearRing(SmallGroup(361,2));
 The local nearrings are sorted by their multiplicative groups.
 [ "AllLocalNearRings(361,2,342,1) (2)", "AllLocalNearRings(361,2,342,2) (2)", \
@@ -34,20 +52,6 @@ The local nearrings are sorted by their multiplicative groups.
  "AllLocalNearRings(361,2,342,8) (6)",
   "AllLocalNearRings(361,2,360,4) (1)", "AllLocalNearRings(361,2,360,15) (1)"\
  ]
-gap> InfoLocalNearRing(SmallGroup(49,1));
-[ "AllLocalNearRings(49,1,42,6) (1)" ]
-gap> G:=SmallGroup(25,2);
-<pc group of size 25 with 2 generators>
-gap> IsAdditiveGroupOfLibraryOfLNRs(G);
-true
-gap> IsAdditiveGroupOfLibraryOfLNRs(SmallGroup(81,14));
-false
-
-
-## Each test file should finish with the call of STOP_TEST.
-## The argument of STOP_TEST should be the name of the test file.
-gap> STOP_TEST( "man-examples.tst" );
 
-#############################################################################
-##
-#E
+#
+gap> STOP_TEST("localnr01.tst", 1);