▼ |  | Dr Racket Plugins

1 | Implementing Dr Racket Plugins
2 | Adding Languages to Dr Racket
3 | Creating New Kinds of Dr Racket Frames
4 | Extending the Existing Dr Racket Classes
5 | Expanding the User’s Program Text and Breaking
6 | Editor Modes
7 | Language-specific capabilities
8 | Check Syntax
9 | Teaching Languages
10 | drracket: get/ extend
11 | drracket: unit
12 | drracket: language
13 | drracket: language-configuration
14 | drracket: debug
15 | drracket: rep
16 | drracket: frame
17 | drracket: help-desk
18 | drracket: eval
19 | drracket: modes
20 | drracket: module-language-tools
21 | drracket: module-language
22 | Documentation Utilities
23 | Backwards compatibility
| Index

► | 22 | Documentation Utilities

22.1 | Searching in the Docs
22.2 | Bug Reporting

On this page:

22.1`` Searching in the Docs
send-main-page
perform-search
22.2`` Bug Reporting
help-desk: report-bug
saved-bug-report-titles/ ids
discard-all-saved-bug-reports
brinfo

top← prev up next →

### 22`` Documentation Utilities

This section describes a bunch of utilities designed for use by DrRacket and its tools to connect to the scribble documentation. See also scribble/xref.

#### 22.1`` Searching in the Docs

(require help/search)

> > procedure
> > (send-main-page | [ | #:sub sub] |  |  |  |
> > |  | #:notify notify |  |  |  |
> > | [ | #:fragment fragment |  |  |  |
> > |  | #:query query]) |  | → |  | any
> sub : path-string? = "index.html"
> notify : (-> path? void)
> fragment : (or/c #f ??) = #f
> query : (or/c #f ??) = #f

Visits the documentation file sub in your browser.

This function builds a url that points into the main collection documentation or into the user-specific documentation, depending on the sub argument. Once it finds the path, send-main-path passes the path to notify. The fragment and query arguments are passed to send-url/file, along with the url.

> procedure (perform-search str [context]) → void?
> str : string?
> | context |  | : |  |
> (or/c #f
> string?
> (list/c string? string))
> |  | = |  | #f

Searches for str in the documentation. The context argument supplies a context for the search or, if it is two strings, a context for the search and a label for that context.

#### 22.2`` Bug Reporting

(require help/bug-report)

> > procedure
> > (help-desk:report-bug | [ | this-bug-id |  |  |  |
> > |  | #:frame-mixin frame-mixin]) |  | → |  | void?
> this-bug-id : #f = (or/c #f exact-positive-integer?)
> frame-mixin : (make-mixin-contract frame%) = values

Opens a bug report window to edit the but report identified by this-bug-id. If this-bug-id is #f, then creates a new bug id and uses that one.

The frame-mixin argument is passed the frame class before creating the window.

> procedure (saved-bug-report-titles/ids) → (listof brinfo?)

Returns a list of the saved bug reports.

> procedure (discard-all-saved-bug-reports) → void?

Deletes all of the saved bug reports, except those currently open in frames.

> > struct
> > (struct |  | brinfo (title id)
> > |  | #:extra-constructor-name make-brinfo
> > |  | #:transparent)
> title : label-string?
> id : number?

A record representing a saved bug report. The id field is suitable for use with help-desk:report-bug and the label field is suitable for use in a GUI control.
top← prev up next →