GreenPepper XWiki Macros

Children Macro

  Description: This macro can execute a batch of documents resulting from a page hierarchy.
  Syntax:

{{greenpepper-children/}}

• all: Default --> false
  If set to true, the complete hierarchy of the parent page will be included in the execution list.
  Otherwise only the first-level children will be included.
• spaceKey: Default --> Macro's residing space
  You can specify a specific space for your parent page.
• pageTitle: Default --> Macro's residing page
  You can specify a specific title for the parent page.
• title: Default --> blank
  You can specify your own title.
• expanded: Default --> false
  You can ask for the list to be expanded on page load.
• suts: Default --> All
  You can narrow the list to specific Systems Under Test (1 or more; if more than one they must be separated by a comma).
• sort Default --> Hierarchical sort
  You can configure the way children are sorted. Choose Creation to sort by content creation dates, Title to sort alphabetically by titles and Modified to sort by modification dates (last date first).
• reverse Default --> false
  You can reverse the sorting sequence.
• openInSameWindow Default --> false
  You can control whether or not the link to the specification will open in the same window.

EXAMPLE

{{greenpepper-children spaceKey="GreenPepper Demo" pageTitle="Demo" expanded="true"/}}

Import Macro

  Description: This macro allows you to import classes into your executable document without polluting it with undesirable and unmeaningful user tables.
  Syntax:

{{greenpepper-import parameter="package1|package2|...|packageN" /}}

{{greenpepper-import parameter="my.class.to.import|some.other.class.to.import"/}}

Info Macro

  Description: This macro allows you to create tables and/or bullet lists that you do not want to be processed as executable specifications within your executable documents.
  Syntax:

{{greenpepper-info}} _your body_ {{/greenpepper-info}}

{{greenpepper-info}}
* My bullet list
* Some information 
{{/greenpepper-info}}

Labels search Macro

  Description: This macro can execute a batch of documents resulting from a label search.
  Syntax:

{{greenpepper-labels\}}

• labels:
  You can pre-enter the labels to base the search on.
  Using the , as the label separation is equivalent to an OR query. Therefore, label1,label2 will retrieve all pages labeled by label1 OR label2.
  Using the & as the label separation is equivalent to an AND query. Therefore, label1&label2 will retrieve all pages labeled by label1 AND label2.

  Optional parameters:

• spaceKey: Default --> None
  You can narrow the label search to a specific space.
  If none is specified, the available GreenPepperized spaces will be in a select list.
• title: Default --> blank
  You can specify your own title.
• expanded: Default --> false
  You can ask for the list to be expanded on page load.
• suts: Default --> All
  You can narrow the list to specific Systems Under Test (1 or more; if more than one they must be separated by a comma).
• sort Default --> NONE
  You can configure the way children are sorted. Choose Creation to sort by content creation dates, Title to sort alphabetically by titles and Modified to sort by modification dates (last date first).
• reverse Default --> false
  You can reverse the sorting sequence.
• openInSameWindow Default --> false
  You can control whether or not the link to the specification will open in the same window.

EXAMPLE

{{greenpepper-labels spaceKey="GreenPepper Demo" title="Demo" labels="Demo" expanded="true" openInSameWindow="true"/}}