Skip to content

ParameterAnnotations

Shlomi Fish edited this page Sep 4, 2020 · 3 revisions

Parameter annotations

DocBookXslStylesheets define a huge set of parameters which can be used to tailor output of transformation.

In order to support development of user-friendly front-ends for setting parameters parameter definitions are augmented by additional metadata. You can find definition of each parameter in a separate file in params subdirectory of DocBookXslStyleheets.

Additional metadata are stored inside refmiscinfo element.

Datatypes

The following syntax is used for specifying datatype of parameter:

<refmiscinfo class="other" otherclass="datatype">...datatype...</refmiscinfo>

The following datatypes are used:

  • attribute set
  • boolean
  • string
  • list
  • filename
  • uri
  • color
  • length
  • number
  • integer
  • rtf
  • table
  • float

Lists

Datatype list denotes that there is a list of enumarations for parameter. Possible values can be listed by using the following syntax:

<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>

<refmiscinfo class="other" otherclass="value">dl</refmiscinfo>

<refmiscinfo class="other" otherclass="value">ul</refmiscinfo>

<refmiscinfo class="other" otherclass="value">ol</refmiscinfo>

This example defines three possible values dl, ul and ol for the parameter.

If not all possible values are listed in metadata, list can be marked as open:

<refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>

By default list of values is considered ''closed'', which can be specified also explicitly:

<refmiscinfo class="other" otherclass="list-type">closed</refmiscinfo>

List values description

Description of each value in list can be specified by alt element:

<refentrytitle>paper.type</refentrytitle>

<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>

<refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>

<refmiscinfo class="other" otherclass="value">A4<alt>210x297 mm</alt></refmiscinfo>

<refmiscinfo class="other" otherclass="value">USletter<alt>8.5x11 in</alt></refmiscinfo>

For longer descriptions annotation feature can be used:

<refmiscinfo class="other" otherclass="value" annotations="paper.type.a4">A4</refmiscinfo>

...

<annotation xml:id="paper.type.a4">
<para>...</para>
</annotation>
Clone this wiki locally