• ★
• indoc 4

The documentation-formatter for the Inform 7 system.

• Preliminaries

  • Introduction to Indoc - What Indoc is, and its limited but complicated uses.

  • Volumes and Instructions - Dual- versus single-volume mode, and how to write instructions files.

  • Documentation Markup - How to mark up the plain-text source for Inform documentation.

• Chapter 1: Setting Up

  • Basics - Some fundamental definitions.

  • Main - The top level of the program.

  • Configuration - Instructions of indoc to different output types.

  • Instructions - Instructions of indoc to different output types.

  • Context Symbols - Provides conditional rendering of text, depending on context.

• Chapter 2: Processing

  • Structural Scan - Finding out how a volume divides up into chapters and sections.

  • Examples - Keeping track of the metadata on and sequencing of the examples.

  • Renderer - The general output apparatus for writing a block of documentation.

  • Rawtext Reader - Reading the rawtext in, breaking it up into blocks, and sending them for output as formatted documentation.

  • Updating the Cross-References - Writing the documentation cross-references to a file used by Inform's in-application documentation.

  • HTML and JavaScript - HTML utility code.

  • CSS - Cascading style sheets for HTML output.

• Chapter 3: Indexing

  • Indexing Utilities - Some conveniences shared by our different forms of index.

  • Contents and Indexes - To produce a general index, for HTML output only.

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

• Chapter 4: Navigation Styles

  • Navigational Designs - To render linking gadgets in HTML forms of documentation, so that the reader can navigate from section to section.

  • Codename Lacuna - The "lacuna" style of navigational gadgets, a plain text style with no navigational features at all.

  • Codename Midnight - The "midnight" style of navigational gadgets.

  • Codename Architect - The "architect" style of navigational gadgets.

  • Codename Twilight - The "twilight" style of navigational gadgets, a minimal version of "midnight".

  • Codename Roadsign - The "roadsign" style of navigational gadgets.

  • Codename Unsigned - The "unsigned" style of navigational gadgets.