Documentation menu

You use the Documentation menu to create, edit and view online documentation.

Create HTML skeleton

HTML documentation create HTML skeleton

Use Documentation > Create HTML documentation to create HTML documentation for the active customized object.

Note

• The name of the file is inherited from the customized object with an html extension.

• This .html file is put in the doc directory of the Simcenter Amesim node in which the customized object is stored.

• The .html file is constructed from the specification (.spe) and source code (.c and .f) (if any) of the customized object. Only customized submodels have a source code. Customized supercomponents do not. Fill in the full description part of the source code as this forms a major part of the documentation.

Edit HTML documentation

HTML documentation edit

Use Documentation > Edit HTML documentation to modify the Sketches and Equations section of your submodel documentation. If no HTML editor is specified in the Component Customization preferences (see section Options), you will be asked to select one.

View HTML documentation

HTML documentation view HTML documentation

Use Documentation > View HTML documentation to view the documentation generated for the active customized object. In contrast if you use Help > Online, you get documentation on all submodels.

Figure 85: Viewing HTML Submodel Documentation

User library documentation

Standard Simcenter Amesim categories contain special index and category files that are used in Help for listing their submodels (in alphabetic order or by icon). Using Help , these categories also appear in the Contents tab and their submodels can be found in the Index tab.

Similar index and category files can be created automatically for your libraries by selecting the User library documentation item. This functionality allows you to generate:

• some html documentation for your own libraries, and

• an index for their components.

This documentation is then automatically made available from the Help Contents tab, and the Index tab is also updated accordingly.

In order to use this facility, you must have created at least one category with components in it, and this category must appear in Submodel Editor: the Path List must contain the node where this library is stored. You must also remember to generate the documentation for each component of your categories by using the Create HTML skeleton facility.

You can then select the User library documentation item and you get a confirmation message similar to the one shown below:

Figure 86: Confirmation message

A new item is added for each user node in the Contents tab:

Figure 87: Contents tab

Two html files are associated with each item:

• One shows the list of the icons contained in the user library followed by their associated submodels Contents page. It is displayed by selecting one of the user categories in the Contents tab.

• The other one shows the submodel list in alphabetic order. It is displayed by selecting the link labeled Alphabetic list in the Contents page described above. It is possible to switch back to the Contents page by selecting the Contents link.

The Index tab is also updated so that all the icons, submodels and descriptions related to your own libraries are taken into account.

Figure 88: Index tab