suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

link 'help' to general docs

Browse Source 
svn: r12374
This commit is contained in:
Matthew Flatt 2008-11-10 15:49:39 +00:00
parent 49a4a3a26f
commit 9a1916e03e
1 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
collects/scribblings/reference/help.scrbl
View File

@ -1,9 +1,18 @@
#lang scribble/doc #lang scribble/doc
@(require "mz.ss" @(require "mz.ss"
scribble/struct
(for-label scheme/help (for-label scheme/help
net/url net/url
scheme/gui)) scheme/gui))
@; Beware of this hard-wired link to the main doc page:
@(define main-doc-page
(link "../index.html"
#:style (make-with-attributes
"plainlink"
`((onclick . ,(format "return GotoPLTRoot(\"~a\");" (version)))))
"main documentation page"))
@title{Interactive Help} @title{Interactive Help}
@note-init-lib[scheme/help] @note-init-lib[scheme/help]
@ -15,10 +24,13 @@
@defform/none[#:literals (help) (help #:search datum ...)] @defform/none[#:literals (help) (help #:search datum ...)]
)]{ )]{
Searches the documentation, and opens a web browser (using the user's @emph{For general help, see the @|main-doc-page|.}
selected browser) to display the results. See
@schememodname[net/sendurl] for information on how the user's browser The @scheme[help] form searches the documentation and opens a web
is launched. browser (using the user's selected browser) to display the results.
@margin-note{See @schememodname[net/sendurl] for information on how
the user's browser is launched to display help information.}
A simple @scheme[help] or @scheme[(help)] form opens this page. A simple @scheme[help] or @scheme[(help)] form opens this page.