Skip to content

Commit

Permalink
Adding preliminary version of a package
Browse files Browse the repository at this point in the history 
   GAPDoc  by Frank Lübeck / Max Neunhöffer

to CVS repository

   GAP/4.0/pkg/gapdoc

Interested users may look into  GAP/4.0/pkg/gapdoc/INSTALL

    



git-svn-id: path/gapdoc/trunk@2
  • Loading branch information
GAP authored and gap committed Jan 5, 2001
0 parents commit fbf5a59
Show file tree
Hide file tree
Showing 48 changed files with 11,331 additions and 0 deletions.
15 changes: 15 additions & 0 deletions 3k+1/3k+1.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
% 3k+1 bibliography
% $Id: 3k+1.bib,v 1.1.1.1 2001-01-05 13:37:49 gap Exp $
@book {Wi98,
author = {Wirsching, Günther J.},
title = {The dynamical system generated by the $3n+1$ function},
publisher = {Springer-Verlag},
series = {Lecture Notes in Mathematics},
volume = {1681},
address = {Berlin},
year = {1998},
pages = {viii+158},
isbn = {3-540-63970-5}
}

68 changes: 68 additions & 0 deletions 3k+1/3k+1.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<?xml version="1.0" encoding="ISO-8859-1"?>

<!-- A complete "fake package" documentation
$Id: 3k+1.xml,v 1.1.1.1 2001-01-05 13:37:49 gap Exp $
-->

<!DOCTYPE Book SYSTEM "gapdoc.dtd">

<Book Name="3k+1">

<TitlePage>
<Title>The <Package>ThreeKPlusOne</Package> Package</Title>
<Version>Version 42</Version>
<Author>Dummy Authör
<Email>3kplusone@dev.null</Email>
</Author>

<Copyright>&copyright; 2000 The Author. <P/>
You can do with this package what you want.<P/> Really.
</Copyright>
</TitlePage>

<TableOfContents/>

<Body>
<Chapter> <Heading>The <M>3k+1</M> Problem</Heading>
<Section Label="sec:theory"> <Heading>Theory</Heading>
Let <M>k \in \N</M> be a natural number. We consider the sequence
<M>n(i, k), i \in \N,</M> with <M>n(1, k) = k</M> and else
<M>n(i+1, k) = n(i, k) / 2</M> if <M>n(i, k)</M> is even and
<M>n(i+1, k) = 3 n(i, k) + 1</M> if <M>n(i, k)</M> is odd.
<P/>
It is not known whether for any natural number <M>k \in \N</M>
there is an <M>m \in \N</M> with <M>n(m, k) = 1</M>.
<P/>
<Package>ThreeKPlusOne</Package> provides the function <Ref
Func="ThreeKPlusOneSequence"/> to explore this for given
<M>n</M>. If you really want to know something about this
problem, see <Cite Key="Wi98"/> or
<URL>http://mathsrv.ku-eichstaett.de/MGF/homes/wirsching/</URL>
for more details (and forget this package).
</Section>

<Section> <Heading>Program</Heading>
In this section we describe the main function of this package.
<ManSection>
<Func Name="ThreeKPlusOneSequence" Arg="k[, max]"/>
<Description>
This function computes for a natural number <A>k</A> the
beginning of the sequence <M>n(i, k)</M> defined in section
<Ref Sect="sec:theory"/>. The sequence stops at the first
<M>1</M> or at <M>n(<A>max</A>, k)</M>, if <A>max</A> is
given.
<Example>
gap> ThreeKPlusOneSequence(101);
"Sorry, not yet implemented. Wait for Version 84 of the package"
</Example>
</Description>
</ManSection>
</Section>
</Chapter>
</Body>

<Bibliography Databases="3k+1" />
<TheIndex/>

</Book>

2 changes: 2 additions & 0 deletions 3k+1/clean
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
rm -f *.{aux,log,dvi,ps,pdf,bbl,ilg,ind,idx,out,html,tex,pnr,txt,blg,toc,six,brf}

57 changes: 57 additions & 0 deletions INSTALL
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
## $Id: INSTALL,v 1.1.1.1 2001-01-05 13:37:46 gap Exp $



INSTALL for GAPDoc package (preliminary!)


You *need* GAP-4-dev (not 4.2) because of recent changes in lib/help.g

---------------------------
Install: just copy package into directory GAP4ROOT/pkg/gapdoc and put the line

gapdoc

into GAP4ROOT/pkg/ALLPKG
---------------------------

(Re)constructing the GAPDoc documentation:

You need a sufficiently good TeX installation including pdflatex,
bibtex, makeindex and several LaTeX packages. For example
teTeX-1.0 or (Linux-)packages based on it are ok.

Then: inside GAP4ROOT/pkg/gapdoc do

gap4dev makedoc.g

(and maybe restart gap4dev to have the documentation available inside GAP)

If this doesn't work unpack: GAP4ROOT/pkg/gapdoc/docu.tar.gz

There are two books in the directories `doc' and `example' (and a short
example from chapter one of `doc/manual....'.

---------------------------

Suggestions for viewing the documentation.

- For text browsing inside GAP terminal window you may set (in .gaprc?)

PAGER := "less";
PAGER_OPTIONS := ["-f", "-r", "-a", "-i", "-M", "-j2"];
# and you may try:
ANSI_COLORS:=true;
# remove the line or change it to `ANSI_COLORS:=false;' if your terminal
# doesn't support ANSI color sequences, or if you don't like it.

- For pdf-viewing with `xpdf' try

SetHelpViewer("xpdf");

or something like

SetHelpViewer("xpdf", "xdvi", "screen", "netscape");



20 changes: 20 additions & 0 deletions banner.g
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#############################################################################
##
#A banner.g GAPDoc Frank Lübeck / Max Neunhöffer
##
#H @(#)$Id: banner.g,v 1.1.1.1 2001-01-05 13:37:46 gap Exp $
##
## A simple banner for the GAPDoc package.
##
if not QUIET and BANNER then
Print(
" ######################################################################\n",
" ## ##\n",
" ## GAPDoc 0.9 (a GAP documentation meta-package) ##\n",
" ## ##\n",
" ## Questions and remarks to: Frank.Luebeck@Math.RWTH-Aachen.De ##\n",
" ## Max.Neunhoeffer@Math.RWTH-Aachen.De ##\n",
" ## ##\n",
" ######################################################################\n\n");
fi;

77 changes: 77 additions & 0 deletions doc/app3k1.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<!-- $Id: app3k1.xml,v 1.1.1.1 2001-01-05 13:37:49 gap Exp $ -->
<Appendix Label="app:3k+1"><Heading>The file <F>3k+1.xml</F></Heading>

Here is the complete source of the example &GAPDoc; document <F>3k+1.xml</F>
discussed in Section&nbsp;<Ref Sect="sec:3k+1expl" />.

<Listing Type="3k+1.xml">
<![CDATA[<?xml version="1.0" encoding="ISO-8859-1"?>
<!-- A complete "fake package" documentation
$Id: app3k1.xml,v 1.1.1.1 2001-01-05 13:37:49 gap Exp $
-->
<!DOCTYPE Book SYSTEM "gapdoc.dtd">
<Book Name="3k+1">
<TitlePage>
<Title>The <Package>ThreeKPlusOne</Package> Package</Title>
<Version>Version 42</Version>
<Author>Dummy Authör
<Email>3kplusone@dev.null</Email>
</Author>
<Copyright>&copyright; 2000 The Author. <P/>
You can do with this package what you want.<P/> Really.
</Copyright>
</TitlePage>
<TableOfContents/>
<Body>
<Chapter> <Heading>The <M>3k+1</M> Problem</Heading>
<Section Label="sec:theory"> <Heading>Theory</Heading>
Let <M>k \in \N</M> be a natural number. We consider the sequence
<M>n(i, k), i \in \N,</M> with <M>n(1, k) = k</M> and else
<M>n(i+1, k) = n(i, k) / 2</M> if <M>n(i, k)</M> is even and
<M>n(i+1, k) = 3 n(i, k) + 1</M> if <M>n(i, k)</M> is odd.
<P/>
It is not known whether for any natural number <M>k \in \N</M>
there is an <M>m \in \N</M> with <M>n(m, k) = 1</M>.
<P/>
<Package>ThreeKPlusOne</Package> provides the function <Ref
Func="ThreeKPlusOneSequence"/> to explore this for given
<M>n</M>. If you really want to know something about this
problem, see <Cite Key="Wi98"/> or
<URL>http://mathsrv.ku-eichstaett.de/MGF/homes/wirsching/</URL>
for more details (and forget this package).
</Section>
<Section> <Heading>Program</Heading>
In this section we describe the main function of this package.
<ManSection>
<Func Name="ThreeKPlusOneSequence" Arg="k[, max]"/>
<Description>
This function computes for a natural number <A>k</A> the
beginning of the sequence <M>n(i, k)</M> defined in section
<Ref Sect="sec:theory"/>. The sequence stops at the first
<M>1</M> or at <M>n(<A>max</A>, k)</M>, if <A>max</A> is
given.
<Example>
gap> ThreeKPlusOneSequence(101);
"Sorry, not yet implemented. Wait for Version 84 of the package"
</Example>
</Description>
</ManSection>
</Section>
</Chapter>
</Body>
<Bibliography Databases="3k+1" />
<TheIndex/>
</Book>
]]></Listing>
</Appendix>

2 changes: 2 additions & 0 deletions doc/clean
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
rm -f *.{aux,log,dvi,ps,pdf,bbl,ilg,ind,idx,out,html,tex,pnr,txt,blg,toc,six,brf}

Loading

0 comments on commit fbf5a59

Please sign in to comment.