1[comment {-*- tcl -*- doctools manpage}]
2[manpage_begin docidx_lang_cmdref n 1.0]
3[copyright {2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>}]
4[moddesc   {Documentation tools}]
5[titledesc {docidx language command reference}]
6[category  {Documentation tools}]
7[description]
8[para]
9
10This document specifies both names and syntax of all the commands
11which together are the docidx markup language, version 1.
12
13As this document is intended to be a reference the commands are listed
14in alphabetical order, and the descriptions are relatively short.
15
16A beginner should read the much more informally written
17[term {docidx language introduction}] first.
18
19
20[section Commands]
21[list_begin definitions]
22
23[call [cmd comment] [arg plaintext]]
24
25Index markup. The argument text is marked up as a comment standing
26outside of the actual text of the document. Main use is in free-form
27text.
28
29[call [cmd include] [arg filename]]
30
31Templating. The contents of the named file are interpreted as text
32written in the docidx markup and processed in the place of the
33include command. The markup in the file has to be self-contained. It
34is not possible for a markup command to cross the file boundaries.
35
36[call [cmd index_begin] [arg text] [arg title]]
37
38Document structure. The command to start an index. The arguments are a
39label for the whole group of documents the index refers to
40([arg text]) and the overall title text for the index ([arg title]),
41without markup.
42
43[para]
44
45The label often is the name of the package (or extension) the
46documents belong to.
47
48[call [cmd index_end]]
49
50Document structure. Command to end an index. Anything in the document
51coming after this command is in error.
52
53[call [cmd key] [arg text]]
54
55Index structure. This command adds the keyword [arg text] to the
56index.
57
58[call [cmd lb]]
59
60Text. The command is replaced with a left bracket. Use in free-form
61text. Required to avoid interpretation of a left bracket as the start
62of a markup command. Its usage is restricted to the arguments of other
63markup commands.
64
65[call [cmd manpage] [arg file] [arg text]]
66
67Index structure. This command adds an element to the index which
68refers to a document. The document is specified through the symbolic
69name [arg file]. The [arg text] argument is used to label the
70reference.
71
72[para]
73
74Symbolic names are used to preserve the convertibility of this format
75to any output format. The actual name of the file will be inserted by
76the chosen formatting engine when converting the input. This will be
77based on a mapping from symbolic to actual names given to the engine.
78
79[call [cmd rb]]
80
81Text. The command is replaced with a right bracket. Use in free-form
82text. Required to avoid interpretation of a right bracket as the end
83of a markup command. Its usage is restricted to the arguments of other
84commands.
85
86[call [cmd url] [arg url] [arg label]]
87
88Index structure. This is the second command to add an element to the
89index. To refer to a document it is not using a symbolic name however,
90but a (possibly format-specific) url describing the exact location of
91the document indexed here.
92
93[call [cmd vset] [arg varname] [arg value] ]
94
95Templating. In this form the command sets the named document variable
96to the specified [arg value]. It does not generate output. I.e. the
97command is replaced by the empty string.
98
99[call [cmd vset] [arg varname]]
100
101Templating. In this form the command is replaced by the value of the
102named document variable
103
104[list_end]
105
106[section {BUGS, IDEAS, FEEDBACK}]
107
108This document, and the package it describes, will undoubtedly contain
109bugs and other problems.
110
111Please report such in the category [emph doctools] of the
112[uri {http://sourceforge.net/tracker/?group_id=12883} {Tcllib SF Trackers}].
113
114Please also report any ideas for enhancements you may have for either
115package and/or documentation.
116
117[see_also docidx_intro]
118[see_also docidx_lang_intro]
119[see_also docidx_lang_syntax]
120[see_also docidx_lang_faq]
121[keywords markup {semantic markup}]
122[keywords {docidx markup} {docidx language} {docidx commands}]
123[manpage_end]
124