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

scribble manual section 2 edits

Browse Source 
svn: r8246

original commit: 14fa3351f185d130c06ad456ad895a1441858fa1
This commit is contained in:
Matthew Flatt 2008-01-07 13:00:44 +00:00
parent 9c7e96a14c
commit 9b95d8fc0c
1 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
collects/scribblings/scribble/layers.scrbl
View File

@ -22,7 +22,7 @@ scribble/doc
Besides making the file a module, this declaration selects the Besides making the file a module, this declaration selects the
Scribble reader (instead of the usual Scheme reader), and it starts Scribble reader (instead of the usual Scheme reader), and it starts
the body of the in ``text'' mode. The reader layers mostly leaves text the body of the in ``text'' mode. The reader layer mostly leaves text
alone, but @litchar["@"] forms can escape to S-expression mode. alone, but @litchar["@"] forms can escape to S-expression mode.
A module written as A module written as
@ -90,7 +90,7 @@ The value bound to @scheme[doc] in the example above is something like
@schemeblock[ @schemeblock[
(make-part .... (make-part ....
(list "To Be" " or Not " "To Be") (list "To Be" " or Not " "To Be") (code:comment "title")
.... ....
(make-flow (make-flow
(list (list
@ -104,15 +104,14 @@ The value bound to @scheme[doc] in the example above is something like
Notice that @litchar{'tis} in the input has turned into Notice that @litchar{'tis} in the input has turned into
@scheme['rsquo] (a curly apostrophe) followed by @scheme["tis"]. The @scheme['rsquo] (a curly apostrophe) followed by @scheme["tis"]. The
conversion to use @scheme['rsquo] was performed by @scheme[decode] via conversion to use @scheme['rsquo] was performed by @scheme[decode] via
@scheme[decode-flow] to @scheme[decode-paragraph] to @scheme[decode-flow] via @scheme[decode-paragraph] via
@scheme[decode-content] to @scheme[decode-string]. @scheme[decode-content] via @scheme[decode-string].
The boldface ``That'' as @scheme[(make-element 'bold (list "That"))], In contrast, @scheme[(make-element 'bold (list "That"))] was produced
in contrast, was produced by the @scheme[bold] function. The by the @scheme[bold] function. The @scheme[decode] operation is a
@scheme[decode] operation is a function, not a syntactic form, and so function, not a syntactic form, and so @scheme[bold] has control over
@scheme[bold] has control over its argument before @scheme[decode] its argument before @scheme[decode] sees the result. Also, decoding
sees the result. Also, decoding traverses only immediate string traverses only immediate string arguments.
arguments.
As it turns out, @scheme[bold] also decodes its argument, because the As it turns out, @scheme[bold] also decodes its argument, because the
@scheme[bold] function is implemented as @scheme[bold] function is implemented as
@ -122,12 +121,12 @@ As it turns out, @scheme[bold] also decodes its argument, because the
(make-element 'bold (decode-content strs))) (make-element 'bold (decode-content strs)))
] ]
The @scheme[verbatim] function, in contrast, does not decode its The @scheme[verbatim] function, however, does not decode its content,
content, and instead typesets its text arguments directly. and instead typesets its text arguments directly.
A document can construct elements directly using A document module can construct elements directly using
@scheme[make-element], but normally functions like @scheme[bold] and @scheme[make-element], but normally functions like @scheme[bold] and
@scheme[verbatim] to construct them. In particular, the @scheme[verbatim] are used to construct them. In particular, the
@schememodname[scribble/manual] library provides many functions and @schememodname[scribble/manual] library provides many functions and
forms to typeset elements and flow elements. forms to typeset elements and flow elements.