4.6 Literal Directive

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

Tutorial

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

Developer

identifiers typeset in the same manner as the program text in the macro

definition.

Reference

To specify that some text be typeset in tt font, enclose the text in curly

1 Introduction

brace special sequences as follows.

2 Interface

3 Scanner

literal = "@{" ordinary_text "@}"

4 Parser

As in macro names, section names, and macro bodies, the text contained

5 Analyser

within the literal construct is protected by FunnelWeb from any

6 Tangle

non literal interpretation by the typesetter and the user is free to enclose

7 Weave

any

  text covered by the definition ordinary_text. FunnelWeb guarantees

8 Shell

that, no matter what the text is, it will be typeset in tt font exactly as it

9 Commands

appears. However, the text will be filled and justified into a paragraph as

10 Glossary

usual.

11 References

Here is an example of the use of the construct:

SEARCH

@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.

http://www.ross.net/funnelweb/reference/parser_type_literal.html [3/3/2000 10:46:38 PM]