Warning, /graphics/kgraphviewer/doc/en_US/index.docbook is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" ?> 0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [ 0003 <!ENTITY graphviz "<application><ulink url="https://www.graphviz.org">Graphviz</ulink></application>"> 0004 <!ENTITY boost "<ulink url="https://www.boost.org">Boost</ulink>"> 0005 <!ENTITY qanava "<application>Qanava</application>"> 0006 <!ENTITY kcachegrind "<application>KCacheGrind</application>"> <!--not in kdoctools 5.16--> 0007 <!ENTITY dot "<application>DOT</application>"> 0008 <!ENTITY neato "<application>NEATO</application>"> 0009 <!ENTITY twopi "<application>TWOPI</application>"> 0010 <!ENTITY fdp "<application>FDP</application>"> 0011 <!ENTITY circo "<application>CIRCO</application>"> 0012 <!ENTITY % addindex "IGNORE"> 0013 <!ENTITY % English "INCLUDE"><!-- change language only here --> 0014 ]> 0015 0016 0017 <book id="kgraphviewer" lang="&language;"> 0018 0019 <bookinfo> 0020 <title>The &kgraphviewer; Handbook</title> 0021 0022 <authorgroup> 0023 <author> 0024 <firstname>Gaël</firstname> 0025 <othername></othername> 0026 <surname>de Chalendar</surname> 0027 <affiliation> 0028 <address><email>kleag@free.fr</email></address> 0029 </affiliation> 0030 </author> 0031 <author> 0032 <firstname>Federico</firstname> 0033 <othername></othername> 0034 <surname>Zenith</surname> 0035 <affiliation> 0036 <address><email>federico.zenith@member.fsf.org</email></address> 0037 </affiliation> 0038 </author> 0039 <!-- TRANS:ROLES_OF_TRANSLATORS --> 0040 </authorgroup> 0041 0042 <copyright> 0043 <year>2006</year> 0044 <holder>Gaël de Chalendar</holder> 0045 </copyright> 0046 <!-- Translators: put here the copyright notice of the translation --> 0047 <!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook 0048 and in the FDL itself on how to use it. --> 0049 <legalnotice>&FDLNotice;</legalnotice> 0050 0051 <date>2020-12-14</date> 0052 <releaseinfo>&kgraphviewer; 2.4.3</releaseinfo> 0053 0054 <abstract> 0055 <para> 0056 &kgraphviewer; is a &graphviz; ˙ graph viewer. It is developed in the &kde; community. The &graphviz; programs are free-software layout engines for graphs. Graphs are commonly used in scientific domains and particularly in computer science. 0057 </para> 0058 <para> 0059 &kgraphviewer; displays the graphs in a modern, user-friendly &GUI;. 0060 </para> 0061 </abstract> 0062 0063 <keywordset> 0064 <keyword>KDE</keyword> 0065 <keyword>kgraphviewer</keyword> 0066 <keyword>graphviz</keyword> 0067 <keyword>dot</keyword> 0068 <keyword>neato</keyword> 0069 <keyword>viewer</keyword> 0070 </keywordset> 0071 0072 </bookinfo> 0073 0074 <chapter id="introduction"> 0075 <title>Introduction</title> 0076 0077 <para> 0078 &kgraphviewer; is a &graphviz; ˙ graph viewer. The &graphviz; programs are free-software layout engines for graphs. &kgraphviewer; displays the graphs in a modern, user-friendly &GUI;. It has the following features: 0079 <screenshot> 0080 <screeninfo>Here is a screenshot of &kgraphviewer;</screeninfo> 0081 <mediaobject> 0082 <imageobject> 0083 <imagedata fileref="kgraphviewer-snap-main.png" format="PNG"/> 0084 </imageobject> 0085 <textobject> 0086 <phrase>The main &kgraphviewer; window displaying one of the &graphviz; examples</phrase> 0087 </textobject> 0088 </mediaobject> 0089 </screenshot> 0090 <itemizedlist> 0091 <listitem><para>Zooming;</para></listitem> 0092 <listitem><para>Loading of several graphs in tabs at the same time;</para></listitem> 0093 <listitem><para>Storage of a list of recent files;</para></listitem> 0094 <listitem><para>A bird's eye view of the graph;</para></listitem> 0095 <listitem><para>Graph panning by mouse dragging;</para></listitem> 0096 <listitem><para>Full-featured printing;</para></listitem> 0097 <listitem><para>Perfect drawing of all &graphviz; example graphs;</para></listitem> 0098 <listitem><para>Node and edge colors and all node shapes are supported;</para></listitem> 0099 <listitem><para>Automatic choice of ˙ for directed graphs and &neato; for undirected ones;</para></listitem> 0100 <listitem><para>Manual or automatic reloading with user confirmation of (externally) modified files (configurable);</para></listitem> 0101 <listitem><para>Opening of new program instances as new tabs in an existing instance (configurable);</para></listitem> 0102 <listitem><para>Help system;</para></listitem> 0103 <listitem><para>Internationalization.</para></listitem> 0104 </itemizedlist> 0105 </para> 0106 0107 <para>Planned features are: 0108 <itemizedlist> 0109 <listitem><para>Eventual use of the &qanava; library to support internal graphs representation;</para></listitem> 0110 <listitem><para>Save session data about graphs (layout program used, zoom factor, &etc;)</para></listitem> 0111 <listitem><para>Integration in &kate; and &konqueror; (so that a change in &kate;'s view of the graph would re-layout and reload the file in &kgraphviewer;);</para></listitem> 0112 <listitem><para>Menu to open the file in &kate; <emphasis>or</emphasis> to open a katepart inside the &kgraphviewer; window;</para></listitem> 0113 <listitem><para>Loading of large and huge graphs (currently, there are performance problems at around 1000 nodes, and a hack to ignore nodes above a specified limit);</para></listitem> 0114 <listitem><para>Progressive support of more and more ˙ attributes and values;</para></listitem> 0115 <listitem><para>Layout in background (with threading in order not to block the interface, with a progress bar).</para></listitem> 0116 </itemizedlist></para> 0117 0118 <note><para>Note that this program includes code from the GPL tool &kcachegrind; by Josef Weidendorfer, with his authorization.</para></note> 0119 <note><para>Note also that the printing system is from the &calligra;'s &kexi; database application.</para></note> 0120 0121 <para>Other required software: &kgraphviewer; is a program that uses the &graphviz; tool ˙ for graph layout. Its dependencies are: 0122 <itemizedlist> 0123 <listitem><para>The &Qt; and &kde-frameworks; libraries version 5.x;</para></listitem> 0124 <listitem><para>The &graphviz; tools as externals programs (tested with version 2.8);</para></listitem> 0125 <listitem><para>The &boost; library version 1.36.</para></listitem> 0126 </itemizedlist></para> 0127 0128 </chapter> 0129 0130 <chapter id="using-kgraphviewer"> 0131 <title>Using &kgraphviewer;</title> 0132 0133 <sect1 id="using-kgraphviewer-mainwin"> 0134 <title>The Main Window</title> 0135 0136 <para>The main window displays the loaded graphs, each in its own tab. Initially, if you start &kgraphviewer; without arguments, its main window will be empty as in the screenshot below. In this case, the toolbar contains only the <guibutton>Open...</guibutton> and the (empty) <guibutton>Open Recent</guibutton> buttons. Click on the first one to open the standard <guilabel>Open File</guilabel> dialog.</para> 0137 0138 <screenshot> 0139 <screeninfo>The initial main window when opening &kgraphviewer; for the first time</screeninfo> 0140 <mediaobject> 0141 <imageobject> 0142 <imagedata fileref="kgraphviewer-snap-init.png" format="PNG"/> 0143 </imageobject> 0144 <textobject> 0145 <phrase>The initial main window when opening &kgraphviewer; for the first time</phrase> 0146 </textobject> 0147 <caption><para>The initial main window when opening &kgraphviewer; for the first time</para></caption> 0148 </mediaobject> 0149 </screenshot> 0150 0151 <para>After selecting one or several ˙ files, the main window looks like the next screenshot below:</para> 0152 0153 <screenshot> 0154 <screeninfo>The main window of &kgraphviewer; with several files opened</screeninfo> 0155 <mediaobject> 0156 <imageobject> 0157 <imagedata fileref="kgraphviewer-snap-main.png" format="PNG"/> 0158 </imageobject> 0159 <textobject> 0160 <phrase>The main window of &kgraphviewer; with several files opened</phrase> 0161 </textobject> 0162 <caption><para>The main window of &kgraphviewer; with several files opened</para></caption> 0163 </mediaobject> 0164 </screenshot> 0165 0166 <para>As you can see, if the graph is larger than the available area, a bird's-eye view is shown in one corner. You can choose with the context menu whether the optimal position of this overview should be automatically computed for you, or place it where you want yourself.</para> 0167 0168 <sect2> 0169 <title>Moving the Graph inside the Window</title> 0170 0171 <para>To move the graph, you can: 0172 <itemizedlist> 0173 <listitem><para>Click and drag it;</para></listitem> 0174 <listitem><para>Use the scroll bars;</para></listitem> 0175 <listitem><para>Press the arrows keys;</para></listitem> 0176 <listitem><para>Click somewhere in the bird's-eye view;</para></listitem> 0177 <listitem><para>Use the mouse wheel (up and down with no modifier, left and right with the &Alt; key pressed);</para></listitem> 0178 <listitem><para>or click and drag in the bird's-eye view.</para></listitem> 0179 </itemizedlist></para> 0180 </sect2> 0181 0182 <sect2> 0183 <title>Zooming</title> 0184 0185 <para>To zoom, you can either use the 0186 <guibutton><inlinemediaobject> 0187 <imageobject> 0188 <imagedata fileref="kgraphviewer-but-zoomin.png" format="PNG" /> 0189 </imageobject> 0190 </inlinemediaobject> 0191 </guibutton> 0192 and 0193 <guibutton><inlinemediaobject> 0194 <imageobject> 0195 <imagedata fileref="kgraphviewer-but-zoomout.png" format="PNG" /> 0196 </imageobject> 0197 </inlinemediaobject> 0198 </guibutton> 0199 toolbar buttons to zoom in and out, or hold down the &Shift; key while rolling your mouse wheel. While zooming in, the red rectangle in the bird's-eye view that indicates the displayed zone gets smaller and smaller. If it were to get smaller than 10 pixels in its shorter side, it will be replaced by a filled red rectangle in order to stay visible. You can see that on the screenshot below.</para> 0200 0201 <screenshot> 0202 <screeninfo>A graph at the maximal zoom in level</screeninfo> 0203 <mediaobject> 0204 <imageobject> 0205 <imagedata fileref="kgraphviewer-snap-zmax.png" format="PNG" /> 0206 </imageobject> 0207 <textobject> 0208 <phrase>A graph at the maximal zoom in level</phrase> 0209 </textobject> 0210 <caption><para>A graph at the maximal zoom in level</para></caption> 0211 </mediaobject> 0212 </screenshot> 0213 0214 <para>Zooming is limited in both directions by a factor of 10. You can see below the maximum zoom-out factor on a graph.</para> 0215 0216 <screenshot> 0217 <screeninfo>A graph at the maximum zoom-out level</screeninfo> 0218 <mediaobject> 0219 <imageobject> 0220 <imagedata fileref="kgraphviewer-snap-zmin.png" format="PNG" /> 0221 </imageobject> 0222 <textobject> 0223 <phrase>A graph at the maximum zoom-out level</phrase> 0224 </textobject> 0225 <caption><para>A graph at the maximum zoom-out level</para></caption> 0226 </mediaobject> 0227 </screenshot> 0228 </sect2> 0229 0230 <sect2> 0231 <title>Graph Files Handling</title> 0232 0233 <sect3> 0234 <title>Files Modified on Disk</title> 0235 0236 <para>If a file currently loaded in &kgraphviewer; is modified by another program, the following dialog is 0237 shown:</para> 0238 0239 <screenshot> 0240 <screeninfo>Dialog to reload a file modified on disk</screeninfo> 0241 <mediaobject> 0242 <imageobject> 0243 <imagedata fileref="kgraphviewer-snap-ask1.png" format="PNG" /> 0244 </imageobject> 0245 <textobject> 0246 <phrase>Dialog to reload a file modified on disk</phrase> 0247 </textobject> 0248 <caption><para>Dialog to reload a file modified on disk</para></caption> 0249 </mediaobject> 0250 </screenshot> 0251 0252 <para>You can choose to reload the graph or to ignore the change. You can also get &kgraphviewer; to remember your choice, so it will do the same thing the next time. If you later want to modify your choice, choose the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kgraphviewer;...</guimenuitem></menuchoice> menu item. See <xref linkend="kgraphviewer-configuration"/>.</para> 0253 </sect3> 0254 0255 <sect3><title>Files and Windows</title> 0256 <para>When you open a graph file from outside a running &kgraphviewer; instance, ⪚ from a file browser or the command line, you have the choice to open a new &kgraphviewer; window or to open the graph in a new tab in the existing window. This is done with the dialog below.</para> 0257 0258 <screenshot> 0259 <screeninfo>Dialog to open a new window</screeninfo> 0260 <mediaobject> 0261 <imageobject> 0262 <imagedata fileref="kgraphviewer-snap-ask2.png" format="PNG" /> 0263 </imageobject> 0264 <textobject> 0265 <phrase>Dialog to open a new window</phrase> 0266 </textobject> 0267 <caption><para>Dialog to open a new window</para></caption> 0268 </mediaobject> 0269 </screenshot> 0270 0271 <para>As for the previous option, you can save your choice as the default and modify it later in the configuration dialog.</para> 0272 0273 </sect3> 0274 0275 <sect3> 0276 <title>Session Handling</title> 0277 0278 <para>At start-up, you can choose to reopen the graphs that you had opened the previous time. Again, you can save your choice and change it later.</para> 0279 0280 <screenshot> 0281 <screeninfo>Dialog to reload the graph of the previous session at start-up</screeninfo> 0282 <mediaobject> 0283 <imageobject> 0284 <imagedata fileref="kgraphviewer-snap-ask3.png" format="PNG" /> 0285 </imageobject> 0286 <textobject> 0287 <phrase>Dialog to reload the graph of the previous session at start-up</phrase> 0288 </textobject> 0289 <caption><para>Dialog to reload the graph of the previous session at start-up</para></caption> 0290 </mediaobject> 0291 </screenshot> 0292 0293 </sect3> 0294 0295 </sect2> 0296 0297 </sect1> 0298 0299 <sect1 id="kgraphviewer-printing"> 0300 <title>Graph Printing</title> 0301 <para>Try the <guibutton>Print preview</guibutton> or <guibutton>Page setup</guibutton> buttons to explore the printing options.</para> 0302 0303 <screenshot> 0304 <screeninfo>Page setup dialog</screeninfo> 0305 <mediaobject> 0306 <imageobject> 0307 <imagedata fileref="kgraphviewer-snap-psetup1.png" format="PNG" /> 0308 </imageobject> 0309 <textobject> 0310 <phrase>Page setup dialog</phrase> 0311 </textobject> 0312 <caption><para>Page setup dialog</para></caption> 0313 </mediaobject> 0314 </screenshot> 0315 0316 <para>You can setup the printing options to fit the graph on exactly one page, as below:</para> 0317 0318 <screenshot> 0319 <screeninfo>Page preview setup to fit on one page</screeninfo> 0320 <mediaobject> 0321 <imageobject> 0322 <imagedata fileref="kgraphviewer-snap-ppview1.png" format="PNG" /> 0323 </imageobject> 0324 <textobject> 0325 <phrase>Page preview setup to fit on one page</phrase> 0326 </textobject> 0327 <caption><para>Page preview setup to fit on one page</para></caption> 0328 </mediaobject> 0329 </screenshot> 0330 0331 <para>You can also choose how to divide the graph on multiple pages. The number of horizontal and vertical pages can be chosen independently.</para> 0332 0333 <screenshot> 0334 <screeninfo>Page preview set up to fit on multiple pages and to fill them</screeninfo> 0335 <mediaobject> 0336 <imageobject> 0337 <imagedata fileref="kgraphviewer-snap-ppview2.png" format="PNG" /> 0338 </imageobject> 0339 <textobject> 0340 <phrase>Page preview set up to fit on multiple pages and to fill them</phrase> 0341 </textobject> 0342 <caption><para>Page preview set up to fit on multiple pages and to fill them</para></caption> 0343 </mediaobject> 0344 </screenshot> 0345 0346 <para>Finally, when using multiple pages, you can choose to make the part of the graph on each page to fit its page like above, not keeping the aspect ratio, or to keep it. In the latter case, the pages will not be filled.</para> 0347 0348 <para>You can change the size of pages and the margins:</para> 0349 0350 <screenshot> 0351 <screeninfo>Page size and margins dialog</screeninfo> 0352 <mediaobject> 0353 <imageobject> 0354 <imagedata fileref="kgraphviewer-snap-pagesmarges.png" format="PNG" /> 0355 </imageobject> 0356 <textobject> 0357 <phrase>Page size and margins dialog</phrase> 0358 </textobject> 0359 <caption><para>Page size and margins dialog</para></caption> 0360 </mediaobject> 0361 </screenshot> 0362 0363 <para>You can also change the font, headers and footers:</para> 0364 0365 <screenshot> 0366 <screeninfo>Page preview setup to fit on multiple pages without header and with a different font</screeninfo> 0367 <mediaobject> 0368 <imageobject> 0369 <imagedata fileref="kgraphviewer-snap-ppview3.png" format="PNG" /> 0370 </imageobject> 0371 <textobject> 0372 <phrase>Page preview setup to fit on multiple pages without header and a different font</phrase> 0373 </textobject> 0374 <caption><para>Page preview setup to fit on multiple pages without header and a different font</para></caption> 0375 </mediaobject> 0376 </screenshot> 0377 0378 </sect1> 0379 0380 <sect1 id="kgraphviewer-configuration"> 0381 <title>Configuring &kgraphviewer;</title> 0382 0383 <para>The <guilabel>Appearance</guilabel> page allows to change the default background 0384 color used in &kgraphviewer; if a graph does not have its own background color.</para> 0385 0386 <screenshot> 0387 <screeninfo>Page to change the appearance of a graph</screeninfo> 0388 <mediaobject> 0389 <imageobject> 0390 <imagedata fileref="kgraphviewer-snap-config-appearance.png" format="PNG" /> 0391 </imageobject> 0392 <textobject> 0393 <phrase>Page to change the appearance of a graph</phrase> 0394 </textobject> 0395 <caption><para>Page to change the appearance of a graph</para></caption> 0396 </mediaobject> 0397 </screenshot> 0398 0399 <para>The <guilabel>Parsing</guilabel> page allows to select an external command 0400 or the internal library for parsing &graphviz; ˙ files.</para> 0401 0402 <screenshot> 0403 <screeninfo>Page to reload files modified on disk in the configuration dialog</screeninfo> 0404 <mediaobject> 0405 <imageobject> 0406 <imagedata fileref="kgraphviewer-snap-config-parsing.png" format="PNG" /> 0407 </imageobject> 0408 <textobject> 0409 <phrase>Page to reload files modified on disk in the configuration dialog</phrase> 0410 </textobject> 0411 <caption><para>Page to reload files modified on disk in the configuration dialog</para></caption> 0412 </mediaobject> 0413 </screenshot> 0414 0415 <para>The <guilabel>Reload</guilabel> page allows to change the behavior of &kgraphviewer; when a file is changed on disk by another application. You can choose a default action (reload automatically or ignore changes), or to be asked each time.</para> 0416 0417 <screenshot> 0418 <screeninfo>Page to reload files modified on disk in the configuration dialog</screeninfo> 0419 <mediaobject> 0420 <imageobject> 0421 <imagedata fileref="kgraphviewer-snap-config1.png" format="PNG" /> 0422 </imageobject> 0423 <textobject> 0424 <phrase>Page to reload files modified on disk in the configuration dialog</phrase> 0425 </textobject> 0426 <caption><para>Page to reload files modified on disk in the configuration dialog</para></caption> 0427 </mediaobject> 0428 </screenshot> 0429 0430 <para>The <guilabel>Opening</guilabel> page allows to change the behavior of &kgraphviewer; when a graph file is opened from outside the current session. You can choose a default action (open in an existing window or in a new one), or to be asked each time.</para> 0431 0432 <screenshot> 0433 <screeninfo>Page to open new files in an existing window in the configuration dialog</screeninfo> 0434 <mediaobject> 0435 <imageobject> 0436 <imagedata fileref="kgraphviewer-snap-config2.png" format="PNG" /> 0437 </imageobject> 0438 <textobject> 0439 <phrase>Page to open new files in an existing window in the configuration dialog</phrase> 0440 </textobject> 0441 <caption><para>Page to open new files in an existing window in the configuration dialog</para></caption> 0442 </mediaobject> 0443 </screenshot> 0444 0445 <para>The <guilabel>Session Management</guilabel> page allows to change the &kgraphviewer;'s start-up behavior. You can choose a default action (reopen files of the previous session or not), or to be asked each time.</para> 0446 0447 <screenshot> 0448 <screeninfo>Page to reopen files of the previous session in the configuration dialog</screeninfo> 0449 <mediaobject> 0450 <imageobject> 0451 <imagedata fileref="kgraphviewer-snap-config3.png" format="PNG" /> 0452 </imageobject> 0453 <textobject> 0454 <phrase>Page to reopen files of the previous session in the configuration dialog</phrase> 0455 </textobject> 0456 <caption><para>Page to reopen files of the previous session in the configuration dialog</para></caption> 0457 </mediaobject> 0458 </screenshot> 0459 0460 </sect1> 0461 0462 <sect1 id="using-kgraphviewer-misc"> 0463 <title>Miscellaneous Functions</title> 0464 0465 <para>The context menu, usually obtained by clicking the &RMB; in the graph view, offers some other possibilities: 0466 <variablelist> 0467 <varlistentry> 0468 <term><guisubmenu>Layout</guisubmenu></term> 0469 <listitem><para>This allows to choose between various &graphviz; layout algorithms or to choose your own one. The entries, as described on the &graphviz; homepage, are the following: 0470 0471 <variablelist> 0472 <varlistentry> 0473 <term><guimenuitem>˙</guimenuitem></term> 0474 <listitem><para>˙ algorithm, default for directed graphs. It produces <quote>hierarchical</quote> or layered drawings of directed graphs. The layout algorithm lays edges in the same direction (top to bottom, or left to right), and then attempts to avoid edge crossings and to reduce edge length.</para></listitem> 0475 </varlistentry> 0476 0477 <varlistentry> 0478 <term><guimenuitem>&neato;</guimenuitem></term> 0479 <listitem><para>&neato; algorithm, default for undirected graphs. It produces <quote>spring model</quote> layouts. It uses the Kamada-Kawai algorithm, which is equivalent to statistical multi-dimensional scaling.</para></listitem> 0480 </varlistentry> 0481 0482 <varlistentry> 0483 <term><guimenuitem>&twopi;</guimenuitem></term> 0484 <listitem><para>&twopi; algorithm, for directed and undirected graphs. Radial layout, after Graham Wills 1997.</para></listitem> 0485 </varlistentry> 0486 0487 <varlistentry> 0488 <term><guimenuitem>&fdp;</guimenuitem></term> 0489 <listitem><para>&fdp; algorithm, for undirected graphs. It produces <quote>spring model</quote> layouts. It implements the Fruchterman-Reingold heuristic including a multigrid solver that handles larger graphs and clustered undirected graphs.</para></listitem> 0490 </varlistentry> 0491 0492 <varlistentry> 0493 <term><guimenuitem>&circo;</guimenuitem></term> 0494 <listitem><para>&circo; algorithm. It produces a circular layout, after Six and Tollis 1999, Kauffman and Wiese 2002. Suitable for certain diagrams of multiple cyclic structures.</para></listitem> 0495 </varlistentry> 0496 0497 <varlistentry> 0498 <term><guimenuitem>Specify layout command</guimenuitem></term> 0499 <listitem><para>Opens a dialog allowing you to specify a layout command executed by the shell. This command should accept one parameter, the graph file name, and write its layout on stdout in the xdot language. This way, you can give specific options to one of the previous commands, or apply a filter modifying your graph before running it through ˙.</para></listitem> 0500 </varlistentry> 0501 0502 <varlistentry> 0503 <term><guimenuitem>Reset layout command to default</guimenuitem></term> 0504 <listitem><para>Determine the graph type (directed or not) and apply the default algorithm to it, currently ˙ and &neato; respectively.</para></listitem> 0505 </varlistentry> 0506 </variablelist> 0507 </para></listitem> 0508 </varlistentry> 0509 0510 <varlistentry> 0511 <term><guisubmenu>Export Graph</guisubmenu></term> 0512 <listitem><para> 0513 <variablelist> 0514 <varlistentry> 0515 <term><guimenuitem>As Image...</guimenuitem></term> 0516 <listitem><para>Allows to export the full graph to all supported image formats.</para></listitem> 0517 </varlistentry> 0518 </variablelist> 0519 </para></listitem> 0520 </varlistentry> 0521 0522 <varlistentry> 0523 <term><guimenu>Enable Bird's-eye View</guimenu></term> 0524 <listitem><para>When checked, the Bird's-eye view is displayed when necessary. Otherwise, it is hidden and its positioning menu is disabled.</para></listitem> 0525 </varlistentry> 0526 0527 <varlistentry> 0528 <term><guisubmenu>Bird's-eye View</guisubmenu></term> 0529 <listitem><para>Configure where to place the bird's-eye view in the graph view. The possible choices are: 0530 <variablelist> 0531 <varlistentry> 0532 <term><guimenuitem>Top Left</guimenuitem></term> 0533 <listitem><para>Places the bird's-eye view at the top left corner;</para></listitem> 0534 </varlistentry> 0535 0536 <varlistentry> 0537 <term><guimenuitem>Top Right</guimenuitem></term> 0538 <listitem><para>Places the bird's-eye view at the top right corner;</para></listitem> 0539 </varlistentry> 0540 0541 <varlistentry> 0542 <term><guimenuitem>Bottom Left</guimenuitem></term> 0543 <listitem><para>Places the bird's-eye view at the bottom left corner;</para></listitem> 0544 </varlistentry> 0545 0546 <varlistentry> 0547 <term><guimenuitem>Bottom Right</guimenuitem></term> 0548 <listitem><para>Places the bird's-eye view at the bottom right corner;</para></listitem> 0549 </varlistentry> 0550 0551 <varlistentry> 0552 <term><guimenuitem>Automatic</guimenuitem></term> 0553 <listitem><para>Automatically choose the best position to hide as little of the graph as possible.</para></listitem> 0554 </varlistentry> 0555 </variablelist> 0556 </para></listitem> 0557 </varlistentry> 0558 0559 </variablelist></para> 0560 0561 </sect1> 0562 0563 </chapter> 0564 0565 <chapter id="commands"> 0566 <title>Command Reference</title> 0567 0568 <sect1 id="kgraphviewer-commands-menus"> 0569 <title>The &kgraphviewer; Menus</title> 0570 0571 <sect2> 0572 <title>The File Menu</title> 0573 0574 <variablelist> 0575 <varlistentry> 0576 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice></term> 0577 <listitem><para><action>Opens</action> a new &kgraphviewer; window.</para></listitem> 0578 </varlistentry> 0579 0580 <varlistentry> 0581 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut><guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice></term> 0582 <listitem><para><action>Displays</action> the <guilabel>Open File</guilabel> dialog.</para></listitem> 0583 </varlistentry> 0584 0585 <varlistentry> 0586 <term><menuchoice><guimenu>File</guimenu><guimenuitem>Open Recent</guimenuitem></menuchoice></term> 0587 <listitem><para><action>Displays</action> the list of the ten most recently opened graph files.</para></listitem> 0588 </varlistentry> 0589 0590 <varlistentry> 0591 <term><menuchoice><guimenu>File</guimenu><guisubmenu>Export Graph</guisubmenu><guimenuitem>As Image...</guimenuitem></menuchoice></term> 0592 <listitem><para>Allows to <action>export</action> the full graph to all supported image formats.</para></listitem> 0593 </varlistentry> 0594 0595 <varlistentry> 0596 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo></shortcut><guimenu>File</guimenu><guimenuitem>Print...</guimenuitem></menuchoice></term> 0597 <listitem><para><action>Prints</action> the current graph using the currently set print parameters.</para></listitem> 0598 </varlistentry> 0599 0600 <varlistentry> 0601 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>P</keycap></keycombo></shortcut><guimenu>File</guimenu><guimenuitem>Print Preview...</guimenuitem></menuchoice></term> 0602 <listitem><para><action>Opens</action> the <guilabel>Print Preview</guilabel> window for the current graph.</para></listitem> 0603 </varlistentry> 0604 0605 <varlistentry> 0606 <term><menuchoice><guimenu>File</guimenu><guimenuitem>Page Setup</guimenuitem></menuchoice></term> 0607 <listitem><para><action>Opens</action> the <guilabel>Page Setup</guilabel> dialog for the current graph.</para></listitem> 0608 </varlistentry> 0609 0610 <varlistentry> 0611 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></shortcut><guimenu>File</guimenu><guimenuitem>Quit</guimenuitem></menuchoice></term> 0612 <listitem><para><action>Quits</action> &kgraphviewer;.</para></listitem> 0613 </varlistentry> 0614 </variablelist> 0615 </sect2> 0616 0617 <sect2> 0618 <title>The View Menu</title> 0619 0620 <variablelist> 0621 <varlistentry> 0622 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo></shortcut><guimenu>View</guimenu><guimenuitem>Zoom In</guimenuitem></menuchoice></term> 0623 <listitem><para><action>Zoom in</action> the current graph by 10%.</para></listitem> 0624 </varlistentry> 0625 0626 <varlistentry> 0627 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo></shortcut><guimenu>View</guimenu><guimenuitem>Zoom Out</guimenuitem></menuchoice></term> 0628 <listitem><para><action>Zoom out</action> the current graph by 10%.</para></listitem> 0629 </varlistentry> 0630 0631 <varlistentry> 0632 <term><menuchoice><guimenu>View</guimenu><guimenuitem>Redisplay</guimenuitem></menuchoice></term> 0633 <listitem><para><action>Reloads</action> the current graph.</para></listitem> 0634 </varlistentry> 0635 0636 <varlistentry> 0637 <term><menuchoice><guimenu>View</guimenu><guisubmenu>Select Layout Algo</guisubmenu></menuchoice></term> 0638 <listitem><para>Opens a submenu with various &graphviz; layout algorithms for the current graph.</para></listitem> 0639 </varlistentry> 0640 0641 <varlistentry> 0642 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo></shortcut><guimenu>View</guimenu><guimenuitem>Enable Bird's-eye View</guimenuitem></menuchoice></term> 0643 <listitem><para>When checked, the Bird's-eye view is displayed when necessary. Otherwise, it is hidden and its positioning menu is disabled.</para></listitem> 0644 </varlistentry> 0645 0646 <varlistentry> 0647 <term><menuchoice><guimenu>View</guimenu><guimenuitem>Birds-eye View</guimenuitem></menuchoice></term> 0648 <listitem><para>Configure where to place the bird-eye view in the graph view. Choices are: 0649 <variablelist> 0650 <varlistentry> 0651 <term><guimenuitem>Top Left</guimenuitem></term> 0652 <listitem><para>Places the bird's-eye view at the top left corner;</para></listitem> 0653 </varlistentry> 0654 0655 <varlistentry> 0656 <term><guimenuitem>Top Right</guimenuitem></term> 0657 <listitem><para>Places the bird's-eye view at the top right corner;</para></listitem> 0658 </varlistentry> 0659 0660 <varlistentry> 0661 <term><guimenuitem>Bottom Left</guimenuitem></term> 0662 <listitem><para>Places the bird's-eye view at the bottom left corner;</para></listitem> 0663 </varlistentry> 0664 0665 <varlistentry> 0666 <term><guimenuitem>Bottom Right</guimenuitem></term> 0667 <listitem><para>Places the bird's-eye view at the bottom right corner;</para></listitem> 0668 </varlistentry> 0669 0670 <varlistentry> 0671 <term><guimenuitem>Automatic</guimenuitem></term> 0672 <listitem><para>Automatically choose the best position to hide as little of the graph as possible.</para></listitem> 0673 </varlistentry> 0674 </variablelist></para></listitem> 0675 </varlistentry> 0676 </variablelist> 0677 0678 </sect2> 0679 0680 <sect2> 0681 <title>The Settings and Help Menu</title> 0682 0683 <para>&kgraphviewer; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu> 0684 menu items, for more information read the sections about the <ulink url="help:/fundamentals/menus.html#menus-settings" 0685 >Settings Menu</ulink> and <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink> 0686 of the &kde; Fundamentals. 0687 </para> 0688 0689 </sect2> 0690 </sect1> 0691 0692 <sect1 id="kgraphviewer-commands-toolbars"> 0693 <title>The &kgraphviewer; Toolbars</title> 0694 0695 <sect2> 0696 <title>The Main Toolbar</title> 0697 <!--document-new--> 0698 <variablelist> 0699 <varlistentry><!--document-open--> 0700 <term><guibutton><inlinemediaobject><imageobject><imagedata fileref="kgraphviewer-but-open.png" format="PNG" /></imageobject></inlinemediaobject></guibutton></term> 0701 <listitem><para><action>Shows</action> the <guilabel>Open File</guilabel> dialog.</para></listitem> 0702 </varlistentry> 0703 0704 <varlistentry><!--document-open-recent--> 0705 <term><guibutton><inlinemediaobject><imageobject><imagedata fileref="kgraphviewer-but-prev.png" format="PNG" /></imageobject></inlinemediaobject></guibutton></term> 0706 <listitem><para><action>Shows</action> the list of recently opened files.</para></listitem> 0707 </varlistentry> 0708 <!--document-close--> 0709 <!--varlistentry> 0710 <term><guibutton><inlinemediaobject><imageobject><imagedata fileref="kgraphviewer-but-print.png" format="PNG" /></imageobject></inlinemediaobject></guibutton></term> 0711 <listitem><para><action>Prints the graph</action> using current setup.</para></listitem> 0712 </varlistentry--> 0713 0714 <varlistentry> 0715 <term><guibutton><inlinemediaobject><imageobject><imagedata fileref="kgraphviewer-but-preview.png" format="PNG" /></imageobject></inlinemediaobject></guibutton></term> 0716 <listitem><para><action>Shows</action> the <guilabel>Print Preview</guilabel> dialog.</para></listitem> 0717 </varlistentry> 0718 0719 <!--varlistentry> 0720 <term><guibutton><inlinemediaobject><imageobject><imagedata fileref="kgraphviewer-but-psetup.png" format="PNG" /></imageobject></inlinemediaobject></guibutton></term> 0721 <listitem><para><action>Shows</action> the <guilabel>Page Setup</guilabel> dialog.</para></listitem> 0722 </varlistentry--> 0723 </variablelist> 0724 </sect2> 0725 0726 <sect2> 0727 <title>The View Toolbar</title> 0728 0729 <variablelist> 0730 <!--varlistentry> 0731 <term><guibutton><inlinemediaobject><imageobject><imagedata fileref="kgraphviewer-but-reload.png" format="PNG" /></imageobject></inlinemediaobject></guibutton></term> 0732 <listitem><para><action>Reloads</action> the current graph.</para></listitem> 0733 </varlistentry--> 0734 0735 <varlistentry> 0736 <term><guibutton><inlinemediaobject><imageobject><imagedata fileref="kgraphviewer-but-layout.png" format="PNG" /></imageobject></inlinemediaobject></guibutton></term> 0737 <listitem><para><action>Edits</action> the layout command or <action>shows</action> the list of preset layout algorithms.</para></listitem> 0738 </varlistentry> 0739 0740 <varlistentry><!--zoom-in--> 0741 <term><guibutton><inlinemediaobject><imageobject><imagedata fileref="kgraphviewer-but-zoomin.png" format="PNG" /></imageobject></inlinemediaobject></guibutton></term> 0742 <listitem><para><action>Zoom in</action> the current graph by 10%.</para></listitem> 0743 </varlistentry> 0744 0745 <varlistentry><!--zoom-out--> 0746 <term><guibutton><inlinemediaobject><imageobject><imagedata fileref="kgraphviewer-but-zoomout.png" format="PNG" /></imageobject></inlinemediaobject></guibutton></term> 0747 <listitem><para><action>Zoom out</action> the current graph by 10%.</para></listitem> 0748 </varlistentry> 0749 </variablelist> 0750 <!--kgraphviewer-bev "Enable Bird's-eye View"--> 0751 </sect2> 0752 0753 <sect2> 0754 <title>The Help Toolbar</title> 0755 0756 <variablelist> 0757 <varlistentry><!--help-contextual--> 0758 <term><guibutton><inlinemediaobject><imageobject><imagedata fileref="kgraphviewer-but-whatsthis.png" format="PNG" /></imageobject></inlinemediaobject></guibutton></term> 0759 <listitem><para><action>Displays</action> the <guilabel>What's This</guilabel> mouse pointer. Click with it on a &GUI; element to obtain help using it (if there is such help available).</para></listitem> 0760 </varlistentry> 0761 </variablelist> 0762 </sect2> 0763 0764 </sect1> 0765 </chapter> 0766 0767 <chapter id="credits"> 0768 <title>Credits and License</title> 0769 0770 <sect1 id="kgraphviewer-credits-program"> 0771 <title>Program</title> 0772 0773 <sect2> 0774 <title>Main Authors</title> 0775 <para>Program copyright 2005-2006 Gaël de Chalendar <email>kleag@free.fr</email></para> 0776 </sect2> 0777 0778 <sect2> 0779 <title>Contributors (to be completed)</title> 0780 <itemizedlist> 0781 <listitem><para>Reimar Döffinger <email>Reimar.Doeffinger@stud.uni-karlsruhe.de</email></para></listitem> 0782 </itemizedlist> 0783 </sect2> 0784 </sect1> 0785 0786 <sect1 id="kgraphviewer-credits-userguide"> 0787 <title>User Guide</title> 0788 <para>Documentation copyright 2006 Gaël de Chalendar <email>kleag@free.fr</email></para> 0789 <sect2> 0790 <title>Contributors</title> 0791 <itemizedlist> 0792 <listitem><para>Federico Zenith <email>federico.zenith@member.fsf.org</email></para></listitem> 0793 </itemizedlist> 0794 </sect2> 0795 </sect1> 0796 0797 <sect1 id="kgraphviewer-credits-other"> 0798 <title>Other Credits</title> 0799 <para>This program contains reused code from the following Free Software projects:</para> 0800 <variablelist> 0801 <varlistentry> 0802 <term><ulink url="https://kcachegrind.github.io/html/Home.html">&kcachegrind;</ulink></term> 0803 <listitem><para>Initial graph model and view classes;</para></listitem> 0804 </varlistentry> 0805 0806 <varlistentry> 0807 <term><ulink url="http://www.kexi-project.org/">&kexi;</ulink></term> 0808 <listitem><para>Print setup and preview classes.</para></listitem> 0809 </varlistentry> 0810 </variablelist> 0811 </sect1> 0812 0813 <sect1 id="kgraphviewer-credits-licenses"><title>Licenses</title> 0814 <!-- TRANS:CREDIT_FOR_TRANSLATORS --> 0815 &underFDL; <!-- FDL: do not remove --> 0816 &underGPL; <!-- GPL License --> 0817 </sect1> 0818 0819 </chapter> 0820 0821 &documentation.index; 0822 </book>