CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutSign UpSign In

Real-time collaboration for Jupyter Notebooks, Linux Terminals, LaTeX, VS Code, R IDE, and more,
all in one place.

| Download

GAP 4.8.9 installation with standard packages -- copy to your CoCalc project to get it

Views: 418346
#SIXFORMAT  GapDocGAP
HELPBOOKINFOSIXTMP := rec(
encoding := "UTF-8",
bookname := "AutoDoc",
entries :=
[ [ "Title page", ".", [ 0, 0, 0 ], 1, 1, "title page", "X7D2C85EC87DD46E5" ],
  [ "Copyright", ".-1", [ 0, 0, 1 ], 43, 2, "copyright", "X81488B807F2A1CF1" ]
    , [ "Table of Contents", ".-2", [ 0, 0, 2 ], 51, 3, "table of contents", 
      "X8537FEB07AF2BEC8" ], 
  [ 
      "\033[1X\033[33X\033[0;-2YGetting started using \033[5XAutoDoc\033[105X\\
033[101X\027\033[1X\027\033[133X\033[101X", "1", [ 1, 0, 0 ], 1, 4, 
      "getting started using autodoc\027\027", "X80F6B32B7E4942F7" ], 
  [ 
      "\033[1X\033[33X\033[0;-2YCreating a package manual from scratch\033[133X\\
033[101X", "1.1", [ 1, 1, 0 ], 22, 4, "creating a package manual from scratch"
        , "X7BFBC6907B26AA95" ], 
  [ 
      "\033[1X\033[33X\033[0;-2YDocumenting code with \033[5XAutoDoc\033[105X\\
033[101X\027\033[1X\027\033[133X\033[101X", "1.2", [ 1, 2, 0 ], 92, 5, 
      "documenting code with autodoc\027\027", "X7A32EA8F7CD306FE" ], 
  [ 
      "\033[1X\033[33X\033[0;-2YUsing \033[5XAutoDoc\033[105X\033[101X\027\033[1X\
\027 in an existing \033[5XGAPDoc\033[105X\033[101X\027\033[1X\027 manual\033[\
133X\033[101X", "1.3", [ 1, 3, 0 ], 152, 6, 
      "using autodoc\027\027 in an existing gapdoc\027\027 manual", 
      "X86F2DE187B493932" ], 
  [ 
      "\033[1X\033[33X\033[0;-2YUsing \033[5XAutoDoc\033[105X\033[101X\027\033[1X\
\027 on a complete \033[5XGAPDoc\033[105X\033[101X\027\033[1X\027 manual\033[1\
33X\033[101X", "1.3-1", [ 1, 3, 1 ], 169, 6, 
      "using autodoc\027\027 on a complete gapdoc\027\027 manual", 
      "X7CBB12E77F2F63A0" ], 
  [ 
      "\033[1X\033[33X\033[0;-2YSetting different \033[5XGAPDoc\033[105X\033[101X\
\027\033[1X\027 options\033[133X\033[101X", "1.3-2", [ 1, 3, 2 ], 227, 7, 
      "setting different gapdoc\027\027 options", "X8206F787869B1645" ], 
  [ "\033[1X\033[33X\033[0;-2YScaffolds\033[133X\033[101X", "1.4", 
      [ 1, 4, 0 ], 289, 8, "scaffolds", "X8524193D824CDE0D" ], 
  [ "\033[1X\033[33X\033[0;-2YGenerating a title page\033[133X\033[101X", 
      "1.4-1", [ 1, 4, 1 ], 292, 8, "generating a title page", 
      "X7CF22DE28478316F" ], 
  [ "\033[1X\033[33X\033[0;-2YGenerating the main XML file\033[133X\033[101X",
      "1.4-2", [ 1, 4, 2 ], 341, 9, "generating the main xml file", 
      "X7CD72CC780874FD5" ], 
  [ 
      "\033[1X\033[33X\033[0;-2YWhat data is extracted from \033[11XPackageInfo.g\
\033[111X\033[101X\027\033[1X\027?\033[133X\033[101X", "1.4-3", [ 1, 4, 3 ], 
      368, 9, "what data is extracted from packageinfo.g\027\027?", 
      "X85E71656845854E2" ], 
  [ "\033[1X\033[33X\033[0;-2YAutoDoc worksheets\033[133X\033[101X", "1.5", 
      [ 1, 5, 0 ], 407, 10, "autodoc worksheets", "X80ED3C2A78146AD1" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y\033[5XAutoDoc\033[105X\033[101X\027\033[1X\027 d\
ocumentation comments\033[133X\033[101X", "2", [ 2, 0, 0 ], 1, 12, 
      "autodoc\027\027 documentation comments", "X8141B1A583434E12" ], 
  [ "\033[1X\033[33X\033[0;-2YDocumenting declarations\033[133X\033[101X", 
      "2.1", [ 2, 1, 0 ], 21, 12, "documenting declarations", 
      "X871482CE838C68F6" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@Description \033[3Xdescr\033[103X\033[101X\027\\
033[1X\027\033[133X\033[101X", "2.1-1", [ 2, 1, 1 ], 29, 12, 
      "description descr\027\027", "X8707DB2E7A8F0C3A" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@Returns \033[3Xret_val\033[103X\033[101X\027\\
033[1X\027\033[133X\033[101X", "2.1-2", [ 2, 1, 2 ], 36, 12, 
      "returns ret_val\027\027", "X86B758CA82D73B41" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@Arguments \033[3Xargs\033[103X\033[101X\027\033[\
1X\027\033[133X\033[101X", "2.1-3", [ 2, 1, 3 ], 43, 12, 
      "arguments args\027\027", "X83FDE7028649130A" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@Group \033[3Xgrpname\033[103X\033[101X\027\033[1\
X\027\033[133X\033[101X", "2.1-4", [ 2, 1, 4 ], 53, 13, 
      "group grpname\027\027", "X86A674A5869BAEC2" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@Label \033[3Xlabel\033[103X\033[101X\027\033[1X\\
027\033[133X\033[101X", "2.1-5", [ 2, 1, 5 ], 59, 13, "label label\027\027", 
      "X8749960C85248897" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@ChapterInfo \033[3Xchapter, section\033[103X\\
033[101X\027\033[1X\027\033[133X\033[101X", "2.1-8", [ 2, 1, 8 ], 95, 13, 
      "chapterinfo chapter section\027\027", "X7E44B99686FE9DC2" ], 
  [ "\033[1X\033[33X\033[0;-2YOther documentation comments\033[133X\033[101X",
      "2.2", [ 2, 2, 0 ], 119, 14, "other documentation comments", 
      "X8152FEF9844B1ACD" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@Chapter \033[3Xname\033[103X\033[101X\027\033[1X\
\027\033[133X\033[101X", "2.2-1", [ 2, 2, 1 ], 126, 14, 
      "chapter name\027\027", "X82747BD18578D5DA" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@Section \033[3Xname\033[103X\033[101X\027\033[1X\
\027\033[133X\033[101X", "2.2-2", [ 2, 2, 2 ], 144, 14, 
      "section name\027\027", "X83651A8B7EAE7F65" ], 
  [ "\033[1X\033[33X\033[0;-2Y@EndSection\033[133X\033[101X", "2.2-3", 
      [ 2, 2, 3 ], 157, 14, "endsection", "X852C1B327A127225" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@Subsection \033[3Xname\033[103X\033[101X\027\\
033[1X\027\033[133X\033[101X", "2.2-4", [ 2, 2, 4 ], 169, 14, 
      "subsection name\027\027", "X8077F8E87C72A051" ], 
  [ "\033[1X\033[33X\033[0;-2Y@EndSubsection\033[133X\033[101X", "2.2-5", 
      [ 2, 2, 5 ], 182, 15, "endsubsection", "X83F70B0F85628361" ], 
  [ "\033[1X\033[33X\033[0;-2Y@BeginAutoDoc\033[133X\033[101X", "2.2-6", 
      [ 2, 2, 6 ], 194, 15, "beginautodoc", "X7D22AA4485535112" ], 
  [ "\033[1X\033[33X\033[0;-2Y@EndAutoDoc\033[133X\033[101X", "2.2-7", 
      [ 2, 2, 7 ], 200, 15, "endautodoc", "X782E748B82E264EB" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@BeginGroup \033[3X[grpname]\033[103X\033[101X\\
027\033[1X\027\033[133X\033[101X", "2.2-8", [ 2, 2, 8 ], 218, 15, 
      "begingroup [grpname]\027\027", "X7937E2BA7E142CC9" ], 
  [ "\033[1X\033[33X\033[0;-2Y@EndGroup\033[133X\033[101X", "2.2-9", 
      [ 2, 2, 9 ], 228, 15, "endgroup", "X7C17EB007FD42C87" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@Level \033[3Xlvl\033[103X\033[101X\027\033[1X\\
027\033[133X\033[101X", "2.2-10", [ 2, 2, 10 ], 248, 16, "level lvl\027\027", 
      "X855AB48C8380D5BE" ], 
  [ "\033[1X\033[33X\033[0;-2Y@ResetLevel\033[133X\033[101X", "2.2-11", 
      [ 2, 2, 11 ], 257, 16, "resetlevel", "X7C6723D57F424215" ], 
  [ "\033[1X\033[33X\033[0;-2Y@BeginExample and @EndExample\033[133X\033[101X"
        , "2.2-12", [ 2, 2, 12 ], 262, 16, "beginexample and endexample", 
      "X83D6DA3B83D3436C" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@ExampleSession and @EndExampleSession\033[133X\\
033[101X", "2.2-13", [ 2, 2, 13 ], 281, 16, 
      "examplesession and endexamplesession", "X7F07018582EA13D6" ], 
  [ "\033[1X\033[33X\033[0;-2Y@BeginLog and @EndLog\033[133X\033[101X", 
      "2.2-14", [ 2, 2, 14 ], 312, 17, "beginlog and endlog", 
      "X81A2D44D834C0A17" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@BeginLogSession and @EndLogSession\033[133X\033[\
101X", "2.2-15", [ 2, 2, 15 ], 318, 17, "beginlogsession and endlogsession", 
      "X7BADE876794FF309" ], 
  [ "\033[1X\033[33X\033[0;-2Y@DoNotReadRestOfFile\033[133X\033[101X", 
      "2.2-16", [ 2, 2, 16 ], 325, 17, "donotreadrestoffile", 
      "X78DC644E8519280C" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@BeginChunk \033[3Xname\033[103X\033[101X\027\\
033[1X\027, @EndChunk, and @InsertChunk \033[3Xname\033[103X\033[101X\027\033[\
1X\027\033[133X\033[101X", "2.2-17", [ 2, 2, 17 ], 339, 17, 
      "beginchunk name\027\027 endchunk and insertchunk name\027\027", 
      "X84F96D3E7BD5F617" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@BeginSystem \033[3Xname\033[103X\033[101X\027\\
033[1X\027, @EndSystem, and @InsertSystem \033[3Xname\033[103X\033[101X\027\
\033[1X\027\033[133X\033[101X", "2.2-18", [ 2, 2, 18 ], 376, 18, 
      "beginsystem name\027\027 endsystem and insertsystem name\027\027", 
      "X86B00B6A876D6E7C" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@BeginCode \033[3Xname\033[103X\033[101X\027\033[\
1X\027, @EndCode, and @InsertCode \033[3Xname\033[103X\033[101X\027\033[1X\027\
\033[133X\033[101X", "2.2-19", [ 2, 2, 19 ], 382, 18, 
      "begincode name\027\027 endcode and insertcode name\027\027", 
      "X79B28EFE7C93E47D" ], 
  [ 
      "\033[1X\033[33X\033[0;-2Y@LatexOnly \033[3Xtext\033[103X\033[101X\027\033[\
1X\027, @BeginLatexOnly , and @EndLatexOnly\033[133X\033[101X", "2.2-20", 
      [ 2, 2, 20 ], 398, 18, 
      "latexonly text\027\027 beginlatexonly and endlatexonly", 
      "X828C684E8582A9D0" ], 
  [ "\033[1X\033[33X\033[0;-2YTitle page commands\033[133X\033[101X", "2.3", 
      [ 2, 3, 0 ], 413, 18, "title page commands", "X841E3AD584F5385C" ], 
  [ "\033[1X\033[33X\033[0;-2YPlain text files\033[133X\033[101X", "2.4", 
      [ 2, 4, 0 ], 449, 19, "plain text files", "X828AE38F80CB02E7" ], 
  [ "\033[1X\033[33X\033[0;-2YGrouping\033[133X\033[101X", "2.5", 
      [ 2, 5, 0 ], 459, 19, "grouping", "X7D7A38F87BC40C48" ], 
  [ "\033[1X\033[33X\033[0;-2YLevel\033[133X\033[101X", "2.6", [ 2, 6, 0 ], 
      512, 20, "level", "X8209AFDE8209AFDE" ], 
  [ 
      "\033[1X\033[33X\033[0;-2YMarkdown-like formatting of text in \033[5XAutoDo\
c\033[105X\033[101X\027\033[1X\027\033[133X\033[101X", "2.7", [ 2, 7, 0 ], 
      532, 20, "markdown-like formatting of text in autodoc\027\027", 
      "X78119E4B870052A3" ], 
  [ "\033[1X\033[33X\033[0;-2YLists\033[133X\033[101X", "2.7-1", [ 2, 7, 1 ], 
      541, 20, "lists", "X7B256AE5780F140A" ], 
  [ "\033[1X\033[33X\033[0;-2YMath modes\033[133X\033[101X", "2.7-2", 
      [ 2, 7, 2 ], 578, 21, "math modes", "X871412737A0E12E2" ], 
  [ "\033[1X\033[33X\033[0;-2YEmphasize\033[133X\033[101X", "2.7-3", 
      [ 2, 7, 3 ], 598, 21, "emphasize", "X7ED0330479146EFC" ], 
  [ "\033[1X\033[33X\033[0;-2YAutoDoc worksheets\033[133X\033[101X", "3", 
      [ 3, 0, 0 ], 1, 22, "autodoc worksheets", "X80ED3C2A78146AD1" ], 
  [ "\033[1X\033[33X\033[0;-2YWorksheets\033[133X\033[101X", "3.1", 
      [ 3, 1, 0 ], 4, 22, "worksheets", "X801D4A2F8292704C" ], 
  [ "\033[1X\033[33X\033[0;-2YAutoDoc\033[133X\033[101X", "4", [ 4, 0, 0 ], 
      1, 23, "autodoc", "X7CBD8AAF7DCEF352" ], 
  [ "\033[1X\033[33X\033[0;-2YThe AutoDoc() function\033[133X\033[101X", 
      "4.1", [ 4, 1, 0 ], 4, 23, "the autodoc function", "X863584DB8497D8BA" ]
    , [ "\033[1X\033[33X\033[0;-2YExamples\033[133X\033[101X", "4.2", 
      [ 4, 2, 0 ], 280, 27, "examples", "X7A489A5D79DA9E5C" ], 
  [ "Index", "ind", [ "Ind", 0, 0 ], 1, 28, "index", "X83A0356F839C696F" ], 
  [ "\033[11Xmakedoc.g\033[111X", "1.1", [ 1, 1, 0 ], 22, 4, "makedoc.g", 
      "X7BFBC6907B26AA95" ], 
  [ "\033[10X@Description\033[110X", "2.1-1", [ 2, 1, 1 ], 29, 12, 
      "description", "X8707DB2E7A8F0C3A" ], 
  [ "\033[10X@Returns\033[110X", "2.1-2", [ 2, 1, 2 ], 36, 12, "returns", 
      "X86B758CA82D73B41" ], 
  [ "\033[10X@Arguments\033[110X", "2.1-3", [ 2, 1, 3 ], 43, 12, "arguments", 
      "X83FDE7028649130A" ], 
  [ "\033[10X@Group\033[110X", "2.1-4", [ 2, 1, 4 ], 53, 13, "group", 
      "X86A674A5869BAEC2" ], 
  [ "\033[10X@Label\033[110X", "2.1-5", [ 2, 1, 5 ], 59, 13, "label", 
      "X8749960C85248897" ], 
  [ "\033[2XAProperty\033[102X (testlabel)", "2.1-6", [ 2, 1, 6 ], 75, 13, 
      "aproperty testlabel", "X83B63B847B5199CF" ], 
  [ "\033[2XAProperty\033[102X (for IsObject)", "2.1-7", [ 2, 1, 7 ], 90, 13, 
      "aproperty for isobject", "X78A9022A7D5CB20E" ], 
  [ "\033[10X@ChapterInfo\033[110X", "2.1-8", [ 2, 1, 8 ], 95, 13, 
      "chapterinfo", "X7E44B99686FE9DC2" ], 
  [ "\033[10X@Chapter\033[110X", "2.2-1", [ 2, 2, 1 ], 126, 14, "chapter", 
      "X82747BD18578D5DA" ], 
  [ "\033[10X@ChapterLabel\033[110X", "2.2-1", [ 2, 2, 1 ], 126, 14, 
      "chapterlabel", "X82747BD18578D5DA" ], 
  [ "\033[10X@Section\033[110X", "2.2-2", [ 2, 2, 2 ], 144, 14, "section", 
      "X83651A8B7EAE7F65" ], 
  [ "\033[10X@SectionLabel\033[110X", "2.2-2", [ 2, 2, 2 ], 144, 14, 
      "sectionlabel", "X83651A8B7EAE7F65" ], 
  [ "\033[10X@EndSection\033[110X", "2.2-3", [ 2, 2, 3 ], 157, 14, 
      "endsection", "X852C1B327A127225" ], 
  [ "\033[10X@Subsection\033[110X", "2.2-4", [ 2, 2, 4 ], 169, 14, 
      "subsection", "X8077F8E87C72A051" ], 
  [ "\033[10X@SubsectionLabel\033[110X", "2.2-4", [ 2, 2, 4 ], 169, 14, 
      "subsectionlabel", "X8077F8E87C72A051" ], 
  [ "\033[10X@EndSubsection\033[110X", "2.2-5", [ 2, 2, 5 ], 182, 15, 
      "endsubsection", "X83F70B0F85628361" ], 
  [ "\033[10X@BeginAutoDoc\033[110X", "2.2-6", [ 2, 2, 6 ], 194, 15, 
      "beginautodoc", "X7D22AA4485535112" ], 
  [ "\033[10X@EndAutoDoc\033[110X", "2.2-7", [ 2, 2, 7 ], 200, 15, 
      "endautodoc", "X782E748B82E264EB" ], 
  [ "\033[10X@BeginGroup\033[110X", "2.2-8", [ 2, 2, 8 ], 218, 15, 
      "begingroup", "X7937E2BA7E142CC9" ], 
  [ "\033[10X@EndGroup\033[110X", "2.2-9", [ 2, 2, 9 ], 228, 15, "endgroup", 
      "X7C17EB007FD42C87" ], 
  [ "\033[10X@Level\033[110X", "2.2-10", [ 2, 2, 10 ], 248, 16, "level", 
      "X855AB48C8380D5BE" ], 
  [ "\033[10X@ResetLevel\033[110X", "2.2-11", [ 2, 2, 11 ], 257, 16, 
      "resetlevel", "X7C6723D57F424215" ], 
  [ "\033[10X@BeginExample and @EndExample\033[110X", "2.2-12", [ 2, 2, 12 ], 
      262, 16, "beginexample and endexample", "X83D6DA3B83D3436C" ], 
  [ 
      "\033[10X@ExampleSession, @BeginExampleSession, and @EndExampleSession\033[\
110X", "2.2-13", [ 2, 2, 13 ], 281, 16, 
      "examplesession beginexamplesession and endexamplesession", 
      "X7F07018582EA13D6" ], 
  [ "\033[10X@BeginLog and @EndLog\033[110X", "2.2-14", [ 2, 2, 14 ], 312, 
      17, "beginlog and endlog", "X81A2D44D834C0A17" ], 
  [ "\033[10X@BeginLogSession and @EndLogSession\033[110X", "2.2-15", 
      [ 2, 2, 15 ], 318, 17, "beginlogsession and endlogsession", 
      "X7BADE876794FF309" ], 
  [ "\033[10X@DoNotReadRestOfFile\033[110X", "2.2-16", [ 2, 2, 16 ], 325, 17, 
      "donotreadrestoffile", "X78DC644E8519280C" ], 
  [ "\033[10X@BeginChunk, @EndChunk, and @InsertChunk\033[110X", "2.2-17", 
      [ 2, 2, 17 ], 339, 17, "beginchunk endchunk and insertchunk", 
      "X84F96D3E7BD5F617" ], 
  [ "\033[10X@BeginSystem, @EndSystem, and @InsertSystem\033[110X", "2.2-18", 
      [ 2, 2, 18 ], 376, 18, "beginsystem endsystem and insertsystem", 
      "X86B00B6A876D6E7C" ], 
  [ "\033[10X@BeginCode, @EndCode, and @InsertCode\033[110X", "2.2-19", 
      [ 2, 2, 19 ], 382, 18, "begincode endcode and insertcode", 
      "X79B28EFE7C93E47D" ], 
  [ "\033[10X@@LatexOnly, @BeginLatexOnly, and @EndLatexOnly\033[110X", 
      "2.2-20", [ 2, 2, 20 ], 398, 18, 
      "latexonly beginlatexonly and endlatexonly", "X828C684E8582A9D0" ], 
  [ "\033[2XFirstOperation\033[102X (for IsInt)", "2.5-1", [ 2, 5, 1 ], 504, 
      20, "firstoperation for isint", "X859517FC87560167" ], 
  [ "\033[2XSecondOperation\033[102X (for IsInt, IsGroup)", "2.5-1", 
      [ 2, 5, 1 ], 504, 20, "secondoperation for isint isgroup", 
      "X859517FC87560167" ], 
  [ "\033[2XThirdOperation\033[102X (for IsGroupIsGroup, )", "2.5-1", 
      [ 2, 5, 1 ], 504, 20, "thirdoperation for isgroupisgroup", 
      "X859517FC87560167" ], 
  [ "\033[2XAutoDocWorksheet\033[102X", "3.1-1", [ 3, 1, 1 ], 7, 22, 
      "autodocworksheet", "X809FE4137C08B28D" ], 
  [ "\033[2XAutoDoc\033[102X", "4.1-1", [ 4, 1, 1 ], 7, 23, "autodoc", 
      "X7CBD8AAF7DCEF352" ] ]
);