commit 121dc93911a42d3cd9efe1b3772c5cf9a3f64387
parent 8e3ed2fcf4a909b85366c0f53c1ac3ec03059377
Author: Matthew Flatt <mflatt@racket-lang.org>
Date: Sun, 16 Dec 2007 03:10:00 +0000
change Scribble to complain about colliding tags
svn: r8025
original commit: fd1de94a484332ae57d648b83b32038011bace1b
Diffstat:
6 files changed, 26 insertions(+), 19 deletions(-)
diff --git a/collects/scribble/base-render.ss b/collects/scribble/base-render.ss
@@ -119,11 +119,11 @@
(hash-table-for-each (collect-info-ht p-ci)
(lambda (k v)
(when (cadr k)
- (hash-table-put! (collect-info-ht ci)
- (if prefix
- (convert-key prefix k)
- k)
- v)))))))
+ (collect-put! ci
+ (if prefix
+ (convert-key prefix k)
+ k)
+ v)))))))
(define/private (convert-key prefix k)
(case (car k)
diff --git a/collects/scribble/manual.ss b/collects/scribble/manual.ss
@@ -780,7 +780,7 @@
(table? (car (splice-run box)))
(eq? 'boxed (table-style (car (splice-run box)))))
(error 'deftogether "element is not a boxing splice containing a single table: ~e" box))
- (list (make-flow (list (make-table #f (table-flowss (car (splice-run box))))))))
+ (list (make-flow (list (make-table "together" (table-flowss (car (splice-run box))))))))
boxes))
(parameterize ([current-variable-list
(apply append (map box-splice-var-list boxes))])
diff --git a/collects/scribble/scribble.css b/collects/scribble/scribble.css
@@ -253,6 +253,10 @@
background-color: #E8E8FF;
}
+ .together {
+ width: 100%;
+ }
+
.prototype td {
vertical-align: top;
}
diff --git a/collects/scribble/struct.ss b/collects/scribble/struct.ss
@@ -15,9 +15,12 @@
(define (collect-put! ci key val)
- (hash-table-put! (collect-info-ht ci)
- key
- val))
+ (let ([ht (collect-info-ht ci)])
+ (when (hash-table-get ht key #f)
+ (fprintf (current-error-port)
+ "WARNING: collected information for key multiple times: ~e\n"
+ key))
+ (hash-table-put! ht key val)))
(define (resolve-get/where part ri key)
(let ([key (tag-key key ri)])
diff --git a/collects/scribblings/scribble/how-to.scrbl b/collects/scribblings/scribble/how-to.scrbl
@@ -49,7 +49,7 @@ EOS
@item{Run @exec{setup-plt} to build your documentation. For a
collection, optionally supply @Flag{l} followed by the
- collection name to limit the build process to the collection.}
+ collection name to limit the build process to that collection.}
@item{The generated documentation is
@filepath{compiled/doc/manual/index.html} within the
@@ -57,9 +57,9 @@ EOS
If you want the output to be relative to the PLT Scheme
documentation directory (which is recommend only for those who
- produce the ``official'' PLT Scheme distribution), add the
- @scheme['main-doc] option to the @scheme[scribblings]
- definition in @filepath{info.ss}.}
+ produce the ``official'' PLT Scheme distribution, and even
+ then only in certain cases), add the @scheme['main-doc] option
+ to the @scheme[scribblings] definition in @filepath{info.ss}.}
}
@@ -92,14 +92,14 @@ one must be present. No spaces are allowed between
A @nonterm{cmd} or @nonterm{datum} is a Scheme datum, while a
@nonterm{text-body} is itself in text mode.
-The expansion of a @litchar["@"] form into Scheme code is
+The expansion of @litchar["@"]@nonterm{cmd} into Scheme code is
@schemeblock[
- @nonterm{cmd}
+ #, @nonterm{cmd}
]
-if neither @litchar["["] @litchar["]"] nor @litchar["{"] @litchar["}"]
-are used, otherwise
+When either @litchar["["] @litchar["]"] or @litchar["{"] @litchar["}"]
+are used, the expansion is
@schemeblock[
(#, @nonterm{cmd} #, @kleenestar{@nonterm{datum}} #, @kleenestar{@nonterm{parsed-body}})
diff --git a/collects/scribblings/scribble/manual.scrbl b/collects/scribblings/scribble/manual.scrbl
@@ -662,7 +662,7 @@ output, a hyperlink underline appears even when the mouse is not over
the link.}
@; ------------------------------------------------------------------------
-@section{Indexing}
+@section[#:tag "manual-indexing"]{Indexing}
@defform[(indexed-scheme datum ...)]{
@@ -801,7 +801,7 @@ correspond to the documented name of the binding and the primary
modules that export the documented name (but this list is not
exhaustive, because new modules can re-export the binding).}
-@defstruct[(procedure-index-desc exported-index-desc) ()]{
+@defstruct[(form-index-desc exported-index-desc) ()]{
Indicates that the index entry corresponds to the definition of a
syntactic form via @scheme[defform] and company.}
