Install and Configure M2Doc¶

M2Doc generates Word documents from Capella models by evaluating model-aware fields in a Word template.

Review the supported configuration before selecting an M2Doc release.

Install M2Doc¶

Open the official Capella M2Doc installation page.
Download the M2Doc package or update-site archive compatible with your Capella release.
In Capella, select Help > Install New Software....
Select Add... > Archive... and choose the downloaded ZIP file.
Enter a name such as M2Doc and select Add.
Select the M2Doc and Capella integration features offered by the package.
Select Next, review the installation, and accept the applicable licenses.
Finish the installation and restart Capella when prompted.

Warning

Use an M2Doc package intended for the installed Capella release. The official installation page lists compatible combinations.

Download an ATICA template¶

These templates contain M2Doc fields that read ATICA and Capella model elements. They are examples and may require adaptation for a project's document format.

Generate a document¶

Copy the required template into the Capella project folder.
Refresh the project so the template appears in the project tree.
Right-click the template and select Initialize Documentation Configurations.
Finish the wizard and confirm that a .genconf file appears.
Right-click the .genconf file and select Generate Documentation.
Open the generated document from the project tree.

For detailed generation steps, see Export an FHA Document. The same initialization and generation sequence applies to the other supplied templates.

Configure a custom template¶

Advanced templates may need access to a custom metamodel:

In the Capella project, right-click the template.
Select Edit Template Properties.
Open the nsURI (expert) tab.
Add the namespace URI for each required custom metamodel.

See the official M2Doc reference documentation for template authoring and advanced generation configuration.