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.

Topics:

Topic

Detail

See also

Example: Rendered Sub-section

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 Sub-section

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

 

Notes:

  • In principle, it is better to leave Child sections blank to replicate their parent sections
     
    Child sections do not contain the same sub-section detail as their parents; for example: Element::Child Element does not contain sub-sections such as Scenario or Attribute, so where Child Element sections are populated, these sub-sections are not rendered
     
    An exception to this is cases where sub-sections are not required, but different formatting of the section fields is preferred