doctoc_lang_cmdref(3tcl) | Documentation tools | doctoc_lang_cmdref(3tcl) |
doctoc_lang_cmdref - doctoc language command reference
comment plaintext
division_end
division_start text ?symfile?
include filename
item file text desc
lb
rb
toc_begin text title
toc_end
vset varname value
vset varname
This document specifies both names and syntax of all the commands which together are the doctoc markup language, version 1. As this document is intended to be a reference the commands are listed in alphabetical order, and the descriptions are relatively short. A beginner should read the much more informally written doctoc language introduction first.
The title of the new division is provided by the argument text.
If the symbolic filename symfile is present then the section title should link to the referenced document, if links are supported by the output format.
The symbolic names are used to preserve the convertibility of this format to any output format. The actual name of the file will be inserted by the chosen formatting engine when converting the input. This will be based on a mapping from symbolic to actual names given to the engine.
The label often is the name of the package (or extension) the documents belong to.
This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category doctools of the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. Please also report any ideas for enhancements you may have for either package and/or documentation.
When proposing code changes, please provide unified diffs, i.e the output of diff -u.
Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.
doctoc_intro, doctoc_lang_faq, doctoc_lang_intro, doctoc_lang_syntax
doctoc commands, doctoc language, doctoc markup, markup, semantic markup
Documentation tools
Copyright (c) 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>
1.0 | tcllib |