1doctoc_lang_cmdref(n)         Documentation tools        doctoc_lang_cmdref(n)
2
3
4
5______________________________________________________________________________
6

NAME

8       doctoc_lang_cmdref - doctoc language command reference
9

SYNOPSIS

11       comment plaintext
12
13       division_end
14
15       division_start text ?symfile?
16
17       include filename
18
19       item file text desc
20
21       lb
22
23       rb
24
25       toc_begin text title
26
27       toc_end
28
29       vset varname value
30
31       vset varname
32
33______________________________________________________________________________
34

DESCRIPTION

36       This document specifies both names and syntax of all the commands which
37       together are the doctoc 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 doctoc language introduction
41       first.
42

COMMANDS

44       comment plaintext
45              Toc markup. The argument text is marked up as a comment standing
46              outside of the actual text of the document. Main use is in free-
47              form text.
48
49       division_end
50              Toc structure. This command closes the division  opened  by  the
51              last  division_begin  command  coming  before  it,  and  not yet
52              closed.
53
54       division_start text ?symfile?
55              Toc structure. This command opens a division  in  the  table  of
56              contents. Its counterpart is division_end. Together they allow a
57              user to give a table of contents additional structure.
58
59              The title of the new division is provided by the argument text.
60
61              If the symbolic filename symfile is  present  then  the  section
62              title  should link to the referenced document, if links are sup‐
63              ported by the output format.
64
65       include filename
66              Templating. The contents of the named file  are  interpreted  as
67              text  written in the doctoc markup and processed in the place of
68              the include command. The markup in the file has to be  self-con‐
69              tained.  It  is  not  possible for a markup command to cross the
70              file boundaries.
71
72       item file text desc
73              Toc structure. This command adds an individual  element  to  the
74              table  of  contents. Each such element refers to a document. The
75              document is specified through the symbolic name file.  The  text
76              argument  is  used to label the reference, whereas the desc pro‐
77              vides a short descriptive text of that document.
78
79              The symbolic names are used to preserve  the  convertibility  of
80              this  format  to  any output format. The actual name of the file
81              will be inserted by the chosen formatting engine when converting
82              the  input.  This  will  be  based on a mapping from symbolic to
83              actual names given to the engine.
84
85       lb     Text. The command is replaced with a left bracket. Use in  free-
86              form text. Required to avoid interpretation of a left bracket as
87              the start of a markup command. Its usage is  restricted  to  the
88              arguments of other markup commands.
89
90       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
95       toc_begin text title
96              Document structure. The command to start a  table  of  contents.
97              The  arguments  are a label for the whole group of documents the
98              index refers to (text) and the overall title text for the  index
99              (title), without markup.
100
101              The  label  often  is the name of the package (or extension) the
102              documents belong to.
103
104       toc_end
105              Document structure. Command to end a table of contents. Anything
106              in the document coming after this command is in error.
107
108       vset varname value
109              Templating.  In  this  form  the command sets the named document
110              variable to the specified value. It does  not  generate  output.
111              I.e. the command is replaced by the empty string.
112
113       vset varname
114              Templating. In this form the command is replaced by the value of
115              the named document variable
116

BUGS, IDEAS, FEEDBACK

118       This document, and the package it describes, will  undoubtedly  contain
119       bugs  and  other problems.  Please report such in the category doctools
120       of the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist].   Please
121       also  report any ideas for enhancements you may have for either package
122       and/or documentation.
123
124       When proposing code changes, please provide unified diffs, i.e the out‐
125       put of diff -u.
126
127       Note  further  that  attachments  are  strongly  preferred over inlined
128       patches. Attachments can be made by going  to  the  Edit  form  of  the
129       ticket  immediately  after  its  creation, and then using the left-most
130       button in the secondary navigation bar.
131

SEE ALSO

133       doctoc_intro, doctoc_lang_faq, doctoc_lang_intro, doctoc_lang_syntax
134

KEYWORDS

136       doctoc commands,  doctoc  language,  doctoc  markup,  markup,  semantic
137       markup
138

CATEGORY

140       Documentation tools
141
143       Copyright (c) 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>
144
145
146
147
148tcllib                                1.0                doctoc_lang_cmdref(n)
Impressum