Creating Applications: Add Selectors

In the previous activity we annotated the template with structural information, and these annotations should be sufficient in presenting XML documents as Web pages for users to interact with. However, in our design, we also wanted to be able to add and remove list items from the example hierarchy:

What we want to do is to have buttons beside each list item (and subitem) which remove only that particular item. In addition, we also want buttons which add items only to the particular list each button appears beneath.

Introducing Selectors

So, we need to add buttons to the Web form which, upon being pressed, provide information about their context to the XSLForms framework and subsequently to the application, so that we know which part of the form is to be altered. To make sure that such contextual information is available in the Web form, we must include such references in the descriptions of these buttons in the template.

The concept of a "selector" is a reference which is expressed in a special notation in the template, converted to concrete references in the final output, and can be interpreted when a user submits a form such that the associated section of the XML document version of the form data can be identified in connection with an action. In other words, we write a special value into the definition of a button in a Web form which can automatically be used to refer to other form data when the form is submitted.

Taking the HTML example from before, we add some additional annotations to the template to produce something like this:

<html xmlns="http://www.w3.org/1999/xhtml"
xmlns:template="http://www.boddie.org.uk/ns/xmltools/template">
<head>
<title>Example</title>
</head>
<body template:element="structure">
<form action="" method="POST">

<!-- Template text between the start and the interesting part. -->

<div template:element="item">
<p>
<span template:attribute="value">
 Some item: <input name="{template:field-name()}" type="text" value="{$this-value}" />
</span>
<input name="remove={template:this-position()}" type="submit" value="Remove" />
</p>
<p>
Itself containing more items:
</p>
<p template:element="subitem">
<span template:attribute="subvalue">
 Sub-item: <input name="{template:field-name()}" type="text" value="{$this-value}" />
</span>
<input name="remove2={template:this-position()}" type="submit" value="Remove" />
</p>
<p>
<input name="add2={template:this-position()}" type="submit" value="Add subitem" />
</p>
</div>
<p>
<input name="add={template:this-position()}" type="submit" value="Add item" />
</p>

<!-- Template text between the interesting part and the end. -->

</form>
</body>
</html>

The Remove Buttons

Some of the attributes in the original HTML code have been changed:

What these amendments provide is a means for the XSLForms framework to connect together the usage of a button in the Web form with an XML document element.

The Add Buttons

Some additional sections have been added to the original HTML code:

What these amendments provide is also a means for the XSLForms framework to connect these buttons to parts of the XML document.

Selector Annotation

Special values of the following form can be used to connect parts of the template with elements in the XML document representation of a form:

selector={template:this-position()}
Given a selector name (selector in this example), this special value produces a reference to an XML document element (or attribute) in the final output. The referenced element or attribute is defined by those template:element and template:attribute annotations on template elements which surround the template element within which this special value is used.

The reference guide provides a complete list of special values for use in template annotations.

Whilst many forms consist only of text fields and action buttons, other types of data are very likely to also be used. Multiple-choice or enumerated value fields in forms are covered in the next activity in the development process.