GAP (AutoDoc) - Chapter 6: AutoDoc worksheets

Goto Chapter: Top 1 2 3 4 5 6 Ind
[Top of Book] [Contents] [Previous Chapter] [Next Chapter]

[MathJax on]

6 AutoDoc worksheets
6.1 Worksheets
6.1-1 AutoDocWorksheet

### 6 AutoDoc worksheets

#### 6.1 Worksheets

##### 6.1-1 AutoDocWorksheet

`‣ AutoDocWorksheet`( list_of_filenames: BookName, TestFile, OutputFolder, TestFileCommands, Bibliography ) | ( function )

This function takes a filename and returns a complete GAPDoc document created out of the file. All AutoDoc commands can be used to create such a file. Also there are some special tags, which have only effect in files if the files are parsed with this command. Those commands are:

Title title

  This adds a title to the document

Author author

  This adds an author to the document.

Note that some commands have no effect, i.e. the level command. The options are as follows.

BookName

  The option BookName is an optional string, specifying the name of the manual book. If there is no BookName, the title is used. If there is no title, the filename of the first file is used.

TestFile

  If TestFile is set to false, no testfile is produced. If TestFile is a string, then it is used as name of the testfile. If nothing is given, the testfile will be maketest.g

OutputFolder

  All files will be stored in OutputFolder. If OutputFolder is not given, the folder of the first file will be used.

TestFileCommands

  String or list of strings to be added at beginning of testfile.

Bibliography

  Path to a bibliography file.

[Top of Book] [Contents] [Previous Chapter] [Next Chapter]
Goto Chapter: Top 1 2 3 4 5 6 Ind

generated by GAPDoc2HTML