1This text file describes how to create the include files in the 2examples/include directory 3 41. All example files used in the documentation are found in the directory 5examples/gap. Each files has the extension '.g'. The first line of the file must 6be a comment, this can be some description where the example is used in the 7documentation. The second line is the first command to be executed in GAP. 8 92. The last line in a file MUST be the GAP command 'quit;' 10 113. If the example is going to cause a break loop, to demonstrate an error, see 12e.g. 'bg_th_ex1.g', then an extra 'quit;' MUST be included to leave the break 13loop. 14 154. The script 'generate_example_files.g' contains all GAP code to produce the 16'.out' files in the examples/out directory and the '.include' files in the 17/examples/include directory. The '.out' file contains a logged version of the 18example, the '.include' file contains a version of the '.out' file suitable to 19be included directly in the xml files of the documentation. 20 215. To produce the '.out' and '.include' files, start up GAP, change the first 22line of the script describing which files need to be processed. You can 23now issue a 'Read("generate_examples.g")' to execute the file and 24generate all examples at once. Alternatively, you can cut and paste the 25first part of the code in GAP. Wait until GAP returns the prompt, and 26then cut and paste the second part of the code. 27 286. This is not meant to be user friendly, it is just a way to generate files 29that can be included directly in the docs from the '.g' files. It is now 30easy to change a '.g' file and see the result in de docs. 31