Reorganize editor and snip documentation to break out `racket/snip'

original commit: f4571cb39ac16a9bab33ea8a4a063e95dee1abc8
This commit is contained in:
Sam Tobin-Hochstadt 2010-12-17 12:07:27 -05:00
parent 859b114198
commit 14e29910a6
4 changed files with 59 additions and 15 deletions

View File

@ -11,8 +11,10 @@
menu-diagram
editor-diagram
snip-diagram
editor-snip-diagram
style-diagram
admin-diagram
snip-list-diagram
editor-admin-diagram
stream-diagram)
(define (diagram->table d)
@ -125,11 +127,21 @@ DIAG
|- string-snip%
| |- tab-snip%
|- image-snip%
|- editor-snip% (not provided by racket/snip)
snip-admin%
DIAG
)
(define editor-snip-diagram
#<<DIAG
snip%
|- editor-snip%
DIAG
)
(define admin-diagram
(define editor-admin-diagram
#<<DIAG
editor-canvas%
@ -145,13 +157,20 @@ DIAG
style<%> style-delta% add-color<%>
style-list% mult-color<%>
DIAG
)
(define snip-list-diagram
#<<DIAG
snip-class%
snip-class-list<%>
DIAG
)
(define stream-diagram
#<<DIAG
editor-data%
editor-data-class% snip-class%
editor-data-class-list<%> snip-class-list<%>
editor-data-class%
editor-data-class-list<%>
editor-stream-in% editor-stream-out%
editor-stream-in-base% editor-stream-out-base%

View File

@ -8,13 +8,13 @@ Editors:
@diagram->table[editor-diagram]
Snips:
Editor Snips:
@diagram->table[snip-diagram]
@diagram->table[editor-snip-diagram]
Displays, Administrators, and Mappings:
@diagram->table[admin-diagram]
@diagram->table[editor-admin-diagram]
Styles:
@ -44,18 +44,10 @@ Alphabetical:
@include-section["editor-stream-out-base-class.scrbl"]
@include-section["editor-stream-out-bytes-base-class.scrbl"]
@include-section["editor-wordbreak-map-class.scrbl"]
@include-section["image-snip-class.scrbl"]
@include-section["keymap-class.scrbl"]
@include-section["mult-color-intf.scrbl"]
@include-section["pasteboard-class.scrbl"]
@include-section["readable-snip-intf.scrbl"]
@include-section["snip-class.scrbl"]
@include-section["snip-admin-class.scrbl"]
@include-section["snip-class-class.scrbl"]
@include-section["snip-class-list-intf.scrbl"]
@include-section["string-snip-class.scrbl"]
@include-section["style-intf.scrbl"]
@include-section["style-delta-class.scrbl"]
@include-section["style-list-class.scrbl"]
@include-section["tab-snip-class.scrbl"]
@include-section["text-class.scrbl"]

View File

@ -43,6 +43,7 @@ Both parts of the toolbox rely extensively on the
@include-section["win-classes.scrbl"]
@include-section["win-funcs.scrbl"]
@include-section["editor-overview.scrbl"]
@include-section["snip-classes.scrbl"]
@include-section["editor-classes.scrbl"]
@include-section["editor-funcs.scrbl"]
@include-section["wxme.scrbl"]

View File

@ -0,0 +1,32 @@
#lang scribble/doc
@(require "common.ss"
"diagrams.ss")
@title[#:style '(toc quiet)]{Snip Classes}
@;@defmodule*/no-declare[(racket/snip)]
The @racketmodname[racket/snip] collection provides access to the
@tech{snip} classes @emph{without} depending on
@racketmodname[racket/gui].
Snips and Administrators:
@diagram->table[snip-diagram]
Snip Lists:
@diagram->table[snip-list-diagram]
Alphabetical:
@local-table-of-contents[]
@include-section["image-snip-class.scrbl"]
@include-section["readable-snip-intf.scrbl"]
@include-section["snip-class.scrbl"]
@include-section["snip-admin-class.scrbl"]
@include-section["snip-class-class.scrbl"]
@include-section["snip-class-list-intf.scrbl"]
@include-section["string-snip-class.scrbl"]
@include-section["tab-snip-class.scrbl"]