Project | WXT | Basics | Download | Documentation | Samples

PI: modulemap

The purpose of a modulemap is to produce a complete or partial modulemap (sitemap).

<?_wxt modulemap?>

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 books) are ignored.
root (optional) The id of the module that defines the subtree we will make a map for.
books (optional) A commaseparated list of book ids that we want to include.
select (optional) Possible values are _siblings and _children.
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.
cols (optional) The number of columns we want. cols=0 generates a horizontal list. Default value is 1.
divider (optional) String that separates the entries. Only effective when cols=0. Default is |.
fragment (optional) The id of a defined fragment. This fragment will replace the modules name. A possible value is _summary.
summary (optional) Possible vaules are yes and no. If yes, the summary of the referenced module will expand on mouseover. Default is no, which expands the modules name.

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: wxtmodulemapn, where n is the number of columns selected, se distributed std styles.

Examples:

<div>
<?_wxt modulemap cols="1"?>
</div>