6.10 Blue Boxes Utilities

► |  | 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

▼ | 6 | Low-Level Scribble API

6.1 | Scribble Layers
6.2 | @ Reader Internals
6.3 | Structures And Processing
6.4 | Renderers
6.5 | Decoding Text
6.6 | Document Language
6.7 | Document Reader
6.8 | Cross-Reference Utilities
6.9 | Tag Utilities
6.10 | Blue Boxes Utilities
6.11 | Extending and Configuring Scribble Output

On this page:

fetch-blueboxes-strs
fetch-blueboxes-method-tags
make-blueboxes-cache
blueboxes-cache?

top ← prev up next →

#### 6.10`` Blue Boxes Utilities

(require scribble/blueboxes) | package: scribble-lib

The scribble/blueboxes provides access to the content of the “blue boxes” that describe some module’s export (but without any styling).

> > procedure
> > (fetch-blueboxes-strs |  | tag |
> > | [ | #:blueboxes-cache blueboxes-cache]) |
> → (or/c #f (non-empty-listof string?))
> tag : tag?
> blueboxes-cache : blueboxes-cache? = (make-blueboxes-cache #t)

Returns a list of strings that show the content of the blue box (without any styling information) for the documentation referenced by tag.

The first string in the list describes the export (e.g. "procedure" when defproc is used, or "syntax" when defform was used to document the export).

> > procedure
> > (fetch-blueboxes-method-tags |
> > |  | method-name |
> > | [ | #:blueboxes-cache blueboxes-cache]) |
> → (listof method-tag?)
> method-name : symbol?
> blueboxes-cache : blueboxes-cache? = (make-blueboxes-cache #t)

Returns the list of tags for all methods that are documented in the documentation in blueboxes-cache.

Added in version 1.11 of package scribble-lib.

> > procedure
> > (make-blueboxes-cache |  | populate? |
> > | [ | #:blueboxes-dirs blueboxes-dirs]) |
> → blueboxes-cache?
> populate? : boolean?
> blueboxes-dirs : (listof path?) = (get-doc-search-dirs)

Constructs a new (mutable) blueboxes cache.

If populate? is #f, the cache is initially unpopulated, in which case it is filled in the first time the cache is passed to fetch-bluebxoes-strs. Otherwise, the cache is populated immediately.

The blueboxes-dirs argument is a list of directories that are looked inside for "blueboxes.rktd" files. The default value is only an approximation for where those files usually reside. See also get-rendered-doc-directories.

> procedure (blueboxes-cache? v) → boolean?
> v : any/c

Determines if v is a blueboxes cache.
top ← prev up next →