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

doc tweaks

Browse Source 
svn: r8043

original commit: ec3f79cf47d6fa6ff4a5896756eeef683d955efa
This commit is contained in:
Matthew Flatt 2007-12-18 01:44:09 +00:00
parent bb408a644f
commit 1b21a6d56e
3 changed files with 23 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
collects/scribblings/scribble/scribble.scrbl
View File

@ -6,8 +6,8 @@
@title[#:tag-prefix '(lib "scribblings/scribble/scribble.scrbl")
#:tag "top"]{@bold{Scribble}: PLT Documentation Tool}
The @filepath{scribble} collection provides libraries that can be used to
create documents from Scheme.
Scribble is a collection of tools for creating prose documents,
especially those that document libraries.
@table-of-contents[]

24
collects/scribblings/scribble/style.scrbl
View File

@ -11,13 +11,16 @@ implicit subject is the form or value being described. Thus, the
description will often start with ``Produces.'' Refer to arguments by
name.
Use @schemeidfont{id} or something that ends @schemeidfont{-id} in a
syntactic form to mean an identifier, not @schemeidfont{identifier},
@schemeidfont{name}, or @schemeidfont{symbol}. Similarly, use
@schemeidfont{expr} or something that ends @schemeidfont{-expr} for an
expression position within a syntactic form. Use @schemeidfont{body}
for a form (definition or expression) in an internal-definition
position.
Use @schemeidfont{id} or something that ends @schemeidfont{-id} in
@scheme[defform] to mean an identifier, not @schemeidfont{identifier},
@schemeidfont{variable}, @schemeidfont{name}, or
@schemeidfont{symbol}. Similarly, use @schemeidfont{expr} or something
that ends @schemeidfont{-expr} for an expression position within a
syntactic form. Use @schemeidfont{body} for a form (definition or
expression) in an internal-definition position. Never use
@schemeidfont{expr} for something that isn't exactly an expression,
@scheme[id] for something that isn't exactly an identifier, etc.;
instead, use @scheme[defform/subs] to define a new non-terminal.
Pay attention to the difference between identifiers and meta-variables
when using @scheme[scheme], especially outside of @scheme[defproc] or
@ -36,8 +39,11 @@ typeset as variables. The correct description is
which produces @scheme[(_rator-expr _rand-expr ...)], where
@schemeidfont{rator-expr} @schemeidfont{rand-expr} are typeset as
meta-variables. The @scheme[defproc], @scheme[defform], @|etc| forms
greatly reduce this burden in description, since they automatically
set up meta-variable typesetting for non-literal identifiers.
greatly reduce this burden in descriptions, since they automatically
set up meta-variable typesetting for non-literal identifiers. In
@scheme[defform], be sure to include literal identifiers (i.e., those
not meant as variables, other than the form name being defined) in a
@scheme[#:literals] clause.
To typeset an identifier with no particular interpretation---syntax,
variable, meta-variable, etc.---use @scheme[schemeidfont] (e.g., as in

8
collects/scribblings/scribble/xref.scrbl
View File

@ -3,7 +3,8 @@
"utils.ss"
(for-label scribble/xref
scribble/base-render
scribble/html-render))
scribble/html-render
setup/xref))
@title[#:tag "xref"]{Cross-Reference Utilities}
@ -30,7 +31,10 @@ serialize-info].
Since the format of serialized information is specific to a rendering
class, the optional @scheme[using-render%] argument accepts the
relevant class. It default to HTML rendering.}
relevant class. It default to HTML rendering.
Use @scheme[load-collections-xref] from @schememodname[setup/xref] to
get all cross-reference information for installed documentation.}
@defproc[(xref-binding->definition-tag [xref xref?]