This version is out of date, covering development from v5.0.0 to v5.12.2. It is maintained here only for inbound reference links from elsewhere.

Jump to the current version of aTbRef.

Tinderbox Icon

^descendants( [template][,N] )^


Code Type: 

Code Scope of Action: 

Code First Added: 

Code Altered: 

 Data Include   [other codes of this type]

 item   [codes with similar scope]

 Already in v5.0.0

 format"


^descendants^

Tells Tinderbox to include the descendants of the current note (or agent) in the current web page using their default template file.

^descendants( template )^

Tells Tinderbox to include the descendants of the current note (or agent) in the current Web page using the specified template file.

^descendants( template,N )^

Tells Tinderbox to include only the first N descendants of the current note (or agent) with the specified template file. If N is used without a template, a comma must be placed before N. In finding N matches, the first branch is to its tip, then all siblings then recursing up branch #1's sub-branches before starting branch #2.

To export immediate children but not the children's descendants, see ^children( template )^. This replaces the old usage of ^children^.

^descendants^ evaluates its template argument, allowing agents and containers to use expressions like

^descendants(^value($MyTemplate)^)^

The HTMLDontExport settings of children are respected.


Possible relevant notes (via "Similar Notes" feature):


A Tinderbox Reference File : Export Codes : Export Code Scope : Item-based : ^descendants( [template][,N] )^