fixed some latex leftovers, and convenient way to make headers and include-extracted

svn: r10723
This commit is contained in:
Eli Barzilay 2008-07-12 07:07:19 +00:00
parent 7c7bc0fd06
commit bf86c29bb7
11 changed files with 68 additions and 51 deletions

View File

@ -28,24 +28,37 @@
(all-from-out mrlib/switchable-button)
(all-from-out framework)))
(provide tools-title tools-include)
(define (tools-title name)
(title (tt (format "drscheme:~a" name))))
(define-syntax (tools-include stx)
(syntax-case stx ()
[(_ name)
(string? (syntax-e #'name))
(let ([name (syntax-e #'name)])
(with-syntax ([rx (regexp (format "^drscheme:~a:" name))])
#'(include-extracted (lib "tool-lib.ss" "drscheme") rx)))]))
(provide docs-get/extend)
(define-syntax (docs-get/extend stx)
(syntax-case stx ()
[(_ id)
(identifier? #'id)
(with-syntax ([get (datum->syntax
#'id
(string->symbol
(format "drscheme:get/extend:get-~a" (syntax-e #'id))))]
[extend (datum->syntax
#'id
(string->symbol
(format "drscheme:get/extend:extend-~a" (syntax-e #'id))))])
(with-syntax ([get (datum->syntax
#'id
(string->symbol
(format "drscheme:get/extend:get-~a"
(syntax-e #'id))))]
[extend (datum->syntax
#'id
(string->symbol
(format "drscheme:get/extend:extend-~a"
(syntax-e #'id))))])
#'(begin
@defproc*[([(extend (mixin mixin-contract))
void?]
[(extend (mixin mixin-contract) (before boolean?))
void?])]{
Adds a new mixin to the class eventually created in DrScheme.
}
@defproc[(get) class?]{Returns the class (with all registered mixins applied).}))]))
Adds a new mixin to the class eventually created in DrScheme.}
@defproc[(get) class?]{
Returns the class (with all registered mixins applied).}))]))

View File

@ -1,11 +1,20 @@
#lang scribble/doc
@(require "common.ss")
@title{@tt{drscheme:debug}}
@(tools-title "debug")
@defmixin[drscheme:debug:profile-unit-frame-mixin (drscheme:frame:<%> drscheme:unit:frame<%>) ()]{}
@defmixin[drscheme:debug:profile-unit-frame-mixin
(drscheme:frame:<%> drscheme:unit:frame<%>)
()]{
}
@defmixin[drscheme:debug:profile-interactions-text-mixin (drscheme:rep:text<%>) ()]{}
@defmixin[drscheme:debug:profile-interactions-text-mixin
(drscheme:rep:text<%>)
()]{
}
@defmixin[drscheme:debug:profile-definitions-text-mixin (drscheme:unit:definitions-text<%> text%) ()]{}
@defmixin[drscheme:debug:profile-definitions-text-mixin
(drscheme:unit:definitions-text<%> text%)
()]{
}
@(include-extracted (lib "tool-lib.ss" "drscheme") #rx"^drscheme:debug:")
@(tools-include "debug")

View File

@ -1,4 +1,4 @@
#lang scribble/doc
@(require "common.ss")
@title{@tt{drscheme:eval}}
@(include-extracted (lib "tool-lib.ss" "drscheme") #rx"^drscheme:eval:")
@(tools-title "eval")
@(tools-include "eval")

View File

@ -1,6 +1,6 @@
#lang scribble/doc
@(require "common.ss")
@title{@tt{drscheme:frame}}
@(tools-title "frame")
@defclass[drscheme:frame:name-message% canvas% ()]{
@ -23,7 +23,7 @@ Sets the names that the button shows.
The string @scheme[short-name] is the name that is shown on the button
and @scheme[name] is shown when the button is clicked on, in a separate
window. If @scheme[name] is \#f, a message indicating that the file
window. If @scheme[name] is @scheme[#f], a message indicating that the file
hasn't been saved is shown.
@ -63,7 +63,7 @@ if the
(file-menu:between-open-and-revert [file-menu (is-a?/c @scheme[menu%])])
void?]{
Adds an {\it Install .plt File...} menu item, which
Adds an ``Install .plt File...'' menu item, which
downloads and installs .plt files from the web, or installs
them from the local disk. After that, calls the super
method.
@ -178,8 +178,7 @@ Returns @scheme[#t].
@definterface[drscheme:frame:basics<%> (frame:standard-menus<%>)]{
This interface is the result of the
\iscmmixin{drscheme:frame:basics-mixin}
This interface is the result of the @scheme[drscheme:frame:basics-mixin]
}
@ -210,7 +209,7 @@ Does nothing.
@defmethod[(get-show-menu)
(is-a?/c menu%)]{
\index{View menu}
@index{View menu}
returns the view menu, for use by the
@method[drscheme:frame:<%> update-shown] method.
@ -262,4 +261,4 @@ Does nothing.
}}}
@(include-extracted (lib "tool-lib.ss" "drscheme") #rx"^drscheme:frame:")
@(tools-include "frame")

View File

@ -1,5 +1,4 @@
#lang scribble/doc
@(require "common.ss")
@title{@tt{drscheme:get/extend}}
@(include-extracted (lib "tool-lib.ss" "drscheme") #rx"^drscheme:get/extend:")
@(tools-title "get/extend")
@(tools-include "get/extend")

View File

@ -1,4 +1,4 @@
#lang scribble/doc
@(require "common.ss")
@title{@tt{drscheme:help-desk}}
@(include-extracted (lib "tool-lib.ss" "drscheme") #rx"^drscheme:help-desk:")
@(tools-title "help-desk")
@(tools-include "help-desk")

View File

@ -1,4 +1,4 @@
#lang scribble/doc
@(require "common.ss")
@title{@tt{drscheme:language-configuration}}
@(include-extracted (lib "tool-lib.ss" "drscheme") #rx"^drscheme:language-configuration:")
@(tools-title "language-configuration")
@(tools-include "language-configuration")

View File

@ -1,6 +1,6 @@
#lang scribble/doc
@(require "common.ss")
@title{@tt{drscheme:language}}
@(tools-title "language")
@definterface[drscheme:language:simple-module-based-language<%> ()]{
@ -1024,4 +1024,4 @@ Translates a Scheme value into a settings, returning
}}
@(include-extracted (lib "tool-lib.ss" "drscheme") #rx"^drscheme:language:")
@(tools-include "language")

View File

@ -1,4 +1,4 @@
#lang scribble/doc
@(require "common.ss")
@title{@tt{drscheme:modes}}
@(include-extracted (lib "tool-lib.ss" "drscheme") #rx"^drscheme:modes:")
@(tools-title "modes")
@(tools-include "modes")

View File

@ -1,10 +1,8 @@
#lang scribble/doc
@(require "common.ss")
@title{@tt{drscheme:rep}}
@(tools-title "rep")
@definterface[drscheme:rep:text<%> ()]{
}
@ -152,7 +150,7 @@ the Run button or the evaluation has been killed.
This thread has all of its parameters initialized according to the
settings of the current execution.
See \Mzhyperref{parameters}{mz:parameters}
See @secref[#:doc '(lib "scribblings/reference/reference.scrbl")]{parameters}
for more information about parameters.
}
@ -446,4 +444,4 @@ in the user's world.
}}
@(include-extracted (lib "tool-lib.ss" "drscheme") #rx"^drscheme:rep:")
@(tools-include "rep")

View File

@ -1,6 +1,6 @@
#lang scribble/doc
@(require "common.ss")
@title{@tt{drscheme:unit}}
@(tools-title "unit")
@definterface[drscheme:unit:tab<%> (drscheme:rep:context<%>)]{
@defmethod[(break-callback) void?]{
@ -277,7 +277,7 @@ It calls
@method[drscheme:rep:context<%> ensure-rep-shown] and then it calls
@method[drscheme:rep:text% do-many-text-evals] passing in the result of
@method[drscheme:unit:frame<%> get-interactions-text] and its entire range, unless the first two characters are
"\#!" in which case, it skips the first line.
@litchar{#!} in which case, it skips the first line.
}}
@ -373,8 +373,8 @@ Returns the result of
}
@defmethod[#:mode override
(get-canvas\%)
@defmethod[#:mode override
(get-canvas%)
(is-a?/c canvas%)]{
Returns the result of
@ -422,8 +422,8 @@ Returns the result of
}
@defmethod[#:mode override
(get-editor\%)
@defmethod[#:mode override
(get-editor%)
(is-a?/c editor<%>)]{
Returns the result of
@ -602,7 +602,7 @@ Calls result of
(is-a?/c menu%)]{
@methspec{
Returns the \scm|"Insert"| menu.
Returns the Insert menu.
}}
@ -666,7 +666,7 @@ when the menus are cliked on).
This assumes that the menu items in this menu are not moved
around, except by the this capability. If they are, things
can go funny ({\it i.e.}, no good checks are in place).
can go funny (i.e., no good checks are in place).
Note that the capability must be registered separately, via
@scheme[drscheme:language:register-capability].
@ -826,7 +826,6 @@ See also
Initializes the visibility of the save button.
}
@(include-extracted (lib "tool-lib.ss" "drscheme") #rx"^drscheme:unit:")
@(tools-include "unit")