► |  | Scribble: PLT Documentation Tool

1 | How to Scribble Documentation
2 | Scribble Layers
3 | @-Reader
4 | Structures And Processing
5 | Renderer
6 | Decoding Text
7 | Document Language
8 | Document Reader
9 | Basic Document Forms
10 | Scheme
11 | Manual Forms
12 | Evaluation and Examples
13 | BNF Grammars
14 | Cross-Reference Utilities
15 | Text Preprocessor
| Index

▼ | 11 | Manual Forms

11.1 | Typesetting Code
11.2 | Documenting Modules
11.3 | Documenting Forms, Functions, Structure Types, and Values
11.4 | Documenting Classes and Interfaces
11.5 | Documenting Signatures
11.6 | Various String Forms
11.7 | Links
11.8 | Indexing
11.9 | Images
11.10 | Bibliography
11.11 | Miscellaneous
11.12 | Index-Entry Descriptions

On this page:

emph
defterm
onscreen
menuitem
filepath
exec
envvar
Flag
DFlag
PFlag
DPFlag
math

Version: 4.1.4
top← prev up next →

#### 11.6`` Various String Forms

(emph pre-content ...) → element?
pre-content : any/c

Typesets the decoded pre-content with emphasis (e.g., in italic).

(defterm pre-content ...) → element?
pre-content : any/c

Typesets the decoded pre-content as a defined term (e.g., in italic). Consider using deftech instead, though, so that uses of tech can hyper-link to the definition.

(onscreen pre-content ...) → element?
pre-content : any/c

Typesets the decoded pre-content as a string that appears in a GUI, such as the name of a button.

(menuitem menu-name item-name) → element?
menu-name : string?
item-name : string?

Typesets the given combination of a GUI’s menu and item name.

(filepath pre-content ...) → element?
pre-content : any/c

Typesets the decoded pre-content as a file name (e.g., in typewriter font and in in quotes).

(exec pre-content ...) → element?
pre-content : any/c

Typesets the decoded pre-content as a command line (e.g., in typewriter font).

(envvar pre-content ...) → element?
pre-content : any/c

Typesets the given decoded pre-content as an environment variable (e.g., in typewriter font).

(Flag pre-content ...) → element?
pre-content : any/c

Typesets the given decoded pre-content as a flag (e.g., in typewriter font with a leading -).

(DFlag pre-content ...) → element?
pre-content : any/c

Typesets the given decoded pre-content a long flag (e.g., in typewriter font with two leading -s).

(PFlag pre-content ...) → element?
pre-content : any/c

Typesets the given decoded pre-content as a + flag (e.g., in typewriter font with a leading +).

(DPFlag pre-content ...) → element?
pre-content : any/c

Typesets the given decoded pre-content a long + flag (e.g., in typewriter font with two leading +s).

(math pre-content ...) → element?
pre-content : any/c

The decoded pre-content is further transformed:

- Any immediate 'rsquo is converted to 'prime.

- Parentheses and sequences of decimal digits in immediate strings are left as-is, but any other immediate string is italicized.

Extensions to math are likely, such as recognizing _ and ^ for subscripts and superscripts.

top← prev up next →