1docidx_lang_cmdref(n) Documentation tools docidx_lang_cmdref(n)
2______________________________________________________________________________
6
8 docidx_lang_cmdref - docidx language command reference
9
11 comment plaintext
12 include filename
14 index_begin text title
16 index_end
18 key text
20 lb
22 manpage file text
24 rb
26 url url label
28 vset varname value
30 vset varname
32______________________________________________________________________________
34
36 This document specifies both names and syntax of all the commands which
37 together are the docidx markup language, version 1. As this document
38 is intended to be a reference the commands are listed in alphabetical
39 order, and the descriptions are relatively short. A beginner should
40 read the much more informally written docidx language introduction
41 first.
42
44 comment plaintext
45 Index markup. The argument text is marked up as a comment stand‐
46 ing outside of the actual text of the document. Main use is in
47 free-form text.
48 include filename
50 Templating. The contents of the named file are interpreted as
51 text written in the docidx markup and processed in the place of
52 the include command. The markup in the file has to be self-con‐
53 tained. It is not possible for a markup command to cross the
54 file boundaries.
55 index_begin text title
57 Document structure. The command to start an index. The arguments
58 are a label for the whole group of documents the index refers to
59 (text) and the overall title text for the index (title), without
60 markup.
61 The label often is the name of the package (or extension) the
63 documents belong to.
64 index_end
66 Document structure. Command to end an index. Anything in the
67 document coming after this command is in error.
68 key text
70 Index structure. This command adds the keyword text to the in‐
71 dex.
72 lb Text. The command is replaced with a left bracket. Use in free-
74 form text. Required to avoid interpretation of a left bracket as
75 the start of a markup command. Its usage is restricted to the
76 arguments of other markup commands.
77 manpage file text
79 Index structure. This command adds an element to the index which
80 refers to a document. The document is specified through the sym‐
81 bolic name file. The text argument is used to label the refer‐
82 ence.
83 Symbolic names are used to preserve the convertibility of this
85 format to any output format. The actual name of the file will be
86 inserted by the chosen formatting engine when converting the in‐
87 put. This will be based on a mapping from symbolic to actual
88 names given to the engine.
89 rb Text. The command is replaced with a right bracket. Use in free-
91 form text. Required to avoid interpretation of a right bracket
92 as the end of a markup command. Its usage is restricted to the
93 arguments of other commands.
94 url url label
96 Index structure. This is the second command to add an element to
97 the index. To refer to a document it is not using a symbolic
98 name however, but a (possibly format-specific) url describing
99 the exact location of the document indexed here.
100 vset varname value
102 Templating. In this form the command sets the named document
103 variable to the specified value. It does not generate output.
104 I.e. the command is replaced by the empty string.
105 vset varname
107 Templating. In this form the command is replaced by the value of
108 the named document variable
109
111 This document, and the package it describes, will undoubtedly contain
112 bugs and other problems. Please report such in the category doctools
113 of the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. Please
114 also report any ideas for enhancements you may have for either package
115 and/or documentation.
116 When proposing code changes, please provide unified diffs, i.e the out‐
118 put of diff -u.
119 Note further that attachments are strongly preferred over inlined
121 patches. Attachments can be made by going to the Edit form of the
122 ticket immediately after its creation, and then using the left-most
123 button in the secondary navigation bar.
124
126 docidx_intro, docidx_lang_faq, docidx_lang_intro, docidx_lang_syntax
127
129 docidx commands, docidx language, docidx markup, markup, semantic
130 markup
131
133 Documentation tools
134
136 Copyright (c) 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>
137tcllib 1.0 docidx_lang_cmdref(n)