Creating user library documentation

You can create HTML documentation for a whole user library in Simcenter Amesim.

To create a user library documentation, do the following:

Procedure

1. If it is not already the case, add your user library to the path list (refer to Adding a user-defined library for more information).

2. To ensure that the links in your user library work properly, generate the documentation for each user submodel and supercomponent contained in your library using the procedure available in Creating an HTML report.

3. In the File menu, select Model documentation > User library documentation to generate the documentation for the whole library.

A message box opens, indicating that the Help application will be restarted to generate the documentation.

4. Select Yes.

A confirmation message appears.

5. Click Ok to launch the Help application.

The documentation generated for the user library appears at the bottom of the Contents tab.

Note If you have several user libraries in your path list, this action will generate the documentation for all of them.

6. Click a submodel or supercomponent from the user library to display its documentation