-*-text-*- $Id: README.ctan,v 2.12 1994/10/28 21:39:53 kris Exp $ ====================================================== THE Xy-pic PACKAGE FOR TYPESETTING GRAPHS AND DIAGRAMS ====================================================== Xy-pic is a package for typesetting graphs and diagrams with TeX/LaTeX. Xy-pic works with most formats, including LaTeX, AMS-LaTeX, AMS-TeX, and plain TeX, and has been used to typeset very complicated diagrams from many application areas including category theory, automata theory, algebra, and databases. Xy-pic is structured as several orthogonal modules, each defining a custom notation for a particular kind of graphical object or structure. These (combinable) structures are available: * A graph combinator mode where diagrams are specified the way they are composed as graphs. * A matrix-like mode where the dimensions of the drawing are computed by aligning diagram entries in rows and columns (this is also the `version 2 compatibility mode'). * A polygon mode where diagrams shaped as regular polygons are entered in a simple way. * A general `turtle graphic' drawing language for specifying graphs with objects and connections between them in a manner independent of orientation. The following objects may be used: + Positions can be given in variety of formats (extendable) including user defined coordinates (x,y) and relative to previous positions, objects, object edges, and points on connections. + Objects may be circular or rectangular (more shapes can be added) and adjusted in several ways. + Large library of objects with mnemonic names. + Objects that orient themself along a connection when placed relative to it, e.g., `\dir{|-}' is like \vdash but thus oriented; new such objects can be defined in a convenient way. + Includes circle segments and arbitrary TeX text. + Connections are aligned between the reference points of objects but start and end on the edges. + Any object can be used to build a connection (using `diagonal filling'); library objects provide common line types. + Flexible notation for drawing arrows and general paths with tail, stem, and head build from any object(s). Special support for arrows that cross each other, arrows that `go by' other entries, paired arrows (including support for 2-cells), curved arrows, and arrows with n/8 bends. + Library of frames and braces. + Special notation for rotation, scaling, colour, and line thickness. The correct typesetting of these features requires a backend that supports it (i.e., PostScript) but even when this is not available Xy-pic tries to approximate what is requested such that at least the picture size is stable (and thus page breaks). + Output can use PostScript for drawing (several \special formats are supported: dvips, dvitops, Textures, and OzTeX -- more are being added continuously: contact Ross Moore for the current list). Notation for inclusion of literal PostScript is available. All object forms may be used with all structures. - o - See CATALOG for up to date version information! See TRAILER for author and accessibility information! See MANIFEST for a complete file list! See the various INSTALL files for how to install Xy-pic on your system! See the W3 for news! And finally, enjoy Xy-pic! Sincerely, Kristoffer H. Rose Ross Moore