Preliminaries

• What This Module Does - An overview of the index module's role and abilities.

Chapter 1: Starting Up

• Index Module - Setting up the use of this module.

• Indexing API - How the parent tool can ask for an Inter tree to be indexed.

Chapter 2: Utilities

• Index Locations - To provide routines to help build the various HTML index files, none of which are actually created in this section.

• Index Interpreter - An index is generated by interpreting an index structure file.

• Styles and Scripts - CSS and Javascripts embedded into the body of index pages.

• Index Utilities - Miscellaneous utility functions for producing index content.

• Index Rules - Utility functions for indexing rules, rulebooks and activities.

• Lexicon - A lexicon for nouns, adjectives and verbs found in an Inter tree.

• Faux Instances - Some of the more complicated indexing tasks need to build data structures cross-referencing the instance packages in the Inter tree: the spatial map, in particular. For convenience, we create faux-instance objects for them, which partly correspond to the instance objects in the original compiler.

• Faux Scenes - Creating a simple graph of scenes, ends and connectors.

Chapter 3: Elements

• The Periodic Table - The index is divided up into 'elements'.

• Alphabetic Element - To write the Alphabetic actions element (A2) in the index.

• Arithmetic Element - To write the Arithmetic element (Ar) in the index.

• Behaviour Element - To write the Behaviour element (Bh) in the index.

• Card Element - To write the Library Card element (Cd) in the index.

• Chart Element - To write the Chart element (Ch) in the index.

• Commands Element - To write the Commands element (Cm) in the index.

• Contents Element - To write the Contents element (C) in the index.

• Events Element - To write the Events element (Ev) in the index.

• Extras Element - To write the Extras element (Xt) in the index.

• Figures Element - To write the Figures element (Fi) in the index.

• Gazetteer Element - To write the Gazetteer element (Gz) in the index.

• Grouped Element - To write the Grouped actions element (A1) in the index, and also the detailed per-action pages linked from it.

• Innards Element - To write the Innards element (In) in the index.

• Lexicon Element - To write the Lexicon element (Lx) in the index.

• Map Element - To write the Map element (Mp) in the index.

• Phrasebook Element - To write the Phrasebook element (Pb) in the index.

• Plot Element - To write the Plot element (Pl) in the index.

• Relations Element - To write the Relations element (Rl) in the index.

• Rules for Scenes Element - To write the Rules for Scenes element (RS) in the index.

• Standards Element - To write the Standards element (St) in the index.

• Tables Element - To write the Tables element (Tb) in the index.

• Tokens Element - To write the Tokens element (To) in the index.

• Values Element - To write the Values element (Vl) in the index.

• Verbs Element - To write the Verbs element (Vb) in the index.

Chapter 4: Spatial Mapping

• Map Configuration - To manage configuration parameters for the EPS and HTML maps.

• Spatial Geometry - Simple mathematical functions for dealing with vectors and cuboids in a three-dimensional integer lattice.

• Spatial Map - To fit the map of the rooms in the game into a cubical grid, preserving distances and angles where possible, and so to give each room approximate coordinate locations.

• Render HTML Map - To render the spatial map of rooms as HTML.

• Render EPS Map - To render the spatial map of rooms as an EPS (Encapsulated PostScript) file.