Table of contents

• New Comments
• Comment Features
  • Format Comment
    • Word Fields
  • Erase Format
  • Parameter Table
    • Parameter values using parameter ID
  • Identifier Table
    • Identifier values in comments
  • Update Image Path
  • Insert Appendix

New Comments

Click “New Comments” to add a comment to all selected objects.

The comment name becomes the heading unless the comment name contains “Comment” (in current language).

You may paste in formatted text from e.g. Word including tables. Also note the text formatting features in the comments window including the option to add images in the text.

Comment Features

Mechanical uses Html when formatting text in a “Comment”. If typing Html specific coding characters, e.g. “&”, “<” and “>” these are replaced by the corresponding Html character code. For this reason you cannot type in Html formatting styles but must use the text formatting identifiers instead.

Format Comment

Click “Format Comment” to replace text identifiers with formatting or Greek letters in selected Comments.

The format action is defined in the function “textFormatReplace(text)” in the file “reportGeneratorDiacritics.py” in the app installation folder. This file can be customized by the user.

Greek letter identifiers:

Html tag text identifiers:

Word Fields

Figure and Table captions are created using a “field code”. During the import in Word a string identified with “{…}” is converted to a field using the VBA macro in the Word report template, e.g. ‘Figure {SEQ Figure * ARABIC }. ‘ Any valid field codes can be added in a comment.

Erase Format

Click “Erase Format” to clear all HTML formatting in selected Comments. This is useful if pasting in formatted text from Word or other editors.

Parameter Table

Click “Parameter Table” to insert a Comment on the selected object with the text identifier “_parameterTable_” for creating a table of all defined parameters in the model.

The comment can be at any place in the model tree and can also contain other text. Individual parameters may be used in the text as well.

Parameter values using parameter ID

Any parameter value can be referenced to in a text comment by using the parameter ID, e.g. “_P1_”. The object and property name are also available to insert, e.g. “P1(Name)” and “P1(Property)”. The object itself does not need to be tagged in order to use the parameter name.

Identifier Table

Click “Identifier Table” to insert a Comment on the selected object with the text identifier “_identifierTable_” for creating a table of all defined results identifiers in the model. The comment can be at any place in the model tree and can also contain other text.

Identifier values in comments

If a result object has an “Identifier”, e.g. “total_def_LC3” the values of “Object Name”, “Minimum”, “Maximum”, “Average”, “Minimum Occurs On” and “Maximum Occurs On” can be inserted in any comment in the model tree using “identifier_name(LAB)” where LAB is one of: Name/Max/Min/Avg/LocMax/LocMin. The result itself does not need to be tagged in order to use the identifier name.

Update Image Path

Images can be embedded in a comment using the “Insert Image” button in the comment window pane. The link to images are not updated if saving the project in a new name.

Click “Update Image path” to check all comments for embedded images. If an image name exists within the current project the path is updated. All updated comments gets selected in the model tree when finished.

This feature is used if the project is saved in a different location and the images are not shown. It is also used automatic when the report is created.

Insert Appendix

To make one report from several Mechanical models in different systems start by defining the main report from one of the Mechanical systems.

1. For each extra system define a unique “ReportName” e.g. “Appendix A.docx” and only Tag those objects to include. Export a Html report to the folder “user_files”.
2. In the main Mechanical model click the “Insert Appendix” button. This will create an appendix comment with listing of all available html files (except the main report). You may remove or change order of the names.
3. Create the report as normal and the selected appendices will be included at the end of the report.

Appendices from other sources are also possible if saved as a html file (with corresponding image folder) in the folder “user_files”.