document scriblib/footnote

original commit: 1e9aa3b132e6a7855215e84426f4450c931ca33f
This commit is contained in:
Matthew Flatt 2010-05-21 19:37:23 -06:00
parent 686e10f25e
commit 1a417716ea
3 changed files with 35 additions and 1 deletions

View File

@ -176,7 +176,7 @@ of inlined.}
@defproc[(margin-note* [pre-content pre-content?] ...) element?]{
Produces an @tech{element} that is typeset in the margin, instead of
Produces an @racket[element] that is typeset in the margin, instead of
inlined. Unlike @racket[margin-note], @racket[margin-note*] can be
used in the middle of a paragraph; at the same time, its content is
constrained to form a single paragraph in the margin.}

View File

@ -0,0 +1,33 @@
#lang scribble/manual
@(require (for-label scribble/struct
scriblib/footnote
scheme/base
scheme/contract))
@title[#:tag "footnotes"]{Footnotes}
@defmodule[scriblib/footnote]
@defproc[(note [pre-content pre-content?] ...) element?]{
Creates a margin note for HTML and a footnote for Latex/PDF output.}
@defform[(define-footnote footnote-id footnote-part-id)]{
Binds @racket[footnote-id] to a form like @racket[note] that generates
a footnote in HTML output as well as Latex/PDF output. To trigger the
HTML output of the footnotes that are registered through
@racket[footnote-id], the function bound to @racket[footnote-part-id]
must be called at a position that corresponds the bottom of the HTML
page. (The generated section will not show a title or appear in a
table of contents; it will look like a footnote area.)
Beware that any content passed to @racket[footnote-id] will occur
twice in at least an intermediate form of the document, and perhaps
also in the rendered form of the document. Consequently, the content
passed to @racket[footnote-id] should not bind link targets or include
other one-time declarations.}

View File

@ -7,3 +7,4 @@
@include-section["gui-eval.scrbl"]
@include-section["figure.scrbl"]
@include-section["autobib.scrbl"]
@include-section["footnote.scrbl"]