@u1f992/vivliostyle-index

unified plugin that integrates automatic index generation into Vivliostyle CLI workflows.

This project seeks to align with the requirements presented in 藤田節子's『本の索引の作り方』(地人書館) and SIST 13　索引作成.

Usage

The basic concept is to embed index manipulation commands in the data-index attribute using the format func,args....

The command body is a YAML list with top-level brackets omitted. Token and escaping rules follow YAML conventions, plus HTML attribute character encoding. For most words as headings, simply use foobar, but for example, to make null a heading word, write "null", which becomes "null".

| Format | Description | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | (page,)<id>,<heading> | Adds a locator (page). Creates the index and heading specified by <id> and <heading> if they don't exist ((page,) must always be omitted). | | page!,<id>,<heading> | Adds a high-importance locator (page). Creates the index and heading specified by <id> and <heading> if they don't exist. | | range,<id>,<heading>,<rangeId> | Starts a locator (range). Not added to the index until properly closed. | | range!,<id>,<heading>,<rangeId> | Starts a high-importance locator (range). Not added to the index until properly closed. | | /range,<rangeId> | Closes the corresponding locator (range) and adds it to the index. Creates the index and heading specified by <id> and <heading> from range/range! if they don't exist. | | see,<id>,<heading>,<target> | Adds a "see" reference. Creates the index and heading specified by <id> and <heading> if they don't exist, but <target> is not automatically created. | | seeAlso,<id>,<heading>,<target> | Adds a "see also" reference. Creates the index and heading specified by <id> and <heading> if they don't exist, but <target> is not automatically created. | | expand,<id> | Expands the index specified by <id> as a child of this element. |

Furthermore, <heading> and <target> follow the format [Key, Key] | [Key, Key, Key] where type Key = null | string | [null, string] | [string, string]. The basic form of Key is a tuple consisting of the heading's innerHTML (JSON representation of hast.Element.children: hast.ElementContent[]) and reading for sorting. When the heading is null, the innerHTML of the element with the data-index attribute is used. null | string should be considered as a tuple with the reading omitted. In this case, after collecting all index items, the reading is supplemented from existing items with matching innerText, or if none exist, the innerText of key[0] is used as the reading. Taking two Keys corresponds to group heading and main heading, while three Keys correspond to group heading, main heading, and subheading.