From ffb88b99e8c974fe365e48114a68d412228e0baa Mon Sep 17 00:00:00 2001 From: Glen Whitney Date: Sat, 18 Aug 2018 10:58:08 -0700 Subject: [PATCH] Standardize on RAQ as the name of this package --- PackageInfo.g | 108 ++++++++++++++++++------------------ README.md | 16 +++--- init.g | 10 ++-- lib/constructions.gi | 4 +- makedoc.g | 4 +- read.g | 10 ++-- tst/bytableAndStructure.tst | 4 +- tst/testall.g | 6 +- 8 files changed, 82 insertions(+), 80 deletions(-) diff --git a/PackageInfo.g b/PackageInfo.g index 3fa8d8b..cb8a1cc 100644 --- a/PackageInfo.g +++ b/PackageInfo.g @@ -1,32 +1,33 @@ SetPackageInfo( rec( -PackageName := "raq", -Subtitle := "Racks And Quandles in GAP", -Version := "0.1.0", -Date := "2018-Oct-1", -PackageWWWHome := "http://code.studioinfinity.org/raq/wiki", -SourceRepository := rec( Type := "git", - URL := "http://code.studioinfity.org/raq" ), -IssueTrackerURL := "http://code.studioinfinity.org/raq/issues", -SupportEmail := "glen@studioinfinity.org", -ArchiveURL := "http://code.studioinfinity.org/raq/releases", -ArchiveFormats := ".tar.gz", + PackageName := "RAQ", + Subtitle := "Racks And Quandles in GAP", + Version := "0.1.0", + Date := "2018-Oct-1", + PackageWWWPrefix := Concatenation("http://code.studioinfinity.org/", + ~.PackageName), + PackageWWWHome := Concatenation(~.PackageWWWPrefix, "/wiki"), + SourceRepository := rec( Type := "git", URL := ~.PackageWWWPrefix ), + IssueTrackerURL := Concatenation(~.PackageWWWPrefix, "/issues"), + SupportEmail := "glen@studioinfinity.org", + ArchiveURL := Concatenation(~.PackageWWWPrefix, "/releases"), + ArchiveFormats := ".tar.gz", -Persons := [ - rec( - LastName := "Whitney", - FirstNames := "Glen", - IsAuthor := true, - IsMaintainer := true, - Email := "glen@studioinfinity.org", - WWWHome := "http://studioinfinity.org", - PostalAddress := Concatenation( [ - "523 Rialto Ave.\n", - "Venice, CA 90291\n", - "USA" ] ), - Place := "Venice", - Institution := "studioInfinity.org" - ) -], + Persons := [ + rec( + LastName := "Whitney", + FirstNames := "Glen", + IsAuthor := true, + IsMaintainer := true, + Email := "glen@studioinfinity.org", + WWWHome := "http://studioinfinity.org", + PostalAddress := Concatenation( [ + "523 Rialto Ave.\n", + "Venice, CA 90291\n", + "USA" ] ), + Place := "Venice", + Institution := "studioInfinity.org" + ) + ], ## Status information. Currently the following cases are recognized: ## "accepted" for successfully refereed packages @@ -35,13 +36,14 @@ Persons := [ ## "dev" for development versions of packages ## "other" for all other packages ## -Status := "other", + Status := "other", -README_URL := "http://code.studioinfinity.org/raq/src/branch/master/README.md", -PackageInfoURL := - "http://code.studioinfinity.org/raq/src/branch/master/PackageInfo.g", + README_URL := Concatenation(~.PackageWWWPrefix, + "/src/branch/master/README.md"), + PackageInfoURL := Concatenation(~.PackageWWWPrefix, + "/src/branch/master/PackageInfo.g"), -AbstractHTML := Concatenation( + AbstractHTML := Concatenation( "The RAQ package provides researchers ", "with means of representing and computing with general one-sided ", "quasigroups, but more more particularly with racks and quandles. ", @@ -52,30 +54,30 @@ AbstractHTML := Concatenation( "on which RAQ is generally modeled." ), -PackageDoc := rec( - BookName := "raq", - ArchiveURLSubset := ["doc"], - HTMLStart := "doc/chap0.html", - PDFFile := "doc/manual.pdf", - SixFile := "doc/manual.six", - LongTitle := "The raq Package: Racks And Quandles in GAP", - Autoload := true # only for the documentation, TEMPORARILY TURNED OFF -), + PackageDoc := rec( + BookName := "raq", + ArchiveURLSubset := ["doc"], + HTMLStart := "doc/chap0.html", + PDFFile := "doc/manual.pdf", + SixFile := "doc/manual.six", + LongTitle := "The raq Package: Racks And Quandles in GAP", + Autoload := true # only for the documentation, TEMPORARILY TURNED OFF + ), -Dependencies := rec( - GAP := ">=4.4", - NeededOtherPackages := [["loops","3.3.0"], ["circle","1.0.0"]], - SuggestedOtherPackages := [], - ExternalConditions := [] -), + Dependencies := rec( + GAP := ">=4.4", + NeededOtherPackages := [["loops","3.3.0"], ["circle","1.0.0"]], + SuggestedOtherPackages := [], + ExternalConditions := [] + ), -AvailabilityTest := ReturnTrue, -BannerString := Concatenation("--\nraq, Racks And Quandles in GAP, Version ", - ~.Version, ".\n--\n"), + AvailabilityTest := ReturnTrue, + BannerString := Concatenation("--\nraq, Racks And Quandles in GAP, Version ", + ~.Version, ".\n--\n"), -Autoload := false, # false for deposited packages -TestFile := "tst/testall.g", -Keywords := ["quasigroup", "self-distributive", "rack", "quandle", + Autoload := false, # false for deposited packages + TestFile := "tst/testall.g", + Keywords := ["quasigroup", "self-distributive", "rack", "quandle", "nichols algebra", "knots"] )); diff --git a/README.md b/README.md index 4c7a1fb..1461cff 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ -# raq, a GAP System package for Racks And Quandles. +# RAQ, a GAP System package for Racks And Quandles. -* Website: code.studioinfinity.org/raq/wiki -* Repository: code.studioinfinity.org/raq +* Website: code.studioinfinity.org/RAQ/wiki +* Repository: code.studioinfinity.org/RAQ This package provides a variety of facilities for computing with one-sided quasigroups, racks, and quandles in GAP. -It uses no external binaries, so installation consists only of placing the raq +It uses no external binaries, so installation consists only of placing the RAQ file tree in a directory in your package search path, e.g. the pkg directory of your GAP installation, or perhaps the .gap/pkg subdirectory of your home directory. -Authors/maintainers of raq: Glen Whitney +Authors/maintainers of RAQ: Glen Whitney -The authors of raq would like to acknowledge their debt to the creators of +The authors of RAQ would like to acknowledge their debt to the creators of RIG, an earlier package for Racks in GAP; chaief among them is Leandro -Vendramin. RIG was an inspiration for the creation of raq, and using and +Vendramin. RIG was an inspiration for the creation of RAQ, and using and reading that package suggested many features needed in the development of -raq. +RAQ. diff --git a/init.g b/init.g index 9ee8203..ebe95b8 100644 --- a/init.g +++ b/init.g @@ -1,13 +1,13 @@ -## init.g raq +## init.g RAQ # Definitions, generation, and elementary properties and operations. -ReadPackage("raq", "lib/structure.gd"); +ReadPackage("RAQ", "lib/structure.gd"); # Quasigroups, racks, and quandles by multiplication tables -ReadPackage("raq", "lib/bytable.gd"); +ReadPackage("RAQ", "lib/bytable.gd"); # Quandles by conjugation -ReadPackage("raq", "lib/byconj.gd"); +ReadPackage("RAQ", "lib/byconj.gd"); # Other quandle constructions -ReadPackage("raq", "lib/constructions.gd"); +ReadPackage("RAQ", "lib/constructions.gd"); diff --git a/lib/constructions.gi b/lib/constructions.gi index f562ecd..c8556df 100644 --- a/lib/constructions.gi +++ b/lib/constructions.gi @@ -23,11 +23,11 @@ WhichI@ := obj -> obj![1]; InstallMethod(String, "for left inert objects", [IsLInertum], - obj -> Concatenation("LInertum@raq(", String(WhichI@(obj)), ")") + obj -> Concatenation("LInertum@RAQ(", String(WhichI@(obj)), ")") ); InstallMethod(String, "for rightt inert objects", [IsRInertum], - obj -> Concatenation("RInertum@raq(", String(WhichI@(obj)), ")") + obj -> Concatenation("RInertum@RAQ(", String(WhichI@(obj)), ")") ); InstallMethod(ViewString, "for left inert objects", diff --git a/makedoc.g b/makedoc.g index 9fb12cf..64e63e9 100644 --- a/makedoc.g +++ b/makedoc.g @@ -1,5 +1,5 @@ -# makedoc.g raq -# build the documentation for raq via AutoDoc +# makedoc.g RAQ +# build the documentation for RAQ via AutoDoc LoadPackage("AutoDoc"); AutoDoc(rec(scaffold := true, autodoc := true)); diff --git a/read.g b/read.g index 6006c4b..93c2a5f 100644 --- a/read.g +++ b/read.g @@ -1,13 +1,13 @@ -## read.g raq +## read.g RAQ # Definitions, representations, and elementary operations. -ReadPackage("raq", "lib/structure.gi"); +ReadPackage("RAQ", "lib/structure.gi"); # Quasigroups, racks, and quandles by multiplication tables -ReadPackage("raq", "lib/bytable.gi"); +ReadPackage("RAQ", "lib/bytable.gi"); # Quandles by conjugation -ReadPackage("raq", "lib/byconj.gi"); +ReadPackage("RAQ", "lib/byconj.gi"); # Other quandle constructions -ReadPackage("raq", "lib/constructions.gi"); +ReadPackage("RAQ", "lib/constructions.gi"); diff --git a/tst/bytableAndStructure.tst b/tst/bytableAndStructure.tst index b2ca368..1e3c838 100644 --- a/tst/bytableAndStructure.tst +++ b/tst/bytableAndStructure.tst @@ -1,7 +1,7 @@ -# bytableAndStructure.tst raq +# bytableAndStructure.tst RAQ # Test the functions in the bytable and structure files -gap> START_TEST("raq package: bytableAndStructure.tst"); +gap> START_TEST("RAQ package: bytableAndStructure.tst"); gap> t4 := [[1,3,2,4], [3,2,1,4], [2,1,3,4], [1,2,3,4]]; [ [ 1, 3, 2, 4 ], [ 3, 2, 1, 4 ], [ 2, 1, 3, 4 ], [ 1, 2, 3, 4 ] ] gap> IsRightSelfDistributiveTable(t4); diff --git a/tst/testall.g b/tst/testall.g index 354a862..01ba21d 100644 --- a/tst/testall.g +++ b/tst/testall.g @@ -1,8 +1,8 @@ -# tst/testall.g raq +# tst/testall.g RAQ -LoadPackage( "raq" ); +LoadPackage( "RAQ" ); -TestDirectory(DirectoriesPackageLibrary("raq","tst"), +TestDirectory(DirectoriesPackageLibrary("RAQ","tst"), rec(exitGAP := true, testOptions := rec(compareFunction := "uptowhitespace")) );