Generating a Network Cartridge Guide

When you create an Activation Network Cartridge project, Design Studio adds a Documentation group entity in the new project, which you can view in the Studio Projects view. After you build the cartridge project, the feature enables you to generate most of the required cartridge documentation.

Note:

The Cartridge Guide template is created as a starting point for Activation Network Cartridge project documentation; you can, however, replace the template with a different file.

To generate a cartridge guide:

1. In the Studio Projects view, expand the contents of the Documentation group.

   The Cartridge Guide file and Templates folder appear.

2. Double-click the Cartridge Guide file.

   The standard template for creating cartridge guides opens in MS Word as an RTF file.

3. Scroll down the cartridge guide template until you reach the Cartridge Model section with the text Paste Model Documentation Here.

4. Right-click on the cartridge project and select Copy Documentation to Clipboard from the context menu.

5. In the Cartridge Guide template's Cartridge Model section, highlight Paste Model Documentation Here.

6. Right-click and select Paste from the context menu.

   The Design Studio-generated documentation for the cartridge now appears below the Cartridge Model heading.

Related Topics

Editing Topic Overviews in the Cartridge Guide

About Cartridge Documentation Guides