► |  | Scribble: The Racket Documentation Tool

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

► | 4 | Scribbling Documentation

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

▼ | 4.3 | Manual Forms

4.3.1 | Typesetting Code
4.3.2 | Documenting Modules
4.3.3 | Documenting Forms, Functions, Structure Types, and Values
4.3.4 | Documenting Classes and Interfaces
4.3.5 | Documenting Signatures
4.3.6 | Various String Forms
4.3.7 | Links
4.3.8 | Indexing
4.3.9 | Images
4.3.10 | Bibliography
4.3.11 | Miscellaneous
4.3.12 | Index-Entry Descriptions
4.3.13 | Manual Rendering Style

top ← prev up next →

##### 4.3.13`` Manual Rendering Style

Using #lang scribble/manual for the main part of a document associates style properties on the doc export to select the Racket manual style for rendering.

A html-defaults style property is added to doc, unless doc’s style already has a html-defaults style property (e.g., supplied to title). Similarly, a latex-default style property is added if one is not already present. Finally, an css-style-addition property is always added.

For HTML rendering:

- The document’s prefix file is set to "scribble-prefix.html", as usual, in html-defaults.

- The document’s style file is set to "manual-style.css" from the "scribble" collection in html-defaults.

- The file "manual-files.css" from the "scribble" collection is designated as an additional accompanying file in html-defaults.

- The file "manual-racket.css" from the "scribble" collection is added as a css-style-addition.

To obtain this configuration without using #lang scribble/manual, use manual-doc-style.

top ← prev up next →