► |  | Scribble: PLT Documentation Tool

1 | Getting Started
2 | @ Syntax
3 | High-Level Scribble API
4 | Scribbling Documentation
5 | Literate Programming
6 | Text Preprocessing
7 | Low-Level Scribble API
| Index

► | 4 | Scribbling Documentation

4.1 | Getting Started with Documentation
4.2 | Manual Forms
4.3 | Scheme
4.4 | Evaluation and Examples
4.5 | In-Source Documentation
4.6 | BNF Grammars
4.7 | Compatibility Libraries

▼ | 4.2 | Manual Forms

4.2.1 | Typesetting Code
4.2.2 | Documenting Modules
4.2.3 | Documenting Forms, Functions, Structure Types, and Values
4.2.4 | Documenting Classes and Interfaces
4.2.5 | Documenting Signatures
4.2.6 | Various String Forms
4.2.7 | Links
4.2.8 | Indexing
4.2.9 | Images
4.2.10 | Bibliography
4.2.11 | Miscellaneous
4.2.12 | Index-Entry Descriptions

On this page:

t
PLane T
hash-lang
void-const
undefined-const
commandline
centerline
math

top← prev up next →

##### 4.2.11`` Miscellaneous

(t pre-content ...) → paragraph?
pre-content : pre-content?

Wraps the decoded pre-content as a paragraph.

PLaneT : element?

"PLaneT" (to help make sure you get the letters in the right case).

(hash-lang) → element?

Returns an element for #lang that is hyperlinked to an explanation.

void-const : element?

Returns an element for #<void>.

undefined-const : element?

Returns an element for #<undefined>.

(commandline pre-content ...) → paragraph?
pre-content : pre-content?

Produces an inset command-line example (e.g., in typewriter font).

(centerline pre-flow ...) → nested-flow?
pre-flow : pre-flow?

An alias for centered for backward compatibility.

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

- When _ appears before a non-empty sequence of numbers and letters, the sequence is typeset as a subscript.

- When ^ appears before a non-empty sequence of numbers and letters, the sequence is typeset as a superscript.

top← prev up next →