Appendix B Structure of Main Components

Structure of a Package

     Short Format
     Package: PkgName [-- ShortDescription]
     
     [LongDescription]
     
     {Module | Topic}
     
     [End Package: PkgName]

     Long Format
     Package: PkgName
     
     ShortDescription
     
     [LongDescription]
     
     {Module | Topic}
     
     [End Package: PkgName]

Structure of a Module

     Short Format
     Module: ModuleName [-- ShortDescription]
     
     [LongDescription]
     
     {Element | Topic}
     
     [End Module: ModuleName]

     Long Format
     Module: ModuleName
     
     ShortDescription
     
     [LongDescription]
     
     {Element | Topic}
     
     [End Module: ModuleName]

Structure of an Element

     Short Format
     Element: Name [-- ShortDescription]
     
     [LongDescription]
     
     {SubElements | Result | SeeAlso | Note | Notes}
     
     {Errors | Example | Version}

     Long Format
     Element: Name
     
     ShortDescription
     
     [LongDescription]
     
     {SubElements | Result | SeeAlso | Note | Notes}
     
     {Errors | Example | Version}

Result, See Also, Errors and Version headers can appear only once inside an element.

Structure of a Topic

     Short Format
     Topic: Name [-- ShortDescription]
     
     [LongDescription]
     
     {SubTopic}

     Long Format
     Topic: Name
     
     ShortDescription
     
     [LongDescription]
     
     {SubTopic}

Structure of a Sub Topic

A Sub Topic can only occur if its parent is directly inside a package.

     Short Format
     Sub Topic: Name [-- ShortDescription]
     
     [LongDescription]

     Long Format
     Sub Topic: Name
     
     ShortDescription
     
     [LongDescription]