Orphan document type

Back to Document types

The Orphan document type is used to generate a page which lists its documentation children as well as its source children. Remark makes use of this document type by creating a virtual orphan.remark-orphan node in the root of document tree, called the orphan node. Those documents which do not find a parent document elsewhere are assigned as children of the orphan node. The role of the orphan document is to generate a useful check report to see that one hasn’t forgotten to link some important documents properly into the documentation.

Properties

Name

Orphan

Input Extension

.remark-orphan

Output extension

.htm

Input syntax

None

Output syntax

Html

Generating Remark text

    Orphans
    =======

    [[DocChildren]]
    [[SourceChildren]]

Remark 1.7.6 - Page generated 09.10.2019 16:13.