| 1 |
-*-text-*- $Id: README,v 3.11 2010/05/06 17:46:29 krisrose Exp $ |
| 2 |
|
| 3 |
====================================================== |
| 4 |
THE Xy-pic PACKAGE FOR TYPESETTING GRAPHS AND DIAGRAMS |
| 5 |
====================================================== |
| 6 |
|
| 7 |
Xy-pic is a package for typesetting graphs and diagrams with TeX. |
| 8 |
|
| 9 |
It works with most formats, including LaTeX (both 2.09 and 2e), |
| 10 |
AMS-LaTeX, AMS-TeX, and plain TeX. |
| 11 |
|
| 12 |
It has been used to typeset complicated diagrams from many application |
| 13 |
areas including category theory, automata theory, algebra, neural |
| 14 |
networks, and database theory. |
| 15 |
|
| 16 |
- o - |
| 17 |
|
| 18 |
See below in this file for an overview of the structure and features! |
| 19 |
See CATALOG for up to date version information! |
| 20 |
See TRAILER for author and accessibility information! |
| 21 |
See COPYING for the conditions for redistribution and modification! |
| 22 |
See VERSIONS for the exact list of the versions of all source files! |
| 23 |
See INSTALL for how to install Xy-pic on your system! |
| 24 |
Go to <URL: http://xy-pic.sourceforge.net> for source and news! |
| 25 |
|
| 26 |
- o - |
| 27 |
|
| 28 |
Xy-pic is structured as a `kernel' and several orthogonal modules called |
| 29 |
`options', each defining a custom notation for a particular kind of |
| 30 |
graphical object or structure. |
| 31 |
|
| 32 |
These (combinable) structures are available: |
| 33 |
|
| 34 |
* A graph combinator mode where diagrams are specified the way they are |
| 35 |
composed as graphs. |
| 36 |
|
| 37 |
* A matrix-like mode where the dimensions of the drawing are computed by |
| 38 |
aligning diagram entries in rows and columns (this is the `diagram' |
| 39 |
mode Xy-pic version 2 users are used to). |
| 40 |
|
| 41 |
* A polygon mode where diagrams shaped as regular polygons are entered |
| 42 |
in a simple way. |
| 43 |
|
| 44 |
* A mode for typesetting beautiful knots and links. |
| 45 |
|
| 46 |
* A general object-oriented `turtle graphic' drawing language for |
| 47 |
specifying graphs with objects and connections between them in a |
| 48 |
manner independent of orientation. |
| 49 |
|
| 50 |
* An experimental facility for generating movies where diagrams wiggle |
| 51 |
and bend into place... |
| 52 |
|
| 53 |
The following objects may be used: |
| 54 |
|
| 55 |
+ Positions can be given in variety of formats (extendable) including |
| 56 |
user defined coordinates (x,y) and relative to previous positions, |
| 57 |
objects, object edges, and points on connections. |
| 58 |
|
| 59 |
+ Objects may be circular, elliptic, or rectangular (more shapes can be |
| 60 |
added) and adjusted in several ways. |
| 61 |
|
| 62 |
+ Large library of objects with mnemonic names. |
| 63 |
|
| 64 |
+ Objects that orient themself along a connection when placed relative |
| 65 |
to it, e.g., `\dir{|-}' is like \vdash but thus oriented; new such |
| 66 |
objects can be defined in a convenient way. |
| 67 |
|
| 68 |
+ TeX `boxes', i.e., text and mathematical formulae. |
| 69 |
|
| 70 |
+ Includes circle segments and optionally arbitrary elliptical, |
| 71 |
quadratic, and cubic arcs. |
| 72 |
|
| 73 |
+ Connections are aligned between the reference points of objects but |
| 74 |
start and end on the edges. |
| 75 |
|
| 76 |
+ Any object can be used to build a connection (using `diagonal |
| 77 |
filling'); library objects provide common line types. |
| 78 |
|
| 79 |
+ Flexible notation for drawing arrows and general paths with tail, |
| 80 |
stem, and head built from any object(s). Special support for arrows |
| 81 |
that cross each other, arrows that `go by' other entries, paired |
| 82 |
arrows (including support for 2-cells), curved arrows, and arrows with |
| 83 |
bends. |
| 84 |
|
| 85 |
+ Library of frames and braces. |
| 86 |
|
| 87 |
+ Special notation for rotation, scaling, colour, and line thickness. |
| 88 |
The correct typesetting of these features requires a backend that |
| 89 |
supports it (i.e., PostScript) but even when this is not available |
| 90 |
Xy-pic tries to approximate what is requested such that at least the |
| 91 |
picture size is stable (and thus page breaks). |
| 92 |
|
| 93 |
+ Output can use PDF or PostScript for drawing (several \special |
| 94 |
formats are supported, including pdfTeX, dvips, and Textures). |
| 95 |
Notation for inclusion of literal PostScript is available. |
| 96 |
|
| 97 |
* Other graphics can be imported and then `decorated' using Xy-pic. |
| 98 |
|
| 99 |
All object forms may be used with all structures. |
| 100 |
|
| 101 |
- o - |
| 102 |
|
| 103 |
Finally, enjoy Xy-pic! |
| 104 |
|
| 105 |
Sincerely, |
| 106 |
Kristoffer H. Rose <[email protected]> |
| 107 |
Ross Moore <[email protected]> |