commit 60d174526e6006c5c1d4d9a06186bacb5bd803a9
parent ffcd5323201f67c5b5fb7f1fbe3d368744235643
Author: Matthew Flatt <mflatt@racket-lang.org>
Date: Mon, 17 Jan 2011 16:23:46 -0700
Scribble docs: clarify 'hidden v.s 'toc-hidden and "on this page"
Closes PR 11554
original commit: 0e0f88be00fc4a62d8f49061a06b9c4d1f444d75
Diffstat:
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/collects/scribblings/scribble/core.scrbl b/collects/scribblings/scribble/core.scrbl
@@ -340,10 +340,11 @@ The recognized @tech{style properties} are as follows:
normally shows only the top-level sections).}
@item{@racket['hidden] --- The part title is not shown in rendered
- HTML output.}
+ HTML output. The @racket['toc-hidden] style usually should be
+ included with @racket['hidden].}
@item{@racket['toc-hidden] --- The part title is not shown in tables
- of contents.}
+ of contents, including in ``on this page'' boxes.}
@item{@racket['quiet] --- In HTML output and most other output modes,
hides entries for sub-parts of this part in a