Perl utilities

Matlab documentation: automatic generation of m-file documentation in XHTML
Search and replace: for whole directory trees, with include before/after, text or from file

Automatic generation of Matlab m-file documentation in XHTML

Program file: mtree2html2001.bat
- A perl script that reads each matlab .m file in a directory to produce a corresponding .html file of help documentation and cross reference information. An index file is written with links to all of the html files produced.
  The working of the script is controlled by build-in options (at the beginning of the perl script), an external options file (example see below) and command line options.
  The command line settings overwrite all other settings (built-in and configuration file). The configuration file settings overwrite the built-in settings (and not the command line settings).
- This script is even able to process the whole tree of all Matlab m-files in toolbox/. However, this may take a few minutes depending on the speed of the computer and the number of installed toolboxes.
Options file (example): mtree2html2001_rc.txt

Usage:

       mtree2html2001 [-h] [-c config_file] [-m|dirmfiles matlab_dir] [-d|dirhtml html_dir]
                      [-i yes|no] [-r yes|no] [-p yes|no] [-quiet|q] [-a authorfile

The command line options are:

      -quiet         or -q : be silent, no status information during generation
      -help          or -h : display this help message
      -todo          or -t : print the todo list for $PROGRAM
      -version       or -v : display version

      -configfile    or -c : name of configuration file (default to $var{'configfile'}).
      -dirmfiles     or -m : top level directory containing matlab files to generate html for;
                             default to actual directory.
      -dirhtml       or -d : top level directory for generated html files;
                             default to actual directory.

      -includesource or -i : Include matlab source in the html documentation [yes|no]
                             default to yes.
      -processtree   or -r : create docu for m-file directory and all subdirectories [yes|no];
                             default to yes.
      -producetree   or -p : create multi-level docu identical to directory structure
                             of m-files [yes|no]; default to yes.
      -writecontentsm or -w: update or write contents.m files into the matlab source
                             directories [yes|no]; default to no.

      -authorfile    or -a : name of file including author information, last element in html;
                             default to empty.

Typical usages are:

     mtree2html2001
        (use default parameters from perl script, if configuration
         file is found then generate docu, else display help)

     mtree2html2001 -dirmfiles matlab -dirhtml html
        (generate html documentation for all m-files in directory matlab,
         place html files in directory html, use built-in defaults for
         all other parameters, this way all m-files in the directory
         matlab and below are converted and the generated html-files are
         placed in the directory html and below producing the same
         directory structure than below matlab)

     mtree2html2001 -quiet
        (use built-in parameters from perl script, if configuration
         file is found use these settings as well, do generation,
         no display except critical errors, status of conversion and result)

     mtree2html2001 -m toolbox -dirhtml doc/html -r yes -p no
        (convert all m-files in directory toolbox and below and place
         the generated html files in directory doc/html, read all m-files
         recursively, however, the generated html files are placed in one
         directory)

     mtree2html2001 -m toolbox -dirhtml doc/html -i no -r no
        (convert all m-files in directory toolbox and place
         the generated html files in directory doc/html, do not read m-files
         recursively, do not include source code in documentation)

Search and replace for whole directory trees

Program file: replacetree98.bat
- A perl script that reads each file with a specified file name pattern, searches for a specified text pattern and if found can do different things:
  - replace the found string with another string
  - replace the found string with the contents of a file
  - include before or after the found string the contents of a file
  - include before or after the found string another string.
  The old file can be saved under the file name with an appended backup extension.

Usage:

 replacetree98 [-h]
             [-dirwork|d workdir] [-patternfiles|p files-pattern]
             [-searchstring|s "searchstring"]
             [-replacestring|r "replacestring"] [-replacefile|f replacefile]
             [-includestring|n includestring]   [-includefile|i includefile]
             [-before|b] [-after|a]
             [-processtree yes|no]
             [-silent|quiet|q] [-backupext|e backupext]

The command line options are:

      -silent|quiet  or -q : be quiet, no status information during generation.
      -help          or -h : display this help message.
      -todo          or -t : print the todo list for $PROGRAM.
      -version       or -v : display version.
      -dirwork       or -d : files directory to process.
      -patternfiles  or -p : pattern for files to process (searchfiles).
      -searchstring  or -s : searchstring (in double quotes).
      -replacestring or -r : replacestring (in double quotes).
      -replacefile   or -f : name of file to use for replace text.
      -includefile   or -i : name of file to use for insert text.
      -includestring or -n : insertstring (in double quotes).
      -before        or -b : include before search text.
      -after         or -a : include after search text.
      -processtree   or -o : process whole tree [yes|no].
      -backupext     or -e : string for backup extension.

Typical usages are:

     replacetree98  -p "t*.html" -s "<hr />" -r "<hr noshade="noshade" />"

     replacetree98  -p "*.html" -s "</body>" -includestring "<address>Author: H. Pohlheim </address>" -before

Matlab functions and utilities

pohlheim (main page)

Main page

Publications (long)

Matlab utils

Perl utils