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

371.3

Browse Source 
svn: r7350

original commit: 001404dec0ddf49e774ecac33df6601c4e1b542c
This commit is contained in:
Matthew Flatt 2007-09-15 22:27:14 +00:00
parent 2f1dc42b9d
commit 9a88fa516c
3 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
collects/scribble/doc/lang/reader.ss Normal file
View File

@ -0,0 +1,4 @@
(module reader mzscheme
(require (prefix doc: (lib "docreader.ss" "scribble")))
(provide (rename doc:read read)
(rename doc:read-syntax read-syntax)))

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

@ -1,4 +1,4 @@
#reader(lib "docreader.ss" "scribble") #lang scribble/doc
@require[(lib "manual.ss" "scribble") @require[(lib "manual.ss" "scribble")
(lib "bnf.ss" "scribble")] (lib "bnf.ss" "scribble")]
@require["utils.ss"] @require["utils.ss"]
@ -18,7 +18,7 @@ To document a collection or @|PLaneT| package:
@item{Start @file{manual.scrbl} like this: @item{Start @file{manual.scrbl} like this:
@verbatim[#<<EOS @verbatim[#<<EOS
#reader(lib "docreader.ss" "scribble") #lang scribble/doc
@begin[(require (lib "manual.ss" "scribble"))] @begin[(require (lib "manual.ss" "scribble"))]
@title{My Library} @title{My Library}
@ -125,7 +125,7 @@ means
For more information on the syntax of @litchar["@"], see For more information on the syntax of @litchar["@"], see
@secref["reader"]. @secref["reader"].
In a document that starts @tt{#reader(lib "docreader.ss" "scribble")}, In a document that starts @tt{#lang scribble/doc},
the top level is a text-mode sequence. The parsed sequence is further the top level is a text-mode sequence. The parsed sequence is further
decoded to turn it into a hierarchy of sections and paragraphs. For decoded to turn it into a hierarchy of sections and paragraphs. For
example, a linear sequence of @scheme[section] declarations with example, a linear sequence of @scheme[section] declarations with
@ -161,7 +161,7 @@ document. Such links require no information about where and how a
binding is documented elsewhere: binding is documented elsewhere:
@verbatim[#<<EOS @verbatim[#<<EOS
#reader(lib "docreader.ss" "scribble") #lang scribble/doc
@begin[(require (lib "manual.ss" "scribble")) @begin[(require (lib "manual.ss" "scribble"))
(require-for-label (lib "lang.ss" "big"))] (require-for-label (lib "lang.ss" "big"))]
@ -177,7 +177,7 @@ so it ignores the source formatting of the expression. The
and it preserves the expression's formatting from the document source. and it preserves the expression's formatting from the document source.
@verbatim[#<<EOS @verbatim[#<<EOS
#reader(lib "docreader.ss" "scribble") #lang scribble/doc
@begin[(require (lib "manual.ss" "scribble")) @begin[(require (lib "manual.ss" "scribble"))
(require-for-label (lib "lang.ss" "big"))] (require-for-label (lib "lang.ss" "big"))]
@ -208,7 +208,7 @@ hyperlink with text other than the section title.
The following example illustrates section hyperlinks: The following example illustrates section hyperlinks:
@verbatim[#<<EOS @verbatim[#<<EOS
#reader(lib "docreader.ss" "scribble") #lang scribble/doc
@begin[(require (lib "manual.ss" "scribble")) @begin[(require (lib "manual.ss" "scribble"))
(require-for-label (lib "lang.ss" "big"))] (require-for-label (lib "lang.ss" "big"))]
@ -248,7 +248,7 @@ following example links to a section in the PLT Scheme reference
manual: manual:
@verbatim[#<<EOS @verbatim[#<<EOS
#reader(lib "docreader.ss" "scribble") #lang scribble/doc
@begin[(require (lib "manual.ss" "scribble")) @begin[(require (lib "manual.ss" "scribble"))
(require-for-label (lib "lang.ss" "big")) (require-for-label (lib "lang.ss" "big"))
(define ref-src (define ref-src
@ -281,7 +281,7 @@ of @file{helper.ss}. Then use @scheme[defproc] to document the
procedure: procedure:
@verbatim[#<<EOS @verbatim[#<<EOS
#reader(lib "docreader.ss" "scribble") #lang scribble/doc
@begin[(require (lib "manual.ss" "scribble")) @begin[(require (lib "manual.ss" "scribble"))
(require-for-label (lib "lang.ss" "big") (require-for-label (lib "lang.ss" "big")
"helper.ss")] "helper.ss")]
@ -349,7 +349,7 @@ from the previous section, then @file{helper.ss} must be imported both
via @scheme[require-for-label] and @scheme[require]: via @scheme[require-for-label] and @scheme[require]:
@verbatim[#<<EOS @verbatim[#<<EOS
#reader(lib "docreader.ss" "scribble") #lang scribble/doc
@begin[(require (lib "manual.ss" "scribble") @begin[(require (lib "manual.ss" "scribble")
(lib "eval.ss" "scribble") ; <--- added (lib "eval.ss" "scribble") ; <--- added
"helper.ss") ; <--- added "helper.ss") ; <--- added
@ -383,7 +383,7 @@ as a sub-part of the enclosing part.
In @file{manual.scrbl}: In @file{manual.scrbl}:
@verbatim[#<<EOS @verbatim[#<<EOS
#reader(lib "docreader.ss" "scribble") #lang scribble/doc
@begin[(require (lib "manual.ss" "scribble"))] @begin[(require (lib "manual.ss" "scribble"))]
@title{My Library} @title{My Library}
@ -396,7 +396,7 @@ EOS
In @file{cows.scrbl}: In @file{cows.scrbl}:
@verbatim[#<<EOS @verbatim[#<<EOS
#reader(lib "docreader.ss" "scribble") #lang scribble/doc
@begin[(require (lib "manual.ss" "scribble"))] @begin[(require (lib "manual.ss" "scribble"))]
@title{Cows} @title{Cows}
@ -408,7 +408,7 @@ EOS
In @file{aardvarks.scrbl}: In @file{aardvarks.scrbl}:
@verbatim[#<<EOS @verbatim[#<<EOS
#reader(lib "docreader.ss" "scribble") #lang scribble/doc
@begin[(require (lib "manual.ss" "scribble")) @begin[(require (lib "manual.ss" "scribble"))
(require-for-label (lib "lang.ss" "big") (require-for-label (lib "lang.ss" "big")
"helper.ss")] "helper.ss")]
@ -440,7 +440,7 @@ sub-sections.
Revising @file{cows.scrbl} from the previous section: Revising @file{cows.scrbl} from the previous section:
@verbatim[#<<EOS @verbatim[#<<EOS
#reader(lib "docreader.ss" "scribble") #lang scribble/doc
@begin[(require (lib "manual.ss" "scribble"))] @begin[(require (lib "manual.ss" "scribble"))]
@title[#:style '(toc)]{Cows} @title[#:style '(toc)]{Cows}

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

@ -1,4 +1,4 @@
#reader(lib "docreader.ss" "scribble") #lang scribble/doc
@require[(lib "manual.ss" "scribble")] @require[(lib "manual.ss" "scribble")]
@require[(lib "bnf.ss" "scribble")] @require[(lib "bnf.ss" "scribble")]
@require["utils.ss"] @require["utils.ss"]