diff --git a/collects/scribblings/scribble/base.scrbl b/collects/scribblings/scribble/base.scrbl index 1917789d..2bd94469 100644 --- a/collects/scribblings/scribble/base.scrbl +++ b/collects/scribblings/scribble/base.scrbl @@ -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.} diff --git a/collects/scriblib/scribblings/footnote.scrbl b/collects/scriblib/scribblings/footnote.scrbl new file mode 100644 index 00000000..c8f3f57e --- /dev/null +++ b/collects/scriblib/scribblings/footnote.scrbl @@ -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.} + + + + diff --git a/collects/scriblib/scribblings/scriblib.scrbl b/collects/scriblib/scribblings/scriblib.scrbl index cee7c91d..1c1c2366 100644 --- a/collects/scriblib/scribblings/scriblib.scrbl +++ b/collects/scriblib/scribblings/scriblib.scrbl @@ -7,3 +7,4 @@ @include-section["gui-eval.scrbl"] @include-section["figure.scrbl"] @include-section["autobib.scrbl"] +@include-section["footnote.scrbl"]