4.12.31 p:variablesConfig

This is not a publisher instruction, but rather configuration information for the variable resolution.

With "variables" we mean the variables that can be embedded in Daisy-HTML parts and document names. See [todo] for more information on this topic.

The p:variablesConfig element can only occur as first child of p:publisherRequest.

4.12.31.1 Syntax

The syntax is as follows:

<p:variablesConfig>

  <p:variableSources>
    <p:variableDocument id="..." branch="..." language="..."/>
    [... more p:variableDocument elements ...]
  </p:variableSources>

  <p:variablesInAttributes [allAttributes="true|false"] >
     <p:element name="img" attributes="daisy-caption,alt"/>
     [... more p:element elements ...]
  </p:variablesInAttributes>

</p:variablesConfig>

All elements are optional.

The p:variableDocument elements point to documents containing the variable-to-value mappings. These are documents containing a part VariablesData. The XML format that should be in there is documented in the variables documents, it is not repeated here to avoid duplication.

The p:variablesInAttributes element configures whether variables should be resolved in attributes. If this element is not present, no variable resolving in attributes will happen. For the case where speed is a concern, you can configure which attributes on which elements should be considered.

4.12.31.2 Effect of p:variablesConfig

When a p:variablesConfig is specified, variable resolution will be enabled for a number of cases:

• most prominently, for p:preparedDocuments, variable resolution in Daisy-HTML parts.
• p:navigationTree: will perform variable resolution in all navigation tree node labels.
• p:performQuery: will perform variable resolution in result set columns corresponding to the 'name' identifier (at the time of this writing, this will only happen for exact selects of 'name', and not when name is used as part of more complex expressions)
• p:annotatedDocument and p:annotatedVersion: variable resolution in the document names