PI: collectsummary
The purpose of a collectsummary is to produce a XML-fragment that collects summaries from other modules. If a module does not have a summary-element, the description attribute is used. (which in turn defaults to the modules name)
<?_wxt collectsummary idlist="" books="" select="" xlink=""?>
The parameters are:
| idlist (optional) | A commaseparated list of module ids that we want to include. If this is set, the others (select, root and book) are ignored. |
| root (optional) | The id of the module that defines the subtree we will collect from. |
| books (optional) | A commaseparated list of book ids that we want to include. |
| select (optional) | Possible values are _siblings and _children. Relative to the module that contains the collect PI. |
| scriptpath (optional) | The scriptpath is an xpath that is used on the script to select modules. Sample: //module[@template='P'] get all modules with template P. |
| xlink (optional) | If this is set to yes, a link to the actual module will be set up. Default is no. |
The selected set of modules will be assembled according to the following rule:
- if idlist is set, the collection is as defined in the idlist.
- if idlist is not set, the collection is made up as the intersection of the modules spesified by root, book, scriptpath and select.
- if neither idlist, root, book, scriptpath or select is set, all modules are selected, except those with books attribute: _never.
Styleclass(es) describing this PI is: wxtcollectsummary, wxtcollectsummaryheading, wxtcollectsummarycontent. See distributed std styles.
Examples:
<div> <?_wxt collectsummary idlist="fid"?> </div>
and
<div> <?_wxt collectsummary idlist="fid" xlink="yes"?> </div>