|
|
Scribe 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 name) | Scribe function |
Declares a new index. It is an error to declare an already existing index.
Note that Scribe automatically declares one global index
named theindex. So, for documents requiring one unique index,
there is no need to use the make-index function call at all.
For instance, the following Scribe 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 document
function.
| (index [:index #f] [:note #f] [:shape #f] name) | Scribe function |
Adds a new entry into one existing index and set 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.
| argument | description |
|---|
| :index | The name of the index whose index entry belongs to. A value
of #f means that the theindex owns
this entry. |
| :note | An optional note added to the index entry. This note will be
displayed in the index printing. |
| :shape | An optional shape to be used for rendering the entry. |
| name | The name of the entry. This must be either a string
or a list of strings. |
The following expressions add entries to the index index1:
[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")
...] |
There is no output associated with these expressions.
The identifier Foo is 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
...
| (print-index [:split #t] [:char-offset 0] [:header-limit 100] . indexes) | Scribe function |
Prints indexes.
| argument | description |
|---|
| :split | If #t, character based sectioning is deployed.
Otherwise all the index entries are displayed one next to the other. |
| :char-offset | The character number to use when split is required.
This option may be useful when printing index whose items share a common
prefix. The :char-offset argument can be used to skip this
prefix. |
| :header-limit | The number of entries from which an index header
is introduced. |
| indexes | The name of the indexes to be displayed. If no name
is provided, the global index theindex is printed. |
The example:
produces:
|