DocChildren macro
=================

[[Parent]]: available_macros.txt

The DocChildren macro generates a list of links to the documentation
children of the given document. This list is preceded by a level-2 
heading. The heading is not generated if there are no documentation 
children.

Properties
----------

### Output type

Remark

### Output expansion default

Enabled.

### Parameters

Ignored.

### Variables

DocChildren.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 `DocChildren`.

DocChildren.exclude
:	A list of tag-name/glob pairs (e.g. file_name *.txt), one per row, 
	where the glob decides whether a given document with a given tag-value 
	is to be excluded from the list. Default empty (matches nothing).

DocChildren.exclude_regex
:	A list of tag-name/regex pairs (e.g. file_name .*\.txt), 
	one per row, where the regex decides whether a given document with a 
	given tag-value is to be excluded from the list. 
	Default empty (matches nothing).

DocChildren.root_document
:	The document to use as the root node.
	Default `[[tag file_name]]` (pre-expanded).

DocChildren.include
:	A list of tag-name/glob pairs (e.g. file_name *.txt), one per row, 
	where the glob decides whether a given document with a given tag-value 
	is to be included in the list. Default `document_type RemarkPage`.

DocChildren.include_regex
:	A list of tag-name/regex pairs (e.g. file_name .*\.txt), 
	one per row, where the regex decides whether a given document with a 
	given tag-value is to be included in the list. 
	Default empty (matches nothing).

DocChildren.title
:	The title of the heading. Default `Learn more`.

Notes
-----

When specifying patterns, multiple rows are interpreted as alternatives. 
Possible surrounding whitespace is stripped off for each line.
If both a regex pattern and a glob pattern is given, they
are combined as alternatives.

Example
-------

This

	[[DocChildren]]
	
produces

[[DocChildren]]

i.e. nothing because this document has no children.
For a more interesting example see the parent document
of this document.

See also
--------

[[Link]]: pattern_matching.txt
