1 <?xml version="1.0" encoding="iso-8859-1"?> 2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3 <html xmlns="http://www.w3.org/1999/xhtml"><head> 4 <meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type" /><title>Template Attribute Reference</title> 5 <link href="styles.css" rel="stylesheet" type="text/css" /></head> 6 <body> 7 8 <h1>Template Attribute Reference</h1> 9 <p>This document presents each of the attributes used in 10 templates to annotate the structure of the XML documents being 11 presented and to modify the final output of the presented document.</p> 12 13 <h2>Basic Annotations</h2> 14 15 <p>The annotation attributes in this section are the most basic of those available. Apart from <code>template:element</code> and <code>template:i18n</code>, it is usually preferable to use the annotations listed in the "Convenience Annotations" section below.</p> 16 17 <h3><a name="element"></a>template:element</h3> 18 19 <p>This 20 attribute associates the template element on which it is used with an 21 element from the XML document being presented. Matching elements are 22 found from the current position (or context), where the position 23 is updated upon entering a template element with a <code>template:element</code> or <code>template:attribute</code> annotation.</p> 24 25 <p>Example:</p> 26 27 <pre><p template:element="item"><br /> For each item element found, this section is produced.<br /> <span template:element="subitem"><br /> For each subitem element found within an item element, this is produced.<br /> </span><br /> <span template:element="other"><br /> This is produced for each other element found within an item element.<br /> </span><br /></p></pre> 28 29 <p>Example:</p> 30 31 <pre><p template:element="first,second,third"><br /> For each third element found, this section is produced.<br /></p></pre> 32 33 <p>Syntax:</p> 34 35 <pre>element-name1[,element-name2[,...]]</pre> 36 37 <p>Related attributes:</p> 38 39 <ul><li><code>template:init</code></li></ul> 40 41 <h3><a name="attribute"></a>template:attribute</h3> 42 43 <p>This attribute associates the template element on which it is used with an attribute in the XML document being presented.</p> 44 45 <p>Example:</p> 46 47 <pre><p template:element="item"><br /> <span template:attribute="value"><br /> This section is associated with the value attribute of the item element.<br /> To be really useful, we should also use other annotations to produce the value of the attribute.<br /> </span><br /></p></pre> 48 49 <p>Syntax:</p> 50 51 <pre>attribute-name</pre> 52 53 <p>Related attributes:</p> 54 55 <ul><li><code>template:value</code></li><li><code>template:attribute-field</code></li><li><code>template:attribute-button</code></li><li><code>template:attribute-area</code></li><li><code>template:attribute-list-button</code></li></ul> 56 57 <h3><a name="value"></a>template:value</h3> 58 59 <p>This attribute produces, in the final output, the value of part of the XML document being presented.</p> 60 61 <p>Example:</p> 62 63 <pre><p template:element="item"><br /> <span template:attribute="value" template:value="$this-value"><br /> This text will be replaced by the value of the attribute, but the span template element will remain.<br /> </span><br /></p></pre> 64 65 <p>Example:</p> 66 67 <pre><p template:element="item"><br /> <span template:attribute="value" template:value="$this-value" template:effect="replace"><br /> This text and its enclosing span element will be replaced by the value of the attribute.<br /> </span><br /></p></pre> 68 69 <p>Syntax:</p> 70 71 <pre>XPath-expression</pre> 72 73 <p>Here, the underlying XPath mechanisms are exposed, but a number of useful shortcuts are available:</p> 74 75 <ul><li><code>$this-value</code> produces the value of the current position (or context) in the XML document being presented.</li><li><code>template:this-attribute()</code> produces a reference to the current attribute (or context).</li></ul>Other XPath expressions can be used to navigate from the current position to other nodes in the XML document. 76 77 <p>Related attributes:</p> 78 79 <ul><li><code>template:effect</code></li></ul> 80 81 <h3><a name="effect"></a>template:effect</h3> 82 83 <p>This attribute modifies the effect of a <code>template:value</code> annotation.</p> 84 85 <p>Example:</p> 86 87 <p>(See above.)</p> 88 89 <p>Syntax:</p> 90 91 <pre><span style="font-weight: bold;">insert</span>|<span style="font-weight: bold;">replace</span></pre> 92 93 <p>Related attributes:</p> 94 95 <ul><li><code>template:effect</code></li><li><code>template:attribute-area</code></li></ul> 96 97 <h3><a name="if"></a>template:if</h3> 98 99 <p>This 100 attribute permits the inclusion of a section of the template document 101 according to a test performed on the XML document being presented.</p> 102 103 <p>Example:</p> 104 105 <pre><p template:if="@value = 'true'"><br /> If the value attribute is set to the string value 'true', include this section.<br /></p></pre> 106 107 <p>Syntax:</p> 108 109 <pre>XPath-expression</pre> 110 111 <p>Here, 112 the underlying XPath mechanisms are exposed, and any XPath expression 113 which tests aspects of the XML document can be written.</p> 114 115 <h3><a name="i18n"></a>template:i18n</h3> 116 117 <p>This 118 attribute is used to translate the textual contents of an element to 119 another language where additional parameters specifying the language 120 and the whereabouts of the translations have been provided to the 121 stylesheet in the output generation process.</p> 122 123 <p>Example:</p> 124 125 <pre><span template:i18n="-">Hello</span></pre> 126 127 <p>In this example, the contents of the <code>span</code> element would be replaced with an appropriate translation for the text <code>Hello</code><span></span>.</p> 128 129 <p>Example:</p> 130 131 <pre><span template:i18n="hello">Hello</span></pre> 132 133 <p>In this example, the contents of the <code>span</code> element would be replaced with an appropriate translation using the token <code>hello</code><span></span> as a key in the translation dictionary.</p> 134 135 <p>Example:</p> 136 137 <pre><span template:i18n="{$this-value}">Hello</span></pre> 138 139 <p>In this example, the value of the special template variable <code>$this-value</code> is used as a key in the translation dictionary.</p> 140 141 <p>Syntax:</p> 142 143 <pre><span style="font-weight: bold;">-</span>|<span style="font-weight: bold;">{</span>expression<span style="font-weight: bold;">}</span>|token</pre> 144 145 <p>See the <a href="internationalisation.html">"Internationalisation"</a> document for more information on this attribute.</p> 146 147 <h2>Initialisation Annotations</h2> 148 149 <p>The annotation attributes in this section control the initialisation of documents where this is done by the XSLForms toolkit.</p> 150 151 <h3><a name="init"></a>template:init</h3> 152 153 <p>This attribute controls the creation of elements in the initialisation process and is used together with <code>template:element</code>. For each element name listed in a <code>template:element</code> annotation, the corresponding value in a <code>template:init</code> annotation states whether or how such elements are to be initialised.</p> 154 155 <p>Example:</p> 156 157 <pre><p template:element="item" template:init="no"><br /> Such item elements will not be created automatically when the document is initialised.<br /></p></pre> 158 159 <p>Example:</p> 160 161 <pre><p template:element="first,second,third" template:init="yes,yes,no"><br /> The first and second elements will be created automatically when the document is initialised.<br /> No third elements will be created automatically when the document is initialised.<br /></p></pre> 162 163 <p>Syntax:</p> 164 165 <pre><span style="font-weight: bold;">yes</span>|<span style="font-weight: bold;">no</span>|<span style="font-weight: bold;">auto</span>[,<span style="font-weight: bold;">yes</span>|<span style="font-weight: bold;">no</span>|<span style="font-weight: bold;">auto</span>[,...]]</pre> 166 167 <p>Here, <code>yes</code> means that an element will be created automatically, <code>no</code> means that an element will not be created automatically (relying on the existence of such elements from before), and <code>auto</code> 168 means that the initialisation process will attempt to guess whether an 169 element should be created automatically (by looking for selectors which 170 use the element's name and only creating elements where no such 171 selectors could be found). Where no values are provided, <code>auto</code> is assumed.</p> 172 173 <p>Related attributes:</p> 174 175 <ul><li><code>template:element</code></li></ul> 176 177 <h2>Convenience Annotations</h2> 178 179 <p>The 180 annotation attributes in this section provide more convenient ways of 181 presenting the XML document information in the final output.</p> 182 183 <h3><a name="attribute-field"></a>template:attribute-field</h3> 184 185 <p>This 186 attribute associates the template element on which it is used with an 187 attribute from the XML document, whilst providing certain other 188 attributes in the final output:</p> 189 190 <ul><li>The <code>name</code> attribute is used to identify the location of the attribute in the XML document being presented.</li><li>The <code>value</code> attribute is used to present the value of the attribute from the XML document.</li></ul> 191 192 <p>Example:</p> 193 194 <pre><input template:attribute-field="name" name="..." value="..." type="text"/></pre> 195 196 <p>This would be output as follows:</p> 197 198 <pre><input name="path-to-name" value="value-of-name" type="text"/></pre> 199 200 <p>...where <code>path-to-name</code> and <code>value-of-name</code> would be replaced with the appropriate computed values.</p> 201 202 <p>Syntax:</p> 203 204 <pre>attribute-name</pre> 205 206 <p>Related attributes:</p> 207 208 <ul><li><code>template:attribute-area</code></li><li><code>template:attribute-button</code></li></ul> 209 210 <p>Implementing attributes:</p> 211 212 <ul><li><code>template:attribute</code></li></ul> 213 214 <h3><a name="attribute-area"></a>template:attribute-area</h3> 215 216 <p>This 217 attribute associates the template element on which it is used with an 218 attribute from the XML document being presented, much in the way 219 that <code>template:attribute-field</code> does. However, the 220 attribute value is not inserted into an attribute in the final output; 221 instead it is inserted into the output in a different way according to 222 additional information specified in the annotation.</p> 223 224 <p>Example:</p> 225 226 <pre><textarea template:attribute-area="name" name="..." cols="40" rows="5"><br /> This text will be replaced by the value of the name attribute from the document being presented.<br /> The textarea element will enclose the attribute value in the final output.<br /></textarea></pre> 227 228 <p>Example:</p> 229 230 <pre><p><br /> The name is:<br /> <span template:attribute-area="name,replace"><br /> This text will be replaced in the final output, and the span element will not be reproduced.<br /> </span><br /></p></pre> 231 232 <p>Syntax:</p> 233 234 <pre>attribute-name[,<span style="font-weight: bold;">insert</span>|<span style="font-weight: bold;">replace</span>]</pre> 235 236 <p>By default, the value of <code>attribute-name</code> is inserted within the template element on which the annotation appears, and this is equivalent to specifying <code>insert</code>. If <code>replace</code> is specified, the template element is entirely replaced by the value of <code>attribute-name</code>.</p> 237 238 <p>Related attributes:</p> 239 240 <ul><li><code>template:attribute-field</code></li></ul> 241 242 <p>Implementing attributes:</p> 243 244 <ul><li><code>template:attribute</code></li></ul> 245 246 <h3><a name="attribute-button"></a>template:attribute-button</h3> 247 248 <p>This attribute associates the template element on which it is used 249 with an attribute from the XML document, whilst providing certain other 250 attributes in the final output, much like <code>template:attribute-field</code> does, but with features which make the presentation of buttons and related user interface controls much simpler:</p> 251 252 <ul><li>The <code>name</code> attribute is used to identify the location of the attribute in the XML document being presented.</li><li>The <code>value</code> attribute is used to present a specified value associated with the button being activated.</li><li>An additional named attribute is used to indicate whether the button was activated or set.</li></ul> 253 254 <p>Example:</p> 255 256 <pre><input template:attribute-button="question-type,text,checked" name="..." value="..." type="radio"/></pre> 257 258 <p>This would produce a "radio" button like the following:</p> 259 260 <pre><input name="path-to-question-type" value="text" type="radio"/></pre> 261 262 <p>If the value of <code>question-type</code> was set to text, output like the following would be produced:</p> 263 264 <pre><input name="path-to-question-type" value="text" type="radio" checked="checked"/></pre> 265 266 <p>In an XHTML document, this would cause the "radio" button to appear selected or activated.</p> 267 268 <p>Syntax:</p> 269 270 <pre>attribute-name,attribute-value,attribute-to-create-when-set</pre> 271 272 <p>Related attributes:</p> 273 274 <ul><li><code>template:attribute-field</code></li><li><code>template:attribute-list-button</code></li></ul> 275 276 <p>Implementing attributes:</p> 277 278 <ul><li><code>template:attribute</code></li><li><code>template:expr</code></li><li><code>template:expr-attr</code></li></ul> 279 280 <h3><a name="selector-field"></a>template:selector-field</h3> 281 282 <p>This 283 attribute permits the definition of references to the parts of the XML 284 document being presented which are associated with the template 285 elements in which it is used. When used in certain HTML form-related 286 elements, it becomes possible to receive and obtain such references 287 from the XSLForms toolkit and to then access the selected parts of the 288 original document.</p> 289 290 <p>Example:</p> 291 292 <pre><p template:element="item"><br /> <input template:selector-field="remove" name="..." value="Remove this item" type="submit"/><br /></p></pre> 293 294 <p>Example:</p> 295 296 <pre><p template:element="item"><br /> An item...<br /></p><br /><input template:selector-field="add,item" name="..." value="Add item" type="submit"/></pre> 297 298 <p>Syntax:</p> 299 300 <pre>selector-name[,element-name]</pre> 301 302 <p>The 303 optional element name can be used to associate the selector with other 304 elements; when this is done, the initialisation of the XML document 305 will be affected such that the named element will not be automatically 306 created in the initialisation process, since the presence of the 307 selector implies that such elements can be added and removed in the 308 application user interface.</p> 309 310 <p>Related attributes:</p> 311 312 <ul><li><code>template:element</code></li></ul> 313 314 <h2>Multiple-choice Annotations</h2> 315 316 <p>The annotation attributes in this section provide ways of presenting enumerations and selections of values.</p> 317 318 <h3><a name="multiple-choice-field"></a>template:multiple-choice-field</h3> 319 320 <p>This 321 attribute associates the template element on which it is used with an 322 attribute in the XML document being presented whose value is to be 323 chosen from a list of possibilities. The list itself is represented by 324 a list of elements, each having an attribute with a distinct 325 value; such information is added in the initialisation of the 326 document before it is presented, since it is not part of the 327 "essential" information in the document.</p> 328 329 <p>Example:</p> 330 331 <pre><select template:multiple-choice-field="base-system,value" name="..."><br /> ...<br /></select></pre> 332 333 <p>Example:</p> 334 335 <pre><select template:multiple-choice-field="-,question-type" name="..."><br /> ...<br /></select></pre> 336 337 <p>See below for an example combining this attribute with the <code>template:multiple-choice-value</code> attribute.</p> 338 339 <p>Syntax:</p> 340 341 <pre>element-name|<span style="font-weight: bold;">-</span>,attribute-name[,<span style="font-weight: bold;">new</span>|,<span style="font-weight: bold;">new</span>,<span style="font-weight: bold;">dynamic</span>|,,<span style="font-weight: bold;">dynamic</span>]</pre> 342 343 <p>Where the special value <code>-</code> 344 is given as the element name, the context element is chosen as the 345 element in the XML document being presented whose attribute is 346 involved. Where the optional parameter <code>new</code> is given, the attribute is assumed not to already exist on the element. Where the optional parameter <code>dynamic</code> is given, the source of the multiple-choice values is considered to be found dynamically rather than from another document.</p> 347 348 <p>Related attributes:</p> 349 350 <ul><li><code>template:multiple-choice-value</code></li><li><code>template:multiple-choice-list-field</code></li></ul> 351 352 <p>Implementing attributes:</p> 353 354 <ul><li><code>template:element</code></li><li><code>template:attribute</code></li></ul> 355 356 <h3><a name="multiple-choice-value"></a>template:multiple-choice-value</h3> 357 358 <p>This 359 attribute associates the template element on which it is used with an 360 element in the XML document being presented whose purpose is to hold 361 one of a list of selectable values (as described above).</p> 362 363 <p>Example:</p> 364 365 <pre><select template:multiple-choice-field="base-system,value" name="..."><br /> <option template:multiple-choice-value="base-system-enum,value,selected" value="..."/><br /></select></pre> 366 367 <p>This presents the following document fragment:</p> 368 369 <pre><base-system value="c"><br /> <base-system-enum value="a"/><br /> <base-system-enum value="b"/><br /> <base-system-enum value="c"/><br /></base-system></pre> 370 371 <p>The output from the combination of the above would be as follows:</p> 372 373 <pre><select name="path-to-base-system"><br /> <option value="a">a</option><br /> <option value="b">b</option><br /> <option value="c" selected="selected">c</option><br /></select></pre> 374 375 <h4>Values and Labels</h4> 376 377 <p>Labels different from the actual values employed can be specified using an extra parameter in the annotation:</p> 378 379 <pre><select template:multiple-choice-field="base-system,value" name="..."><br /> <option template:multiple-choice-value="base-system-enum,value,selected,text()" value="..."/><br /></select></pre> 380 381 <p>This 382 additional parameter is an XPath expression whose context is the 383 current value-bearing element. The above example selects the text from 384 inside each <code>base-system-enum</code> element in the modified document fragment presented below.</p> 385 386 <p>A modified document fragment providing the labels can be written as follows:</p> 387 388 <pre><base-system value="c"><br /> <base-system-enum value="a">A</base-system-enum><br /> <base-system-enum value="b">B</base-system-enum><br /> <base-system-enum value="c">C</base-system-enum><br /></base-system></pre> 389 390 <p>The output from the modified combination would be as follows:</p> 391 392 <pre><select name="path-to-base-system"><br /> <option value="a">A</option><br /> <option value="b">B</option><br /> <option value="c" selected="selected">C</option><br /></select></pre> 393 394 <p>Syntax:</p> 395 396 <pre>list-element-name,list-attribute-name,attribute-to-create-when-selected[,content-expression]</pre> 397 398 <p>Related attributes:</p> 399 400 <ul><li><code>template:multiple-choice-field</code></li><li><code>template:multiple-choice-list-value</code></li></ul> 401 402 <p>Implementing attributes:</p> 403 404 <ul><li><code>template:element</code></li><li><code>template:expr</code></li><li><code>template:expr-attr</code></li><li><code>template:value</code></li></ul> 405 406 <h3><a name="multiple-choice-list-field"></a>template:multiple-choice-list-field</h3> 407 408 <p>This attribute is similar to <code>template:multiple-choice-field</code> 409 except that it associates the template element on which it is used with 410 an element in the XML document being presented containing a list 411 of elements whose values have been selected. This list of selected 412 elements is expanded before presentation to include elements whose 413 values have not been selected. Consequently, the selected elements are 414 marked in a particular way to distinguish them from the non-selected 415 elements.</p> 416 417 <p>Example:</p> 418 419 <pre><select template:multiple-choice-list-field="question-types,question-type-enum,question-type" name="..." multiple="multiple"><br /> ...<br /></select></pre> 420 421 <p>See below for an example combining this attribute with the <code>template:multiple-choice-list-value</code> attribute.</p> 422 423 <p>Syntax:</p> 424 425 <pre>element-name|<span style="font-weight: bold;">-</span>,list-element-name,list-attribute-name[,<span style="font-weight: bold;">dynamic</span>]</pre> 426 427 <p>Here, <code>element-name</code> is the element in the document being presented which contains the selected value elements; if the special value <code>-</code> is given then the context element is the element containing the selected value elements. The <code>list-element-name</code> and <code>list-attribute-name</code> indicate the details of the elements providing the list of selectable values. Where the optional parameter <code>dynamic</code> is given, the source of the multiple-choice values is considered to be found dynamically rather than from another document.</p> 428 429 <p>Related attributes:</p> 430 431 <ul><li><code>template:multiple-choice-list-value</code></li><li><code>template:multiple-choice-list-element</code></li><li><code>template:multiple-choice-field</code></li></ul> 432 433 <p>Implementing attributes:</p> 434 435 <ul><li><code>template:element</code></li></ul> 436 437 <h3><a name="multiple-choice-list-value"></a>template:multiple-choice-list-value</h3> 438 439 <p>This attribute is similar to <code>template:multiple-choice-value</code> 440 in that it associates the template element on which it is used with an 441 element holding a value in a list of selectable values, with the 442 principal difference that potentially many such values may be selected 443 in this case.</p> 444 445 <p>Example:</p> 446 447 <pre><select template:multiple-choice-list-field="question-types,question-type-enum,question-type" multiple="multiple"><br /> <option template:multiple-choice-list-value="question-type-enum,question-type,selected" value="..."/><br /></select></pre> 448 449 <p>This presents the following document fragment:</p> 450 451 <pre><question-types><br /> <question-type-enum question-type="text"/><br /> <question-type-enum question-type="choice" value-is-set="true"/><br /> <question-type-enum question-type="special" value-is-set="true"/><br /></question-types></pre> 452 453 <p>The output from the combination of the above would be as follows:</p> 454 455 <pre><select name="path-to-question-types" multiple="multiple"><br /> <option value="text">text</option><br /> <option value="choice" selected="selected">choice</option><br /> <option value="special" selected="selected">special</option><br /></select></pre> 456 457 <h4>Values and Labels</h4> 458 459 <p>Labels different from the actual values employed can be specified using an extra parameter in the annotation:</p> 460 461 <pre><select template:multiple-choice-list-field="question-types,question-type-enum,question-type" multiple="multiple"><br /> <option template:multiple-choice-list-value="question-type-enum,question-type,selected,text()" value="..."/><br /></select></pre> 462 463 <p>This additional parameter is an XPath expression whose context is 464 the current value-bearing element. The above example selects the text 465 from inside each <code>base-system-enum</code> element in the modified document fragment presented below.</p> 466 467 <p>A modified document fragment providing the labels can be written as follows:</p> 468 469 <pre><question-types><br /> <question-type-enum question-type="text">Text</question-type-enum><br /> <question-type-enum question-type="choice" value-is-set="true">Choice</question-type-enum><br /> <question-type-enum question-type="special" value-is-set="true">Special</question-type-enum><br /></question-types></pre> 470 471 <p>The output from the modified combination would be as follows:</p> 472 473 <pre><select name="path-to-question-types" multiple="multiple"><br /> <option value="text">Text</option><br /> <option value="choice" selected="selected">Choice</option><br /> <option value="special" selected="selected">Special</option><br /></select></pre> 474 475 <p>Syntax:</p> 476 477 <pre>list-element-name,list-attribute-name,attribute-to-create-when-selected[,content-expression]</pre> 478 479 <p>Related attributes:</p> 480 481 <ul><li><code>template:multiple-choice-list-field</code></li><li><code>template:multiple-choice-value</code></li></ul> 482 483 <p>Implementing attributes:</p> 484 485 <ul><li><code>template:element</code></li><li><code>template:expr</code></li><li><code>template:expr-attr</code></li><li><code>template:value</code></li></ul> 486 487 <h3><a name="multiple-choice-list-element"></a>template:multiple-choice-list-element</h3> 488 489 <p>This attribute works in much the same way as <code>template:multiple-choice-list-field</code> except that it does not add a <code>name</code> attribute to the template element on which it is used. The purpose of this attribute, along with <code>template:attribute-list-button</code>, is to provide an alternative approach to presenting lists of selectable values.</p> 490 491 <p>Example:</p> 492 493 <pre><p template:multiple-choice-list-element="question,question-types,question-type"><br /> ...<br /></p></pre> 494 495 <p>See below for an example combining this attribute with the <code>template:attribute-list-button</code> attribute.</p> 496 497 <p>Syntax:</p> 498 499 <pre>element-name|<span style="font-weight: bold;">-</span>,list-element-name,list-attribute-name</pre> 500 501 <p>Here, <code>element-name</code> is the element in the document being presented which contains the selected value elements; if the special value <code>-</code> is given then the context element is the element containing the selected value elements. The <code>list-element-name</code> and <code>list-attribute-name</code> indicate the details of the elements providing the list of selectable values.</p> 502 503 <p>Related attributes:</p> 504 505 <ul><li><code>template:multiple-choice-list-field</code></li><li><code>template:attribute-list-button</code></li></ul> 506 507 <p>Implementing attributes:</p> 508 509 <ul><li><code>template:element</code></li></ul> 510 511 <h3><a name="attribute-list-button"></a>template:attribute-list-button</h3> 512 513 <p>This attribute works in much the same way as <code>template:attribute-button</code> 514 does, but instead presents a button or related user interface control 515 whose state reflects the presence of an attribute on an element in a 516 collection of elements.</p> 517 518 <p>Example:</p> 519 520 <pre><p template:multiple-choice-list-element="question,question-types,question-type"><br /> <input template:attribute-list-button="question-type,checked" name="..." value="..." type="checkbox"/><br /></p></pre> 521 522 <p>Given an XML document like this...</p> 523 524 <pre><question><br /> <question-types question-type="text" value-is-set="true"/><br /> <question-types question-type="choice"/><br /></question></pre> 525 526 <p>...the following would be produced as output:</p> 527 528 <pre><p><br /> <input name="path-to-question-type" value="text" type="checkbox" checked="checked"/><br /></p><br /><p><br /> <input name="path-to-question-type" value="choice" type="checkbox"/><br /></p></pre> 529 530 <p>Syntax:</p> 531 532 <pre>attribute-name,attribute-to-create-when-set</pre> 533 534 <p>Related attributes:</p> 535 536 <ul><li><code>template:multiple-choice-list-element</code></li><li><code>template:attribute-button</code></li></ul> 537 538 <p>Implementing attributes:</p> 539 540 <ul><li><code>template:attribute</code></li><li><code>template:expr</code></li><li><code>template:expr-attr</code></li></ul> 541 542 <h2>Internal Annotations</h2> 543 544 <p>The special annotations <code>template:expr</code> and <code>template:expr-attr</code> 545 are used respectively to test an XPath expression in the current 546 context and to provide the name of an attribute which is to be created 547 in the final output, should the expression evaluate to a true value.</p> 548 549 <h2><a name="housekeeping-annotations"></a>Housekeeping Annotations</h2> 550 551 <p>In order to support explicit, additional namespaces in output document processing, the special <code>expr-prefix</code> 552 attribute can be used to ensure the presence of a namespace declaration 553 in the generated stylesheet files. Consider the usage of various 554 stylesheet extension functions:</p> 555 556 <pre><body><br /> <p><br /> <span template:value="sum(str:split('1 2 3 4 5'))">result</span><br /> </p><br /></body></pre> 557 558 <p>For the stylesheet which produces the output, the <code>str</code> 559 namespace will need to be declared somewhere. To do this, we must not 560 only declare the namespace in the template document, but we must also 561 provide a hint to the stylesheet processor that the namespace is 562 important (even though it is only mentioned in the text of an 563 attribute, which might persuade some XML processing toolkits to abandon 564 the namespace declaration).</p> 565 566 <pre><body xmlns:str="http://exslt.org/strings" str:expr-prefix="str http://exslt.org/strings"><br /> <p><br /> <span template:value="sum(str:split('1 2 3 4 5'))">result</span><br /> </p><br /></body></pre> 567 568 <p>What the special <code>expr-prefix</code> 569 attribute does is to provide that hint to the stylesheet processor, 570 although XSLTools also uses the attribute for other internal purposes. 571 Consequently, the resulting output stylesheet is able to find the <code>str:split</code> extension function and to evaluate the expected result.</p> 572 573 <h3>Fixing Annotations</h3> 574 575 <p>One important application of the <code>expr-prefix</code> 576 attribute is the restoration of damaged attributes after the editing of 577 a template document using a less than careful HTML editor. Consider the 578 above document fragment after a small edit in Nvu:</p> 579 580 <pre><body expr-prefix="str http://exslt.org/strings" str="http://exslt.org/strings"><br /> <p><br /> <span value="sum(str:split('1 2 3 4 5'))">result!</span><br /> </p><br /></body></pre> 581 582 <p>Nvu has obviously decided to remove the <code>str</code> and <code>template</code> namespace prefixes. To revert this damage, a tool is provided with XSLTools called <code>xslform_fix.py</code> (found in the <code>scripts</code> directory in the source distribution), and this tool will attempt to re-add namespace declarations for <code>template</code> automatically (since the <code>template</code> namespace is obviously the basis of XSLForms) along with any namespaces declared using <code>expr-prefix</code> attributes. The tool is invoked as follows:</p> 583 584 <pre>xslform_fix.py template.xhtml template_fixed.xhtml</pre> 585 586 <p>Since 587 namespace declarations may be moved to the root element of the new 588 template document, it is possible that some problems may result 589 with documents using namespaces in advanced ways, but the tool 590 should provide a reasonable solution for most documents.</p></body></html>