Next: Caveats, Previous: Coding Style, Up: Documentation Tuning [Contents][Index]
All text coming from either Common Lisp or one of declt’s
initialization arguments (:introduction and :conclusion
excepted) is properly escaped for the Texinfo format, so you don’t need
to worry about that.
In non-verbatim contexts, Declt attempts to pretty-print symbols the names of which would otherwise be problematic. In particular, the empty symbol (||) is denoted as the math empty set, and blank characters (spaces, tabs, and newlines), are replaced by more explicit Unicode symbols. Note that this means that even for Info output, a Unicode reader is required.
Declt also attempts to do some pretty printing on things like docstrings, system long description etc.. Currently, there’s a simple heuristic that tries to detect short lines that should probably stand on their own (with an explicit line break). For every piece of text, Declt first calculates the longest line and bases its line breaking decision on that. In the future, it will be possible to bypass this calculation by specifying an intended line width. Other pretty printers will likely be made available as well.