Moritz Files

Moritz 0.9.20 RC6 Test- and Demonstration 

Copyright (C) 2004-2007 by Eckard Klotz. 

Permission to use, copy, modify, and distribute this software and its 
documentation under the terms of the GNU General Public License is hereby 
granted. No representations are made about the suitability of this software for
any purpose. It is provided "as is" without express or implied warranty. 
See the GNU General Public License for more details. 

Documents produced by Moritz are derivative works derived from the input used in
their production; they are not affected by this license. 

As help-tool for Doxygen (www.Doxygen.org) Moritz is designed as a source-code
analysing program wich generates nassi-shneiderman diagrams of the c-functions
and cpp-methods. At the moment this diagrams are stored as html-files. Moritz
has no own source parser and uses the xml-output of Doxygen as base-information.
The output of Moritz may be included in a documentation generated by Doxygen via
the command "htmlinclude". 

Moritz it self is console- or terminal-application
which has to be started via command-line. With configuration-files you may control
the general style of the diagrams. You can also change this configuration for a
function or a part of a function by using special commands in the source-code.

You can find more information under "www.sourceforge.net/projects/moritz/" use the forum. 


This Distribution contains 12 sub-directories: 

bin		: binary of Moritz ,base-versions of the configuration-files and the
		  gif-pictures of the diagonal lines to create the if- and switch-tables
res		: additional ressources for Moritz and the gif-pictures of the diagonal
		  lines to create the if- and switch-tables
cfg		: user-configuration of Moritz

src		: example sources
inc		: example include-diagrams
xml		: input-files for Moritz

fnc		: source-output of Moritz
nsd		: html diagram-output of Moritz
des		: description-tables made by Moritz
dot		: dot diagram-output of Moritz

doxygen		: configuration-files of Doxygen
txt		: additional input-files for Doxygen to create the user documentation
html		: user documentation made by Doxygen

ControlMoritz	: example batchs / scripts to run Moritz 


The batch-file "makeDoc.bat" controls the generation of the diagrams by 
Moritz and the generation of a documentation by Doxygen.



First Steps

0. Moritz needs Doxygen as source-code parser. If you don't already have
   installed, download Doxygen from www.doxygen.org. This Distribution of Moritz
   was tested with the versions 1.5.1 and 1.5.2 of Doxygen

1. Start the bat/sh-file. It should generate the user-documentation of Moritz.
   If this process ends successfully you may open the user-docu by starting the
   file "StartDoc.html" in the Moritz root-directory or "index.html" in the
   directory "html". You are recommended to copy this directory to an other
   location, so that you can use the documentation every time.

2. If the user-documentation was build successfully take a look into the 
   directories fnc, nsd and des. Here you will see the output of Moritz.
   You can open each source-code or diagramm with an html-browser. This may be
   helpful if you use Moritz during the code-development to check the 
   algorithm of single functions.

3. Copy your own sources in to the folder src and delete the original example-
   sources or rename their file-attachments. Change into the folder ControlMoritz 
   and tryout the bat/sh-files "scrHTMxx.yyy". Look in to the folder nsd to watch
   the results.

Command-Line Arguments

Command-Line arguments are used to give Moritz some base-informations about the
directories and file which should be used .


The following arguments has to been used without an own configuration-file:
SP[source-path] 	source-path of the xml-files
DP[destination-path] 	destination-path of the created diagrams


The following argument tells Moritz to use another configuration-file:
CF[configuration-file] 	file with detail-configurations default is mrtz_cfg.xml


The following arguments may be used to override the equal information in the 
used configuration-file:
DscP[description-path] 	destination-path of the created description-tables
SF[source-file] 	first xml-file default is index.xml
RP[resource-path] 	path with additional work-files of Moritz 
                        default-value : home-path of Moritz


Here are some examples:

moritz SPc:\docu\xml DPc:\docu\nsd

This win32-example starts Moritz to load xml-files from "c:\docu\xml" where the
file index.xml is loaded first and to save the diagrams at "c:\docu\nsd". The 
resource-path is the home-directory of Moritz. As base-configuration the file
 mrtz_cfg.xml is used witch is also placed in the home-directory of Moritz.


Moritz CFhome:/project/config/docu_config.xml

This linux-example starts Moritz with the own configuration-file "docu_config.xml"
in the directory "home:/project/config". All other informations are placed in
this configuration file.



If you have an other operation-sytem you have to download the source-files and 
compile them on your system you have change the bat-file into a shell-script of
your system also.









Using the help argument of Moritz 

Since version 0.9.10 RC5 moritz offers a help-argument to provide online information 
 
 
 moritz                 -> general program-information 
 moritz help            -> shows this text 
 moritz help All        -> shows all help-information (rerout it into a file!) 
 moritz help Resources  -> general overview about the neded resource-files 
 moritz help Arguments  -> general overview about the comand-line arguments 
 moritz help SP         -> describes the source-path argument 
 moritz help DP         -> describes the destination-path argument 
 moritz help DscP       -> describes the description-path argument 
 moritz help CF         -> describes the configuration-file argument 
 moritz help SF         -> describes the source-file argument 
 moritz help RP         -> describes the resource-path argument 







To build Moritz the following files has to be used:

src\
    diverse\ 
            c\
              KeyListSet.cpp 
              MoritzHelp.cpp 
              String_imp.cpp 
            h\         
              KeyListSet.h 
              MoritzHelp.h 
              String_imp.h 
    Moritz\ 
           c\
             main.cpp
    xmlblock\ 
             c\
               xmlBlock.cpp
             h\         
               xmlBlock.h
    xmlvisitor\ 
               c\
                 tool_gennsd.cpp  
                 tool_nsdanl.cpp  
                 xmlVisitor.cpp  
                 xmlvst_fileanl.cpp 
                 xmlvst_fncbdy.cpp 
                 xmlvst_fnchd.cpp
                 xmlvst_gennsd.cpp 
               h\         
                 tool_gennsd.cpp  
                 tool_nsdanl.cpp  
                 xmlVisitor.cpp  
                 xmlvst_fileanl.cpp 
                 xmlvst_fncbdy.cpp 
                 xmlvst_fnchd.cpp
                 xmlvst_gennsd.cpp 


This are the standard include-files of c/c++ used by Moritz:

   map.h
   set.h
   vector.h
   list.h
   fstream.h
   string.h
   sstream.h
   sys/stat.h


Since Moritz is a common console-application no special libraries are necessary.

I'm not very familiar with make-files and use an ide (DevC++, Code-Blocks, 
MinGW Developer-Studio, ...) to manage the project and the compile-process.
I don't use special compiler-options to optimize the program. For me the only
steps to compile the sources is to add them into the ide-project, add the
3 h-paths and start the compilation.