checkpoint GUI manual work

svn: r7117

original commit: c9f1aec9eb0491a6e80f5454815361a79c92618a

collects/scribblings/gui/diagrams.ss

@@ -8,7 +8,12 @@
            short-windowing-diagram
            windowing-diagram
            event-diagram
-           menu-diagram)
+           menu-diagram
+           editor-diagram
+           snip-diagram
+           style-diagram
+           admin-diagram
+           stream-diagram)
 
   (define (diagram->table d)
     (make-table
@@ -103,4 +108,52 @@ DIAG
                 |- menu-item%                        
                 |- checkable-menu-item%
 DIAG
+)
+
+  (define editor-diagram
+#<<DIAG
+  editor<%>
+   |- text%                   
+   |- pasteboard%
+DIAG
+)
+
+  (define snip-diagram
+#<<DIAG
+  snip%                   readable-snip<%>
+   |- string-snip%
+   |   |- tab-snip%
+   |- image-snip%
+   |- editor-snip%
+DIAG
+)
+ 
+  (define admin-diagram
+#<<DIAG
+  editor-canvas%       
+
+  editor-admin<%>                   snip-admin%
+   |- editor-snip-editor-admin<%>
+
+  editor-wordbreak-map%   keymap%
+DIAG
+)
+ 
+  (define style-diagram
+#<<DIAG
+  style<%>         style-delta%       add-color<%>
+  style-list%                         mult-color<%>
+DIAG
+)
+
+  (define stream-diagram
+#<<DIAG
+ editor-data%
+ editor-data-class%                     snip-class%
+ editor-data-class-list<%>              snip-class-list<%>
+ 
+ editor-stream-in%                   editor-stream-out%
+ editor-stream-in-base%              editor-stream-out-base%
+  |- editor-stream-in-bytes-base%     |- editor-stream-out-bytes-base%
+DIAG
 ))

collects/scribblings/gui/editor-classes.scrbl

@@ -2,7 +2,29 @@
 @require["common.ss"]
 @require["diagrams.ss"]
 
-@title[#:style '(toc quiet)]{Editor Class Reference}
+@title[#:style '(toc quiet)]{Editor Classes}
+
+Editors:
+
+@diagram->table[editor-diagram]
+
+Snips:
+
+@diagram->table[snip-diagram]
+
+Displays, Administrators, and Mappings:
+
+@diagram->table[editor-diagram]
+
+Styles:
+
+@diagram->table[style-diagram]
+
+Streams for Saving and Cut-and-Paste:
+
+@diagram->table[stream-diagram]
+
+Alphabetical:
 
 @local-table-of-contents[]
 
@@ -10,8 +32,17 @@
 @require["editor-intf.scrbl"]
 @require["editor-admin-class.scrbl"]
 @require["editor-canvas-class.scrbl"]
+@require["editor-data-class.scrbl"]
+@require["editor-data-class-class.scrbl"]
+@require["editor-data-class-list-intf.scrbl"]
 @require["editor-snip-editor-admin-intf.scrbl"]
 @require["editor-snip-class.scrbl"]
+@require["editor-stream-in-class.scrbl"]
+@require["editor-stream-in-base-class.scrbl"]
+@require["editor-stream-in-bytes-base-class.scrbl"]
+@require["editor-stream-out-class.scrbl"]
+@require["editor-stream-out-base-class.scrbl"]
+@require["editor-stream-out-bytes-base-class.scrbl"]
 @require["editor-wordbreak-map-class.scrbl"]
 @require["image-snip-class.scrbl"]
 @require["keymap-class.scrbl"]
@@ -20,6 +51,8 @@
 @require["readable-snip-intf.scrbl"]
 @require["snip-class.scrbl"]
 @require["snip-admin-class.scrbl"]
+@require["snip-class-class.scrbl"]
+@require["snip-class-list-intf.scrbl"]
 @require["string-snip-class.scrbl"]
 @require["style-intf.scrbl"]
 @require["style-delta-class.scrbl"]
@@ -31,7 +64,17 @@
 @include-class[editor<%>]
 @include-class[editor-admin%]
 @include-class[editor-canvas%]
+@include-class[editor-data%]
+@include-class[editor-data-class%]
+@include-class[editor-data-class-list<%>]
+@include-class[editor-snip-editor-admin<%>]
 @include-class[editor-snip%]
+@include-class[editor-stream-in%]
+@include-class[editor-stream-in-base%]
+@include-class[editor-stream-in-bytes-base%]
+@include-class[editor-stream-out%]
+@include-class[editor-stream-out-base%]
+@include-class[editor-stream-out-bytes-base%]
 @include-class[editor-wordbreak-map%]
 @include-class[image-snip%]
 @include-class[keymap%]
@@ -40,6 +83,8 @@
 @include-class[readable-snip<%>]
 @include-class[snip%]
 @include-class[snip-admin%]
+@include-class[snip-class%]
+@include-class[snip-class-list<%>]
 @include-class[string-snip%]
 @include-class[style<%>]
 @include-class[style-delta%]

collects/scribblings/gui/editor-overview.scrbl

@@ -2,7 +2,7 @@
 @require[(lib "bnf.ss" "scribble")]
 @require["common.ss"]
 
-@title[#:tag "mr:editor-overview"]{Editor Guide}
+@title[#:tag "mr:editor-overview"]{Editor}
 
 The editor toolbox provides a foundation for two common kinds of
  applications:

collects/scribblings/gui/gui.scrbl

@@ -14,6 +14,7 @@ This manual describes MrEd.
 
 @include-section["guide.scrbl"]
 @include-section["reference.scrbl"]
+@include-section["config.scrbl"]
 
 @;------------------------------------------------------------------------
 

collects/scribblings/gui/guide.scrbl

@@ -1,7 +1,7 @@
 #reader(lib "docreader.ss" "scribble")
 @require["common.ss"]
 
-@title[#:style 'toc]{Guide}
+@title[#:style '(toc reveal)]{Guide}
 
 For documentation purposes, the MrEd toolbox is organized into three
 parts:

collects/scribblings/gui/reference.scrbl

@@ -1,7 +1,7 @@
 #reader(lib "docreader.ss" "scribble")
 @require["common.ss"]
 
-@title[#:style 'toc]{Reference}
+@title[#:style '(toc reveal)]{Reference}
 
 @local-table-of-contents[]
 
@@ -10,5 +10,4 @@
 @include-section["draw-classes.scrbl"]
 @include-section["draw-funcs.scrbl"]
 @include-section["editor-classes.scrbl"]
-@include-section["editor-stream-classes.scrbl"]
 @include-section["editor-funcs.scrbl"]

collects/scribblings/gui/win-classes.scrbl

@@ -2,7 +2,7 @@
 @require["common.ss"]
 @require["diagrams.ss"]
 
-@title[#:style '(toc quiet)]{Windowing Class Reference}
+@title[#:style '(toc quiet)]{Windowing Classes}
 
 Windows and controls:
 

collects/scribblings/gui/win-funcs.scrbl

@@ -1,7 +1,7 @@
 #reader(lib "docreader.ss" "scribble")
 @require["common.ss"]
 
-@title{Windowing Function Reference}
+@title{Windowing Functions}
 
 @local-table-of-contents[]
 

collects/scribblings/gui/win-overview.scrbl

@@ -3,7 +3,7 @@
 @require["common.ss"]
 @require["diagrams.ss"]
 
-@title[#:tag "mr:windowing-overview"]{Windowing Guide}
+@title[#:tag "mr:windowing-overview"]{Windowing}
 
 @section{Basic GUI Building Blocks}