scriblib doc corrections and clarification

original commit: 009468d6a8e25878d2256717e829aadf4144efbc
This commit is contained in:
Matthew Flatt 2011-03-27 13:00:52 -06:00
parent 5a9053820f
commit df42879d73
2 changed files with 7 additions and 20 deletions

View File

@ -9,13 +9,6 @@
@defmodule[scriblib/autobib]
@defproc[(autobib-style-extras) list?]{
Includes the content of the result list in the style of a document part
that includes all figures. These style extras pull in HTML and Latex
rendering support.}
@defform[(define-cite ~cite-id citet-id generate-bibliography-id)]{
Binds @scheme[~cite-id], @scheme[citet-id], and

View File

@ -9,13 +9,6 @@
@defmodule[scriblib/figure]
@defproc[(figure-style-extras) list?]{
Include the content of the result list in the style of a document part
that includes all figures. These style extras pull in HTML and Latex
rendering support.}
@deftogether[(
@defproc[(figure [tag string?] [caption content?] [pre-flow pre-flow?] ...) block?]
@defproc[(figure* [tag string?] [caption content?] [pre-flow pre-flow?] ...) block?]
@ -28,15 +21,16 @@ Creates a figure. The given @scheme[tag] is for use with
@scheme[figure-ref] or @scheme[Figure-ref]. The @scheme[caption] is an
element. The @scheme[pre-flow] is decoded as a flow.
For HTML output, the @scheme[figure*] and @scheme[figure*] functions
For HTML output, the @scheme[figure] and @scheme[figure*] functions
center the figure content, while @scheme[figure**] allows the content
to be wider than the document body.
For two-column Latex output, @scheme[figure*] and @scheme[figure**]
generate a figure that spans columns.
For latex output, @scheme[figure-here] generates a figure to be
included at the position in the text where the call to
@scheme[figure-here] occurs.
For two-column latex output, @scheme[figure*] and @scheme[figure**]
generate a figure that spans columns.}
For Latex output, @scheme[figure-here] generates a figure to be included at
the position in the output text where the @scheme[figure-here] occurs
in the source text. For HTML output, all @scheme[figure] variants
place the figure where the use appears in the source text.}
@defproc[(figure-ref [tag string?]) element?]{