!contents with Help Text Option

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.

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.

Test Rollover Help

First create the parent page.
start Page Builder
line I'm the parent
line !contents
page ParentPage

Included page: ContentsTestsIncludeWithHelp (edit)

Next create a child
start Page Builder
line I came first!
attributes Help=First Child's help
page ParentPage.FirstChild

Next create a sibling
start Page Builder
line I'm younger, but wiser
attributes Help=Second Child's help
page ParentPage.SecondChild

Then request the parent page.
Response Requester.
uri valid? contents?
ParentPage true

...and examine the requested page to insure rollover help text exists
Response Examiner.
type pattern matches?
contents a href="ParentPage.FirstChild"[\s\w="]+ title="First Child's help">FirstChild</a true
contents a href="ParentPage.SecondChild"[\s\w="]+ title="Second Child's help">SecondChild</a true

Explicitly Request Help Text Suffix

First create the parent page.
start Page Builder
line I'm also the parent
line !contents -h
page ParentPage

Included page: ContentsTestsIncludeWithHelp (edit)

Next create a child
start Page Builder
line I came first!
attributes Help=First Child's help
page ParentPage.FirstChild

Next create a sibling
start Page Builder
line I'm younger, but wiser
attributes Help=Second Child's help
page ParentPage.SecondChild

Then request the parent page.
Response Requester.
uri valid? contents?
ParentPage true

...and examine the requested page to insure help text is visible
Response Examiner.
type pattern matches?
contents a href="ParentPage.FirstChild"[\s\w="]+>FirstChild</a true
contents span class="pageHelp">: First Child's help</span true
contents a href="ParentPage.SecondChild"[\s\w="]+>SecondChild</a true
contents span class="pageHelp">: Second Child's help</span true

Implicitly Request Help Text Suffix via Variable

First create the parent page.
start Page Builder
line I'm also the parent
line !define HELP_TOC {true}
line !contents
line !define HELP_TOC {false}
page ParentPage

Included page: ContentsTestsIncludeWithHelp (edit)

Next create a child
start Page Builder
line I came first!
attributes Help=First Child's help
page ParentPage.FirstChild

Next create a sibling
start Page Builder
line I'm younger, but wiser
attributes Help=Second Child's help
page ParentPage.SecondChild

Then request the parent page.
Response Requester.
uri valid? contents?
ParentPage true

...and examine the requested page to insure help text is visible
Response Examiner.
type pattern matches?
contents a href="ParentPage.FirstChild"[\s\w="]+>FirstChild</a true
contents span class="pageHelp">: First Child's help</span true
contents a href="ParentPage.SecondChild"[\s\w="]+>SecondChild</a true
contents span class="pageHelp">: Second Child's help</span true