Mercurial > hg > camir-ismir2012

annotate toolboxes/graph_visualisation/share/graphviz/doc/html/GVedit.html @ 0:cc4b1211e677 tip

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