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