suzanne.soy/hyper-literate
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
collects/scribblings/scribble/decode.scrbl
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,
decoding makes just a few special text conversions:
@itemize{
@itemize[
@item{@litchar{---}: converted to @scheme['mdash], which the HTML render
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: '}
}
]
Some functions @deftech{decode} a sequence of @scheme[_pre-flow] or
@scheme[_pre-content] arguments using @scheme[decode-flow] or

12
collects/scribblings/scribble/how-to.scrbl
View File

@ -20,7 +20,7 @@ documents.
To document a collection or @|PLaneT| package:
@itemize{
@itemize[
@item{Create a file in your collection or planet package with the
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
the installation's main @filepath{doc} directory.}
}
]
@; ----------------------------------------
@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
one must be present. No spaces are allowed between
@itemize{
@itemize[
@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["{"].}
}
]
A @nonterm{cmd} or @nonterm{datum} is a Scheme datum, while a
@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
generates:
@itemize{
@itemize[
@item{The @scheme[list?], @scheme[listof], @|etc| elements of
contracts are hyperlinked to their documentation.}
@ -388,7 +388,7 @@ generates:
(for-label ....))] of @filepath{helper.ss}, then the
reference is hyperlinked to the definition above.}
}
]
See @scheme[defproc*], @scheme[defform], @|etc| for more information
on forms to document Scheme bindings.

4
collects/scribblings/scribble/layers.scrbl
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:
@itemize{
@itemize[
@item{@schememodname[scribble/reader]: A reader that extends the
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
@schememodname[scribble/reader] preprocessing text files.}
}
]
The @exec{scribble} command-line utility generates output with a
specified renderer. More specifically, the executable installs a

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

@ -79,7 +79,7 @@ instead of @scheme[unsyntax].
A few other escapes are recognized symbolically:
@itemize{
@itemize[
@item{@scheme[(#,(scheme code:line) _datum ...)] typesets as 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
@scheme[defproc], etc.}
}
]
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]
declaration:
@itemize{
@itemize[
@item{If no @scheme[#:use-sources] clause is supplied, then the
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
the @scheme[declare-exporting] declaration.}
}
]
The initial @scheme[mod-path]s sequence can be empty if
@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
@scheme[pre-content] is further transformed:
@itemize{
@itemize[
@item{Any immediate @scheme['rsquo] is converted to @scheme['prime].}
@item{Parentheses and sequences of decimal digits in immediate
strings are left as-is, but any other immediate string is
italicized.}
}
]
Extensions to @scheme[math] are likely, such as recognizing @litchar{_}
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
as follows:
@itemize{
@itemize[
@item{A trailing ``ies'' is replaced by ``y''.}
@ -958,7 +958,7 @@ as follows:
@item{Consecutive hyphens and whitespaces are all replaced by a
single space.}
}
]
These normalization steps help support natural-language references
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
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
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
key (so that it's sorted using the string content).}
}}
]}
@defproc[(idefterm [pre-content any/c] ...) element?]{Combines
@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
the entry:
@itemize{
@itemize[
@item{@scheme[title] is the title of the cited work. It will be
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
omitted if given as @scheme[#f].}
}}
]}
@defproc[(bib-entry? [v any/c]) boolean?]{

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

@ -12,7 +12,7 @@
language provides everything from @scheme[scheme/base] with a few
changes that make it suitable as a preprocessor language:
@itemize{
@itemize[
@item{It uses @scheme[read-syntax-inside] to read the body of the
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
@scheme[output] function. This function displays most values
in a similar way to @scheme[display], except that it is more
convenient for a preprocessor output.}}
convenient for a preprocessor output.}]
}

4
collects/scribblings/scribble/reader.scrbl
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
resulting reader in several ways:
@itemize{
@itemize[
@item{@scheme[readtable] --- a readtable to base the @"@"-readtable
on.}
@ -937,7 +937,7 @@ resulting reader in several ways:
@item{@scheme[start-inside?] --- if true, creates a readtable for
use starting in text mode, instead of S-expression mode.}
}}
]}
@defproc[(use-at-readtable ...) void?]{

18
collects/scribblings/scribble/struct.scrbl
View File

@ -44,7 +44,7 @@ A @deftech{block} is either a @techlink{table}, an
@techlink{itemization}, @techlink{blockquote}, @techlink{paragraph},
or a @techlink{delayed block}.
@itemize{
@itemize[
@item{A @deftech{table} is an instance of @scheme[table]; it
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
a list of @techlink{elements}:
@itemize{
@itemize[
@item{An @deftech{element} can be a string, one of a few
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
allowed by the current renderer.
@itemize{
@itemize[
@item{A string element is included in the result
document verbatim, except for space, and
@ -160,14 +160,14 @@ A @deftech{block} is either a @techlink{table}, an
@techlink{render pass} of document
processing.}
}}}}
]}]}
@item{A @deftech{delayed block} is an instance of
@scheme[delayed-block], which has a procedure that
is called in the @techlink{resolve pass} of document
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
values (must be in a list) are as follows:
@itemize{
@itemize[
@item{@scheme['toc] --- sub-parts of the part are rendered on separate
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"]
as the @tt{id} for any document that it builds.}
}
]
The @scheme[to-collect] field contains @techlink{content} that is
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
@itemize{
@itemize[
@item{a string, which corresponds to a CSS class for HTML output and
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
style with a set of additional HTML attributes.}
}
]
The @scheme[content] field is a list of @techlink{elements}.

4
collects/scribblings/scribble/xref.scrbl
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
binding. The @scheme[binding] is specified in one of four ways:
@itemize{
@itemize[
@item{If @scheme[binding] is an identifier, then
@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
case.}
}
]
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