4.2.6 Various String Forms

► |  | Scribble: The Racket Documentation Tool

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

► | 4 | Scribbling Documentation

4.1 | Getting Started with Documentation
4.2 | Manual Forms
4.3 | Racket
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 | Bibliography
4.2.10 | Version History
4.2.11 | Miscellaneous
4.2.12 | Index-Entry Descriptions
4.2.13 | Manual Rendering Style

On this page:

aux-elem
defterm
onscreen
menuitem
filepath
exec
envvar
Flag
DFlag
PFlag
DPFlag

top ← prev up next →

##### 4.2.6`` Various String Forms

> procedure (aux-elem pre-content ...) → element?
> pre-content : pre-content?

Like elem, but adds an 'aux style property.

> procedure (defterm pre-content ...) → element?
> pre-content : pre-content?

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.

> procedure (onscreen pre-content ...) → element?
> pre-content : pre-content?

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

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

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

> procedure (filepath pre-content ...) → element?
> pre-content : pre-content?

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

> procedure (exec pre-content ...) → element?
> pre-content : pre-content?

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

> procedure (envvar pre-content ...) → element?
> pre-content : pre-content?

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

> procedure (Flag pre-content ...) → element?
> pre-content : pre-content?

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

> procedure (DFlag pre-content ...) → element?
> pre-content : pre-content?

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

> procedure (PFlag pre-content ...) → element?
> pre-content : pre-content?

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

> procedure (DPFlag pre-content ...) → element?
> pre-content : pre-content?

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