manual/manual.tex

   1 \documentclass{manual}
   2
   3 % to shorten edit-compile-view cycles use
   4 % \includeonly{graph}
   5
   6 \usepackage{pyx}
   7 \ifhtml % redefine the PyX macro for html (the other makes trouble)
   8 \def\PyX{PyX}
   9 \fi
  10 \ifhtml % make double quotes available in html
  11 \def\textquotedbl{"}
  12 \fi
  13 \usepackage{graphicx}
  14 \usepackage[T1]{fontenc}
  15 \usepackage{tabularx} % TODO: get rid of that
  16 \usepackage{units}    % TODO: get rid of that
  17
  18 \title{\PyX{} Reference Manual}
  19 \author{J\"org Lehmann\\
  20 Andr\'e Wobst}
  21 \authoraddress{http://pyx.sourceforge.net/}
  22 \date{\today}
  23 \release{\input{pyxversion.tex}}
  24
  25 \makeindex
  26
  27 \begin{document}
  28
  29 \maketitle
  30
  31 \ifhtml % make abstact better available (as in the Python docs)
  32 \chapter*{Front Matter\label{front}}
  33 \fi
  34 \begin{abstract}
  35 \noindent
  36 \PyX{} is a Python package to create encapsulated PostScript figures. It
  37 provides classes and methods to access basic PostScript functionality
  38 at an abstract level. At the same time the emerging structures are
  39 very convenient to produce all kinds of drawings in a non-interactive
  40 way. In combination with the Python language itself the user can just
  41 code any complexity of the figure wanted. Additionally an
  42 \TeX{}/\LaTeX{} interface enables one to use the famous high quality
  43 typesetting within the figures.
  44
  45 A major part of \PyX{} on top of the already described basis is the
  46 provision of high level functionality for complex tasks like 2d plots
  47 in publication-ready quality.
  48 \end{abstract}
  49
  50 \tableofcontents
  51
  52 \include{intro}
  53 \include{graphics}
  54 \include{path}
  55 \include{canvas}
  56 \include{text}
  57 \include{graph}
  58 \include{axis}
  59 \include{box}
  60 \include{connector}
  61 \include{epsfile}
  62 \include{bbox}
  63 \include{color}
  64 \include{unit}
  65 \include{trafo}
  66 \appendix
  67 \include{mathtree}
  68 \include{colorname}
  69 \include{palettename}
  70 \include{pathstyles}
  71 \include{arrows}
  72
  73 \input{manual.ind}
  74
  75 \end{document}