Skip to content

Commit 3625b53

Browse files
committed
Switch to old doc system
1 parent 4b23b68 commit 3625b53

File tree

7 files changed

+154
-34
lines changed

7 files changed

+154
-34
lines changed

.gitignore

Lines changed: 17 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,21 @@
1-
/doc/chap*.html
2-
/doc/chap*.txt
3-
/doc/*.css
4-
/doc/*.js
5-
/doc/chooser.html
6-
/doc/*.aux
7-
/doc/*.bbl
8-
/doc/*.blg
9-
/doc/*.brf
10-
/doc/*.idx
11-
/doc/*.ilg
12-
/doc/*.ind
13-
/doc/*.lab
14-
/doc/*.log
15-
/doc/*.out
16-
/doc/*.pnr
17-
/doc/*.six
18-
/doc/*.tex
19-
/doc/*.toc
1+
/doc/manual.aux
2+
/doc/manual.bbl
3+
/doc/manual.blg
4+
/doc/manual.dvi
5+
/doc/manual.idx
6+
/doc/manual.ilg
7+
/doc/manual.ind
8+
/doc/manual.lab
9+
/doc/manual.log
2010
/doc/manual.pdf
21-
/doc/_*.xml
11+
/doc/manual.ps
12+
/doc/manual.six
13+
/doc/manual.toc
14+
/doc/manual.example*.tst
15+
/doc/tthmacros.tex
16+
/doc/tthout
2217

23-
/bin/
24-
/gen/
25-
/Makefile
18+
/htm/
2619

27-
/tmp/
2820
/gh-pages/
21+
/tmp/

doc/ActionTestOldDocPackage.tex

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3+
\Chapter{The GAP Package ActionTestOldDocPackage}
4+
5+
This chapter describes the package {\ActionTestOldDocPackage}.
6+
for {\GAP4} \cite{GAP4}
7+
8+
9+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10+
\Section{General functionality}
11+
12+
In this section we will describe the general functionality provided by
13+
this package.

doc/make_doc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
#!/bin/sh
2+
set -e
3+
4+
echo "TeXing documentation"
5+
# TeX the manual
6+
tex manual
7+
# ... and build its bibliography (uncomment if there is a `manual.bib')
8+
bibtex manual
9+
# TeX the manual again to incorporate the ToC ... and build the index
10+
tex manual
11+
tex manual
12+
../../../doc/manualindex manual
13+
# Finally TeX the manual again to get cross-references right
14+
tex manual
15+
# Create PDF version
16+
pdftex manual; pdftex manual
17+
18+
# The HTML version of the manual
19+
rm -rf ../htm
20+
mkdir ../htm
21+
echo "Creating HTML documentation"
22+
../../../etc/convert.pl -i -u -c -n ActionTestOldDocPackage . ../htm
23+
24+
#############################################################################
25+
##
26+
#E

doc/manual.bib

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
@manual {GAP4,
2+
TITLE = "{GAP -- Groups, Algorithms, and Programming,
3+
Version 4.14,0}",
4+
ORGANIZATION = "The GAP~Group",
5+
YEAR = 2024,
6+
NOTE = "\URL{https://www.gap-system.org}",
7+
KEY = "GAP",
8+
KEYWORDS = "groups; *; gap; manual"
9+
}

doc/manual.mst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
preamble ""
2+
postamble "\n"
3+
group_skip "\n"
4+
headings_flag 1
5+
heading_prefix "\\letter "
6+
numhead_positive "{}"
7+
symhead_positive "{}"
8+
item_0 "\n "
9+
item_1 "\n \\sub "
10+
item_01 "\n \\sub "
11+
item_x1 ", "
12+
item_2 "\n \\subsub "
13+
item_12 "\n \\subsub "
14+
item_x2 ", "
15+
page_compositor "--"
16+
line_max 1000

doc/manual.tex

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
%
2+
%
3+
%
4+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5+
%%
6+
%F gapmacro . . . . . . . . . . . . . . . . read the GAP macro package
7+
%%
8+
\input ../../../doc/gapmacro.tex
9+
\Package{ActionTestOldDocPackage}
10+
%
11+
%
12+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13+
%%
14+
%F BeginningOfBook . . . . . . . . . . . . . . . . . . . start the book
15+
%%
16+
\BeginningOfBook{ActionTestOldDocPackage}
17+
%
18+
%
19+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
20+
%%
21+
%F UseReferences . . . . . . . . . . . . . . . . . . specify references
22+
%%
23+
\UseReferences{../../../doc/ref}
24+
%
25+
%
26+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27+
%%
28+
%F TitlePage . . . . . . . . . . . . . . . . . . . . . . nice title page
29+
%%
30+
\TitlePage{
31+
\centerline{\titlefont ActionTestOldDocPackage}\medskip
32+
\centerline{\titlefont ---}\medskip
33+
\centerline{\titlefont A GAP4 Package}\bigskip
34+
}
35+
%
36+
%
37+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38+
%%
39+
%F TableOfContents . . . . . . . . . . . . generate a table of contents
40+
%%
41+
\OneColumnTableOfContents
42+
%
43+
%
44+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
45+
%%
46+
%F FrontMatter . . . . . . . . . . . . . . . . . . . . . GAP 4 Tutorial
47+
%%
48+
\FrontMatter
49+
\immediate\write\citeout{\bs bibdata{./manual}}
50+
%
51+
%
52+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
53+
%%
54+
%F Chapters . . . . . . . . . . . . . . . . . . . . . . GAP 4 Tutorial
55+
%%
56+
\Chapters
57+
\Input{ActionTestOldDocPackage}
58+
%
59+
%
60+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
61+
%%
62+
%F Appendices . . . . . . . . . . . . Extending GAP 4 Reference Manual
63+
%%
64+
%\Appendices
65+
\Bibliography
66+
\Index
67+
%
68+
%
69+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
70+
%%
71+
%F EndOfBook . . . . . . . . . . . . . . . . . . . . . . . . . that's it
72+
%%
73+
\EndOfBook

makedoc.g

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)