‣ 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:
This adds a title to the document
This adds an author to the document.
This adds a dependency to the worksheet which will be checked at compile time. If your GAP does not provide the correct version of the package packagename the command will give an error. If you only want to compile the worksheet, you can continue. A possible version is >=20.
Adds the string date as a date to the titlepage of the pdf.
Adds the following lines as abstract to the title of the worksheet.
Adds the following lines as acknowledgement to the title of the worksheet.
Adds the URL url as a link to the titlepage of the worksheet. This is done in the TitleComment section of the TitlePage.
Note that some commands have no effect, i.e. the level command. The options are as follows.
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.
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.
Defines an output folder for a testfile. If the string "current" is given, the current folder will be used to output the testfile. If nothing is given, OutputFolder will be used.
All files will be stored in OutputFolder. If OutputFolder is not given, the folder of the first file will be used.
String or list of strings to be added at beginning of testfile.
Path to a bibliography file.
Enables the index if set to true. Please enable it only if you have something to index. It will create an error otherwise.
Works like the entities part in the AutoDoc command.
generated by GAPDoc2HTML