Version: 4.2.5

Scribble: PLT Documentation Tool

Matthew Flatt
and Eli Barzilay

Scribble is a collection of tools for creating prose documents – papers, books, library documentation, etc. – in HTML or PDF (via Latex) form. More generally, Scribble helps you write programs that are rich in textual content, whether the content is prose to be typeset or some other form of text to be generated programmatically.

This document itself is written using Scribble. At the time that it was written, its source was available at http://svn.plt-scheme.org/plt/trunk/collects/scribblings/scribble/ starting with the "scribble.scrbl" file.

    1 Getting Started

      1.1 A First Example

      1.2 Multiple Sections

      1.3 Splitting the Document Source

      1.4 Document Styles

      1.5 More Functions

      1.6 Text Mode vs. Scheme Mode for Arguments

      1.7 @ Syntax Basics

      1.8 Decoding Sequences

      1.9 Next Steps

    2 @ Syntax

      2.1 The Scribble Syntax at a Glance

      2.2 The Command Part

      2.3 The Datum Part

      2.4 The Body Part

        2.4.1 Alternative Body Syntax

        2.4.2 Scheme Expression Escapes

        2.4.3 Comments

        2.4.4 Spaces, Newlines, and Indentation

    3 High-Level Scribble API

      3.1 Base Document Format

        3.1.1 Document Structure

        3.1.2 Blocks

        3.1.3 Text Styles and Content

        3.1.4 Links

        3.1.5 Indexing

        3.1.6 Tables of Contents

      3.2 PLT Scheme Manual Format

      3.3 SIGPLAN Paper Format

      3.4 JFP Paper Format

    4 Scribbling Documentation

      4.1 Getting Started with Documentation

        4.1.1 Setting Up Library Documentation

        4.1.2 Scheme Typesetting and Hyperlinks

        4.1.3 Section Hyperlinks

        4.1.4 Defining Scheme Bindings

        4.1.5 Showing Scheme Examples

        4.1.6 Multi-Page Sections

        4.1.7 Style Guide

          4.1.7.1 Prose and Terminology

          4.1.7.2 Typesetting Code

          4.1.7.3 Typesetting Prose

          4.1.7.4 Section Titles

      4.2 Manual Forms

        4.2.1 Typesetting Code

          4.2.1.1 Typesetting Comments

        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

      4.3 Scheme

      4.4 Evaluation and Examples

      4.5 In-Source Documentation

        4.5.1 Source Annotations for Documentation

        4.5.2 Extracting Documentation from Source

      4.6 BNF Grammars

      4.7 Compatibility Libraries

        4.7.1 Compatibility Structures And Processing

        4.7.2 Compatibility Basic Functions

    5 Literate Programming

      5.1 scribble/lp Language

      5.2 scribble/lp-include Module

    6 Text Preprocessing

      6.1 Writing Preprocessor Files

      6.2 Defining Functions and More

      6.3 Using Printouts

      6.4 Indentation in Preprocessed output

      6.5 Using External Files

    7 Low-Level Scribble API

      7.1 Scribble Layers

        7.1.1 Typical Composition

        7.1.2 Layer Roadmap

      7.2 @ Reader Internals

        7.2.1 Using the @ Reader

        7.2.2 Syntax Properties

        7.2.3 Adding @-expressions to a Language

        7.2.4 Interface

      7.3 Structures And Processing

        7.3.1 Parts

        7.3.2 Tags

        7.3.3 Styles

        7.3.4 Collected and Resolved Information

        7.3.5 Structure Reference

        7.3.6 HTML Style Properties

        7.3.7 Latex Style Properties

      7.4 Renderer

        7.4.1 Base Renderer

        7.4.2 Text Renderer

        7.4.3 HTML Renderer

        7.4.4 Latex Renderer

      7.5 Decoding Text

      7.6 Document Language

      7.7 Document Reader

      7.8 Cross-Reference Utilities

      7.9 Extending and Configuring Scribble Output

        7.9.1 Implementing Styles

        7.9.2 Configuring Output

    Index