FICO Xpress Optimization Examples Repository: Using moseldoc

defining and using annotations
text handling
generating XML and HTML files with Mosel
subroutines
use of 'datablock' functionality

The moseldoc program can be used from Mosel:

mosel moseldoc -- mddoc.bim

where the BIM file to which it is applied (here: mddoc.bim) must have been compiled specifying the option '-D'. Note that if no filename is specified moseldoc will display a help text and terminate with an error. It is possible to use wildcards such as '*.bim' meaning all bim files in current directory.

Alternatively, the program can be turned into an executable using 'deploy' with the command (requires a C compiler):

mosel comp -s moseldoc.mos -o deploy.exe:moseldoc

The resulting program expects as its parameters a list of files:

moseldoc mddoc.bim

When compiling moseldoc, the 'datablock' functionality is used to include some styles file for the webpage layout. The provided set of files also contains the dictionary template (.pot) generated with the xprnls tool and sets of translations for German and French.

The file 'mddoc.mos' contains examples of using the 'doc' annotations markup and a detailed description of the functionality available through moseldoc. Processing this file with one of the commands shown above will generate the documentation for moseldoc.

Further explanation of this example: 'Mosel Language Reference', Section 2.19 Documenting models using annotations and 'Mosel User Guide', Section 18.2 moseldoc: Generating model documentation.

# Created by Mosel v5.6.0 from 'moseldoc.mos' # Domain name: moseldoc msgid "" "\n" "Usage: %s [-f] [-u] [-xml|-ixml|-html] [-o of] [-i sp] bimf|mosf [bimf|mosf...]\n" "\n" msgstr "" msgid "! Target location `%s' not found\n" msgstr "" msgid "+ Creating `%000T' from `%000T'\n" msgstr "" msgid "+ Directory `%000T' already exists. Not regenerating it.\n" msgstr "" msgid "+ Directory `%000T' cannot be created. Ignored.\n" msgstr "" msgid "+ File `%000T' already exists. Not regenerating it.\n" msgstr "" msgid "+ File `%000T' cannot be loaded. Ignored.\n" msgstr "" msgid "+ File `%000T' does not contain any `doc.' annotation. Ignored.\n" msgstr "" msgid "+ File `%000T' does not include documentation annotations. Ignored.\n" msgstr "" msgid "Annotation '%000T' not found (%s)\n" msgstr "" msgid "Cannot find argument `%000T' for value `%000T' (ignored)\n" msgstr "" msgid "Cannot group `%s' with `%s' (name not found)\n" msgstr "" msgid "Control parameter '%000T' not found (%s)\n" msgstr "" msgid "" "Generate documentation from annotated bim files or mosel sources.\n" " -f force creation of the document even if it already exists\n" " -u keep documentation of annotations that are not defined via 'mc.def'\n" " -xml generate only the XML file\n" " -ixml generate only the XML file without header/root node (for inclusion)\n" " -html generate only the HTML document (from an existing XML file)\n" " -o of write to file 'of' if xml, or directory 'of' if html\n" " -i sp add 'sp' to the list of paths for file inclusion\n" " -e exit on XML error\n" msgstr "" msgid "Link date" msgstr "" msgid "Root node `%s' does not exist\n" msgstr "" msgid "" "The XML file '%000T' could not be loaded (%s)\n" "\n" msgstr "" msgid "" "The XML file '%000T' does not contain any chapter or section (%s)\n" "\n" msgstr "" msgid "" "The XML file '%000T' includes a section and target location is not defined (%s)\n" "\n" msgstr "" msgid "" "The following text is not valid XML (%s):\n" "%000T\n" msgstr "" msgid "Topics covered in this chapter:" msgstr "" msgid "abort" msgstr "" msgid "ignored" msgstr ""