Ext Rep Docmentation in LaTex
Peter Dobcsanyi
p.dobcsanyi at designtheory.org
Mon Oct 20 16:29:11 BST 2003
The ext-rep documentation has been converted into LaTex format.
That also involved significant changes in the CVS tree, although the
documentation is still in the xml/doc subdirectory.
Important: you need to checkout a new sandbox -- upgrade is not enough!
First, go to the directory where your old sandbox is and remove it
completely:
rm -fr DTRS
Then check out the new one:
cvs checkout DTRS
Alternatively, you can get only the parts of the CVS tree you are
interested in, for example:
cvs checkout DTRS/xml DTRS/articles
Changes:
- ext-rep.txt has become ext-rep.tex.
Version: 1.0rc3 ; Revision: 1.6
- New Makefile. The forced commit and update were removed. It is
the user's responsibility to regularly cvs update and commit.
Please, check for conflicts and resolve them before continuing
work.
The new targets: dvi ps pdf html install clean
Always perform a 'make clean' before upgrade/commit.
- The 3 examples used in the ext-rep doc were moved into the
xml/doc/Examples subdir. They are also checked in into the CVS.
Obviously, they are somewhat out of date -- the GAP writer needs
to be updated. The stats part produced by the Python
stats-expander.
- The primary format is PDF. It is now installed in the Internal
Pages. The 'install' target puts it there (assuming you are
working on the DTRS server). The PDF file contains bookmarks,
external and internal links.
There are many http links embedded into the documentation. Note,
these show up correctly only in the final PDF doc and not in the
DVI file.
- The automatic inclusion of xml and rnc segments are performed by
processing a special comment in the latex source. Here is an
example:
%@ xrpp -a -d info -d automorphism_group
%@ -d info -d point_labels -d indicators
%@ -d combinatorial_properties -d resolutions
%@ -d statistical_properties
%@ -c block Examples/t2-v7-k3-L1.xml
The same method can be used in the Tehran paper. I think we should
use the same example files from xml/doc/Examples.
- There is also a new subdir called HTML/. The HTML version of the
documentation is produced there.
Could all authors, please, read the most recent version and correct any
mistakes I made during the conversion. Also, we need to update the doc
to reflect recent developments. (However, do not make any page layout
related changes before consulting me first.)
-- ,
Peter Dobcsanyi
More information about the Developers
mailing list