fine-tune typechecking index entry

svn: r12920

original commit: ec600c59bb9caa15f10fb68844677e56a4ce86dc
This commit is contained in:
Matthew Flatt 2008-12-21 13:57:46 +00:00
parent c77f08c015
commit 72c0651986

View File

@ -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?)]