ParameterAnnotations

Norman Walsh edited this page Oct 1, 2015 · 1 revision
Clone this wiki locally

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:

...datatype...

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:

list

dl

ul

ol

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''':

open

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

closed

List values description

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

paper.type

list

open

A4210x297 mm

USletter8.5x11 in

For longer descriptions annotation feature can be used:

A4

...

...