Literal Directive

literaldirective

Experience has shown that one of the most common typesetting requirement is that of being able to typeset small program fragments in the middle of the documenting free text. Typically there is a frequent need to refer to program identifiers, and it assists the reader to have such identifiers typeset in the same manner as the program text in the macro definition. FunnelWeb V1 defined a TEX macro for this (called p) that simply typeset its argument in tt font. This proved so useful, that the facility has been made typesetter-independent in FunnelWeb V3.

To specify that some text be typeset in tt font, enclose the text in curly brace special sequences as follows.

literal = "@{" ordinary_text "@}"

As in macro names, section names, and macro bodies, the text contained within the literal construct is protected by FunnelWeb from any non-literal interpretation by the typesetter and the user is free to enclose ıany text covered by the definition ordinary_text. FunnelWeb guarantees that, no matter what the text is, it will be typeset in tt font exactly as it appears. However, the text will be filled and justified into a paragraph as usual.

Here is an example of the use of the construct:

@C The @{WOMBAT@} (Waste Of Money, Brains, And Time) function
calls the @{kangaroo@} input function which has been
known to cause keybounce.
This keybounce can be dampened using the @{wet_sloth@} subsystem.