Skip to content

Commit 59e635d

Browse files
committed
Let AutoDoc generate manual title page
1 parent 2c53a65 commit 59e635d

File tree

6 files changed

+28
-43
lines changed

6 files changed

+28
-43
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
/doc/*.toc
2020
/doc/*.xml.bib
2121
/doc/manual.pdf
22+
/doc/title.xml
2223

2324
/tmp/
2425
/gh-pages/

PackageInfo.g

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,30 @@ BannerString := Concatenation( "\nLoading ResClasses ", ~.Version,
6161
" (Computations with Residue Classes)",
6262
"\nby Stefan Kohl, stefan@mcs.st-and.ac.uk\n\n" ),
6363
TestFile := "tst/testall.g",
64-
Keywords := [ "residue classes", "integers", "number theory" ]
64+
Keywords := [ "residue classes", "integers", "number theory" ],
65+
66+
AutoDoc := rec(
67+
TitlePage := rec(
68+
Copyright := """
69+
&copyright; 2003 - 2017 by Stefan Kohl. <P/>
70+
71+
&ResClasses; is free software: you can redistribute it and/or modify
72+
it under the terms of the GNU General Public License as published by
73+
the Free Software Foundation, either version 2 of the License, or
74+
(at your option) any later version. <P/>
75+
76+
&ResClasses; is distributed in the hope that it will be useful,
77+
but WITHOUT ANY WARRANTY; without even the implied warranty of
78+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
79+
GNU General Public License for more details. <P/>
80+
81+
For a copy of the GNU General Public License, see
82+
the file <F>GPL</F> in the <F>etc</F> directory of the &GAP;
83+
distribution or see <URL>https://www.gnu.org/licenses/gpl.html</URL>.
84+
""",
85+
Abstract := """<#Include SYSTEM "abstract.xml">""",
86+
),
87+
),
6588

6689
) );
6790

doc/abstract.xml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
<!-- ## ## -->
55
<!-- #################################################################### -->
66

7-
<Abstract>
8-
97
&ResClasses; is a package for &GAP; 4 which provides a fully-featured
108
and easy-to-use implementation of set-theoretic unions of residue classes
119
of the integers and of a few other rings. <P/>
@@ -23,6 +21,4 @@
2321
The &ResClasses; package is used in a group theoretical context by the
2422
&RCWA; package&nbsp;<Cite Key="RCWA"/>.
2523

26-
</Abstract>
27-
2824
<!-- #################################################################### -->

doc/main.xml

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -15,41 +15,7 @@
1515

1616
<!-- #################################################################### -->
1717

18-
<TitlePage>
19-
<Title>&ResClasses;</Title>
20-
<Subtitle>
21-
Set-Theoretic Computations with Residue Classes
22-
</Subtitle>
23-
<Version>
24-
Version <#Include SYSTEM "../version">
25-
</Version>
26-
<Author>
27-
Stefan Kohl
28-
<Email>stefan@mcs.st-and.ac.uk</Email>
29-
<Homepage>
30-
https://stefan-kohl.github.io/
31-
</Homepage>
32-
</Author>
33-
<Date>December 18, 2017</Date>
34-
<Copyright>
35-
&copyright; 2003 - 2017 by Stefan Kohl. <P/>
36-
37-
&ResClasses; is free software: you can redistribute it and/or modify
38-
it under the terms of the GNU General Public License as published by
39-
the Free Software Foundation, either version 2 of the License, or
40-
(at your option) any later version. <P/>
41-
42-
&ResClasses; is distributed in the hope that it will be useful,
43-
but WITHOUT ANY WARRANTY; without even the implied warranty of
44-
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
45-
GNU General Public License for more details. <P/>
46-
47-
For a copy of the GNU General Public License, see
48-
the file <F>GPL</F> in the <F>etc</F> directory of the &GAP;
49-
distribution or see <URL>https://www.gnu.org/licenses/gpl.html</URL>.
50-
</Copyright>
51-
<#Include SYSTEM "abstract.xml">
52-
</TitlePage>
18+
<#Include SYSTEM "title.xml">
5319

5420
<!-- #################################################################### -->
5521

makedoc.g

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ if fail = LoadPackage("AutoDoc", ">= 2016.01.21") then
77
Error("AutoDoc 2016.01.21 or newer is required");
88
fi;
99

10-
AutoDoc(rec( gapdoc := rec( main := "main.xml" ) ));
11-
PrintTo("version", GAPInfo.PackageInfoCurrent.Version, "\n");
10+
AutoDoc(rec( gapdoc := rec( main := "main.xml" ),
11+
scaffold := rec( MainPage := false ) ));

version

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)