Topics
Prev Next

Documentation Sub-Menu

The 'Documentation' submenu of the 'Package' context menu provides options for generating several types of documentation or reports on the contents of the selected Package.

Access

Context Menu

Project Browser | Right-click on Package | Documentation

Options

Option

Description

See also

Generate Documentation

Select this option to design and generate reports and documentation on the contents of the selected Package.

The 'Generate Documentation' dialog displays.

Shortcut: F8

Document Reports

HTML Report

Select this option to design and generate web documentation on the contents of the selected Package.

The 'Publish as HTML' dialog displays.

Shortcut: Shift+F8

Create a Web Page Report

Publish as Joomla! Article

Publish the model content as a Joomla! Article (HTML page) in a local Joomla! installation.

Publish as Joomla! Article

Diagrams Only Report

Select this option to generate a Diagrams Only report, which describes the diagrams in the selected Package.

The 'Export Diagrams to RTF Document' dialog displays.

Shortcut: Ctrl+Shift+F8

Diagrams Only Report

Testing Report

Select this option to generate a Testing report, which describes the software development tests defined for the selected Package.

The 'Generate Test Documentation' dialog displays.

Test Documentation

Generated Report Options

Select this option to exclude the selected Package from any reports generated from now onwards, or to include the excluded Package in reports again.

Exclude Package from Report

Package Metrics

Select this option to perform some calculations on the selected Package to establish Project Metrics for planning purposes.

The QA Reports view opens on the 'Use Case Metrics' tab.

Estimating Project Size