|
wolffd@0
|
1 <html>
|
|
wolffd@0
|
2
|
|
wolffd@0
|
3 <head>
|
|
wolffd@0
|
4 <meta http-equiv=Content-Type content="text/html; charset=windows-1252">
|
|
wolffd@0
|
5 <meta name=Generator content="Microsoft Word 11 (filtered)">
|
|
wolffd@0
|
6 <title>GVedit Help</title>
|
|
wolffd@0
|
7 <style>
|
|
wolffd@0
|
8 <!--
|
|
wolffd@0
|
9 /* Style Definitions */
|
|
wolffd@0
|
10 p.MsoNormal, li.MsoNormal, div.MsoNormal
|
|
wolffd@0
|
11 {margin:0in;
|
|
wolffd@0
|
12 margin-bottom:.0001pt;
|
|
wolffd@0
|
13 font-size:12.0pt;
|
|
wolffd@0
|
14 font-family:"Times New Roman";}
|
|
wolffd@0
|
15 @page Section1
|
|
wolffd@0
|
16 {size:8.5in 11.0in;
|
|
wolffd@0
|
17 margin:1.0in 1.25in 1.0in 1.25in;}
|
|
wolffd@0
|
18 div.Section1
|
|
wolffd@0
|
19 {page:Section1;}
|
|
wolffd@0
|
20 -->
|
|
wolffd@0
|
21 </style>
|
|
wolffd@0
|
22
|
|
wolffd@0
|
23 </head>
|
|
wolffd@0
|
24
|
|
wolffd@0
|
25 <body lang=EN-US>
|
|
wolffd@0
|
26
|
|
wolffd@0
|
27 <div class=Section1>
|
|
wolffd@0
|
28
|
|
wolffd@0
|
29 <p class=MsoNormal align=center style='text-align:center'><b><u>Introduction</u></b></p>
|
|
wolffd@0
|
30
|
|
wolffd@0
|
31 <p class=MsoNormal style='text-indent:.5in'>GVedit<span style='color:black'> is a
|
|
wolffd@0
|
32 Graphviz tool for creating, viewing, editing and processing DOT files. It
|
|
wolffd@0
|
33 allows users to set attributes of graphs with dialogue boxes and save them
|
|
wolffd@0
|
34 for future use. GVedit users can also take advantage of the simple
|
|
wolffd@0
|
35 instant previewing feature of the program.</span></p>
|
|
wolffd@0
|
36
|
|
wolffd@0
|
37 <p class=MsoNormal><span style='color:black'> </span></p>
|
|
wolffd@0
|
38
|
|
wolffd@0
|
39 <p class=MsoNormal align=center style='text-align:center'><b><u><span
|
|
wolffd@0
|
40 style='color:black'>Menu system</span></u></b></p>
|
|
wolffd@0
|
41
|
|
wolffd@0
|
42 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>GVedit's main menu bar
|
|
wolffd@0
|
43 provides basic file options such as <b>Open</b>, <b>Save</b>, <b>Save As</b> and simple editing
|
|
wolffd@0
|
44 operations such as <b>Cut</b>, <b>Copy</b> and <b>Paste</b>. Most of the common commands
|
|
wolffd@0
|
45 also have standard keyboard shortcuts.
|
|
wolffd@0
|
46 Below you will find a list of the menu items and brief information on
|
|
wolffd@0
|
47 each of them.</span></p>
|
|
wolffd@0
|
48
|
|
wolffd@0
|
49 <p class=MsoNormal><span style='color:black'> </span></p>
|
|
wolffd@0
|
50 <p class=MsoNormal><b><span style='color:black'>File:</span></b></p>
|
|
wolffd@0
|
51
|
|
wolffd@0
|
52 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>New: Creates a blank text
|
|
wolffd@0
|
53 window. You can use it to write a description of a graph in the DOT language.
|
|
wolffd@0
|
54 New graphs are not saved to disk until you save them manually.</span></p>
|
|
wolffd@0
|
55
|
|
wolffd@0
|
56 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Open: Opens a file
|
|
wolffd@0
|
57 dialogue box to select and load a DOT file into the editor. Each file is opened in a
|
|
wolffd@0
|
58 new window and does not affect other open graphs.</span></p>
|
|
wolffd@0
|
59
|
|
wolffd@0
|
60 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Save: Saves the active
|
|
wolffd@0
|
61 graph to disk. If the active graph is new and does not have a name,
|
|
wolffd@0
|
62 it opens a <b>Save As</b> dialogue to allow you
|
|
wolffd@0
|
63 to specify the file's name before saving.</span></p>
|
|
wolffd@0
|
64
|
|
wolffd@0
|
65 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Save as: Opens a <b>Save As</b>
|
|
wolffd@0
|
66 dialogue to save the active graph. You can save a graph under different names but
|
|
wolffd@0
|
67 you will always be working with the most recently saved graph.</span></p>
|
|
wolffd@0
|
68
|
|
wolffd@0
|
69 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>
|
|
wolffd@0
|
70 Close: Closes the active graph window. If there are any unsaved changes,
|
|
wolffd@0
|
71 you get a dialogue box asking if you want to
|
|
wolffd@0
|
72 save the changes before closing the graph.</span></p>
|
|
wolffd@0
|
73
|
|
wolffd@0
|
74 <p class=MsoNormal><span style='color:black'> </span></p>
|
|
wolffd@0
|
75
|
|
wolffd@0
|
76 <p class=MsoNormal><b><span style='color:black'>Edit:</span></b></p>
|
|
wolffd@0
|
77
|
|
wolffd@0
|
78 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Undo : This command
|
|
wolffd@0
|
79 rolls back the last thing that you have done within the active graph. </span></p>
|
|
wolffd@0
|
80
|
|
wolffd@0
|
81 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Cut : Removes selected
|
|
wolffd@0
|
82 text and keeps it in the clipboard. </span></p>
|
|
wolffd@0
|
83
|
|
wolffd@0
|
84 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Copy: Copies selected
|
|
wolffd@0
|
85 text to the clipboard. </span></p>
|
|
wolffd@0
|
86
|
|
wolffd@0
|
87 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>
|
|
wolffd@0
|
88 Paste: Inserts the text from the clipboard into the cursor position on the
|
|
wolffd@0
|
89 active graph.</span></p>
|
|
wolffd@0
|
90
|
|
wolffd@0
|
91 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Find: Opens the find
|
|
wolffd@0
|
92 dialogue box to allow you to locate desired text in a graph.</span></p>
|
|
wolffd@0
|
93
|
|
wolffd@0
|
94 <p class=MsoNormal><span style='color:black'> </span></p>
|
|
wolffd@0
|
95 <p class=MsoNormal><b><span style='color:black'>Graphviz</span></b></p>
|
|
wolffd@0
|
96
|
|
wolffd@0
|
97 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Run: Processes the active
|
|
wolffd@0
|
98 graph with the last attributes that were used for it. If the active graph has
|
|
wolffd@0
|
99 never been processed before, it opens the settings window.</span></p>
|
|
wolffd@0
|
100
|
|
wolffd@0
|
101 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Settings: Opens the
|
|
wolffd@0
|
102 settings window. Details of this window are given below.
|
|
wolffd@0
|
103 </span></p>
|
|
wolffd@0
|
104
|
|
wolffd@0
|
105 <p class=MsoNormal><span style='color:black'> </span></p>
|
|
wolffd@0
|
106 <p class=MsoNormal><b><span style='color:black'>View</span></b></p>
|
|
wolffd@0
|
107 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Cascade:
|
|
wolffd@0
|
108 Sets the style for handling multiple windows to cascade, in which each
|
|
wolffd@0
|
109 new window overlaps the previous one.
|
|
wolffd@0
|
110 </span></p>
|
|
wolffd@0
|
111 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Tile:
|
|
wolffd@0
|
112 Sets the style for handling multiple windows to tiling, in which the
|
|
wolffd@0
|
113 open graph windows partition the root window.
|
|
wolffd@0
|
114 </span></p>
|
|
wolffd@0
|
115
|
|
wolffd@0
|
116 <p class=MsoNormal><span style='color:black'> </span></p>
|
|
wolffd@0
|
117 <p class=MsoNormal><b><span style='color:black'>Help</span></b></p>
|
|
wolffd@0
|
118 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>
|
|
wolffd@0
|
119 Help: Opens a manual page describing how to use this program.
|
|
wolffd@0
|
120 </span></p>
|
|
wolffd@0
|
121 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>
|
|
wolffd@0
|
122 Graphviz on net: Opens a browser window on the Graphviz home page.
|
|
wolffd@0
|
123 </span></p>
|
|
wolffd@0
|
124 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>
|
|
wolffd@0
|
125 About GVedit: Provides version information about the program.
|
|
wolffd@0
|
126 </span></p>
|
|
wolffd@0
|
127
|
|
wolffd@0
|
128 <p class=MsoNormal align=center style='text-align:center'><b><u><span
|
|
wolffd@0
|
129 style='color:black'>Tool bar</span></u></b></p>
|
|
wolffd@0
|
130
|
|
wolffd@0
|
131 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Under the menu bar,
|
|
wolffd@0
|
132 there is a toolbar with five buttons on it. These buttons are nothing but shortcuts
|
|
wolffd@0
|
133 to some menu items. Each button has a tool tip attached to it to
|
|
wolffd@0
|
134 indicate its purpose.</span></p>
|
|
wolffd@0
|
135
|
|
wolffd@0
|
136 <p class=MsoNormal align=center style='text-align:center'><b><u><span
|
|
wolffd@0
|
137 style='color:black'><span style='text-decoration:none'> </span></span></u></b></p>
|
|
wolffd@0
|
138
|
|
wolffd@0
|
139 <p class=MsoNormal align=center style='text-align:center'><b><u><span
|
|
wolffd@0
|
140 style='color:black'>Working with multiple graphs; the active graph</span></u></b><span
|
|
wolffd@0
|
141 style='color:black'>.</span></p>
|
|
wolffd@0
|
142
|
|
wolffd@0
|
143 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>
|
|
wolffd@0
|
144 GVedit allows you to have multiple graphs open at the same time. At any
|
|
wolffd@0
|
145 time, there is a single active graph.
|
|
wolffd@0
|
146 Anything you do using either the GVedit menus or the settings window affects the
|
|
wolffd@0
|
147 active graph. When you go to the settings window, you always see the
|
|
wolffd@0
|
148 settings of active graph.
|
|
wolffd@0
|
149 The settings of each graph are maintained separately.
|
|
wolffd@0
|
150 </span></p>
|
|
wolffd@0
|
151 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>
|
|
wolffd@0
|
152 To make a graph active, click on its window.
|
|
wolffd@0
|
153 The background of the active graph window is white
|
|
wolffd@0
|
154 while all others are gray.
|
|
wolffd@0
|
155 </span></p>
|
|
wolffd@0
|
156
|
|
wolffd@0
|
157 <p class=MsoNormal align=center style='text-align:center'><b><u><span
|
|
wolffd@0
|
158 style='color:black'><span style='text-decoration:none'> </span></span></u></b></p>
|
|
wolffd@0
|
159 <p class=MsoNormal align=center style='text-align:center'><b><u><span
|
|
wolffd@0
|
160 style='color:black'>Settings window</span></u></b></p>
|
|
wolffd@0
|
161
|
|
wolffd@0
|
162 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>
|
|
wolffd@0
|
163 With the settings window,
|
|
wolffd@0
|
164 you can select the layout engine, set the output type and file,
|
|
wolffd@0
|
165 and set any attributes that are available with the Graphviz release
|
|
wolffd@0
|
166 installed on your computer.</span></p>
|
|
wolffd@0
|
167
|
|
wolffd@0
|
168 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'><b>Layout engine:</b>
|
|
wolffd@0
|
169 Graphviz provides five different graph layouts. You can select
|
|
wolffd@0
|
170 the one which best fits your needs. More information about these layouts
|
|
wolffd@0
|
171 can be found at the <A HREF="http://www.graphviz.org">Graphviz home page</A>
|
|
wolffd@0
|
172 </span></p>
|
|
wolffd@0
|
173
|
|
wolffd@0
|
174 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'><b>Output file name:</b>
|
|
wolffd@0
|
175 This field allows you to specify the output file name.
|
|
wolffd@0
|
176 You can either type in the name, or use the
|
|
wolffd@0
|
177 small button by the text box to open a file
|
|
wolffd@0
|
178 dialogue box.
|
|
wolffd@0
|
179 This field corresponds to the –o option of Graphviz.
|
|
wolffd@0
|
180 </span></p>
|
|
wolffd@0
|
181
|
|
wolffd@0
|
182 <p class=MsoNormal style='text-indent:.5in'><b><span style='color:black'>Output
|
|
wolffd@0
|
183 file type:</span></b><span style='color:black'> This drop down list allows
|
|
wolffd@0
|
184 you to select the output file type. The output file name's extension is changed
|
|
wolffd@0
|
185 accordingly.
|
|
wolffd@0
|
186 This field corresponds to the –T option of Graphviz.
|
|
wolffd@0
|
187 </span></p>
|
|
wolffd@0
|
188
|
|
wolffd@0
|
189 <p class=MsoNormal style='text-indent:.5in'><b><span style='color:black'>Graphviz
|
|
wolffd@0
|
190 bin folder:</span></b><span style='color:black'>You usually do not need to
|
|
wolffd@0
|
191 enter anything here. During the Graphviz installation, locations of the Graphviz
|
|
wolffd@0
|
192 files are stored in the registry and GVedit retrieves it from there. If,
|
|
wolffd@0
|
193 for some reason, Graphviz files are not where they are supposed to be
|
|
wolffd@0
|
194 and GVedit can not
|
|
wolffd@0
|
195 find them, you can edit this information manually.
|
|
wolffd@0
|
196 </span></p>
|
|
wolffd@0
|
197
|
|
wolffd@0
|
198 <p class=MsoNormal style='text-indent:.5in'><b><span style='color:black'>
|
|
wolffd@0
|
199 Preview Output file:</span></b><span style='color:black'>
|
|
wolffd@0
|
200 If this box is checked,
|
|
wolffd@0
|
201 GVedit creates a low-quality preview of the output and shows it in a
|
|
wolffd@0
|
202 separate window. It is a convenient way to preview the results without
|
|
wolffd@0
|
203 executing another viewing program.
|
|
wolffd@0
|
204 </span></p>
|
|
wolffd@0
|
205
|
|
wolffd@0
|
206 <p class=MsoNormal style='text-indent:.5in'><b><span style='color:black'>
|
|
wolffd@0
|
207 Apply cairo filter:</span></b><span style='color:black'>
|
|
wolffd@0
|
208 If this output format is supported by the cairo library, this box becomes
|
|
wolffd@0
|
209 active. If checked, output will be generated using the cairo library
|
|
wolffd@0
|
210 rather than the default renderer.
|
|
wolffd@0
|
211 </span></p>
|
|
wolffd@0
|
212
|
|
wolffd@0
|
213 <p class=MsoNormal style='text-indent:.5in'><b><span style='color:black'>Attributes:</span></b><span style='color:black'>
|
|
wolffd@0
|
214 On the lower half of the settings window, you will see two dropdown lists,
|
|
wolffd@0
|
215 one small text box, and a larger text editing area. GVedit processes the
|
|
wolffd@0
|
216 contents of the large box as additional, generic graph, node or edge attributes.
|
|
wolffd@0
|
217 (These correspond to the –G, –N, and –E command-line options of Graphviz.)
|
|
wolffd@0
|
218 You can either type directly in the large text box,
|
|
wolffd@0
|
219 or use the drop down lists to pick
|
|
wolffd@0
|
220 an allowed scope and one of the common attribute names.
|
|
wolffd@0
|
221 For details of these attributes, refer to the
|
|
wolffd@0
|
222 <A HREF="http://www.graphviz.org/doc/info/attrs.html">page of Graphviz attributes.</A>
|
|
wolffd@0
|
223 </span></p>
|
|
wolffd@0
|
224
|
|
wolffd@0
|
225 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>
|
|
wolffd@0
|
226 If you specify an attribute using the drop down lists, you need to click on the
|
|
wolffd@0
|
227 <b>Add</b> button to register the attribute.
|
|
wolffd@0
|
228 If you do not click on
|
|
wolffd@0
|
229 <b>Add</b> button, the attribute that you entered will not be
|
|
wolffd@0
|
230 added to the large box, hence will not be processed.
|
|
wolffd@0
|
231 </span></p>
|
|
wolffd@0
|
232
|
|
wolffd@0
|
233 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>As an
|
|
wolffd@0
|
234 example, assume that we would like to have a graph drawn
|
|
wolffd@0
|
235 with a green background.
|
|
wolffd@0
|
236 First, click on the scope list and select <b>graph</b>;
|
|
wolffd@0
|
237 then click on the name list and
|
|
wolffd@0
|
238 select <b>bgcolor</b>; and then type <tt>green</tt> to the value box.
|
|
wolffd@0
|
239 Finally, click on the <b>Add</b> button to send the attribute to large box.
|
|
wolffd@0
|
240 </span></p>
|
|
wolffd@0
|
241
|
|
wolffd@0
|
242 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>
|
|
wolffd@0
|
243 Belowe the <b>Add</b> button is a <b>Help</b> button. Clicking on this
|
|
wolffd@0
|
244 will open a browser window on the Graphviz page describing the supported
|
|
wolffd@0
|
245 attributes.
|
|
wolffd@0
|
246 </span></p>
|
|
wolffd@0
|
247
|
|
wolffd@0
|
248 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'>
|
|
wolffd@0
|
249 Under the large box, there are 3 small buttons, plus
|
|
wolffd@0
|
250 <b>Cancel</b> and <b>OK</b> buttons. The first button is used to
|
|
wolffd@0
|
251 clear the attributes box;
|
|
wolffd@0
|
252 the second one is used to load an existing text file into the attributes box;
|
|
wolffd@0
|
253 and the last one is used to save the attributes to a text file for later use.
|
|
wolffd@0
|
254 The <b>Cancel</b> button closes the window without processing anything;
|
|
wolffd@0
|
255 the <b>OK</b> button processes the
|
|
wolffd@0
|
256 active document file with the settings on the screen and closes the settings
|
|
wolffd@0
|
257 window. If you check the preview check box, you will see the preview of the
|
|
wolffd@0
|
258 graph layout on the screen.</span></p>
|
|
wolffd@0
|
259
|
|
wolffd@0
|
260 <p class=MsoNormal><span style='color:black'> </span></p>
|
|
wolffd@0
|
261
|
|
wolffd@0
|
262 <p class=MsoNormal align=center style='text-align:center'><b><u><span
|
|
wolffd@0
|
263 style='color:black'>Console window</span></u></b></p>
|
|
wolffd@0
|
264
|
|
wolffd@0
|
265 <p class=MsoNormalstyle='text-indent:.5in'><span style='color:black'>
|
|
wolffd@0
|
266 At the bottom of the
|
|
wolffd@0
|
267 main window, there is a console window where you can see the results of your
|
|
wolffd@0
|
268 actions. This provides a trace of your layout actions, showing the
|
|
wolffd@0
|
269 Graphviz command corresponding to the active graph's settings. It also
|
|
wolffd@0
|
270 displays warnings from GVedit, as well as the output of the
|
|
wolffd@0
|
271 executed Graphviz programs.
|
|
wolffd@0
|
272 By right clicking on the console window, you will get a menu providing some
|
|
wolffd@0
|
273 additional functions, such as clearing or saving the console logs.</span></p>
|
|
wolffd@0
|
274
|
|
wolffd@0
|
275 <p class=MsoNormal><span style='color:black'> </span></p>
|
|
wolffd@0
|
276
|
|
wolffd@0
|
277 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'> </span></p>
|
|
wolffd@0
|
278
|
|
wolffd@0
|
279 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'> </span></p>
|
|
wolffd@0
|
280
|
|
wolffd@0
|
281 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'> </span></p>
|
|
wolffd@0
|
282
|
|
wolffd@0
|
283 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'> </span></p>
|
|
wolffd@0
|
284
|
|
wolffd@0
|
285 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'> </span></p>
|
|
wolffd@0
|
286
|
|
wolffd@0
|
287 <p class=MsoNormal style='text-indent:.5in'><span style='color:black'> </span></p>
|
|
wolffd@0
|
288
|
|
wolffd@0
|
289 <p class=MsoNormal><span style='color:black'> </span></p>
|
|
wolffd@0
|
290
|
|
wolffd@0
|
291 <p class=MsoNormal><span style='color:black'> </span></p>
|
|
wolffd@0
|
292
|
|
wolffd@0
|
293 <p class=MsoNormal><span style='color:black'> </span></p>
|
|
wolffd@0
|
294
|
|
wolffd@0
|
295 <p class=MsoNormal><span style='color:black'> </span></p>
|
|
wolffd@0
|
296
|
|
wolffd@0
|
297 <p class=MsoNormal><span style='color:black'> </span></p>
|
|
wolffd@0
|
298
|
|
wolffd@0
|
299 <p class=MsoNormal><span style='color:black'> </span></p>
|
|
wolffd@0
|
300
|
|
wolffd@0
|
301 </div>
|
|
wolffd@0
|
302
|
|
wolffd@0
|
303 </body>
|
|
wolffd@0
|
304
|
|
wolffd@0
|
305 </html>
|
