Preliminaries

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

Chapter 1: Setting Up

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

• Inbuild Control - Who shall supervise the supervisor? This section of code will.

Chapter 2: Conceptual Framework

• Genres - The different sorts of work managed by inbuild.

• Works - To store, hash code and compare title/author pairs used to identify works.

• Editions - An edition is a numbered version of a work.

• Copies - A copy is an instance in the file system of a specific edition of a work.

• Copy Errors - A copy error is attached to a copy when scanning it reveals some malformation.

• Requirements - A requirement is a way to specify some subset of works: for example, those with a given title, and/or version number.

• Nests - Nests are repositories of Inform-related resources.

• Registries - Registries are nests provided with metadata and intended to be presented as an online source from which Inform resources can be downloaded.

• JSON Metadata - Managing JSON-encoded metadata files for resources such as kits.

• Licences - A copy of any genre can in principle have a licence declaration attached to it.

Chapter 3: Incremental Builds

• Build Graphs - Graphs in which vertices correspond to files or copies, and edges to dependencies between them.

• Build Methodology - Whether to run tasks internally in some merged tool, or run via the shell, or simply trace to the standard output what we think ought to be done.

• Incremental Building - Deciding what is the least possible amount which needs to be built, in what order, to arrive at a working version of a copy.

• Build Scripts - Scripts are nothing more than lists of build steps.

• Build Steps - A build step is a task which exercises one of the build skills.

• Inter Skill - The skills of kit building and of code generation from Inter.

• Inform7 Skill - The skill of turning source text into Inter code.

• Inform6 Skill - The skill of compiling Inform 6 into a story file for the target VM.

• Inblorb Skill - The skill of packaging a story file and associated resources into a blorb.

Chapter 4: Genre Management

• Extension Manager - Claiming and creating copies of the extension genre: used for Inform 7 extensions.

• Extension Bundle Manager - Claiming and creating copies of the kit genre: used for kits of precompiled Inter code.

• Kit Manager - Claiming and creating copies of the kit genre: used for kits of precompiled Inter code.

• Language Manager - Claiming and creating copies of the language genre: used for bundles of natural language metadata in the Inform 7 compiler.

• Pipeline Manager - Claiming and creating copies of the pipeline genre: used for pipelines of code-generation stages.

• Project Bundle Manager - Claiming and creating copies of the projectbundle genre: used for Inform 7 projects as created by the GUI apps.

• Project File Manager - Claiming and creating copies of the projectfile genre: used for Inform 7 source texts stored as stand-alone plain text files, outside the GUI apps.

• Template Manager - Claiming and creating copies of the template genre: used for website and interpreter templates when releasing an Inform project.

Chapter 5: Genre Services

• Extension Services - Behaviour specific to copies of the extension genre.

• Kit Services - Behaviour specific to copies of the kit genre.

• Language Services - Behaviour specific to copies of the language genre.

• Pipeline Services - Behaviour specific to copies of the pipeline genre.

• Project Services - Behaviour specific to copies of either the projectbundle or projectfile genres.

• Template Services - Behaviour specific to copies of the template genre.

Chapter 6: Inform Source Text

• Source Text - Using the lexer and syntax analysis modules to read in Inform 7 source text.

• Headings - To keep track of the hierarchy of headings and subheadings found in the source text.

• The Options File - The optional file of Options applied to all of the user's projects.

• Inclusions - To fulfill requests to include extensions, adding their material to the parse tree as needed, and removing INCLUDE nodes.

• Control Structures - To specify the syntax of control structures such as repeat, if and otherwise.

• Virtual Machine Grammar - Grammar for parsing natural language descriptions of a virtual machine.

Chapter 7: Extension Management

• The Mini-Website - To refresh the mini-website of available extensions presented in the Inform GUI applications.

• Extensions Index Page - To generate the index page for the extension mini-website, which is the home page displayed in the Extensions tab for the Inform GUI apps.

• The Installer - To install or uninstall an extension into an Inform project, producing an HTML page as a report on what happened.

• The Converter - To convert an extension from the traditional one-file format to the more modern directory-based format.

• Documentation Compiler - To compile documentation from the textual syntax in an extension into a tree.

• Documentation Renderer - To render a passage of extension documentation as HTML.

• In-App Manuals - Adaptations to extension documentation for rendering inside the app.

• Making RTP Pages - To turn Markdown source into outcome or run-time-problem pages.

• Indexing Data - A set of compiled documentation has some notations for indexing, some categories for its index entries, and a collection of "lemmas", or entries.

• Index Terms - Hypothetical index entries with no references to position as yet.

• Index Lemmas - To scan a Markdown tree of documentation and accumulate a set of index lemmas.

• Index Markup Notations - Lemmas are marked up semantically using all sorts of notations.

• General Index - To render a documentation index into HTML form.

• Examples Index - To produces the contents and indexing pages, for HTML output and multiple-files mode only.