Changes between Initial Version and Version 1 of WebInterface/DependencyExaminations

Timestamp:

Apr 9, 2012, 5:19:31 PM (13 years ago)

Author:

manualwiki

Comment:

--

WebInterface/DependencyExaminations

@@ +1 @@
+= Dependency Examinations =
+
+[[Image(web_interface_depanal)]]
+
+To learn more about dependency analysises see the [wiki:Dependency Dependency Analysis page].
+
+An application called Graphviz, is needed to generate results in .svg format.
+
+All images generated during examinations are placed in the directory which has been set during startup by the 'images_dir' switch. If this parameter has not been set, all images are placed in the current working the directory.
+
+== Analyse in function or in module level ==
+Dependency examinations can be performed on a module or function level, using the whole graph or the cyclic sub-graph. A self-defined module or function can also be set as the starting node of an examination. This service is available in the ”Dependency graph” menu under the ”Function or Module level” tab.
+
+Possible configurations for an examination are:
+
+* Configuring the level of the examination: setting {{{module}}} or {{{function}}} from the ”Level” drop-down.
+
+* Configuring the type of the examination:
+ * {{{None}}}: In this case, the type of examination is not given, this mode is used when the user wants to set the starting node of the examination.
+ * {{{Whole graph}}}: Dependency examinations are performed on the whole graph.
+ * {{{Cyclic sub-graph}}}: Dependency examinations are performed only on the set of cyclic sub-graphs.
+
+* Configuring the starting node of the examination:
+ * {{{module}}}: can be set in the text-field located under ”Starting node (module)”. The interface offers possible endings while typing a module name, based on modules that are loaded into the database. An offered module name can be chosen from a drop-down list.
+ * {{{function}}}: can be set in the text-field located under ”Starting node (function)”. The function should be given in the following form: {{{module name:function name/arity}}}. The interface offers possible endings here as well.
+
+Modules or functions which you don't want to see in the graph, should be added to the Excluded list with the provided button, or directly in the text area separated by newlines.
+Modules or functions which leaves you don't want to see in the graph, should be added to the No leaves list the same way.
+You can also exclude all OTP modules/functions by checking the Exclude OTP checkbox.
+
+After configurating an examination, click the ”Generate graph” button to start it. The result is available in two different graphic formats. By clicking ”Generated graph in .dot” the result is sent to the browser in .dot format. By clicking ”See generated graph in .svg” the result is displayed in a new window in the browser.
+
+== Analyse in functionblock level ==
+Dependency analysis can also be done in functionblock level. This service is available in the ”Dependency graphs” menu under the ’Functionblock’ tab.
+
+Predefined functionblocks are the loaded directories, but a functionblock can also be defined by the user, by typing the needed Perl-like regular expression into the textfield, and pressing the ’Add’ button.
+
+The available functionblocks are placed in the ’Functionblock’ list. From there the subjects of the analysis can be drag and dropped into the ’Subjects’ list. After this you can generate a graph as usual.