doc mr-interaction

svn: r13897
This commit is contained in:
Matthew Flatt 2009-03-02 19:11:30 +00:00
parent e51ea7f217
commit 77d1cfdb84
2 changed files with 23 additions and 1 deletions

View File

@ -1,3 +1,4 @@
#lang setup/infotab
(define scribblings '(("quick.scrbl" () (getting-started 9))))
(define scribblings '(("quick.scrbl" () (getting-started 9))
("mreval.scrbl")))

View File

@ -0,0 +1,21 @@
#lang scribble/manual
@(require (for-label scribble/eval "mreval.ss"))
@title{Writing Examples with Pict Results}
@defmodule[scribblings/quick/mreval]{The
@schememodname[scribblings/quick/mreval] library support example
evaluations with results that are @schememodname[slideshow] picts.}
@defform[(mr-interaction datum ...)]{
Like @scheme[interaction], but using an evaluator that includes
@schememodname[scheme/gui/base] and @schememodname[slideshow].
The trick is that @schememodname[scheme/gui] is not generally
available when rendering documentation, because it requires a GUI
context. The picture output is rendered to an image file when the
@envvar{MREVAL} environment variable is set, so run the enclosing
document once with the environment varibale to generate the
images. Future runs (with the environment variable unset) use the
generated image.}