suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

more slideshow docs/refinements

Browse Source 
svn: r7751
This commit is contained in:
Matthew Flatt 2007-11-16 21:58:33 +00:00
parent fd0d99f158
commit cc2a099a32
12 changed files with 507 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
collects/scribble/manual.ss
View File

@ -1051,7 +1051,8 @@
(schemeparenfont "(")))))
(to-flow (if (or (null? fields)
(short-width . < . max-proto-width))
(to-element (map field-view fields))
(make-element #f (list (to-element (map field-view fields))
(schemeparenfont ")")))
(to-element (field-view (car fields)))))))
(if (short-width . < . max-proto-width)
null
@ -1070,7 +1071,7 @@
#f
(list e
(schemeparenfont
(if (and (not immutable?)
(if (and immutable?
(not transparent?))
"))"
")"))))
@ -1398,7 +1399,7 @@
(provide cite)
(define (cite #:key key #:title title #:author author #:location location #:date date)
(define (cite #:key key #:title title #:author author #:location location #:date date #:url [url #f])
"[...]"
#;
(make-bibliography-element

19
collects/scribblings/reference/namespaces.scrbl
View File

@ -21,23 +21,10 @@ Returns @scheme[#t] if @scheme[v] is a namespace value, @scheme[#f]
otherwise.}
@defproc[(make-namespace [flag (one-of/c 'initial 'empty) 'initial]) namespace?]{
@defproc[(make-namespace) namespace?]{
Creates a new namespace with a new module registry. The @scheme[flag]
is an option that determines the initial bindings in the namespace:
@itemize{
@item{@indexed-scheme['initial] --- the new namespace contains the
module declarations of the initial namespace, and the new
namespace's @tech{phase-level} 1 top-level environment contains
bindings and imports as in the initial namespace. However, the
namespace's @tech{phase-level} 1 top-level environment is empty.}
@item{@indexed-scheme['empty] --- creates a namespace with no
initial bindings or module declarations.}
}}
Creates a new namespace that is empty. Attach modules from an existing
namespace to the new one with @scheme[namespace-attach-module].}
@defparam[current-namespace n namespace?]{

2
collects/scribblings/slideshow/guide.scrbl
View File

@ -109,7 +109,7 @@ mixture of strings and picts, and it formats them as a paragraph.
@; ------------------------------------------------------------------------
@section{Staging Slides}
@section[#:tag "staging"]{Staging Slides}
The @scheme[slide] function creates a slide as a side effect. It can
be put inside a function to abstract over a slide:

8
collects/scribblings/slideshow/picts.scrbl
View File

@ -4,10 +4,14 @@
@title[#:style 'toc]{Making Pictures}
The @scheme[slideshow/pict] layer provides core functions for
@declare-exporting[slideshow/pict slideshow]
The @schememodname[slideshow/pict] layer provides core functions for
constructing pictures, and it is independent of the slide viewer. This
layer can be used, for example, to generate a picture as encapsulated
PostScript for inclusion into a larger document.
PostScript for inclusion into a larger document. The
@schememodname[slideshow/pict] layer is re-provided by the
@schememodname[slideshow] module.
@local-table-of-contents[]

447
collects/scribblings/slideshow/slides.scrbl Normal file
View File

@ -0,0 +1,447 @@
#lang scribble/doc
@require["ss.ss"]
@require[(for-label mred)]
@title[#:style 'toc]{Making Slides}
@local-table-of-contents[]
@; ----------------------------------------------------------------------
@section{Primary Slide Functions}
@defproc[(slide [#:title title (or/c false/c string?) #f]
[#:name name (or/c false/c string?) title]
[#:layout layout (one-of-/c 'auto 'center 'top 'tall) 'auto]
[#:inset inset slide-inset? (make-slide-inset 0 0 0 0)]
[#:timeout secs (or/c false/c real?) #f]
[#:condense? condense? any/c (and timeout #t)]
[element (flat-rec-contract elem/c
(or/c pict?
(one-of/c 'next 'next! 'alts 'alts~ 'nothing)
comment?
(listof (listof elem/c))))] ...)
void?]{
Creates and registers a slide. See @secref["staging"] for information
about @scheme[element]s.
When this function is first called in non-printing mode, then the
viewer window is opened. Furthermore, each call to the function
@scheme[yield]s, so that the viewer window can be refreshed, and so
the user can step through slides.
If @scheme[title] is not @scheme[#f], then a title is shown for the
slide. The @scheme[name] is used in the slide-navigation dialog, and
it defaults to @scheme[title].
If @scheme[layout] is @scheme['top], then the content is top-aligned,
with @scheme[(* 2 gap-size)] space between the title and the
content. The @scheme['tall] layout is similar, but with only
@scheme[gap-size]. The @scheme['center] mode centers the content
(ignoring space consumed by the title). The @scheme['auto] mode is
like @scheme['center], except when @scheme[title] is non-@scheme[#f]
and when the space between the title and content would be less than
@scheme[(* 2 gap-size)], in which case it behaves like @scheme['top].
The @scheme[inset] argument supplies an inset that makes the
slide-viewing window smaller when showing the slide. See
@scheme[make-slide-inset] for more information.
If @scheme[secs] argument for @scheme[#:timeout] is not @scheme[#f],
then the viewer automatically advances from this slide to the next
after @scheme[secs] seconds, and manual advancing skips this slide.
If @scheme[condense?] is ture, then in condense mode (as specified by
the @Flag{c} command-line flag), the slide is not created and
registered.}
@defproc[(t [str string?]) pict?]{
The normal way to make plain text. Returns @scheme[(text str
(current-main-font) (current-font-size))].}
@defproc[(it [str string?]) pict?]{
The normal way to make italic text. Returns @scheme[(text str (cons
'italic (current-main-font)) (current-font-size))].}
@defproc[(bt [str string?]) pict?]{
The normal way to make bold text. Returns @scheme[(text str (cons
'bold (current-main-font)) (current-font-size))].}
@defproc[(bit [str string?]) pict?]{
Bold-italic text. Returns @scheme[(text str (list* 'bold 'italic
(current-main-font)) (current-font-size))].}
@defproc[(tt [str string?]) pict?]{
The normal way to make monospaced text. Returns @scheme[(text str
`(bold . modern) (current-font-size))].}
@defproc[(rt [str string?]) pict?]{
The normal way to make serif text. Returns @scheme[(text str 'roman
(current-font-size))].}
@defproc[(titlet [str string?]) pict?]{
Creates title text. Returns @scheme[((current-titlet) str)].}
@defproc[(para [#:width width real? (current-para-width)]
[#:align align (one-of/c 'left 'center 'right) 'left]
[#:fill? fill? any/c #t]
[element (flat-rec-contract elem/c
(or/c string? pict? (listof elem/c)))] ...)
pict?]{
Generates a paragraph pict that is no wider than @scheme[width] units,
and that is exactly @scheme[width] units if @scheme[fill?] is true. If
@scheme[fill?] is @scheme[#f], then the result pict is as wide as the
widest line.
Each list @scheme[element]s are sliced into the sequence of string and
pict elements. Strings are split at spaces for word-wrapping to fit
the page, and a space is added between elements. If a string element
starts with a punctuation mark (e.g., a comma), however, no space is
added before the string.
The @scheme[align] argument specifies how to align lines within the
paragraph.
See the spacing between lines is determined by the
@scheme[current-line-sep] parameter.}
@defproc[(item [#:width width real? (current-para-width)]
[#:bullet blt pict? bullet]
[#:align align (one-of/c 'left 'center 'right) 'left]
[#:fill? fill? any/c #t]
[element (flat-rec-contract elem/c
(or/c string? pict? (listof elem/c)))] ...)
pict?]{
Like @scheme[para], but with @scheme[blt] followed by @scheme[(/
gap-size 2)] space appended horizontally to the resulting paragraph,
aligned with the top line. The paragraph width of @scheme[blt] plus
@scheme[(/ gap-size 2)] is subtracted from the maximum width of the
paragraph.}
@defproc[(subitem [#:width width real? (current-para-width)]
[#:bullet blt pict? o-bullet]
[#:align align (one-of/c 'left 'center 'right) 'left]
[#:fill? fill? any/c #t]
[element (flat-rec-contract elem/c
(or/c string? pict? (listof elem/c)))] ...)
pict?]{
Like @scheme[item], but an additional @scheme[(* 2 gap-size)] is
subtracted from the paragraph width and added as space to the left of
the pict. Also, @scheme[o-bullet] is the default bullet, instead of
@scheme[bullet].}
@defproc[(clickback [pict pict?] [thunk (-> any)])
pict?]{
Creates a pict that embeds the given one, and is the same size as the
given pict, but that when clicked during a presentation calls
@scheme[thunk].}
@defproc[(size-in-pixels [pict pict?]) pict?]{
Scales @scheme[pict] so that it is displayed on the screen as
@scheme[(pict-width pict)] pixels wide and @scheme[(pict-height pict)]
pixels tall. The result is @scheme[pict] when using a 1024 by 768
display.}
@defproc[(make-outline [name (or/c symbol? (listof symbol?))]
[title (or/c string? pict?)]
[subitems (or/c false/c null?
(symbol? . -> . pict?))]
...)
(symbol? . -> . void?)]{
Returns a function that takes a symbol and generates an outline
slide.
The @scheme[...] above applies to all three arguments together. Each
trio of arguments defines a section for the outline:
@itemize{
@item{The section @scheme[name] is either a symbol or a list of symbols. When
the outline function is called later to make an outline, the
given symbol is compared to the section's symbol(s), and the
section is marked as current if the symbol matches.}
@item{The @scheme[title] is used as the displayed name of the
section.}
@item{The @scheme[subitems] are displayed when the section is
active. It can be @scheme[#f] or @scheme[null] (for historical
reasons) if no subitems are to be displayed. Otherwise, it
should be a function that takes a symbol (the same one passed
to the outline maker) and produces a pict.}
}}
@defproc[(comment (or/c string? pict?) ...)
comment?]{
Combines strings and picts to be used as a slide element for (usually
hidden) commentary. Use the result as an argument to @scheme[slide]}
@defproc[(comment? [v any/c]) boolean?]{
Returns @scheme[#t] if @scheme[v] is a comment produced by
@scheme[comment].}
@; ------------------------------------------------------------------------
@section{Slide Registration}
@defproc[(most-recent-slide) slide?]{
Returns a slide structure that be supplied @scheme[re-slide] to make a
copy of the slide.}
@defproc[(retract-most-recent-slide) slide?]{
Cancels the most recently created slide, and also returns a slide
structure that be supplied to @scheme[re-slide] to restore the slide
(usually in a later position).}
@defproc[(re-slide [slide slide?] [pict pict? (blank)])]{
Re-inserts a slide, @scheme[lt-superimpose]ing the given additional
@scheme[pict].}
@defproc[(slide? [v any/c]) boolean?]{
Returns @scheme[#t] if @scheme[v] is a slide produced by
@scheme[most-recent-slide] or @scheme[retract-most-recent-slide].}
@; ------------------------------------------------------------------------
@section{Viewer Control}
@defproc[(start-at-recent-slide)]{
Sets the starting slide for the talk to the most recently created
slide. If this function is used multiple times, the last use overrides
the earlier uses.}
@defproc[(enable-click-advance! [on? any/c]) void?]{
Enables or disables slide advance as a result of a mouse click.}
@defproc[(set-use-background-frame! [on? any/c]) void?]{
Enables or disables the creation of a background frame, which is
typically useful only when @scheme[make-slide-inset] is used are
active. The last enable/disable before the first slide registration
takes effect once and for all.}
@defproc[(set-page-numbers-visible! [on? any/c]) void?]{
Determines whether slide numbers are initially visible in the viewer.}
@defparam[current-page-number-font font (is-a?/c font%)]{
Parameter that determines the font used to draw the page number (if
visible).}
@defparam[current-page-number-color color (or/c string? (is-a?/c color%))]{
Parameter that determines the color used to draw the page number (if
visible).}
@; ------------------------------------------------------------------------
@section{Constants and Layout Variables}
@defthing[gap-size (one-of/c 24)]{
A width commonly used for layout.}
@defthing[bullet pict?]{
A filled bullet used by default by @scheme[item].}
@defthing[o-bullet pict?]{
A hollow bullet used by default by @scheme[subitem].}
@defidform[client-w]{
Produces the width of the display area, minus @scheme[margin]s. The
result of the form changes if the margin is adjusted via
@scheme[set-margin!].}
@defidform[client-h]{
Produces the height of the display area, minus @scheme[margin]s, but
including the title area). The result of the form changes if the
margin is adjusted via @scheme[set-margin!].}
@defidform[full-page]{
Produces an empty pict that is the same size as the client area, which
is like @scheme[(blank client-w client-h)].}
@defidform[titleless-page]{
Produces an empty pict that is the same size as the client area minus
the title area in @scheme['top] layout mode, which is like
@scheme[(blank client-w (- client-h title-h (* 2 gap-size)))].}
@defidform[margin]{
Produces a number that corresponds to the current margin, which
surrounds every side of the slide. The client area for a slide
corresponds to the display area (which is always 1024 by 768) minus
this margin on each side. The default margin is @scheme[20].
The margin can be adjusted via @scheme[set-margin!].}
@defidform[title-h]{
Produces a number that corresponds to the height of a title created by
@scheme[titlet].
If @scheme[titlet] is changed via the @scheme[current-titlet]
parameter, the title height should be updated via
@scheme[set-title-h!].}
@defthing[printing? boolean?]{
The value is @scheme[#t] if slides are being generated for printed
output, @scheme[#f] for normal on-screen display. Printing mode is
normally triggered via the @DFlag{print} or @DFlag{ps} command-line
flag.}
@defthing[condense? boolean?]{
The value is @scheme[#t] if slides are being generated in condensed
mode, @scheme[#f] for normal mode. Condensed mode is normally
triggered via the @DFlag{condense} command-line flag.}
@; ------------------------------------------------------------------------
@section{Configuration}
@defparam[current-font-size n nonnegative-exact-integer?]{
Parameter that determines he font size used by @scheme[t],
@scheme[para], etc. The default size is @scheme[32].}
@defparam[current-main-font style text-style/c]{
Parameter that determines the font size used by @scheme[t],
@scheme[para], etc. The default is platform-specific; possible
initial values include @scheme['swiss], @scheme["Verdana"], and
@scheme["Gill Sans"].}
@defparam[current-line-sep n nonnegative-exact-integer?]{
Parameter that controls the amount of space used between lines by
@scheme[para], @scheme[item], and @scheme[subitem].}
@defparam[current-title-color color (or/c string? (is-a?/c color%))]{
Parameter used by the default @scheme[current-titlet] to colorize the
title. The default is @scheme["black"].}
@defparam[current-slide-assembler proc ((or/c string? false/c)
nonnegative-exact-integer?
pict?
. -> .
pict?)]{
Parameter whose value is a function for assembling slide content into
a single pict; the assembling function takes a string for the title
(or @scheme[#f]), a separation for the title (if any) and pict, and a
pict for the slide content (not counting the title).
The result is of the assembler is @scheme[lt-superimpose]d with the
client area, but the result pict might draw outside the client region
to paint the screen margins, too.
The default assembler uses @scheme[titlet] to turn a title string (if
any) to a pict. See also @scheme[current-titlet] and
@scheme[set-title-h!],.
The slide assembler is @italic[not] responsible for adding page
numbers to the slide; that job belongs to the viewer. See also
@scheme[current-page-number-font], @scheme[current-page-number-color],
and @scheme[set-page-numbers-visible!].}
@defparam[current-titlet proc (string? . -> . pict?)]{
Parameter to configure @scheme[titlet]. The default is
@schemeblock[
(lambda (s)
(colorize (text s (current-main-font) 40)
(current-title-color)))
]
If this parameter is changed such that the result is a different
height, then @scheme[set-title-h!] should be called to update the
value produced by @scheme[title-h], @scheme[titleless-page], etc.}
@defproc[(set-margin! [amt real?]) void?]{
Changes the margin that surrounds the client area. See also
@scheme[margin].}
@defproc[(set-title-h! [amt real?]) void?]{
Changes the expected height of a title, which adjusts @scheme[title-h],
@scheme[client-h], @scheme[full-page], and @scheme[titleless-page].}
@defproc[(make-slide-inset [left-inset exact-nonnegative-integer?]
[top-inset exact-nonnegative-integer?]
[right-inset exact-nonnegative-integer?]
[bottom-inset exact-nonnegative-integer?])
slide-inset?]{
Creates a slide inset, which describes a number of pixels to inset the
viewer for a slide on each side.}
@defproc[(slide-inset? [v any/c]) boolean?]{
Returns @scheme[#t] if @scheme[v] is a slide inset created by
@scheme[make-slide-inset], @scheme[#f] otherwise.}

14
collects/scribblings/slideshow/slideshow.scrbl
View File

@ -13,14 +13,11 @@ program.
To get started, run the @exec{slideshow} executable, and click the
@onscreen{Run Tutorial} link.
To learn more about why Slideshow is cool, read the paper
@schemeblock[
#, @elem{``Slideshow: Functional Presentations''}
#, @elem{Robert Bruce Findler and Matthew Flatt}
#, @elem{@italic{Journal of Functional Programming}, 16(4-5), pp. 583--619, 2006.}
#, @link[paper-url (tt paper-url)]
]
To learn more about why Slideshow is cool, see also ``Slideshow:
Functional Presentations'' @cite[#:key "slideshow" #:title "Slideshow:
Functional Presentations" #:author "Robert Bruce Findler and Matthew
Flatt" #:location @elem{@italic{Journal of Functional Programming},
16(4-5), pp. 583--619} #:date "2006" #:url paper-url].
@table-of-contents[]
@ -28,3 +25,4 @@ To learn more about why Slideshow is cool, read the paper
@include-section["guide.scrbl"]
@include-section["picts.scrbl"]
@include-section["slides.scrbl"]

30
collects/slideshow/base.ss
View File

@ -1,6 +1,9 @@
(module base scheme
(require "slide.ss")
(require "slide.ss"
(only-in "core.ss"
sliderec?
just-a-comment?))
(current-line-sep 5)
@ -12,31 +15,34 @@
(current-para-width (* 3/4 client-w))
(current-titlet (lambda (s)
(text s (current-main-font) 40)))
(colorize (text s (current-main-font) 40)
(current-title-color))))
(set-title-h! (pict-height (titlet "Hi")))
(current-title-color "black")
(provide (rename-out [slide/kw slide])
(provide (rename-out [slide/kw slide]
[sliderec? slide?]
[just-a-comment? comment?])
comment
most-recent-slide retract-most-recent-slide re-slide start-at-recent-slide
scroll-transition pause-transition
make-outline
(rename-out [item/kw item]
[subitem/kw subitem]
[para/kw para])
font-size gap-size current-font-size current-line-sep line-sep title-size
main-font current-main-font with-font current-title-color
red green blue purple orange size-in-pixels
gap-size current-font-size current-line-sep
current-main-font current-title-color
size-in-pixels
t it bt bit tt titlet tt* rt
bullet o-bullet
margin get-margin set-margin!
client-w client-h get-client-w get-client-h
full-page titleless-page get-full-page get-titleless-page
margin set-margin!
client-w client-h
full-page titleless-page
printing? condense?
skip-slides
set-use-background-frame!
enable-click-advance!
title-h get-title-h set-title-h! current-slide-assembler
title-h set-title-h! current-slide-assembler
current-page-number-font current-page-number-color
current-titlet current-para-width
set-page-numbers-visible! done-making-slides
clickback make-slide-inset apply-slide-inset))
clickback make-slide-inset slide-inset? apply-slide-inset))

25
collects/slideshow/core.ss
View File

@ -253,7 +253,7 @@
(lambda (s v-sep p)
(apply vc-append v-sep
(if s
(list (evenize-width (titlet s)) p)
(list (evenize-width (if (pict? s) s (titlet s))) p)
(list p)))))
(define current-slide-assembler
@ -846,22 +846,23 @@
;; ----------------------------------------
(define subitem/kw
(let ([subitem (lambda (#:bullet [bullet bullet]
(let ([subitem (lambda (#:bullet [bullet o-bullet]
#:width [width (current-para-width)]
#:align [align 'left]
#:fill? [fill? #t]
#:decode? [decode? #t]
. s)
(htl-append (/ gap-size 2)
bullet
(para/kw #:width (- width
(* 2 gap-size)
(pict-width bullet)
(/ gap-size 2))
#:align align
#:fill? fill?
#:decode? decode?
s)))])
(inset (htl-append (/ gap-size 2)
o-bullet
(para/kw #:width (- width
(* 2 gap-size)
(pict-width o-bullet)
(/ gap-size 2))
#:align align
#:fill? fill?
#:decode? decode?
s))
(* 2 gap-size) 0 0 0))])
subitem))
(define (subitem* w . s)

2
collects/slideshow/doc.txt
View File

@ -491,7 +491,7 @@ Procedure Reference
> current-main-font - Parameter for the font specification
used for `t'. Its argument must be a text-style (see
texpict for details).
> main-font - Defaultfor `current-main-font'
> main-font - Default for `current-main-font'
> current-title-color - Parameter for the color used by titles/`titlet'
> (with-font f thunk) - Calls `thunk' with

4
collects/slideshow/initial-ones.ss
View File

@ -22,7 +22,7 @@
(size-in-pixels
(bitmap (build-path (collection-path "icons") "PLT-206.png")))
(blank)
(colorize (it "Press the spacebar to continue") blue)
(colorize (it "Press the spacebar to continue") "blue")
(comment "Welcome to Slideshow"))
(slide
@ -34,7 +34,7 @@
"you get the power of Scheme"))
(define (symbol n)
(text (string (integer->char n)) 'symbol font-size))
(text (string (integer->char n)) 'symbol (current-font-size)))
(define sym:rightarrow (symbol 174))
(define sym:leftarrow (symbol 172))

3
collects/slideshow/slide.ss
View File

@ -106,7 +106,8 @@
slide/timeout
slide/title/timeout
slide/center/timeout
slide/title/center/timeout)
slide/title/center/timeout
(rename sinset? slide-inset?))
(provide/contract [clickback
((pict? (lambda (x)
(and (procedure? x)

8
collects/slideshow/tutorial-show.ss
View File

@ -186,7 +186,7 @@
"There's a margin, so the ``client'' area is"
(number->string client-w) "x" (number->string client-h))
(para #:fill? #f
"The font size is" (number->string font-size)))))
"The font size is" (number->string (current-font-size))))))
(slide
#:title "Titled Client Area"
@ -203,9 +203,9 @@
(para "Functions exist for" (bt "bold") ","
(it "italic") ", and even" (bit "bold-italic") "text")
(para "The" (tt "text") "function gives you more direct control over the"
(text "font" '(italic . modern) font-size) ","
(text "size" main-font 24) ", and even"
(text "angle" main-font font-size (/ 3.14159 4))))
(text "font" '(italic . modern) (current-font-size)) ","
(text "size" (current-main-font) 24) ", and even"
(text "angle" (current-main-font) (current-font-size) (/ 3.14159 4))))
(require slideshow/code)
(slide