Tutorial Developer Reference 1 Introduction 2 Interface 3 Scanner 4 Parser 5 Analyser 6 Tangle 7 Weave 8 Shell 9 Commands 10 Glossary 11 References SEARCH

4.6 Literal Directive

Experience has shown that one of the most common typesetting requirements 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.

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.

Webmaster Copyright © Ross N. Williams 1992,1999. All rights reserved.