Use !contents to list all or some of the child pages of the current page along with additional information such as help text, suite filters, some property settings, and graceful names. Example:
!contents -R2 -g -p -f -h
Instead of defining arguments on the !contents widget, variables can be defined that act as global properties.
comment
argument
description
Variable
-R
Include all of the descendent pages.
-Rn
Include n levels of descendent pages.
-f
Show suite filters.
FILTER_TOC {true}
-g
Show graceful names in the list.
REGRACE_TOC {true}
-h
Show help property text
HELP_TOC {true}
-H
Show help property text as TOC title, and show page name using small letters.
HELP_INSTEAD_OF_TITLE_TOC {true}
-p
Show property suffixes.
Defaults: Suite(*), Test(+), Imported(@), Symbolic(>), Skip(-).
PROPERTY_TOC {true}
PROPERTY_CHARACTERS {*+@>-}
-c
Show number of test pages in a suite.
Explicit Property Option
First create the parent page.
script
start
Page Builder
line
I'm the parent
line
!contents -f
page
ParentPage
Next create a child
script
start
Page Builder
line
I came first!
attributes
Suite=true,Test=true,Suites=FC1
page
ParentPage.FirstChild
Next create a sibling
script
start
Page Builder
line
I'm younger, but wiser
attributes
WikiImport=true,Prune=true,Suites=FC2
page
ParentPage.SecondChild
Then request the parent page.
Response Requester.
uri
valid?
contents?
ParentPage
true
...and examine the requested page to be sure that the child pages are included
Response Examiner.
type
pattern
matches?
contents
a href="ParentPage.FirstChild"[\s\w="]+>FirstChild \(FC1\)</a>
true
contents
a href="ParentPage.SecondChild"[\s\w="]+>SecondChild \(FC2\)</a>
true
Indirect via PROPERTY_TOC Variable
First create the parent page.
script
start
Page Builder
line
I'm also the parent
line
!define FILTER_TOC {true}
line
!contents
line
!define FILTER_TOC {false}
page
ParentPage
Next create a child
script
start
Page Builder
line
I came first!
attributes
Suite=true,Test=true,Suites=FC1
page
ParentPage.FirstChild
Next create a sibling
script
start
Page Builder
line
I'm younger, but wiser
attributes
WikiImport=true,Prune=true,Suites=FC2
page
ParentPage.SecondChild
Then request the parent page.
Response Requester.
uri
valid?
contents?
ParentPage
true
...and examine the requested page to be sure that the child pages are included
Response Examiner.
type
pattern
matches?
contents
a href="ParentPage.FirstChild"[\s\w="]+>FirstChild \(FC1\)</a
true
contents
a href="ParentPage.SecondChild"[\s\w="]+>SecondChild \(FC2\)</a