Subnodes -- a menu of documentation nodes

Synopsis

Usage:

document { ... , Subnodes => { ... }, ... }
Consequences:
- the documentation subnodes listed will appear as descendents of this node in the documentation tree

Description

This option inserts into a documentation page a menu of subnodes and defines how the tree structure of the documentation is constructed. This is relevant when printing the documentation.

Example of usage as an optional argument to document(List)


Subnodes => {
        "An example of subnodes",
        TO "a link name",
        TO "another link name"
        },

Example of usage as a keyword in doc(String)

When used as a main section of a documentation node, Subnodes can be used as follows:


Subnodes
    :Heading 1
      myFunction
      "a link name"
      :A subheading about @TO "mySecondFunction"@
        mySecondFunction
    :Heading 2
      "another link name"

Functions with optional argument named Subnodes :

document(...,Subnodes=>...)

For the programmer

The object Subnodes is a symbol.