From 72c065198695dc2e7622d764335dc350ae4beebb Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Sun, 21 Dec 2008 13:57:46 +0000 Subject: [PATCH] fine-tune typechecking index entry svn: r12920 original commit: ec600c59bb9caa15f10fb68844677e56a4ce86dc --- collects/scribblings/scribble/basic.scrbl | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/collects/scribblings/scribble/basic.scrbl b/collects/scribblings/scribble/basic.scrbl index fab7f608..d4a6131c 100644 --- a/collects/scribblings/scribble/basic.scrbl +++ b/collects/scribblings/scribble/basic.scrbl @@ -189,7 +189,13 @@ strings for a hierarchy, such as @scheme['("strings" "plain")] for a the strings are ``cleaned'' using @scheme[clean-up-index-strings]. The strings (without clean-up) also serve as the text to render in the index. The @tech{decode}d @scheme[pre-content] is the text to appear -inline as the index target.} +inline as the index target. + +Use @scheme[index] when an index entry should point to a specific word +or phrase within the typeset document (i.e., the +@scheme[pre-content]). Use @scheme[section-index], instead, to create +an index entry that leads to a section, instead of a specific word or +phrase within the section.} @defproc[(index* [words (listof string?)]