ColdFrame: Documentation


ColdFrame can generate HTML-formatted documentation from your model.

At first sight this may seem unnecessary. However, there are at least three reasons why it may be helpful:


No special installation is needed, but diagram generation depends on Graphviz.

Normally you should have Graphviz's binary directory on your PATH: if not, set the environment variables DOT and CIRCO to the locations of dot and circo respectively.


Assuming you have set up your Makefile using the supplied, simply say

make Domain.html

or, if you don't want diagrams (easier to do comparisons, perhaps; or maybe you can't install Graphviz),

make Domain.html GENERATE_DIAGRAMS=no

Images will be created in the subdirectory Domain.images/, which needs to be copied with Domain.html.

Simon Wright