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
50
51
52
53
54
55
|
[comment {-*- tcl -*- --- !doctools ---}]
[manpage_begin doctools::idx::export::[vset PACKAGE] n [vset VERSION]]
[copyright {2009-2019 Andreas Kupries <andreas_kupries@users.sourceforge.net>}]
[moddesc {Documentation tools}]
[titledesc "[vset NAME] export plugin"]
[category {Text formatter plugin}]
[require Tcl 8.4]
[require doctools::idx::export::[vset PACKAGE] [opt [vset VERSION]]]
[include format/[vset REQUIRE].inc]
[keywords doctools index serialization export [vset NAME]]
[description]
This package implements the doctools keyword index export plugin for
the generation of [vset NAME] markup.
[para]
This is an internal package of doctools, for use by the higher level
management packages handling keyword indices, especially [package \
doctools::idx::export], the export manager.
[para]
Using it from a regular interpreter is possible, however only with
contortions, and is not recommended.
The proper way to use this functionality is through the package
[package doctools::idx::export] and the export manager objects it
provides.
[section API]
The API provided by this package satisfies the specification of the
docidx export plugin API version 2.
[list_begin definitions]
[call [cmd export] [arg serial] [arg configuration]]
This command takes the canonical serialization of a keyword index, as
specified in section [sectref {Keyword index serialization format}],
and contained in [arg serial], the [arg configuration], a dictionary,
and generates [vset NAME] markup encoding the index.
The created string is then returned as the result of the command.
[list_end]
[include config/[vset CONFIG].inc]
[include ../serialization.inc]
[vset CATEGORY doctools]
[include ../../../common-text/feedback.inc]
[manpage_end]
|
