summaryrefslogtreecommitdiffstats
path: root/tcllib/modules/pt/include/export/config/param.inc
blob: 2c3d9118635de832501daccc5c027c28aa1b72c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
[section Configuration]

The PARAM export plugin recognizes the following configuration
variables and changes its behaviour as they specify.

[list_begin arguments]

[arg_def string template]

If this configuration variable is set it is assumed to contain a
string into which to put the generated text and other configuration
data. The various locations are expected to be specified with the
following placeholders:

[list_begin definitions]

[def [const @user@]]
To be replaced with the value of the configuration variable [option user].

[def [const @format@]]
To be replaced with the the constant [const PARAM].

[def [const @file@]]
To be replaced with the value of the configuration variable [option file].

[def [const @name@]]
To be replaced with the value of the configuration variable [option name].

[def [const @code@]]
To be replaced with the generated text.

[list_end]

[para]

If this configuration variable is not set, or empty, then the plugin
falls back to a standard template, which is defined as "[const @code@]".

[list_end]

[emph Note] that this plugin may ignore the standard configuration
variables [var user], [var format], [var file], and their values,
depending on the chosen template.

[para]

The content of the standard configuration variable [var name], if set,
is used as name of the grammar in the output. Otherwise the plugin
falls back to the default name [const a_pe_grammar].