changed readme for graph ipelet
[Misc/ipe.git] / ipelets / graph / README.md
1 This ipelet helps when drawing graphs.  To install the ipelet,
2 download [graph.lua](graph.lua) and copy it to `~/.ipe/ipelets/` (or
3 to some other directory for ipelets).
4
5 # Features #
6
7 The menu entry "toggle graph mode" turns a new graph editing mode on
8 and off (by default it is on).  The graph mode adds the feature that
9 vertices of a graph can be moved such that the incident edges follow
10 automatically.  At the moment this only works for vertices represented
11 by marks.
12
13 ## Moving Vertices ##
14
15 Select a mark and press Ctrl+E to edit the position of the vertex.
16 Move the displayed cycle to a new position (changing its radius does
17 not have any effect) and press the space key.  The mark moves to the
18 new position and all endpoints of poly-lines and splines incident to
19 the previous position of the mark follow.
20
21 There are two different modes.  Either, only visible edges or all
22 edges on the current page are changed.  The menu entry "toggle move
23 invisible" switches between these two modes (by default only visible
24 edges are changed).
25
26 ## Shortening Edges ##
27
28 Using the "shorten target/source/both" commands you can shorten edges
29 by a specified distance.  This is useful if you have directed edges
30 with arrowheads hiding under vertices (or vice versa).  Instead of
31 shortening each of them by hand, you can select all of them and run
32 the ipelet (at least if all vertices have the same size).
33
34 # Compatibility #
35
36 ## Ipe Version ##
37
38 I tested the ipelet with versions 7.0.14, 7.1.2, 7.1.5, 7.1.7, and
39 7.1.8 of Ipe.
40
41 ## Presentation Ipelet ##
42
43 The graph iplet does not work together with the original version of
44 the presentation ipelet.  I'm using a modified [presentation
45 ipelet](presentation.lua).
46
47 # Changes #
48
49 **26 August 2015**
50         the ipelets (graph and presentation) should now also work with Ipe
51         7.1.7 and Ipe 7.1.8
52
53 **8 November 2013**
54     new mode that only changes edges that are currently visible; see
55     "Moving Vertices" (previously, all edges on the current page were
56     modified) 
57
58 **7 May 2012**
59     the Presentation Ipelet should now also work with Ipe 7.1.2
60
61 **29 April 2012**
62     shortening edges should now work with version 7.1.2 of Ipe
63
64 **26 April 2012**
65     first version of the Graph Ipelet online