doctools(9)
[Home]
[Commands]
[Variables]
[Macro-Dev]
[Glossary]
SYNOPSIS
tman, man - Tcl Doctools Markup File.
FILES
hkdtools.emf - Tcl Doctools file hook definition
dtools.eaf - Tcl Doctools abbreviation file
dtools.etf - Tcl Doctools template file
EXTENSIONS
MAGIC STRINGS
-[*!]- doctools
MicroEmacs recognizes the magic string on the first line of the file used to indicate the file type. The files may be extension less or have an extension like .man and are still recognized.
DESCRIPTION
The Tcl Doctools file hook provides a editing environment for Tcl doctools files. The file hook provides highlighting, folding of section, document outline using item-list and abbreviations.
File recognition is performed using the standard file extension .tman.
Abbreviations
The installation comes with a default abbreviation file for Typst code editing which can be used by writing short abbreviations like "se" for a section header, "ex" for an example block, "dl" for a definition list, or "li" for an item list - and then pressing the key-binding for the
expand-abbrev-handle(3) command. The list of abbreviations can be used interactively in the GUI version of MicroEmacs using the
abbrev-list(3) command.
Folding and Information Hiding
Generic folding is enabled within the Tcl doctools files. The folds occur about the section lines. The following commands are supported to show and hide the function bodies.
collapse-all(3) (un)folds all regions in the file,
collapse-current(3) (un)folds the current region.
List Items
Item listing is available and the section headers of the file are displayed in the item-list.
Short Cuts
The short cut keys used within the buffer are:-
C-c C-c - Comment out the current line.
C-c C-d - Uncomment the current line.
f2 - (un)fold the current region
f3 - (un)fold all regions
f6 - list items
esc f6 - close list items
SEE ALSO
(c) Copyright JASSPA 2025
Last Modified: 2025/11/01
Generated On: 2025/12/01