6.40. subsections Macro


Interface

The general syntax is:

  !subsections labels [; prefix] [; layout]

The arguments are:

Name Type Default Rule
labels string    
prefix string Topic <Topic|Noprefix|noprefix>
layout string Left <Left|Center|Right|None|left|center|right|none>

See Understanding Macro Interfaces, if necessary.


Description

The subsections macro specifies the subsections in a topic.


Examples

Typical usage is:

   H1: MyApp
   !subsections "Purpose,Usage,Description,Examples"

In this case, the subsections macro changes the id generated for the headings listed to:

   MyApp - heading

For HTML, it will also generate a line of jumps to the headings.


Limitations & Future Directions

html is currently the only target for which a jump line is generated.