Skip to content

ivoa-std/ivoatex

Repository files navigation

ivoatex Version 1.1
===================

This is an authoring system for IVOA (https://www.ivoa.net) documents
with the design goals of

 * version-controlled (or at least controllable) source file(s)
 * reasonable-quality PDF and HTML output
 * low to moderate installation effort (on POSIX systems with LaTeX)
 * support with routine drudgery.


Documentation
=============

Documentation on ivoatex, including a chapter on a quick start, is 
given in the IVOA note "The IVOATeX Document Preparation System",
available at https://ivoa.net/documents/Notes/IVOATex/index.html.



If you have the dependencies together (essentially, a GNU build
toolchain, a texlive-equivalent TeX distribution, subversion, and
xsltproc; on the average linux machines, chances are you're almost
there), you can build this note (which is written in IVOATeX itself)
like this::

	svn co https://volute.g-vo.org/svn/trunk/projects/ivoapub/ivoatexDoc
	cd ivoatexDoc
	make biblio
	make forcetex

Then start your favourite PDF viewer on ivoatexDoc.pdf.


Trouble?
========

In case of ivoatex-related issues, contact [email protected].
See also https://ivoatex.g-vo.org.


Acknowledgements
================

The immediate predecessor of this is the document generation system created
by Mark Taylor for SAMP and VOTable; essentially, this is a generalisation
of Mark's work.  This, in turn, built on work done by Sebastien Derriere.

Another inspiration was Paul Harrison's ivoadoc system; in particular,
parts of the XSL style sheet were taken from there, as well as the idea of
using svn:externals.

The document generation from XML schema files was adapted from XSLT 
stylesheets written by Ray Plante.


Fonts
=====

The fonts embedded in the architecture diagram are derived from
Liberation Sans and Liberation Sans Mono in the following way:

pyftsubset /usr/share/fonts/truetype/ttf-liberation/LiberationSansNarrow-Regular.ttf --unicodes="20,41-5a,61-7a" --output-file="lsn-sub.ttf"
pyftsubset /usr/share/fonts/truetype/ttf-liberation/LiberationSans-Regular.ttf --unicodes="20,41-5a,61-7a" --output-file="ls-sub.ttf"

What is inserted into the CSS within the XSLT is then the output of 

base64 -w0 ls-sub.ttf


License
=======

Unless stated otherwise in the files, ivoatex is (c) 2014-2015, the GAVO
project and can be used and distributed under the GNU General Public License
(ask for additional licenses if you're unhappy with the GPL).  See COPYING for
details.  

The files in tth_C have their own license.  See there for details.

The font excerpts in the architecture diagram are
(C) 2007 Red Hat, Inc. All rights reserved and are used in compliance
with GPL exception (a) in Red Hat's license agreement.