Debian Codegraph @

texmf-dist/doc/generic/xypic/Xy-pic.html

raw ◀ ▶
Source reconstructed at patch state 0 of 1 — not the installed (fully patched) source.
1 Debian patch touch this file
1 <html> <head>
2 <!--$Id: Xy-pic.html,v 3.38 2013/10/02 02:04:28 krisrose Exp $-->
3 <title>Xy-pic Home Page</title>
4 <!--``Xy-pic home page.''
5 %%
6 %% This file is part of the Xy-pic package for graphs and diagrams in TeX.
7 %% See the companion README and INSTALL files for further information.
8 %% Copyright (c) 1991-2012 Kristoffer H. Rose <[email protected]>
9 %%
10 %% The Xy-pic package is free software; you can redistribute it and/or modify
11 %% it under the terms of the GNU General Public License as published by the
12 %% Free Software Foundation; either version 2 of the License, or (at your
13 %% option) any later version.
14 %%
15 %% The Xy-pic package is distributed in the hope that it will be useful, but
16 %% WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
17 %% or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 %% for more details.
19 %%
20 %% You should have received a copy of the GNU General Public License along
21 %% with this package; if not, see http://www.gnu.org/licenses/.
22 -->
23 <meta name="description"
24 content="Xy-pic diagram drawing (La)TeX package home page.">
25 <meta name="keywords"
26 content="xypic, TeX, LaTeX, commutative diagram, planar graph, flow chart">
27 </head>
28
29 <body lang="EN" bgcolor="#FFFFFF">
30 <center>
31 <h1>
32 <img src="Xy-logo.png" alt="Xy" width=95 height=111 align=center alt="Xy">-pic
33 &mdash;
34 Typesetting Graphs and Diagrams in TeX
35 </h1>
36 </center>
37
38 <p>
39 Xy-pic is a package for typesetting graphs and diagrams using the
40 principle of <q>logical composition of visual components.</q> It is
41 structured as several modules, each defining a mnemonic plain text
42 notation for a particular kind of graphical object or structure.
43 Example objects are arrows, curves, frames, and colouring/rotation
44 on drivers that support it; these can be organised in matrix,
45 directed graph, path, polygon, knot, and 2-cell structure (a more
46 complete list of the features is given below).
47 <p>
48 Xy-pic works with most formats, including all variants of LaTeX,
49 AMS-TeX, and plain TeX, and has been used to typeset complicated
50 diagrams from many application areas including category theory,
51 automata theory, algebra, neural networks, topology (knots and
52 braids), database theory, chemistry, and genealogy.
53 <p>
54 Xy-pic has been designed with great care to allow the style of
55 pictures to match well with the exquisite quality of the surrounding
56 TeX typeset material.
57 </p>
58
59 <h2><a name="avail">Availability</a></h2>
60
61 <p>
62 You can get Xy-pic from
63 <a href="http://ctan.org/tex-archive/macros/generic/diagrams/xypic/">CTAN</a>
64 or directly from the
65 <a href="http://sourceforge.net/projects/xy-pic/">SourceForge development project home</a>,
66 however, chances are that Xy-pic is already included with your TeX installation
67 (for <a href="http://www.tug.org/texlive/">TeX Live</a>, for example,
68 Xy-pic is part of the <q>pictures</q> bundle).
69 <p>
70 Xy-pic was conceived by
71 <a href="http://www.krisrose.net">Kristoffer H&oslash;gsbro Rose</a>,
72 the present version is the result of several years of collaboration with
73 <a href="http://www.maths.mq.edu.au/~ross/">Ross Moore</a> with
74 essential contributions from George Necula, Jeremy Gibbons,
75 <a href="http://www.math.uni-bonn.de/people/muellner">Daniel M&uuml;llner</a>,
76 and Alex Perlis<!--, <a href="http://www.tug.org/yandy/">Y&amp;Y Inc.</a>-->,
77 and with many suggestions from more than two decades of users.
78 <p>
79 Xy-pic is &copy; by its authors as
80 <a href="http://www.fsf.org/">free software</a>.
81 </p>
82
83 <h2>Features</h2>
84
85 <p>
86 Xy-pic is structured as a <q>kernel</q> and several orthogonal modules
87 called <q>options</q>, each defining a custom notation for a particular
88 kind of graphical object or structure.
89 <p>
90
91 These (combinable) <q>logical composition</q> structures are available:
92
93 <ul>
94 <li>A graph combinator mode where diagrams are specified the way they are
95 composed as graphs.
96 <li>A matrix-like mode where the dimensions of the drawing are computed by
97 aligning diagram entries in rows and columns (this is the <q>diagram</q>
98 mode Xy-pic version 2 users are used to).
99 <li>A polygon mode where diagrams shaped as regular polygons are entered
100 in a simple way.
101 <li>A mode for typesetting beautiful knots and links.
102 <li>A general object-oriented <q>turtle graphic</q> drawing language for
103 specifying graphs with objects and connections between them in a
104 manner independent of orientation.
105 </ul>
106
107 The following <q>visual component</q> objects can be used:
108
109 <ul>
110 <li>Positions can be given in variety of formats (extendable) including
111 user defined coordinates (x,y) and relative to previous positions,
112 objects, object edges, and points on connections.
113 <li>Objects may be circular, elliptic, or rectangular (more shapes can be
114 added) and adjusted in several ways.
115 <li>Large library of objects with mnemonic names.
116 <li>Objects that orient themself along a connection when placed relative
117 to it, e.g., <q><code>@{|-}</code></q> is like <q><code>\vdash</code></q>
118 but thus oriented; new such objects can be defined in a convenient way.
119 <li>TeX <q>boxes</q>, i.e., text and mathematical formulae.
120 <li>Includes circle segments and optionally arbitrary elliptical,
121 quadratic, and cubic arcs.
122 <li>Connections are aligned between the reference points of objects but
123 start and end on the edges.
124 <li>Any object can be used to build a connection (using <q>diagonal
125 filling</q>); library objects provide common line types.
126 <li>Flexible notation for drawing arrows and general paths with
127 tail, stem, and head built from any object(s). Special support
128 for arrows that cross each other, arrows that <q>go by</q> other
129 entries, paired arrows (including support for 2-cells), curved
130 arrows, and arrows with bends. The style of arrow tips can be
131 configured to match several styles of symbol arrows.
132 <li>Library of frames and braces.
133 <li>Special notation for rotation, scaling, colour, and line thickness.
134 The correct typesetting of these features requires a backend that
135 supports it but even when this is not available
136 Xy-pic tries to approximate what is requested such that at least the
137 picture size is stable (and thus page breaks).
138 <li>Output can use PostScript<a href="#PS">*</a> for drawing (several \special formats are
139 supported: dvips, Textures, and OzTeX - more are being added
140 continuously: contact Ross Moore <[email protected]> for the current
141 list). Notation for inclusion of literal PostScript<a href="#PS">*</a> is available.
142 <li>Support for Adobe PDF<a href="#PS">*</a> output is available
143 from version 3.8 (thanks to support by Daniel M&uuml;llner and
144 font conversion software by Scott Pakin).</a>).
145 </ul>
146
147 <h2>Documentation</h2>
148
149 The official Xy-pic documentation, updated with each release, consists of the following four documents.
150
151 <ul>
152
153 <li><em>Xy-pic User's Guide</em>
154 by <a href="http://www.krisrose.net/">Kristoffer H. Rose</a>.
155 Explains how to use the Xy-pic macro package to typeset
156 basic <q>matrix-like</q> diagrams with TeX
157 (<a href="http://ctan.org/tex-archive/macros/generic/diagrams/xypic/xy/doc/xyguide.pdf">pdf</a>).<p>
158
159 <li><em>Xy-pic Reference Manual</em>
160 by <a href="http://www.krisrose.net/">Kristoffer H. Rose</a> &amp; <a href="http://www.maths.mq.edu.au/~ross/">Ross Moore</a>.
161 Reference manual for Xy-pic summarising syntax and <q>drawing
162 semantics</q> of the capabilities in the kernel, all extensions and
163 features, and the PostScript<a href="#PS">*</a> backend
164 (<a href="http://ctan.org/tex-archive/macros/generic/diagrams/xypic/xy/doc/xyrefer.pdf">pdf</a>).<p>
165
166 <li><em>Xy-pic Complete Sources with TeXnical Commentary</em>
167 by <a href="http://www.krisrose.net/">Kristoffer H. Rose</a> &amp; <a href="http://www.maths.mq.edu.au/~ross/">Ross Moore</a>.
168 Just that (a large document, <a href="http://ctan.org/tex-archive/macros/generic/diagrams/xypic/xy/doc/xysource.pdf">pdf</a>).<p>
169
170 <li><em>The xypdf package</em>
171 by <a href="http://www.math.uni-bonn.de/people/muellner">Daniel M&uuml;llner</a>.
172 Detailed user and TeXnical documentation of the PDF<a href="#PS">*</a> support for Xy-pic
173 (<a href="http://ctan.org/tex-archive/macros/generic/diagrams/xypic/xy/doc/xypdf.pdf">pdf</a>).<p>
174
175 </ul>
176
177 In addition there are several tutorials on Xy-pic.
178
179 <ul>
180
181 <li><em>An Introduction to Xy-pic</em>
182 by Cameron McLeman (<a href="http://math.arizona.edu/~swig/documentation/xypic/Xypic.pdf">pdf slides</a>).<p>
183
184 <li><em>Commutative Diagrams with XY-pic---I. Kernel Functions and Arrows</em>
185 by Paul A. Blaga (<a href="http://tug.org/pracjourn/2006-4/blaga/blaga.pdf">pdf</a>).<p>
186
187 <li><em>LaTeX/Creating Graphics/Xy-pic</em>
188 is a <a href="http://en.wikibooks.org/wiki/LaTeX/Creating_Graphics#XY-pic">WikiBook chapter</a>.<p>
189
190 <li><em>The LaTeX Graphics Companion</em>, Second Edition
191 by <a href="http://goossens.web.cern.ch/goossens/">Michel Goossens</a>, <a href="http://users.ox.ac.uk/~rahtz/">Sebastian Rahtz</a>, Frank Mittelbach, Denis Roegel, and Herbert Vo&szlig;,
192 <a href="http://aw.com">Addison-Wesley</a>, 2007.
193 Chapter 7 gives a concise introduction to some advanced uses of Xy-pic
194 (<a href="http://www.informit.com/store/product.aspx?isbn=0321508920">official page</a>;
195 in the <a href="http://books.google.com/books?id=hh6rdgZ9m3MC&printsec=frontcover&dq=The+LaTeX+Graphics+Companion&source=bl&ots=1rmNFdwt3O&sig=dQdy79YBDYQBq2r-CHfY3jL63ek&hl=en&ei=FrPXS_SkDpX49AS3tPiXBw&sa=X&oi=book_result&ct=result&resnum=1&ved=0CAsQ6AEwAA#v=onepage&q&f=false">first edition on Google books</a> chapter 5 is dedicated to Xy-pic).<p>
196
197 <li><em>Examples on Typesetting Commutative Diagrams Using Xy-pic</em>
198 by M. Alsani (<a href="http://north.ecc.edu/alsani/xypicbyexample.ps">ps</a>).<p>
199
200 <li><em>Using Xy-pic in LyX</em>
201 by H. Peter Gumm (<a href="http://wiki.lyx.org/uploads/Examples/XY-pic/xypic.pdf">pdf</a>).<p>
202
203 <li><em>Drawing knot pictures using LaTeX with Xy-pic &ndash; An introduction and tutorial</em>
204 by Lars Fischer (<a href="http://lf.starlogik.de/drawing_knot_pictures.html">html</a>).<p>
205
206 <li><em>Xy-pic tutorial with an archive of examples</em>
207 by Aaron Lauda (<a href="http://www.math.columbia.edu/~lauda/xy/">html</a>).
208 Uses low level Xy-pic directives for everything.
209 <p>
210
211 <li><em>Tutorial de Xy-pic</em>
212 by Carlos A. P. Campani (<a href="http://ufpel.edu.br/~campani/xypictutorial.pdf">pdf</a>, in Portuguese).<p>
213
214 </ul>
215
216 Finally, we maintain a collection of
217 <a href="http://ctan.org/tex-archive/macros/generic/diagrams/xypic/xysamples/">examples</a> and
218 <a href="http://ctan.org/tex-archive/macros/generic/diagrams/xypic/xypapers/">papers</a> on CTAN.
219
220 <p>
221
222 If you know of other tutorials, interesting papers, or instructive examples, that can be shared, then please drop a note to the <a href="http://www.tug.org/mailman/listinfo/xy-pic">mailing list</a>!
223
224 <h2>Help and Support</h2>
225
226 Help and support on Xy-pic matters, as well as announcement of new versions, etc., is provided by the <a href="http://www.tug.org/mailman/listinfo/xy-pic">Xy-pic mailing list</a>, graciously hosted by <a href="http://tug.org">TUG</a>.
227
228 <hr>
229 <p>
230 <a name="PS">*</a> PostScript and PDF are trademarks of <a href="http://www.adobe.com/">Adobe, Inc.</a>
231 <p>
232 <hr>
233 <address>
234 <a href="http://www.krisrose.net/">Kristoffer H&oslash;gsbro Rose</a>
235 &mdash;
236 $Id: Xy-pic.html,v 3.38 2013/10/02 02:04:28 krisrose Exp $
237 &mdash;
238 Hits by
239 <A HREF="http://www.digits.com/thumbnail/"><IMG
240 ALT=WebCounter SRC="http://www.digits.com/thumbnail/wc-01.gif"
241 WIDTH=79 HEIGHT=22 BORDER=1 ALIGN=absmiddle></A>:
242 <IMG SRC="http://counter.digits.com/wc/-c/13/-d/5/-f/000000/-b/bebebe/Xy-pic"
243 ALIGN=absmiddle WIDTH=75 HEIGHT=20 BORDER=0 ALT=Count>.
244 </address>
245 </body></html>
246
247 <!--
248 -- $Log: Xy-pic.html,v $
249 -- Revision 3.38 2013/10/02 02:04:28 krisrose
250 -- Release 3.8.9 including Barr's diagxy feature.
251 --
252 -- Revision 3.37 2011/03/14 20:14:00 krisrose
253 -- Preparing for release 3.8.6.
254 --
255 -- Revision 3.36 2010/06/23 21:20:33 krisrose
256 -- Bad backslash.
257 --
258 -- Revision 3.35 2010/06/23 21:17:35 krisrose
259 -- Chemistry rules!
260 --
261 -- Revision 3.34 2010/06/10 18:45:49 krisrose
262 -- Reference to GPL by URL.
263 --
264 -- Revision 3.33 2010/06/04 03:44:06 krisrose
265 -- More tutorials!
266 --
267 -- Revision 3.32 2010/06/03 22:58:26 krisrose
268 -- Oops.
269 --
270 -- Revision 3.31 2010/06/03 22:53:58 krisrose
271 -- Link documents on CTAN.
272 --
273 -- Revision 3.30 2010/06/03 05:51:20 krisrose
274 -- Link to v3.8 documentation.
275 --
276 -- Revision 3.29 2010/06/02 19:44:21 krisrose
277 -- Cleanup.
278 --
279 -- Revision 3.28 2010/05/22 23:20:35 dmuellner
280 -- no message
281 --
282 -- Revision 3.27 2010/05/21 04:36:29 krisrose
283 -- Experimental version with Alex's xymatrix adjustment modifiers as default.
284 --
285 -- Revision 3.26 2010/05/17 23:29:21 krisrose
286 -- Experiment: generate all the Type1 fonts with METAPOST.
287 --
288 -- Revision 3.25 2010/05/14 00:50:09 krisrose
289 -- Daniel's link included.
290 --
291 -- Revision 3.24 2010/05/14 00:37:09 krisrose
292 -- Update documentation links to PDF and include Daniel's manual.
293 --
294 -- Revision 3.23 2010/05/06 17:46:29 krisrose
295 -- Ross Moore's e-mail address updated.
296 -- Many obsolete files degraded to Historic.
297 --
298 -- Revision 3.22 2010/04/28 20:17:28 krisrose
299 -- Link to (defunct) Y&Y Inc.
300 --
301 -- Revision 3.21 2010/04/28 19:59:28 krisrose
302 -- Acknowledge properly.
303 --
304 -- Revision 3.20 2010/04/28 19:31:55 krisrose
305 -- Boast about the style integration.
306 --
307 -- Revision 3.19 2010/04/28 07:17:17 krisrose
308 -- PDF only in 3.8.
309 --
310 -- Revision 3.18 2010/04/28 07:11:02 krisrose
311 -- Sic, again...
312 --
313 -- Revision 3.17 2010/04/28 07:09:10 krisrose
314 -- CTAN samples and papers links...
315 --
316 -- Revision 3.16 2010/04/28 07:05:39 krisrose
317 -- &szlig;
318 --
319 -- Revision 3.15 2010/04/28 07:01:24 krisrose
320 -- Users!
321 --
322 -- Revision 3.14 2010/04/28 06:54:55 krisrose
323 -- Removed Latin1 specific characters.
324 --
325 -- Revision 3.13 2010/04/28 06:50:42 krisrose
326 -- Removed dangling link.
327 --
328 -- Revision 3.12 2010/04/28 06:43:27 krisrose
329 -- Sic.
330 --
331 -- Revision 3.11 2010/04/28 05:39:25 krisrose
332 -- Checked and made version independent.
333 --
334 -- Revision 3.10 2010/04/26 05:56:57 krisrose
335 -- Link fixes in progress...
336 --
337 -- Revision 3.9 2010/04/21 18:41:02 krisrose
338 -- Adjustments preparing for xypdf.dtx and friends!
339 --
340 -- Revision 3.8 2010/04/16 06:06:51 krisrose
341 -- Preparing for a new release...
342 --
343 -- Revision 3.7 1999/02/16 15:01:59 krisrose
344 -- Updated for the interim 3.7.
345 --
346 -- Revision 3.6 1998/03/06 01:28:05 krisrose
347 -- Releasing (with Y&Y fonts).
348 --
349 -- Revision 3.5 1997/05/28 13:05:01 krisrose
350 -- Fixed missing breaks bug.
351 --
352 -- Revision 3.4 1997/05/18 01:14:25 krisrose
353 -- Essential bugfixes.
354 --
355 -- Revision 3.3 1996/12/19 17:03:13 krisrose
356 -- Maintenance release.
357 --
358 -- Revision 3.2 1995/09/19 18:22:27 kris
359 -- Bug fix release.
360 --
361 -- Revision 3.1 1995/09/05 20:31:32 kris
362 -- Releasing!
363 --
364 -- Revision 3.0 1995/07/07 20:55:47 kris
365 -- Refers to v3!
366 --
367 -- Revision 2.13 1995/07/04 15:11:17 kris
368 -- Ready to release v3?
369 --
370 -- Revision 1.2 1994/10/06 16:43:38 kris
371 -- Cleaned up to be a proper Xy-pic home page.
372 --
373 -- Revision 1.1 1994/08/29 12:24:13 kris
374 -- Initial revision
375 --
376 -- Xy-pic `home page'.
377 -->