mirror of
https://github.com/ganelson/inform.git
synced 2024-07-03 07:24:58 +03:00
309 lines
14 KiB
HTML
309 lines
14 KiB
HTML
<html>
|
|
<head>
|
|
<title>index</title>
|
|
<link href="../docs-assets/Breadcrumbs.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<meta name="viewport" content="width=device-width initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta http-equiv="Content-Language" content="en-gb">
|
|
|
|
<link href="../docs-assets/Contents.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<link href="../docs-assets/Progress.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<link href="../docs-assets/Navigation.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<link href="../docs-assets/Fonts.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<link href="../docs-assets/Base.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
|
|
</head>
|
|
<body class="commentary-font">
|
|
<nav role="navigation">
|
|
<h1><a href="../index.html">
|
|
<img src="../docs-assets/Inform.png" height=72">
|
|
</a></h1>
|
|
<ul><li><a href="../compiler.html">compiler tools</a></li>
|
|
<li><a href="../other.html">other tools</a></li>
|
|
<li><a href="../extensions.html">extensions and kits</a></li>
|
|
<li><a href="../units.html">unit test tools</a></li>
|
|
</ul><h2>Compiler Webs</h2><ul>
|
|
<li><a href="../inbuild/index.html">inbuild</a></li>
|
|
<li><a href="../inform7/index.html">inform7</a></li>
|
|
<li><a href="../inter/index.html">inter</a></li>
|
|
</ul><h2>Inbuild Modules</h2><ul>
|
|
<li><a href="../supervisor-module/index.html">supervisor</a></li>
|
|
</ul><h2>Inform7 Modules</h2><ul>
|
|
<li><a href="../core-module/index.html">core</a></li>
|
|
<li><a href="../assertions-module/index.html">assertions</a></li>
|
|
<li><a href="../values-module/index.html">values</a></li>
|
|
<li><a href="../knowledge-module/index.html">knowledge</a></li>
|
|
<li><a href="../imperative-module/index.html">imperative</a></li>
|
|
<li><a href="../runtime-module/index.html">runtime</a></li>
|
|
<li><a href="../if-module/index.html">if</a></li>
|
|
<li><a href="../multimedia-module/index.html">multimedia</a></li>
|
|
<li><span class="unlink">index</span></li>
|
|
</ul><h2>Inter Modules</h2><ul>
|
|
<li><a href="../bytecode-module/index.html">bytecode</a></li>
|
|
<li><a href="../building-module/index.html">building</a></li>
|
|
<li><a href="../pipeline-module/index.html">pipeline</a></li>
|
|
<li><a href="../final-module/index.html">final</a></li>
|
|
</ul><h2>Services</h2><ul>
|
|
<li><a href="../arch-module/index.html">arch</a></li>
|
|
<li><a href="../calculus-module/index.html">calculus</a></li>
|
|
<li><a href="../html-module/index.html">html</a></li>
|
|
<li><a href="../inflections-module/index.html">inflections</a></li>
|
|
<li><a href="../kinds-module/index.html">kinds</a></li>
|
|
<li><a href="../linguistics-module/index.html">linguistics</a></li>
|
|
<li><a href="../problems-module/index.html">problems</a></li>
|
|
<li><a href="../syntax-module/index.html">syntax</a></li>
|
|
<li><a href="../words-module/index.html">words</a></li>
|
|
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</a></li>
|
|
|
|
</ul>
|
|
</nav>
|
|
<main role="main">
|
|
<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="../compiler.html">Inter Modules</a></li><li><b>index</b></li></ul>
|
|
<p class="purpose">Generating the index for an Inform project. This is version 1.</p>
|
|
<hr>
|
|
<div class="contentspage">
|
|
<ul class="chapterlist">
|
|
<li>
|
|
<p class="chapterentry"><a name="P"></a>
|
|
<span class="chaptertitle">Preliminaries</span></p>
|
|
<ul class="sectionlist">
|
|
<li>
|
|
<p class="sectionentry"><a href="P-wtmd.html">
|
|
<spon class="sectiontitle">What This Module Does</span></a> -
|
|
<span class="sectionpurpose">An overview of the index module's role and abilities.</span></p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p class="chapterentry"><a name="1"></a>
|
|
<span class="chaptertitle">Chapter 1: Starting Up</span></p>
|
|
<ul class="sectionlist">
|
|
<li>
|
|
<p class="sectionentry"><a href="1-im.html">
|
|
<spon class="sectiontitle">Index Module</span></a> -
|
|
<span class="sectionpurpose">Setting up the use of this module.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="1-ia.html">
|
|
<spon class="sectiontitle">Indexing API</span></a> -
|
|
<span class="sectionpurpose">How the parent tool can ask for an Inter tree to be indexed.</span></p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p class="chapterentry"><a name="2"></a>
|
|
<span class="chaptertitle">Chapter 2: Utilities</span></p>
|
|
<ul class="sectionlist">
|
|
<li>
|
|
<p class="sectionentry"><a href="2-il.html">
|
|
<spon class="sectiontitle">Index Locations</span></a> -
|
|
<span class="sectionpurpose">To provide routines to help build the various HTML index files, none of which are actually created in this section.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="2-ii.html">
|
|
<spon class="sectiontitle">Index Interpreter</span></a> -
|
|
<span class="sectionpurpose">An index is generated by interpreting an index structure file.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="2-sas.html">
|
|
<spon class="sectiontitle">Styles and Scripts</span></a> -
|
|
<span class="sectionpurpose">CSS and Javascripts embedded into the body of index pages.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="2-iu.html">
|
|
<spon class="sectiontitle">Index Utilities</span></a> -
|
|
<span class="sectionpurpose">Miscellaneous utility functions for producing index content.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="2-ir.html">
|
|
<spon class="sectiontitle">Index Rules</span></a> -
|
|
<span class="sectionpurpose">Utility functions for indexing rules, rulebooks and activities.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="2-lxc.html">
|
|
<spon class="sectiontitle">Lexicon</span></a> -
|
|
<span class="sectionpurpose">A lexicon for nouns, adjectives and verbs found in an Inter tree.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="2-fi.html">
|
|
<spon class="sectiontitle">Faux Instances</span></a> -
|
|
<span class="sectionpurpose">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.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="2-fs.html">
|
|
<spon class="sectiontitle">Faux Scenes</span></a> -
|
|
<span class="sectionpurpose">Creating a simple graph of scenes, ends and connectors.</span></p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p class="chapterentry"><a name="3"></a>
|
|
<span class="chaptertitle">Chapter 3: Elements</span></p>
|
|
<ul class="sectionlist">
|
|
<li>
|
|
<p class="sectionentry"><a href="3-tpt.html">
|
|
<spon class="sectiontitle">The Periodic Table</span></a> -
|
|
<span class="sectionpurpose">The index is divided up into 'elements'.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-ae.html">
|
|
<spon class="sectiontitle">Alphabetic Element</span></a> -
|
|
<span class="sectionpurpose">To write the Alphabetic actions element (A2) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-ae2.html">
|
|
<spon class="sectiontitle">Arithmetic Element</span></a> -
|
|
<span class="sectionpurpose">To write the Arithmetic element (Ar) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-be.html">
|
|
<spon class="sectiontitle">Behaviour Element</span></a> -
|
|
<span class="sectionpurpose">To write the Behaviour element (Bh) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-ce.html">
|
|
<spon class="sectiontitle">Card Element</span></a> -
|
|
<span class="sectionpurpose">To write the Library Card element (Cd) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-ce2.html">
|
|
<spon class="sectiontitle">Chart Element</span></a> -
|
|
<span class="sectionpurpose">To write the Chart element (Ch) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-ce3.html">
|
|
<spon class="sectiontitle">Commands Element</span></a> -
|
|
<span class="sectionpurpose">To write the Commands element (Cm) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-ce4.html">
|
|
<spon class="sectiontitle">Contents Element</span></a> -
|
|
<span class="sectionpurpose">To write the Contents element (C) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-ee.html">
|
|
<spon class="sectiontitle">Events Element</span></a> -
|
|
<span class="sectionpurpose">To write the Events element (Ev) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-ee2.html">
|
|
<spon class="sectiontitle">Extras Element</span></a> -
|
|
<span class="sectionpurpose">To write the Extras element (Xt) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-fe.html">
|
|
<spon class="sectiontitle">Figures Element</span></a> -
|
|
<span class="sectionpurpose">To write the Figures element (Fi) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-ge.html">
|
|
<spon class="sectiontitle">Gazetteer Element</span></a> -
|
|
<span class="sectionpurpose">To write the Gazetteer element (Gz) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-ge2.html">
|
|
<spon class="sectiontitle">Grouped Element</span></a> -
|
|
<span class="sectionpurpose">To write the Grouped actions element (A1) in the index, and also the detailed per-action pages linked from it.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-ie.html">
|
|
<spon class="sectiontitle">Innards Element</span></a> -
|
|
<span class="sectionpurpose">To write the Innards element (In) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-le.html">
|
|
<spon class="sectiontitle">Lexicon Element</span></a> -
|
|
<span class="sectionpurpose">To write the Lexicon element (Lx) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-me.html">
|
|
<spon class="sectiontitle">Map Element</span></a> -
|
|
<span class="sectionpurpose">To write the Map element (Mp) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-pe.html">
|
|
<spon class="sectiontitle">Phrasebook Element</span></a> -
|
|
<span class="sectionpurpose">To write the Phrasebook element (Pb) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-pe2.html">
|
|
<spon class="sectiontitle">Plot Element</span></a> -
|
|
<span class="sectionpurpose">To write the Plot element (Pl) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-re.html">
|
|
<spon class="sectiontitle">Relations Element</span></a> -
|
|
<span class="sectionpurpose">To write the Relations element (Rl) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-rfse.html">
|
|
<spon class="sectiontitle">Rules for Scenes Element</span></a> -
|
|
<span class="sectionpurpose">To write the Rules for Scenes element (RS) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-se.html">
|
|
<spon class="sectiontitle">Standards Element</span></a> -
|
|
<span class="sectionpurpose">To write the Standards element (St) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-te.html">
|
|
<spon class="sectiontitle">Tables Element</span></a> -
|
|
<span class="sectionpurpose">To write the Tables element (Tb) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-te2.html">
|
|
<spon class="sectiontitle">Tokens Element</span></a> -
|
|
<span class="sectionpurpose">To write the Tokens element (To) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-ve.html">
|
|
<spon class="sectiontitle">Values Element</span></a> -
|
|
<span class="sectionpurpose">To write the Values element (Vl) in the index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="3-ve2.html">
|
|
<spon class="sectiontitle">Verbs Element</span></a> -
|
|
<span class="sectionpurpose">To write the Verbs element (Vb) in the index.</span></p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p class="chapterentry"><a name="4"></a>
|
|
<span class="chaptertitle">Chapter 4: Spatial Mapping</span></p>
|
|
<ul class="sectionlist">
|
|
<li>
|
|
<p class="sectionentry"><a href="4-mc.html">
|
|
<spon class="sectiontitle">Map Configuration</span></a> -
|
|
<span class="sectionpurpose">To manage configuration parameters for the EPS and HTML maps.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="4-sg.html">
|
|
<spon class="sectiontitle">Spatial Geometry</span></a> -
|
|
<span class="sectionpurpose">Simple mathematical functions for dealing with vectors and cuboids in a three-dimensional integer lattice.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="4-sm.html">
|
|
<spon class="sectiontitle">Spatial Map</span></a> -
|
|
<span class="sectionpurpose">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.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="4-rhm.html">
|
|
<spon class="sectiontitle">Render HTML Map</span></a> -
|
|
<span class="sectionpurpose">To render the spatial map of rooms as HTML.</span></p>
|
|
</li>
|
|
<li>
|
|
<p class="sectionentry"><a href="4-rem.html">
|
|
<spon class="sectiontitle">Render EPS Map</span></a> -
|
|
<span class="sectionpurpose">To render the spatial map of rooms as an EPS (Encapsulated PostScript) file.</span></p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<hr>
|
|
<p class="purpose">Powered by <a href="https://github.com/ganelson/inweb">Inweb</a>.</p>
|
|
</main>
|
|
</body>
|
|
</html>
|
|
|