mirror of
https://github.com/ganelson/inform.git
synced 2024-07-08 01:54:21 +03:00
150 lines
6.4 KiB
HTML
150 lines
6.4 KiB
HTML
<html>
|
|
<head>
|
|
<title>indoc 4</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta http-equiv="Content-Language" content="en-gb">
|
|
<link href="inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
</head>
|
|
|
|
<body>
|
|
<ul class="crumbs"><li><a href="../webs.html">★</a></li><li><b>indoc 4</b></li></ul>
|
|
<p class="purpose">The documentation-formatter for the Inform 7 system.</p>
|
|
<hr>
|
|
<ul class="chapterlist">
|
|
<li>
|
|
<p><a name="P"></a><spon class="chaptertitle">Preliminaries</span></p>
|
|
<p><span class="purpose"></span></p>
|
|
<ul class="sectionlist">
|
|
<li>
|
|
<p><a href="P-iti.html"><spon class="sectiontitle">Introduction to Indoc</span></a> -
|
|
<span class="purpose">What Indoc is, and its limited but complicated uses.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="P-vai.html"><spon class="sectiontitle">Volumes and Instructions</span></a> -
|
|
<span class="purpose">Dual- versus single-volume mode, and how to write instructions files.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="P-dm.html"><spon class="sectiontitle">Documentation Markup</span></a> -
|
|
<span class="purpose">How to mark up the plain-text source for Inform documentation.</span></p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><a name="1"></a><spon class="chaptertitle">Chapter 1: Setting Up</span></p>
|
|
<p><span class="purpose"></span></p>
|
|
<ul class="sectionlist">
|
|
<li>
|
|
<p><a href="1-bsc.html"><spon class="sectiontitle">Basics</span></a> -
|
|
<span class="purpose">Some fundamental definitions.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="1-mn.html"><spon class="sectiontitle">Main</span></a> -
|
|
<span class="purpose">The top level of the program.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="1-cnf.html"><spon class="sectiontitle">Configuration</span></a> -
|
|
<span class="purpose">Instructions of indoc to different output types.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="1-ins.html"><spon class="sectiontitle">Instructions</span></a> -
|
|
<span class="purpose">Instructions of indoc to different output types.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="1-cs.html"><spon class="sectiontitle">Context Symbols</span></a> -
|
|
<span class="purpose">Provides conditional rendering of text, depending on context.</span></p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><a name="2"></a><spon class="chaptertitle">Chapter 2: Processing</span></p>
|
|
<p><span class="purpose"></span></p>
|
|
<ul class="sectionlist">
|
|
<li>
|
|
<p><a href="2-ss.html"><spon class="sectiontitle">Structural Scan</span></a> -
|
|
<span class="purpose">Finding out how a volume divides up into chapters and sections.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="2-exm.html"><spon class="sectiontitle">Examples</span></a> -
|
|
<span class="purpose">Keeping track of the metadata on and sequencing of the examples.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="2-rnd.html"><spon class="sectiontitle">Renderer</span></a> -
|
|
<span class="purpose">The general output apparatus for writing a block of documentation.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="2-rr.html"><spon class="sectiontitle">Rawtext Reader</span></a> -
|
|
<span class="purpose">Reading the rawtext in, breaking it up into blocks, and sending them for output as formatted documentation.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="2-utc.html"><spon class="sectiontitle">Updating the Cross-References</span></a> -
|
|
<span class="purpose">Writing the documentation cross-references to a file used by Inform's in-application documentation.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="2-haj.html"><spon class="sectiontitle">HTML and JavaScript</span></a> -
|
|
<span class="purpose">HTML utility code.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="2-css.html"><spon class="sectiontitle">CSS</span></a> -
|
|
<span class="purpose">Cascading style sheets for HTML output.</span></p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><a name="3"></a><spon class="chaptertitle">Chapter 3: Indexing</span></p>
|
|
<p><span class="purpose"></span></p>
|
|
<ul class="sectionlist">
|
|
<li>
|
|
<p><a href="3-iu.html"><spon class="sectiontitle">Indexing Utilities</span></a> -
|
|
<span class="purpose">Some conveniences shared by our different forms of index.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="3-cai.html"><spon class="sectiontitle">Contents and Indexes</span></a> -
|
|
<span class="purpose">To produce a general index, for HTML output only.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="3-ei.html"><spon class="sectiontitle">Examples Index</span></a> -
|
|
<span class="purpose">To produces the contents and indexing pages, for HTML output and multiple-files mode only.</span></p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><a name="4"></a><spon class="chaptertitle">Chapter 4: Navigation Styles</span></p>
|
|
<p><span class="purpose"></span></p>
|
|
<ul class="sectionlist">
|
|
<li>
|
|
<p><a href="4-nd.html"><spon class="sectiontitle">Navigational Designs</span></a> -
|
|
<span class="purpose">To render linking gadgets in HTML forms of documentation, so that the reader can navigate from section to section.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="4-cl.html"><spon class="sectiontitle">Codename Lacuna</span></a> -
|
|
<span class="purpose">The "lacuna" style of navigational gadgets, a plain text style with no navigational features at all.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="4-cm.html"><spon class="sectiontitle">Codename Midnight</span></a> -
|
|
<span class="purpose">The "midnight" style of navigational gadgets.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="4-ca.html"><spon class="sectiontitle">Codename Architect</span></a> -
|
|
<span class="purpose">The "architect" style of navigational gadgets.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="4-ct.html"><spon class="sectiontitle">Codename Twilight</span></a> -
|
|
<span class="purpose">The "twilight" style of navigational gadgets, a minimal version of "midnight".</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="4-cr.html"><spon class="sectiontitle">Codename Roadsign</span></a> -
|
|
<span class="purpose">The "roadsign" style of navigational gadgets.</span></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="4-cu.html"><spon class="sectiontitle">Codename Unsigned</span></a> -
|
|
<span class="purpose">The "unsigned" style of navigational gadgets.</span></p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
</body>
|
|
|
|
</html>
|
|
|