formdiagram.html

DelphiDoc is a program for automatic generation of documentation on a Delphi-Project. At the momen

This button shows a zoomed view of the whole diagram. Click it to move the shown region of the diagram. This window can be shown and hidden via a the first button in the tool bar or by a menu item or simply by pressing <code>F8</code>. 
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ToolBar">Tool Bars</a></h2>
Several options of the diagram can be set within the tool bars. Some options are only available in diagrams of files, others only in diagrams of classes. The picture shows the available buttons in a diagram of classes.<br>
The following buttons will be visible for diagrams of files: A button to toggle if associations of units using of other files in their implementation part should be shown. Five buttons for each kind of record-like type to set, if they should be listed within the boxes of the files. And one button to set if record-like type in the implementation part of units should not be listed.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ToolButtonZoomWindow">Toggle the Window of the Zoom Map</a></h2>
This button toggles the visibility of the window of the zoom map.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ToolButtonEditMargin">Set the Size of the Margin in the Diagram</a></h2>
This button shows a small dialog to set the size of the margin in the diagram. This margin is used in several places, first of all it is the margin of all text in the boxes, so it influences the size of each box. Then it is used by all algorithms to aumomatically lay-out the diagram to decide the distance between boxes.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ToolButtonFont">Edit the Font of the Diagram</a></h2>
This button shows a dialog to edit the font to be used in the diagram. It's probably the best to use a scalable TrueType font or similar.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ToolButtonModules">Show Modules</a></h2>
This button toggles whether the modules of the files or classes should be shown. Currently the modules are extracted as the directories in which the files reside. This option is currently only available in this dialog and can't be used when automatically generating diagrams because at the moment there is no algorithm to automatically lay-out the files/classes module-wise.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ToolButtonFileNamesInClasses">Names of the Files of the Classes</a></h2>
This button toggles whether the names of the files the classes are defined in should be shown in the boxes. If each file is regarded as a package this may be closer to UML.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ToolButtonAssociations">Associations of used Classes</a></h2>
This button toggles whether the associations depicting a usage-association should be shown. If a class contains a field or property with the type of another class in the diagram a usage-association is created, these associations can be filtered with this button. You may need to filter this kind of association in order to simplify the diagram to automatically lay-out it with the Sugiyama algorithm.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ToolButtonScopePrivate">Filter Members of Classes by their Visibility</a></h2>
With these five buttons the scopes of the members to list in a box of a class can be set.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ToolButtonMemberField">Filter Members of Classes by their Kind</a></h2>
With these three buttons the kind of the members to list in a box of a class can be set. There are three kinds: fields, properties and methods.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ToolButtonShowFunctionReturnType">Show the Return Type of Functions</a></h2>
This button toggles whether the return types of functions of the classes should be shown.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ToolButtonShowMethodParameter">Show the Return Type of Functions</a></h2>
This button toggles whether the parameter list of methods of the classes should be shown. This will increase the width of the boxes considerably.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ComboBoxFont">Font of the Diagram</a></h2>
With this component the font of the diagram can be chosen. TrueType fonts are probably the best choice for big diagrams, so their size can be shrinked to decrease the size of the diagram.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ComboBoxFontSize">Size of the Font of the Diagram</a></h2>
With this component the size of the font of the diagram can be chosen. TrueType fonts can use any fonts and a in general preferred, for non-scalable fonts their available sizes are added to the drop-down list.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ToolButtonAutoLayOut">Automatically Lay-Out the Diagram</a></h2>
This button can be used to automatically lay-out the diagram. The Sugiyama algorithm is used to do this. Unfortunately it can't lay-out too complex diagrams, so you may need to filter some of the associations of the diagram before it is able to. And even then it may not be able to do it.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="ToolButtonAutoSimpleLayOut">Automatically Lay-Out the Diagram simply</a></h2>
These two buttons can be used to automatically lay-out the diagram. Actually two different algorithms are used depending whether it is a diagram of classes or files. Both are simple and can only used for the specific diagram.<br>
For diagrams of classes it simply lay-outs it by creating inheritance trees and sorting each class into one. Within the inheritance trees the classes are sorted alphabetically. The button to the right will run a post-optimization and a second pass to decrease the overall size of diagram.<br>
For diagrams of files it simply lay-outs it by putting used files under files that use them. Using in the implementation part of units is weighted lesser.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="MenuItemDiagrams">Menu Diagrams</a></h2>
This menu contains three menu items to load and save sets of diagram layouts and to close the window. All currently present diagrams can be saved to a file or a set of them loaded. The files are in the simple INI file format.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="MenuItemLayout">Menu Layout</a></h2>
This menu contains several options for the current diagram. At first a diagram can be created, diagrams can either contain classes or files. The diagrams can saved in the list of diagrams, if the last changed should be undone, it can be reseted to the last saved state. It can also be renamed or deleted from the list. Finally the diagram can be exported. It can either be saved as an image or a map of the boxes in the diagram can be exported as an HTML image map or as an ~[image ] inline command. <p>
The image can be either saved as a Windows Bitmap (.bmp), a Portable Network Graphic (.png), a Windows Meta File (.wmf) or a Scalable Vector Graphics (.svg). If it is saves as an SVG image links to HTML documentation can be included directly into the SVG file, the generator and its relevant options have to be selected in this menu before the image is generated. <p>
The used targets are compatible with the HTML generator of documentation, so if the map is exported to the same directory as the documentation and the diagram is saved as PNG file with the same base name (of course another extension) in the same directory most graphical browsers should be able to show the HTML snippet and to go to the correct documentation if one of the boxes is clicked. The exported image map is only a HTML snippet, not a full and correct HTML page, so some browsers might not be able to do it that way, also if the diagram is quite big the browser may not be able to show the image. The needed ~[image ] inline command to be used in <em>DelphiDoc</em> to include an image of the diagram with all the correct links can be copied to the clipboard, too.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="MenuItemDiagramList">Menu Diagram List</a></h2>
This menu shows all saved diagrams, and well also the current one, even if it hasn't been saved. Just chose a menu item to edit the corresponding diagram.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="MenuItemView">Menu View</a></h2>
With this menu some of the components can be hidden, i.e. the tool bar, the status bar and the window of the zoom map.
<div align="right"><a href="#X.top">top</a></div>


      <h2><a name="X.Default" id="X.Default">No specific Help</a></h2>
Please see one of the contained components for a more specific help.
<div align="right"><a href="#X.top">top</a></div>

</body>
</html>