id	summary	reporter	owner	description	type	status	priority	milestone	component	version	resolution	keywords	cc
2913	Online documentation of OMC flags	Francesco Casella	Lennart Ochel	"The OMC compiler and the executable codes it generates have a lot of optional flags. The documentation of these flags in the User's Guide and System Documentation is inevitably going to be incomplete and outdated, because new flags are constantly being added or removed during the development process.

Furthermore, the exhaustive documentation of these flags in those two documents makes them bulky and awkward-looking.

Currently, some basic information is available at run-time by running the appropriate executables with the appropriate help flags. This is not very convenient, in particular for OMEdit and OMNotebook users, which are not familiar with the settings required for the command line usage. They might even ignore that a command-line interface actually exist, and they should not be forced to learn how to use that in order to use the GUI - what would a GUI be good for, in that case?

Proposal: automatically gather that information and generate some reports that can be published online and included in the installation package as well. Then, the bulk of this information can be removed from the User's Guide and System Documentation, which should only refer to this automatically generated documentation.

Requirements:

* The documentation should be automatically generated from information present in the source code (à la Doxygen).

* The document generation should be handled by Hudson, so it is always up-to-date.

* The generated documentation should be available in platform-independent formats, e.g. HTML for online viewing and PDF for those who prefer an old-fashioned comprehensive printed reference.

* It would be good to have some kind of tags, so that the appropriate sections of the generated documentation could be referred to. For instance, when setting up a simulation in OMEdit, the ""method"" field should have a ""Help"" button close to it; clicking on this button should open an HTML page with all the information about integration methods. Ditto for all other flags.

* Links to this documentation should also be included in the Help menu of all the OMC suite tools (OMEdit, OMShell, OMNotebook), and a local copy included in the released versions and nightly builds

Suggestions are welcome for the best choice of tools to meet these requirements with the least possible effort by the developers."	enhancement	closed	critical	1.9.3	Build Environment	trunk	fixed		Martin Sjölund Adrian Pop peter.fritzson@… massimo.ceraolo@… Adeel Asghar