1. Remark
  2. User documentation
  3. Remark syntax
  4. Macros
  5. Available macros
  6. SourceChildren macro

SourceChildren macro

Back to Available macros

The SourceChildren macro generates a list of links to the source children of the given document. This list is preceded by a level-2 heading. If the document does not have source children, the heading is not generated.

Properties

Output expansion default

Disabled.

Parameters

Ignored.

Variables

SourceChildren.class_name
The name of the html-class to give to the <div> tag. The html-class allows to style the generated list using CSS. Default SourceChildren.
SourceChildren.title
The title of the heading. Default Files.

Warnings

missing-description
This warning is generated when a document-group does not have a description. To fix this, add a description for some document in the document-group.

Example

[[set SourceChildren.title]]
[[SourceChildren]]

SourceChildren macro

Generates links to source code children.

Files

SourceChildren macro

Generates links to source code children.