Help and Documentation Utilities
This section describes utilities designed to connect to documentation
and to support bug reports. See also scribble/xref.
1 Searching in the Documentation
Visits the documentation file sub in the user’s 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-page passes the path to
notify. The fragment and query arguments are passed
to send-url/file, along with the URL.
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.
2 Connecting to racket
library is dynamically loaded by the help
form that is
available by default in racket
after concatenating the
elements of strs
and adding spaces between them.
Visits the documentation page for id as an export of lib.
Visits the documentation for id.
Visits the main entry page for the documentation.
3 Bug Reporting
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.
Returns a list of the saved bug reports.
Deletes all of the saved bug reports, except those currently
open in frames.
|(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
is suitable for use in a GUI control.