5. Skribilo User Manual — Indexes
Skribe support indexes. One may accumulate all entries inside one unique index or dispatch them amongst user declared indexes. Indexes may be monolithic or split. They only differ in the way they are rendered by the back-ends. For a split index a sectioning based on the specific (e.g., "the first one") character of index entries is deployed.
make-index declares a new index.
identA string, the name the index (currently unused).
For instance, the following Skribe expression declares an index named *index1*:
This example produces no output but enables entries to be added to that
index. In general it is convenient to declare indexes before
the call to the
default-index returns the default index
that pre-exists to all execution.
index adds a new entry into one existing
index and sets a mark in the text where the index will point to. It is
an error to add an entry into an index that is not already declared.
(index [:url] [:shape] [:index] [:note] [:class
nameThe name of the entry. This must be a string.
The following expressions add entries to the index
[The identifier ,(code "Foo"),(index :index *index1* "Foo") is a usually used as an example. When two identifiers have to used, frequently the second choice is ,(code "Bar"),(index :index *index1* "Bar" :shape (it "Bar")). When three are needed, some use ,(code "Baz") ,(index :index *index1* "Baz" :shape (it "Baz")). This illustrates how to use identifier ,(index :index *index1* "Foo" :note "How to use Foo") ,(index :index *index1* "Foo" :note "How not to use Foo") ,(index :index *index1* "Fooz") ...]
Foois a usually used as an example. When two identifiers have to used, frequently the second choice is
Bar. When three are needed, some use
Baz. This illustrates how to use identifier ...
There is no output associated with these expressions.
the-index displays indexes in the produced
0] [:split] [:class
index...The indexes to be displayed. If index is provided, the global index default-index is printed.
If the engine custom
index-page-ref is true when a
index is rendered then, page reference framework is used instead of
a direct reference framework.
See the Skribe [?mark global index: ./index.skb:127:21:] for a real life index example.