minor doc edits

svn: r7121
This commit is contained in:
Matthew Flatt 2007-08-19 13:20:06 +00:00
parent af3a4197df
commit 3f2341cda8
4 changed files with 22 additions and 17 deletions

View File

@ -492,7 +492,7 @@
(define (register-scheme-definition stx)
(unless (identifier? stx)
(error 'register-scheme-definition "not an identifier: ~e" (syntax-object->datum stx)))
(format "definition:~s"
(format "definition:~a"
(let ([b (identifier-binding stx)])
(cond
[(not b) (format "top:~a" (syntax-e stx))]

View File

@ -3,7 +3,15 @@
@title{PLT Scheme GUI: MrEd}
This manual describes MrEd.
This reference manual describes the MrEd GUI toolbox that is part of
PLT Scheme. See @secref["guide:mred"] in
@italic{@link["../guide/index.html"]{A Guide to PLT Scheme}} for an
introduction to MrEd.
The @scheme[(lib "mred")] module provides all of the class, interface,
and procedure bindings defined in this manual. The
@schememodname[big-gui] language (for use with @schemefont{#module})
extends the @schememodname[big] language with @scheme[(lib "mred")].
@bold{This reference describes a potential future version of PLT Scheme.
It does not match the current implementation.}

View File

@ -1,10 +1,10 @@
#reader(lib "docreader.ss" "scribble")
@require["common.ss"]
@title[#:style '(toc reveal)]{Guide}
@title[#:style '(toc reveal)]{Overview}
For documentation purposes, the MrEd toolbox is organized into three
parts:
parts:
@itemize{
@ -30,18 +30,7 @@ These three parts roughly represent layers of increasing
sophistication. Simple GUI programs access only the windowing toolbox
directly, more complex programs use both the windowing and drawing
toolboxes, and large-scale applications rely on all three
toolboxes. This three-layer view of the toolbox breaks down under
close scrutiny, because the windowing, drawing, and editor toolboxes
are actually interdependent and intertwined. Nevertheless, the
layered separation is a good approximation.
All three parts are immediately available when MrEd is started, as
well as the base class system from MzLib. The @indexed-file{mred.ss}
library module of the @file{mred} collection provides all of the
class, interface, and procedure names defined in this manual. When
MrEd starts up, it imports the @file{mred.ss} module and MzLib's
@indexed-file{class.ss} module into the initial namespace (so no
knowledge about modules is required to understand this manual).
toolboxes.
@local-table-of-contents[]

View File

@ -121,8 +121,16 @@ constant propagation, constant folding, and inlining optimizations.
@; ----------------------------------------------------------------------
@section[#:tag "gui"]{Graphical User Interfaces@aux-elem{ (GUIs)}}
@section[#:tag "guide:mred"]{Graphical User Interfaces@aux-elem{ (GUIs)}}
@deftech{MrEd} is both a library and an executable. As a library,
@scheme[(lib "mred/mred.ss")] provides class, interface, and function
bindings for writing GUI programs. An an executable, @exec{mred}
substitutes for @exec{mzscheme} to run MrEd programs. (The
@exec{mzscheme} executable cannot run MrEd programs, because
@exec{mzscheme} does not include primitive GUI support, and because
some operating systems distinguish GUI applications from command-line
applications.)
@; ----------------------------------------------------------------------
@section[#:tag "tools"]{More Tools}