bkyk8rc3zvpnsf5inmcqq4n3k98cv6hj-my-site-hyper-literate-git.test.suzanne.soy-0.0.1

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

book-index.scrbl (1175B)

      1 #lang scribble/manual
      2 @(require (for-label scribble/core
      3                      racket/base
      4                      scriblib/book-index))
      5 
      6 @title[#:tag "book-index"]{Book-Style Indexing}
      7 
      8 @defmodule[scriblib/book-index]{Provides a list of style properties to
      9 attach to a Scribble document that contains an index part, making the
     10 index more suitable for a traditional rendering on paper. The style
     11 properties cause index entries to be merged when they have the same
     12 content, with (potentially) multiple page numbers attached to the
     13 merged entry.}
     14 
     15 @defthing[book-index-style-properties list?]{
     16 
     17 Combine these style properties with others for the style of a part
     18 (typically specified in @racket[title]) for a document that contains
     19 an index. The style properties enable index merging and select an
     20 implementation based on the @tt{cleveref} Latex package.
     21 
     22 Example:
     23 
     24 @codeblock[#:keep-lang-line? #t]|{
     25 #lang scribble/base
     26 @(require scriblib/book-index
     27           (only-in scribble/core make-style))
     28 
     29 @title[#:style (make-style #f book-index-style-properties)]{Demo}
     30 
     31 This paragraph is about @as-index{examples}.
     32 
     33 This paragraph is about @as-index{examples}, too.
     34 
     35 @index-section[]}|}