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