Changed @itemize{...} to @itemize[...] (done after comparing the doc

tree and verifying that there are no changes).
(Also fixed a few bugs that were in the code)

svn: r14427

original commit: c0a8a0122200209e38dff1959d79b58f847814db
This commit is contained in:
Eli Barzilay 2009-04-05 17:46:20 +00:00
parent 8b1a22893d
commit 134b15abd5
8 changed files with 37 additions and 37 deletions

View File

@ -14,7 +14,7 @@ At the @tech{flow} level, decoding recognizes a blank line as a
@tech{paragraph} separator. At the @tech{paragraph}-content level, @tech{paragraph} separator. At the @tech{paragraph}-content level,
decoding makes just a few special text conversions: decoding makes just a few special text conversions:
@itemize{ @itemize[
@item{@litchar{---}: converted to @scheme['mdash], which the HTML render @item{@litchar{---}: converted to @scheme['mdash], which the HTML render
outputs as an en-dash surrounded by space (so don't put spaces around outputs as an en-dash surrounded by space (so don't put spaces around
@ -28,7 +28,7 @@ decoding makes just a few special text conversions:
@item{@litchar{'}: converted to @scheme['rsquo], which is a fancy apostrophe: '} @item{@litchar{'}: converted to @scheme['rsquo], which is a fancy apostrophe: '}
} ]
Some functions @deftech{decode} a sequence of @scheme[_pre-flow] or Some functions @deftech{decode} a sequence of @scheme[_pre-flow] or
@scheme[_pre-content] arguments using @scheme[decode-flow] or @scheme[_pre-content] arguments using @scheme[decode-flow] or

View File

@ -20,7 +20,7 @@ documents.
To document a collection or @|PLaneT| package: To document a collection or @|PLaneT| package:
@itemize{ @itemize[
@item{Create a file in your collection or planet package with the @item{Create a file in your collection or planet package with the
file extension @filepath{.scrbl}. Beware that the file name file extension @filepath{.scrbl}. Beware that the file name
@ -80,7 +80,7 @@ To document a collection or @|PLaneT| package:
documentation is generated as @filepath{manual/index.html} in documentation is generated as @filepath{manual/index.html} in
the installation's main @filepath{doc} directory.} the installation's main @filepath{doc} directory.}
} ]
@; ---------------------------------------- @; ----------------------------------------
@section[#:tag "how-to:reader"]{Document Syntax} @section[#:tag "how-to:reader"]{Document Syntax}
@ -98,7 +98,7 @@ provides an escape to Scheme mode. The syntax of @litchar["@"] is
where all three parts after @litchar["@"] are optional, but at least where all three parts after @litchar["@"] are optional, but at least
one must be present. No spaces are allowed between one must be present. No spaces are allowed between
@itemize{ @itemize[
@item{@litchar["@"] and @nonterm{cmd}, @litchar{[}, or @litchar["{"]} @item{@litchar["@"] and @nonterm{cmd}, @litchar{[}, or @litchar["{"]}
@ -106,7 +106,7 @@ one must be present. No spaces are allowed between
@item{@litchar{]} and @litchar["{"].} @item{@litchar{]} and @litchar["{"].}
} ]
A @nonterm{cmd} or @nonterm{datum} is a Scheme datum, while a A @nonterm{cmd} or @nonterm{datum} is a Scheme datum, while a
@nonterm{text-body} is itself in text mode. @nonterm{text-body} is itself in text mode.
@ -364,7 +364,7 @@ guarantees a result that is a list where none of the elements are
Some things to notice in this example and the documentation that it Some things to notice in this example and the documentation that it
generates: generates:
@itemize{ @itemize[
@item{The @scheme[list?], @scheme[listof], @|etc| elements of @item{The @scheme[list?], @scheme[listof], @|etc| elements of
contracts are hyperlinked to their documentation.} contracts are hyperlinked to their documentation.}
@ -388,7 +388,7 @@ generates:
(for-label ....))] of @filepath{helper.ss}, then the (for-label ....))] of @filepath{helper.ss}, then the
reference is hyperlinked to the definition above.} reference is hyperlinked to the definition above.}
} ]
See @scheme[defproc*], @scheme[defform], @|etc| for more information See @scheme[defproc*], @scheme[defform], @|etc| for more information
on forms to document Scheme bindings. on forms to document Scheme bindings.

View File

@ -144,7 +144,7 @@ normally packaged into higher-level functions and forms, such as
Working roughly from the bottom up, the Scribble layers are: Working roughly from the bottom up, the Scribble layers are:
@itemize{ @itemize[
@item{@schememodname[scribble/reader]: A reader that extends the @item{@schememodname[scribble/reader]: A reader that extends the
syntax of Scheme with @"@"-forms for conveniently embedding a syntax of Scheme with @"@"-forms for conveniently embedding a
@ -208,7 +208,7 @@ Working roughly from the bottom up, the Scribble layers are:
@item{@schememodname[scribble/text]: A language that uses @item{@schememodname[scribble/text]: A language that uses
@schememodname[scribble/reader] preprocessing text files.} @schememodname[scribble/reader] preprocessing text files.}
} ]
The @exec{scribble} command-line utility generates output with a The @exec{scribble} command-line utility generates output with a
specified renderer. More specifically, the executable installs a specified renderer. More specifically, the executable installs a

View File

@ -79,7 +79,7 @@ instead of @scheme[unsyntax].
A few other escapes are recognized symbolically: A few other escapes are recognized symbolically:
@itemize{ @itemize[
@item{@scheme[(#,(scheme code:line) _datum ...)] typesets as the @item{@scheme[(#,(scheme code:line) _datum ...)] typesets as the
sequence of @scheme[_datum]s (i.e., without the sequence of @scheme[_datum]s (i.e., without the
@ -104,7 +104,7 @@ A few other escapes are recognized symbolically:
non-terminal via @scheme[defform], a variable via non-terminal via @scheme[defform], a variable via
@scheme[defproc], etc.} @scheme[defproc], etc.}
} ]
See also @schememodname[scribble/comment-reader]. See also @schememodname[scribble/comment-reader].
} }
@ -324,7 +324,7 @@ is documented by each @scheme[defform], @scheme[defproc], or similar
form within the section that contains the @scheme[declare-exporting] form within the section that contains the @scheme[declare-exporting]
declaration: declaration:
@itemize{ @itemize[
@item{If no @scheme[#:use-sources] clause is supplied, then the @item{If no @scheme[#:use-sources] clause is supplied, then the
documentation applies to the given name as exported by the first documentation applies to the given name as exported by the first
@ -338,7 +338,7 @@ declaration:
as the identifier as exported by the first @scheme[mod-path] in as the identifier as exported by the first @scheme[mod-path] in
the @scheme[declare-exporting] declaration.} the @scheme[declare-exporting] declaration.}
} ]
The initial @scheme[mod-path]s sequence can be empty if The initial @scheme[mod-path]s sequence can be empty if
@scheme[mod-path]s are given with @scheme[#:use-sources]. In that @scheme[mod-path]s are given with @scheme[#:use-sources]. In that
@ -855,14 +855,14 @@ typewriter font with two leading @litchar{+}s).}
@defproc[(math [pre-content any/c] ...) element?]{The @tech{decode}d @defproc[(math [pre-content any/c] ...) element?]{The @tech{decode}d
@scheme[pre-content] is further transformed: @scheme[pre-content] is further transformed:
@itemize{ @itemize[
@item{Any immediate @scheme['rsquo] is converted to @scheme['prime].} @item{Any immediate @scheme['rsquo] is converted to @scheme['prime].}
@item{Parentheses and sequences of decimal digits in immediate @item{Parentheses and sequences of decimal digits in immediate
strings are left as-is, but any other immediate string is strings are left as-is, but any other immediate string is
italicized.} italicized.}
} ]
Extensions to @scheme[math] are likely, such as recognizing @litchar{_} Extensions to @scheme[math] are likely, such as recognizing @litchar{_}
and @litchar{^} for subscripts and superscripts.} and @litchar{^} for subscripts and superscripts.}
@ -949,7 +949,7 @@ The @scheme[content->string] result of the @tech{decode}d
@scheme[pre-content] is used as a key for references, but normalized @scheme[pre-content] is used as a key for references, but normalized
as follows: as follows:
@itemize{ @itemize[
@item{A trailing ``ies'' is replaced by ``y''.} @item{A trailing ``ies'' is replaced by ``y''.}
@ -958,7 +958,7 @@ as follows:
@item{Consecutive hyphens and whitespaces are all replaced by a @item{Consecutive hyphens and whitespaces are all replaced by a
single space.} single space.}
} ]
These normalization steps help support natural-language references These normalization steps help support natural-language references
that differ slightly from a defined form. For example, a definition of that differ slightly from a defined form. For example, a definition of
@ -1002,7 +1002,7 @@ the link.}
A combination of @scheme[scheme] and @scheme[as-index], with the A combination of @scheme[scheme] and @scheme[as-index], with the
following special cases when a single @scheme[datum] is provided: following special cases when a single @scheme[datum] is provided:
@itemize{ @itemize[
@item{If @scheme[datum] is a @scheme[quote] form, then the quote is @item{If @scheme[datum] is a @scheme[quote] form, then the quote is
removed from the key (so that it's sorted using its unquoted removed from the key (so that it's sorted using its unquoted
@ -1011,7 +1011,7 @@ following special cases when a single @scheme[datum] is provided:
@item{If @scheme[datum] is a string, then quotes are removed from the @item{If @scheme[datum] is a string, then quotes are removed from the
key (so that it's sorted using the string content).} key (so that it's sorted using the string content).}
}} ]}
@defproc[(idefterm [pre-content any/c] ...) element?]{Combines @defproc[(idefterm [pre-content any/c] ...) element?]{Combines
@scheme[as-index] and @scheme[defterm]. The content normally should be @scheme[as-index] and @scheme[defterm]. The content normally should be
@ -1082,7 +1082,7 @@ Creates a bibliography entry. The @scheme[key] is used to refer to the
entry via @scheme[cite]. The other arguments are used as elements in entry via @scheme[cite]. The other arguments are used as elements in
the entry: the entry:
@itemize{ @itemize[
@item{@scheme[title] is the title of the cited work. It will be @item{@scheme[title] is the title of the cited work. It will be
surrounded by quotes in typeset form if @scheme[is-book?] is surrounded by quotes in typeset form if @scheme[is-book?] is
@ -1108,7 +1108,7 @@ the entry:
bibliography using @scheme[tt] and hyperlinked, or it is bibliography using @scheme[tt] and hyperlinked, or it is
omitted if given as @scheme[#f].} omitted if given as @scheme[#f].}
}} ]}
@defproc[(bib-entry? [v any/c]) boolean?]{ @defproc[(bib-entry? [v any/c]) boolean?]{

View File

@ -12,7 +12,7 @@
language provides everything from @scheme[scheme/base] with a few language provides everything from @scheme[scheme/base] with a few
changes that make it suitable as a preprocessor language: changes that make it suitable as a preprocessor language:
@itemize{ @itemize[
@item{It uses @scheme[read-syntax-inside] to read the body of the @item{It uses @scheme[read-syntax-inside] to read the body of the
module, similar to @secref["docreader"]. This means that by module, similar to @secref["docreader"]. This means that by
@ -23,7 +23,7 @@ changes that make it suitable as a preprocessor language:
@item{Values of expressions are printed with a custom @item{Values of expressions are printed with a custom
@scheme[output] function. This function displays most values @scheme[output] function. This function displays most values
in a similar way to @scheme[display], except that it is more in a similar way to @scheme[display], except that it is more
convenient for a preprocessor output.}} convenient for a preprocessor output.}]
} }

View File

@ -904,7 +904,7 @@ Useful for implementing languages that are textual by default (see
Constructs an @"@"-readtable. The keyword arguments can customize the Constructs an @"@"-readtable. The keyword arguments can customize the
resulting reader in several ways: resulting reader in several ways:
@itemize{ @itemize[
@item{@scheme[readtable] --- a readtable to base the @"@"-readtable @item{@scheme[readtable] --- a readtable to base the @"@"-readtable
on.} on.}
@ -937,7 +937,7 @@ resulting reader in several ways:
@item{@scheme[start-inside?] --- if true, creates a readtable for @item{@scheme[start-inside?] --- if true, creates a readtable for
use starting in text mode, instead of S-expression mode.} use starting in text mode, instead of S-expression mode.}
}} ]}
@defproc[(use-at-readtable ...) void?]{ @defproc[(use-at-readtable ...) void?]{

View File

@ -44,7 +44,7 @@ A @deftech{block} is either a @techlink{table}, an
@techlink{itemization}, @techlink{blockquote}, @techlink{paragraph}, @techlink{itemization}, @techlink{blockquote}, @techlink{paragraph},
or a @techlink{delayed block}. or a @techlink{delayed block}.
@itemize{ @itemize[
@item{A @deftech{table} is an instance of @scheme[table]; it @item{A @deftech{table} is an instance of @scheme[table]; it
has a list of list of @techlink{flows} with a particular has a list of list of @techlink{flows} with a particular
@ -62,7 +62,7 @@ A @deftech{block} is either a @techlink{table}, an
@scheme[paragraph]; it has a @deftech{content}, which is @scheme[paragraph]; it has a @deftech{content}, which is
a list of @techlink{elements}: a list of @techlink{elements}:
@itemize{ @itemize[
@item{An @deftech{element} can be a string, one of a few @item{An @deftech{element} can be a string, one of a few
symbols, an instance of @scheme[element] (possibly symbols, an instance of @scheme[element] (possibly
@ -71,7 +71,7 @@ A @deftech{block} is either a @techlink{table}, an
@techlink{delayed element}, or anything else @techlink{delayed element}, or anything else
allowed by the current renderer. allowed by the current renderer.
@itemize{ @itemize[
@item{A string element is included in the result @item{A string element is included in the result
document verbatim, except for space, and document verbatim, except for space, and
@ -160,14 +160,14 @@ A @deftech{block} is either a @techlink{table}, an
@techlink{render pass} of document @techlink{render pass} of document
processing.} processing.}
}}}} ]}]}
@item{A @deftech{delayed block} is an instance of @item{A @deftech{delayed block} is an instance of
@scheme[delayed-block], which has a procedure that @scheme[delayed-block], which has a procedure that
is called in the @techlink{resolve pass} of document is called in the @techlink{resolve pass} of document
processing to obtain a @defterm{block}.} processing to obtain a @defterm{block}.}
} ]
@; ------------------------------------------------------------------------ @; ------------------------------------------------------------------------
@ -261,7 +261,7 @@ The @scheme[style] field is normally either a symbol or a list. The
currently recognized style symbols (alone or in a list) or other currently recognized style symbols (alone or in a list) or other
values (must be in a list) are as follows: values (must be in a list) are as follows:
@itemize{ @itemize[
@item{@scheme['toc] --- sub-parts of the part are rendered on separate @item{@scheme['toc] --- sub-parts of the part are rendered on separate
pages for multi-page HTML mode.} pages for multi-page HTML mode.}
@ -306,7 +306,7 @@ values (must be in a list) are as follows:
but @exec{setup-plt} installs @scheme["doc-plt-scheme.org"] but @exec{setup-plt} installs @scheme["doc-plt-scheme.org"]
as the @tt{id} for any document that it builds.} as the @tt{id} for any document that it builds.}
} ]
The @scheme[to-collect] field contains @techlink{content} that is The @scheme[to-collect] field contains @techlink{content} that is
inspected during the @techlink{collect pass}, but ignored in later inspected during the @techlink{collect pass}, but ignored in later
@ -495,7 +495,7 @@ pass} to obtain a normal @tech{block}. The first argument to
The @scheme[style] field is normally either The @scheme[style] field is normally either
@itemize{ @itemize[
@item{a string, which corresponds to a CSS class for HTML output and @item{a string, which corresponds to a CSS class for HTML output and
a macro name for Latex output (see @secref["extra-style"]);} a macro name for Latex output (see @secref["extra-style"]);}
@ -526,7 +526,7 @@ The @scheme[style] field is normally either
@item{an instance of @scheme[with-attributes], which combines a base @item{an instance of @scheme[with-attributes], which combines a base
style with a set of additional HTML attributes.} style with a set of additional HTML attributes.}
} ]
The @scheme[content] field is a list of @techlink{elements}. The @scheme[content] field is a list of @techlink{elements}.

View File

@ -69,7 +69,7 @@ re-exported from other other module, for the other module
The @scheme[mode] argument specifies the relevant phase level for the The @scheme[mode] argument specifies the relevant phase level for the
binding. The @scheme[binding] is specified in one of four ways: binding. The @scheme[binding] is specified in one of four ways:
@itemize{ @itemize[
@item{If @scheme[binding] is an identifier, then @item{If @scheme[binding] is an identifier, then
@scheme[identifier-binding] is used with @scheme[mode] to @scheme[identifier-binding] is used with @scheme[mode] to
@ -89,7 +89,7 @@ binding. The @scheme[binding] is specified in one of four ways:
elements are as in the last four elements of the seven-element elements are as in the last four elements of the seven-element
case.} case.}
} ]
If a documentation point exists in @scheme[xref], a tag is returned, If a documentation point exists in @scheme[xref], a tag is returned,
which might be used with @scheme[xref-tag->path+anchor] or embedded in which might be used with @scheme[xref-tag->path+anchor] or embedded in