Quelle  _Chapter_The_PackageName_package.xml   Sprache: XML

<?xml version="1.0" encoding="UTF-8"?>

<!-- This is an automatically generated file. -->
<Chapter Label="Chapter_The_PackageName_package">
<Heading>The &PackageName; package</Heading>

 This is the manual for the &GAP; 4 package &PACKAGENAME; version
 &VERSION;, developed by &AUTHOR;.
<Section Label="Chapter_The_PackageName_package_Section_Installation">
<Heading>Installation</Heading>

 If you are using &GAP; version 4.15.0 or newer, then &PACKAGENAME; should
 be installed by default.
<P/>
 If this is not the case, but the &PackageManager; package is installed and
 loaded, you can install &PACKAGENAME; from within a &GAP; session using
 <Ref Func="InstallPackage" BookName="PackageManager" Style="Number"/>.
<Log><![CDATA[
gap> InstallPackage( "TwistedConjugacy" );
...
true
]]></Log>


<P/>
 Alternatively, you can download &PACKAGENAME; as a .tar.gz archive
 <URL Text='here'>&ARCHIVEURL;.tar.gz</URL>. After extracting, you should
 place it in a suitable <F>pkg</F> folder. For example, on a Debian-based
 Linux distribution (e.g. Ubuntu, Mint), you can place it in
 <F>$HOME/.gap/pkg</F> (recommended) which makes it available for just
 yourself, or in the &GAP; installation directory (<F>gap-X.Y.Z/pkg</F>)
 which makes it available for all users.
<P/>
 You can use the following command to efficiently install the package for
 yourself:
 <Listing Type="Command">wget -qO - https://[...].tar.gz | tar xzf - --one-top-level=$HOME/.gap/pkg</Listing>
</Section>


<Section Label="Chapter_The_PackageName_package_Section_Loading">
<Heading>Loading</Heading>

 Once installed, loading &PACKAGENAME; can be done by using
 <Ref Func="LoadPackage" BookName="ref" Style="Number"/>.
<Log><![CDATA[
gap> LoadPackage( "TwistedConjugacy" );
...
true
]]></Log>


</Section>


<Section Label="Chapter_The_PackageName_package_Section_Citing">
<Heading>Citing</Heading>

 If you use the &PACKAGENAME; package in your research, we would love to
 hear about your work via an email to the address
 <Email>&SUPPORTEMAIL;</Email>.
 If you have used the &PACKAGENAME; package in the preparation of a
 paper and wish to refer to it, please cite it as described below.
 <P/>
 In &BibTeX;:
<Listing Type="BibTeX">
@misc{&ABBREV;&VERSION;,
    author =       {&AUTHORREVERSED;},
    title =        {{&PackageName;,
                    &SUBTITLE;,
                    Version &VERSION;}},
    note =         {GAP package},
    year =         {&RELEASEYEAR;},
    howpublished = {\url{&HOMEURL;}}
}</Listing><P/>
 In &BibLaTeX;:
<Listing Type="BibLaTeX">
@software{&ABBREV;&VERSION;,
    author =   {&AUTHORREVERSED;},
    title =    {&PackageName;},
    subtitle = {&SUBTITLE;},
    version =  {&VERSION;},
    note =     {GAP package},
    year =     {&RELEASEYEAR;},
    url =      {&HOMEURL;}
}</Listing>
</Section>


<Section Label="Chapter_The_PackageName_package_Section_Support">
<Heading>Support</Heading>

 If you encounter any problems, please submit them to the
 <URL Text='issue tracker'>&ISSUEURL;</URL>.
 If you have any questions on the usage or functionality of
 &PACKAGENAME;, you may contact me via email at
 <Email>&SUPPORTEMAIL;</Email>.
 <P/>
 Bugs in &GAP;, in this package, or in any other package used directly or
 indirectly, may cause functions provided by &PACKAGENAME; to produce
 errors or incorrect results.
 To help detect such issues, you can enable internal checks by setting the
 variable <C>TWC.ASSERT</C> to <K>true</K>. Note that this
 will come at the cost of reduced performance.
 <P/>
 For additional safety, you can enable &GAP;'s built-in assertion features by
 calling <C>SetAssertionLevel( <A>lev</A> )</C> (we recommend setting
 <A>lev</A> to <C>2</C>) and, when working with PcpGroups, setting the
 variables <C>CHECK_CENT@Polycyclic</C>, <C>CHECK_IGS@Polycyclic</C>
 and <C>CHECK_INTSTAB@Polycyclic</C> to <K>true</K>.
</Section>


</Chapter>