Mercurial > hg > camir-aes2014
diff toolboxes/graph_visualisation/share/graphviz/doc/html/GVedit.html @ 0:e9a9cd732c1e tip
first hg version after svn
| author | wolffd |
|---|---|
| date | Tue, 10 Feb 2015 15:05:51 +0000 |
| parents | |
| children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/toolboxes/graph_visualisation/share/graphviz/doc/html/GVedit.html Tue Feb 10 15:05:51 2015 +0000 @@ -0,0 +1,305 @@ +<html> + +<head> +<meta http-equiv=Content-Type content="text/html; charset=windows-1252"> +<meta name=Generator content="Microsoft Word 11 (filtered)"> +<title>GVedit Help</title> +<style> +<!-- + /* Style Definitions */ + p.MsoNormal, li.MsoNormal, div.MsoNormal + {margin:0in; + margin-bottom:.0001pt; + font-size:12.0pt; + font-family:"Times New Roman";} +@page Section1 + {size:8.5in 11.0in; + margin:1.0in 1.25in 1.0in 1.25in;} +div.Section1 + {page:Section1;} +--> +</style> + +</head> + +<body lang=EN-US> + +<div class=Section1> + +<p class=MsoNormal align=center style='text-align:center'><b><u>Introduction</u></b></p> + +<p class=MsoNormal style='text-indent:.5in'>GVedit<span style='color:black'> is a +Graphviz tool for creating, viewing, editing and processing DOT files. It +allows users to set attributes of graphs with dialogue boxes and save them +for future use. GVedit users can also take advantage of the simple +instant previewing feature of the program.</span></p> + +<p class=MsoNormal><span style='color:black'> </span></p> + +<p class=MsoNormal align=center style='text-align:center'><b><u><span +style='color:black'>Menu system</span></u></b></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>GVedit's main menu bar +provides basic file options such as <b>Open</b>, <b>Save</b>, <b>Save As</b> and simple editing +operations such as <b>Cut</b>, <b>Copy</b> and <b>Paste</b>. Most of the common commands +also have standard keyboard shortcuts. +Below you will find a list of the menu items and brief information on +each of them.</span></p> + +<p class=MsoNormal><span style='color:black'> </span></p> +<p class=MsoNormal><b><span style='color:black'>File:</span></b></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>New: Creates a blank text +window. You can use it to write a description of a graph in the DOT language. +New graphs are not saved to disk until you save them manually.</span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Open: Opens a file +dialogue box to select and load a DOT file into the editor. Each file is opened in a +new window and does not affect other open graphs.</span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Save: Saves the active +graph to disk. If the active graph is new and does not have a name, +it opens a <b>Save As</b> dialogue to allow you +to specify the file's name before saving.</span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Save as: Opens a <b>Save As</b> +dialogue to save the active graph. You can save a graph under different names but +you will always be working with the most recently saved graph.</span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> +Close: Closes the active graph window. If there are any unsaved changes, +you get a dialogue box asking if you want to +save the changes before closing the graph.</span></p> + +<p class=MsoNormal><span style='color:black'> </span></p> + +<p class=MsoNormal><b><span style='color:black'>Edit:</span></b></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Undo : This command +rolls back the last thing that you have done within the active graph. </span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Cut : Removes selected +text and keeps it in the clipboard. </span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Copy: Copies selected +text to the clipboard. </span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> +Paste: Inserts the text from the clipboard into the cursor position on the +active graph.</span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Find: Opens the find +dialogue box to allow you to locate desired text in a graph.</span></p> + +<p class=MsoNormal><span style='color:black'> </span></p> +<p class=MsoNormal><b><span style='color:black'>Graphviz</span></b></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Run: Processes the active +graph with the last attributes that were used for it. If the active graph has +never been processed before, it opens the settings window.</span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Settings: Opens the +settings window. Details of this window are given below. +</span></p> + +<p class=MsoNormal><span style='color:black'> </span></p> +<p class=MsoNormal><b><span style='color:black'>View</span></b></p> +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Cascade: +Sets the style for handling multiple windows to cascade, in which each +new window overlaps the previous one. +</span></p> +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Tile: +Sets the style for handling multiple windows to tiling, in which the +open graph windows partition the root window. +</span></p> + +<p class=MsoNormal><span style='color:black'> </span></p> +<p class=MsoNormal><b><span style='color:black'>Help</span></b></p> +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> +Help: Opens a manual page describing how to use this program. +</span></p> +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> +Graphviz on net: Opens a browser window on the Graphviz home page. +</span></p> +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> +About GVedit: Provides version information about the program. +</span></p> + +<p class=MsoNormal align=center style='text-align:center'><b><u><span +style='color:black'>Tool bar</span></u></b></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>Under the menu bar, +there is a toolbar with five buttons on it. These buttons are nothing but shortcuts +to some menu items. Each button has a tool tip attached to it to +indicate its purpose.</span></p> + +<p class=MsoNormal align=center style='text-align:center'><b><u><span +style='color:black'><span style='text-decoration:none'> </span></span></u></b></p> + +<p class=MsoNormal align=center style='text-align:center'><b><u><span +style='color:black'>Working with multiple graphs; the active graph</span></u></b><span +style='color:black'>.</span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> +GVedit allows you to have multiple graphs open at the same time. At any +time, there is a single active graph. +Anything you do using either the GVedit menus or the settings window affects the +active graph. When you go to the settings window, you always see the +settings of active graph. +The settings of each graph are maintained separately. +</span></p> +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> +To make a graph active, click on its window. +The background of the active graph window is white +while all others are gray. +</span></p> + +<p class=MsoNormal align=center style='text-align:center'><b><u><span +style='color:black'><span style='text-decoration:none'> </span></span></u></b></p> +<p class=MsoNormal align=center style='text-align:center'><b><u><span +style='color:black'>Settings window</span></u></b></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> +With the settings window, +you can select the layout engine, set the output type and file, +and set any attributes that are available with the Graphviz release +installed on your computer.</span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'><b>Layout engine:</b> +Graphviz provides five different graph layouts. You can select +the one which best fits your needs. More information about these layouts +can be found at the <A HREF="http://www.graphviz.org">Graphviz home page</A> +</span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'><b>Output file name:</b> +This field allows you to specify the output file name. +You can either type in the name, or use the +small button by the text box to open a file +dialogue box. +This field corresponds to the –o option of Graphviz. +</span></p> + +<p class=MsoNormal style='text-indent:.5in'><b><span style='color:black'>Output +file type:</span></b><span style='color:black'> This drop down list allows +you to select the output file type. The output file name's extension is changed +accordingly. +This field corresponds to the –T option of Graphviz. +</span></p> + +<p class=MsoNormal style='text-indent:.5in'><b><span style='color:black'>Graphviz +bin folder:</span></b><span style='color:black'>You usually do not need to +enter anything here. During the Graphviz installation, locations of the Graphviz +files are stored in the registry and GVedit retrieves it from there. If, +for some reason, Graphviz files are not where they are supposed to be +and GVedit can not +find them, you can edit this information manually. +</span></p> + +<p class=MsoNormal style='text-indent:.5in'><b><span style='color:black'> +Preview Output file:</span></b><span style='color:black'> +If this box is checked, +GVedit creates a low-quality preview of the output and shows it in a +separate window. It is a convenient way to preview the results without +executing another viewing program. +</span></p> + +<p class=MsoNormal style='text-indent:.5in'><b><span style='color:black'> +Apply cairo filter:</span></b><span style='color:black'> +If this output format is supported by the cairo library, this box becomes +active. If checked, output will be generated using the cairo library +rather than the default renderer. +</span></p> + +<p class=MsoNormal style='text-indent:.5in'><b><span style='color:black'>Attributes:</span></b><span style='color:black'> +On the lower half of the settings window, you will see two dropdown lists, +one small text box, and a larger text editing area. GVedit processes the +contents of the large box as additional, generic graph, node or edge attributes. +(These correspond to the –G, –N, and –E command-line options of Graphviz.) +You can either type directly in the large text box, +or use the drop down lists to pick +an allowed scope and one of the common attribute names. +For details of these attributes, refer to the +<A HREF="http://www.graphviz.org/doc/info/attrs.html">page of Graphviz attributes.</A> +</span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> +If you specify an attribute using the drop down lists, you need to click on the +<b>Add</b> button to register the attribute. +If you do not click on +<b>Add</b> button, the attribute that you entered will not be +added to the large box, hence will not be processed. +</span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'>As an +example, assume that we would like to have a graph drawn +with a green background. +First, click on the scope list and select <b>graph</b>; +then click on the name list and +select <b>bgcolor</b>; and then type <tt>green</tt> to the value box. +Finally, click on the <b>Add</b> button to send the attribute to large box. +</span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> +Belowe the <b>Add</b> button is a <b>Help</b> button. Clicking on this +will open a browser window on the Graphviz page describing the supported +attributes. +</span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> +Under the large box, there are 3 small buttons, plus +<b>Cancel</b> and <b>OK</b> buttons. The first button is used to +clear the attributes box; +the second one is used to load an existing text file into the attributes box; +and the last one is used to save the attributes to a text file for later use. +The <b>Cancel</b> button closes the window without processing anything; +the <b>OK</b> button processes the +active document file with the settings on the screen and closes the settings +window. If you check the preview check box, you will see the preview of the +graph layout on the screen.</span></p> + +<p class=MsoNormal><span style='color:black'> </span></p> + +<p class=MsoNormal align=center style='text-align:center'><b><u><span +style='color:black'>Console window</span></u></b></p> + +<p class=MsoNormalstyle='text-indent:.5in'><span style='color:black'> +At the bottom of the +main window, there is a console window where you can see the results of your +actions. This provides a trace of your layout actions, showing the +Graphviz command corresponding to the active graph's settings. It also +displays warnings from GVedit, as well as the output of the +executed Graphviz programs. +By right clicking on the console window, you will get a menu providing some +additional functions, such as clearing or saving the console logs.</span></p> + +<p class=MsoNormal><span style='color:black'> </span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> </span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> </span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> </span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> </span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> </span></p> + +<p class=MsoNormal style='text-indent:.5in'><span style='color:black'> </span></p> + +<p class=MsoNormal><span style='color:black'> </span></p> + +<p class=MsoNormal><span style='color:black'> </span></p> + +<p class=MsoNormal><span style='color:black'> </span></p> + +<p class=MsoNormal><span style='color:black'> </span></p> + +<p class=MsoNormal><span style='color:black'> </span></p> + +<p class=MsoNormal><span style='color:black'> </span></p> + +</div> + +</body> + +</html>