The ivoaTeX document preparation system

IvoaTeX is a TeX-based software for authoring IVOA standards and Notes. Authors are encouraged to use it in connection with the volute version controlled repository.

An IVOA note describing the system is written in ivoaTeX itself and can be checked out from volute (if you believe you have the dependencies installed, building the document from there is a good idea; in general, checkouts will contain updates over the published Note).

Getting ivoaTeX

IvoaTeX is designed to be included with the document source, preferably via mechanisms of the version control system chosen (e.g., svn:externals or git submodule).

Still, in some situations it may be preferable to fetch tarballs of releases. Here they are:

[Version 1.1] [Version 1.0] [Version 0.4]

Crib Sheet

For your convenience (you should skim over the note anyway), here's a few crib sheets on ivoaTeX operation.

Installing the dependencies

Debian-derived systems:
apt-get install build-essential texlive-latex-extra zip xsltproc\
  texlive-bibtex-extra imagemagick ghostscript cm-super librsvg2-bin
yum install texlive-scheme-full libxslt make gcc zip\
  ImageMagick ghostscript
Mac OS X with MacPorts
port install ImageMagick  libxslt ghostscript texlive +full

Checking Out a Standard from Volute and Building it

svn co
cd ivoatexDoc
make biblio
make forcetex
# result: ivoatexDoc.pdf

Starting a Document on Volute

export DOCNAME=???? # your short name, e.g., TAP, VOResource
export VOLUTEBASE=""
export WG=?????
# this would be the Working Group name as represented in
# volute subdirectories: dal, dm, edu, grid, registry
rm -r $DOCNAME
svn propset svn:externals\
  "ivoatex $VOLUTEBASE/ivoapub/ivoatex" .
svn update
svn propset svn:ignore . --file ivoatex/svn-ignore.txt
cp ivoatex/Makefile.template Makefile
cp ivoatex/document.template $DOCNAME.tex
cp ivoatex/archdiag.png .
svn add Makefile $DOCNAME.tex archdiag.png
# Now fill out the variables in Makefile
# then start editing $DOCNAME.tex
# To build a PDF, now run
# make biblio  (first time and when you change citations and such)
# make