example.xml

<!-- %W  example.xml            GAP documentation                Werner Nickel -->
<!-- %W                                                            Greg Gamble -->
<!-- %H                                                                        -->
<!-- %Y  Copyright (C) 1997, School of Math & Comp. Sci., St Andrews, Scotland -->


<!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
<Chapter Label="The Example Package">
<Heading>The Example Package</Heading>

<Index>Example package</Index>
This chapter  describes  the  &GAP;  package  &Example;.  As  its  name
suggests it is an example of how to  create  a  &GAP;  package.  It  has
little functionality except for being a package.
<P/>
See Sections&nbsp;<Ref Sect="Unpacking the Example Package"/>,
<Ref Sect="Compiling Binaries of the Example Package"/>
and&nbsp;<Ref Sect="Loading the Example Package"/>
for  how  to  install, compile and  load  the  &Example;  package,  or
Appendix&nbsp;<Ref Chap="Guidelines for Writing a GAP Package"/>
for guidelines on how  to  write  a &GAP; package.
<P/>
If you are viewing this with on-line help, type: 
<P/>
<Example><![CDATA[
gap> ?Example package
]]></Example>
<P/>
to see the functions provided by the &Example; package.


<!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
<Section Label="The Main Functions">
<Heading>The Main Functions</Heading>

The following functions are available:

<#Include Label="ListDirectory">

<#Include Label="FindFile">

<#Include Label="LoadedPackages">

You might like to check out some of the other information in the <C>GAPInfo</C>
record (see <Ref Sect="GAPInfo" BookName="ref"/>).

<#Include Label="Which">

<#Include Label="WhereIsPkgProgram">

<#Include Label="HelloWorld">

<#Include Label="FruitCake">

<#Include Label="Recipe">

</Section>
</Chapter>

<!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
<!-- %% -->
<!-- %E -->