It is unclear how it is possible to "tie in" models into documentation. Models have multiple view modes and ideally the tool should generate documentation including single or multiple optionally selected views on the same document. Now the graphics and the exported document is about the view mode which is currently open. It would be useful to know how to force exported document include all view modes or allow the user of the tool to select combination of view modes to be documented.

Configuration parameters
menuname STRING
The text for the menuentry in the "Documentation" menu. Must be unique to all other menu names in the documentation menu.
filename STRING
The target filename. Specifies the file to which the documentation should be written. This setting is set dynamically at run time by the export dialog to the filename the user has entered.
filedescription STRING
The description of the output file format. This is needed for the File-Choose Dialog (e.g. "HTML Files").
fileextension STRING
The file extension of the output file. This is needed for the File-Choose Dialog (e.g. "*.rtf" or "*.html").
[ temp1 ] STRING
For documentation generation temporary files are needed (e.g. the sgml file). With the temp setting (temp1, temp2, ...) filenames for temporary files can be created (e.g. "C:\temp\ado2"). After the documentation is exported these files are deleted automatically.
[ requirefile1 ] STRING
With these statements you can specify files (requirefile1:"db:\\sgm2html.dsl", requirefile2:"f:\myfolder\mypicture.bmp", etc) which are to be copied to the export destination folder. After the generation these file are removed again. If the files should not be removed afterwards, add as well a "copy" (see below) statement with the same filename.
If a file doesn't exist, an error message is displayed and the export is aborted. Use "%H" to specify the ADOxx installation directory. For example requirefile1:"%Hboclogo.gif" checks if the file boclogo.gif is contained in the ADOxx installation directory.
Use only "requirefile" for temporary required files like dsl files.
Use both "requirefile" and "copy" for files needed afterwards, too, like pictures for html files.
[ copy1 ] STRING
One or more copy settings can be set (copy1, copy2, ...). The files specified here are copied to the target directory and are not removed after generation. Files starting with "db:\" are copied out of the ADOxx database. Files specified by the "copy" statement must be specified as well with the "requirefile" statement.
Use only "requirefile" for temporary required files like dsl files.
Use both "requirefile" and "copy" for files needed afterwards, too, like pictures for html files.
[ visible ] INTEGER
Set visible to 1, if a menuentry should be added to the menu "Documentation" for this EXPORT block. Set visible to 0, if the corresponding menu entry for this EXPORT block should be hidden.
[ charmap ] STRING
This defines the character map used for documentation export. As string the filename (database file or absolute file) of the character map table file is expected. You can either define a static or dynamic value.
NOTE: For compatibility reasons a special value "DEFAULT" if defined which loads the character map table defined as resource in all versions of ADOxx. It contains the release language of ADOxx. If charmap is not defined, value "DEFAULT" is set.
smarticon: (html|rtf)
If smarticon is set to html, this menuentry is called when the user clicks on the smarticon. When it is set to rtf, the menu entry is called when the user clicks on the smarticon. Only one EXPORT block may be set to html and only one to rtf. This setting may not be set dynamically!

Configuration parameters
filename STRING
The name of the sgml file where the model group and model reference information should be written.
[ exportall ] INTEGER
Can be either 0 or 1. If it is set to 1, all modelgroups and model references are exported. If if is set to 0, only the modelreferences (and their modelgroups) are exported that the user has selected in the export dialog.

EXAMPLE USAGE


The file to which the modelgroups will be exported will usually be the same file as the file to which the model data is exported: The sgml-file which will later be parsed by jade. In the example only the model refernces which the user selects at export will be added to the documentation.

Configuration parameters
filename STRING
The name of the sgml file where the user variables should be written.
[ var1 ] STRING
Variable declarations (var1, var2, var3, ...) for user specific variables.

EXAMPLE USAGE


The file to which the uservariables will be exported will usually be the same file as the file to which the model data is exported: The sgml-file which will later be parsed by jade. Three variables are defined in the example. Each variable can be set by the user. The DSL-script will insert the values entered by the user in the document.