diff --git a/collects/scribblings/scribble/base.scrbl b/collects/scribblings/scribble/base.scrbl index b3857d1f39..8a7312fc3f 100644 --- a/collects/scribblings/scribble/base.scrbl +++ b/collects/scribblings/scribble/base.scrbl @@ -27,15 +27,14 @@ @title[#:tag "base"]{Base Document Format} -@defmodule[scribble/base]{The @schememodname[scribble/base] library +@defmodulelang[scribble/base]{The @schememodname[scribble/base] language provides functions and forms that can be used from code written either in Scheme or with @elem["@"] expressions. The @schememodname[scribble/base] name can also be used as a -language with @hash-lang[]. It acts like the -@schememodname[scribble/doc] language, except that the -@schememodname[scribble/base] library is also required into -the module.} +library with @scheme[require], in which case it provides all of the same +bindings, but without setting the reader or setting the default +rendering format to the PLT Scheme manual format.} Functions provided by this library, such as @scheme[title] and @scheme[italic], might be called from Scheme as diff --git a/collects/scribblings/scribble/how-to-paper.scrbl b/collects/scribblings/scribble/how-to-paper.scrbl index 49dbfd2cd6..36401b7039 100644 --- a/collects/scribblings/scribble/how-to-paper.scrbl +++ b/collects/scribblings/scribble/how-to-paper.scrbl @@ -596,10 +596,11 @@ renders as @section[#:tag "roadmap"]{Next Steps} If your immediate goal is to document a PLT Scheme library or write -literate programs, skip to @secref["how-to-doc"]. +literate programs, skip to @secref["how-to-doc"], and then go back to +@secref["reader"] and other chapters. If you are more interested in producing documents unrelated to PLT -Scheme, skip continue with @secref["reader"] and then +Scheme, continue with @secref["reader"] and then @secref["generic-prose"]. Move on to @secref["internals"] when you need more power. diff --git a/collects/scribblings/scribble/how-to.scrbl b/collects/scribblings/scribble/how-to.scrbl index 7914229ff2..170c19b8b6 100644 --- a/collects/scribblings/scribble/how-to.scrbl +++ b/collects/scribblings/scribble/how-to.scrbl @@ -3,7 +3,7 @@ scribble/bnf "utils.ss") -@title[#:tag "how-to-doc"]{Starting Documentation} +@title[#:tag "how-to-doc"]{Getting Started with Documentation} Although the @exec{scribble} command-line utility generates output from a Scribble document, documentation of PLT Scheme libraries is @@ -15,7 +15,7 @@ across documents. @exec{scribble} command-line utility.} @;---------------------------------------- -@section[#:tag "setting-up"]{Setting Up Documentation} +@section[#:tag "setting-up"]{Setting Up Library Documentation} To document a collection or @|PLaneT| package: diff --git a/collects/scribblings/scribble/manual.scrbl b/collects/scribblings/scribble/manual.scrbl index e267ff19a6..4f54699540 100644 --- a/collects/scribblings/scribble/manual.scrbl +++ b/collects/scribblings/scribble/manual.scrbl @@ -9,22 +9,21 @@ @title[#:tag "manual" #:style 'toc]{Manual Forms} -@defmodule[scribble/manual]{The @schememodname[scribble/manual] -library provides all of @schememodname[scribble/basic] plus additional -functions, including all of @scheme[scribble/base] plus many others -that are relatively specific to writing PLT Scheme documentation. +@defmodulelang[scribble/manual]{The @schememodname[scribble/manual] +language provides all of @schememodname[scribble/base] plus many +additional functions that are specific to writing PLT Scheme +documentation. -The @schememodname[scribble/manual] name can also be used as a -language with @hash-lang[]. It acts like the -@schememodname[scribble/doc] language, except that the -@schememodname[scribble/manual] library is also required into the -module. +The @schememodname[scribble/manual] name can also be used as a library +with @scheme[require], in which case it provides all of the same +bindings, but without setting the reader or setting the default +rendering format to the PLT Scheme manual format.} -In addition, @scheme[#, @hash-lang[] #, @schememodname[scribble/manual]] -associates a @scheme[latex-defaults] style @tech{variant} with its -@scheme[doc] export to select the default PLT Scheme manual style for -Latex rendering---unless a style is supplied to @scheme[title] that -already includes a @scheme[latex-defaults] @tech{variant}.} +With @hash-lang[], @schememodname[scribble/manual] associates a +@scheme[latex-defaults] style @tech{variant} with its @scheme[doc] +export to select the default PLT Scheme manual style for Latex +rendering---unless a style is supplied to @scheme[title] that already +includes a @scheme[latex-defaults] @tech{variant}. @local-table-of-contents[] diff --git a/collects/scribblings/scribble/sigplan.scrbl b/collects/scribblings/scribble/sigplan.scrbl index 0a4df4e26b..5ec0aa9a47 100644 --- a/collects/scribblings/scribble/sigplan.scrbl +++ b/collects/scribblings/scribble/sigplan.scrbl @@ -18,3 +18,43 @@ same line as @hash-lang[], with only whitespace between @verbatim[#:indent 2]|{ #lang scribble/sigplan @preprint }|} + + +@defproc[(abstract [pre-content pre-content?] ...) block?]{ + +Generates a @tech{nested flow} for a paper abstract.} + +@defform[(include-abstract module-path)]{ + +Similar to @scheme[include-path], but incorporates the document in the +specified module as an abstract. The document must have no title or +sub-parts.} + +@defproc[(authorinfo [name pre-content?] + [affiliation pre-content?] + [email pre-content?]) + block?]{ + +A replacement for @scheme[author] that associates an affiliation and +e-mail address with the author name.} + +@deftogether[( +@defproc[(conferenceinfo [conference pre-content?] [location pre-content?]) block?] +@defproc[(copyrightyear [content pre-content?] ...) block?] +@defproc[(copyrightdata [content pre-content?] ...) block?] +)]{ + +Declares information that is collected into the copyright region of the paper.} + + +@deftogether[( +@defproc[(category [CR-number pre-content?] + [subcategory pre-content?] + [third-level pre-content?] + [fourth-level (or/c #f pre-content?) #f]) block?] +@defproc[(terms [content pre-content?] ...) block?] +@defproc[(keywords [content pre-content?] ...) block?] +)]{ + +Typesets category, term, and keyword information for the paper, which +is normally placed immediately after an @scheme[abstract] form.}