3. Use
Make a page executable
As you might have already noticed, Pages in
registered spaces have a checkbox labeled GreenPepperized. Checking it will automatically register the document in the
server. The default System Under Test will be automatically associated to your newly executable page.
I. Configurating your executable page
You might want to associate your page to other Systems Under Test. To do so, click the Configure button.
You can now remove or add System Under Test associations. This is important if you want the greenpepper-labels or greenpepper-children macro to select your page.
II. Executing your page
You can now Execute your page. Next to the Execute button you will find which System Under Test will be involved. You can select the desired System Under Test. The dropdown list only contains the Systems Under Test configured in step I.
GreenPepper XWiki Macros
Children Macro
Description: This macro can execute a batch of documents resulting from a page hierarchy.
Syntax:
Optional parameters:
- 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.
Import Macro
Description: This macro allows you to import classes into your executable document without polluting it with undesirable and unmeaningful user tables.
Syntax:
This will generate the following hidden table:
| import |
| 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:
Labels search Macro
Description: This macro can execute a batch of documents resulting from a label search.
Syntax:
Mandatory parameter:
- 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.
XWiki with IDE
To connect your Eclipse or Visual Studio environment to XWiki, then context path should look like
which is the main XWiki url followed by
/greenpepper/xmlrpc and the
handler is
greenpepper1