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

On this page:

indexed-scheme
idefterm
pidefterm
indexed-file
indexed-envvar

Version: 4.0.2
contents index
← prev up next →

#### 11.8`` Indexing

(indexed-scheme datum ...)

A combination of scheme and as-index, with the following special cases when a single datum is provided:

- If datum is a quote form, then the quote is removed from the key (so that it’s sorted using its unquoted form).

- If datum is a string, then quotes are removed from the key (so that it’s sorted using the string content).

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

Combines as-index and defterm. The content normally should be plural, rather than singular. Consider using deftech, instead, which always indexes.

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

Like idefterm, but plural: adds an “s” on the end of the content for the index entry. Consider using deftech, instead.

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

A combination of file and as-index, but where the sort key for the index iterm does not include quotes.

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

A combination of envvar and as-index.

contents index
← prev up next →