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

more Scribble "---" doc fixes

Browse Source
This commit is contained in:
Matthew Flatt 2010-12-14 07:45:15 -07:00
parent 0b1b3772f5
commit 78b54a7324
3 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
collects/scribblings/scribble/base.scrbl
View File

@ -233,7 +233,7 @@ beginning of each line.
The @racket[str]s are @emph{not} decoded with @racket[decode-content], The @racket[str]s are @emph{not} decoded with @racket[decode-content],
so @racket[(verbatim "---")] renders with three hyphens instead of an so @racket[(verbatim "---")] renders with three hyphens instead of an
em-dash. Beware, however, that @emph{reading} em dash. Beware, however, that @emph{reading}
@litchar["@"]@racket[verbatim] converts @litchar["@"] syntax @litchar["@"]@racket[verbatim] converts @litchar["@"] syntax
within the argument, and such reading occurs well before within the argument, and such reading occurs well before
arguments to @racket[verbatim] are delivered at run-time. To disable simple arguments to @racket[verbatim] are delivered at run-time. To disable simple

8
collects/scribblings/scribble/how-to-paper.scrbl
View File

@ -101,10 +101,8 @@ Add more text to @filepath{mouse.scrbl} so that it looks like this:
of the second @racket[section] call, has a single paragraph. of the second @racket[section] call, has a single paragraph.
Run the @exec{scribble} command(s) from @secref["first-example"] Run the @exec{scribble} command(s) from @secref["first-example"]
again. You may notice the curly double-quotes in the output; in PDF again. You may notice the curly double-quotes in the output, and
output, the @litchar{---} turned into an em-dash. For HTML, it turned the @litchar{---} turned into an em dash.
into a en-dash with surrounding spaces, which is a typical convention
for em-dashes in HTML.
@;---------------------------------------- @;----------------------------------------
@section{Splitting the Document Source} @section{Splitting the Document Source}
@ -526,7 +524,7 @@ recognized by @racket[decode].
A different but related @defterm{content decoding} takes place within A different but related @defterm{content decoding} takes place within
a paragraph or section title. Content decoding is responsible for a paragraph or section title. Content decoding is responsible for
converting @litchar{---} to an em-dash or for converting @litchar{"} converting @litchar{---} to an em dash or for converting @litchar{"}
and @litchar{'} to suitable curly quotes. and @litchar{'} to suitable curly quotes.
The decoding process for document's stream is ultimately determined by The decoding process for document's stream is ultimately determined by

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

@ -125,9 +125,8 @@ Refrain from referring to documentation ``above'' or ``below,'' and
instead have a hyperlink point to the right place. instead have a hyperlink point to the right place.
In prose, use @litchar{``} and @litchar{''} quotation marks instead of In prose, use @litchar{``} and @litchar{''} quotation marks instead of
@litchar{"}. Use @litchar{---} for an em-dash, and do not include @litchar{"}. Use @litchar{---} for an em dash, and do not include
spaces on either side, though it will typeset as an en-dash and spaces spaces on either side. Use American style for quotation marks and punctuation
in HTML output. Use American style for quotation marks and punctuation
@; [Eli] BTW, I've asked several people about this, and the general @; [Eli] BTW, I've asked several people about this, and the general
@; agreement that I've seen is that this is a rather arbitrary rule @; agreement that I've seen is that this is a rather arbitrary rule
@; and there's no harm in doing the more logical thing of putting @; and there's no harm in doing the more logical thing of putting