Child Sections

Child sections can be rendered in RTF documentation using one of the following two methods:

  • Render model components directly into the RTF as defined by the section's content and fields.
  • Render indirectly to the RTF by using a parent section to describe the content.

The second option occurs as a result of creating a section that has a placeholder section tag (that is, no content within the tags). This method is used to create recursive documentation of child packages.

Example: Rendered Subsection

This example shows a template with content between the Child Element tags. In this example child elements of the parent are rendered using the Child Elements section because it contains valid content and fields.

RTFChildSubsectionRendered

Example: Non-rendered Subsection

This example shows a template with no content between the child element tags. In this example, child elements of the parent are rendered using the element section because the child element section is empty. The child element section is used as a placeholder.

RTFChildSubsectionNonRendered

Child Document Sections and Their Corresponding Parent Sections

Child Section

Section Rendered when used as a placeholder

Package->Child Package

Package

Package->Element->Child Element

Package->Element

Package->Element->Diagram

Package->Diagram

Package->Diagram->Element

Package->Element

Package->Diagram->Connector

Package->Element->Connector