MMBase Editwizard Reference Manual

The destination type of a related object. This filter is combined with 'role' and 'searchdir' to select the objects to show in the list.

The role of the relation. This filter is used combined with 'destination' and 'searchdir' to select the objects to show in the list.

The direction to follow the relation in. You can specify the values 'source', 'destination', or 'both'. 'Source' and 'destination' in this context refer to the directionality of the relation. Each relation in mmbase has a 'source' (where the relation starts) and a 'destination' (where the relation ends). Most of the time this directionality is not of import. You can follow relations either way without worrying on directionality, and most of the time only one relation is possible between two object types (so specifying destinationtype is often enough). In some cases you may have more possible relations (say, when you relate objects of the same type, i.e. a pool hierarchy). If you want to narrow down the selection based on direction of the relation, you specify searchdir.

If you specify 'source', only those relations are returned where the 'current' object is the destination object (and the related objects are the 'source'). Specifying 'destination' only returns those relations are returned where the 'current' object is the source object. 'Both' returns all relations.

This filter is used combined with 'role' and 'destination' to select the objects to show in the list.

The xpath describing the relations whose objects to show in this list. Note that if you specify fdatapath, you cannot use destination, role, or searchdir.

The xpath describing the parent object of the list. The value of this path is used when adding new relations (using the add or create actions), as the parent object of the list is the node new relations are added to.

Normally, the parent of a list is automatically determined. In general, it will be the object that has focus when the list is created - i.e. the main wizard object for a normal list, or an object identified by an 'item' tag, when using a list-within-a-list. Generally you do not have to specify this attribute.

However, if you specify a fdatapath attribute, it is possible to obtain a list of relations who are not the children of the focus object. In that case, if you want to be able to create new relations, you need to add the fparentdatapath to point out the parent object.

For example, suppose you use an 'employee' object, that contains contract data. It is related to one 'people' object (containing person data), which is connected to several 'contact' objects, containing alternate email addresses. If you want to edit the emailaddresses directly from the 'employee' object, you can dot so as follows:

<list fdatapath="relation/object[@type='people']/relation[object/@type='email']" fparentdatapath="relation/object[@type='people']" >
        <item>
          <field name="email" />
        </item>

        <command name="insert" />

        <action type="create">
          <relation role="related">
                  <object type="email" />
                </relation>
        </action>
</list>

The field on which to order the list. By default, a list is unordered, and newly added items are added at the end of the list. By specifying a field you can order the list as you wish. The value of orderby can either be a fieldname of the related node, or a xpath..

For instance, using a fieldname:

<list role="posrel" destinationtype="email" orderby="title" hidecommand="move-up|move-down" >
...
</list>

If the ordering need be on another property, such as the field of a relation or the number of a node, you specify an xpath Take into account that the xpath is relative to the relation selected by the list (and not to the related node). For instance:

<list role="posrel" destinationtype="email" ordertype="number" orderby="object/@number" hidecommand="move-up|move-down" >
...
</list>

<list role="posrel" destinationtype="email" ordertype="number" orderby="@number" hidecommand="move-up|move-down" >
...
</list>

Finally:

<list role="posrel" destinationtype="email" ordertype="number" orderby="field[@name='pos']" >
...
</list>

When specifying a sort order, the wizard will automatically make up/down buttons that allow you to change the order of the objects in a list. The ordering is rather crude, as it merely switches the value of the 'orderby' field between objects. As such, when you order a list on a field you do not want to have changed (such as the title field of a newsitem or the number field, as in the examples above), you should disable these buttons using the hidecommand attribute.

Also note that you if the order field is a numerical value, you will need to specify this using the ordertype attribute.

The type of the orderby field. Possible values are string and number. This attribute determines whether sorting takes place on lexical or numerical value. I.e., with ordertype="string", the value '12' will come after '100'. With ordertype="number", the value '12' will come before '100'.

The minimum number of objects that should be in this list. If the list contains less than the indicated number, the wizard will disable the save button. The default minimum is 0 (no) objects.

The maximum number of objects that are allowed in this list. If the list contains more than the indicated number, the wizard will disable the save button. This attribute can be a number or the character '*' (infinite). The default maximum is infinite.

A list of commands that should NOT be made available in the list. The attributes contains the command names, separated by a '|' character. The commands that can be turned off are move-up, move-down, delete-item, and add-item. By default, all commands are active when appropriate.

The title of a list, often displayed as a caption or prompt

The description of a list, often shown as a help text in for instance a roll-over text

Defines how to manipulate a list when creating or deleting list items. Possible actions are add (add an existing object to the list) create (create a new object and add it), and delete (delete an object)

Defines ways to manipulate (add data) to the list. Possible commands are search (search for an object to include in the list), insert (create a new empty object and add it to the list), and startwizard (call a subwizard to create a new object to add to the list).

Item determines how a show a related object. It is similar to a form-schema, in that it can contain fields and lists.

A representation of a form in the wizard.

An item in a (higher) list.