1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-07 17:44:22 +03:00
inform7/docs/webs.html

214 lines
12 KiB
HTML
Raw Normal View History

2019-03-17 14:40:57 +02:00
<html>
<head>
<title>Inform &#9733; Webs for ganelson/inform</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Language" content="en-gb">
<link href="inblorb/inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
</head>
<body>
<ul class="crumbs"><li><a href="https://github.com/ganelson/inform"><b>&#9733 Webs for ganelson/inform</b></a></li></ul>
<p class="purpose">Human-readable source code.</p>
<hr>
<p class="chapter">
This GitHub project was written as a literate program, powered by a LP tool
called Inweb. While almost all programs at Github are open to inspection, most
are difficult for new readers to navigate, and are not structured for extended
reading. By contrast, a "web" (the term goes back to Knuth: see
<a href="https://en.wikipedia.org/wiki/Literate_programming">Wikipedia</a>)
is designed to be read by humans in its "woven" form, and to be compiled or
run by computers in its "tangled" form.
These pages showcase the woven form, and are for human eyes only.</p>
<hr>
2020-03-11 02:21:09 +02:00
<p class="chapter">The main Inform 7 compiler; its front end, inbuild; and its back end, inter:</p>
2019-03-17 14:40:57 +02:00
<ul class="sectionlist">
<li>
<p>&#9733; <a href="inform7/index.html"><spon class="sectiontitle">inform7</span></a> -
version 7.10.1 'Krypton' (build 6Q21)
- <span class="purpose">The core compiler in a natural-language design system for interactive fiction.</span>
Documentation is <a href="inform7/P-cu.html">here</a>.</p>
</li>
<li>
2020-01-13 13:02:57 +02:00
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="inflections-module/index.html"><spon class="sectiontitle">inflections</span></a> (module of inform7) -
2019-03-17 14:40:57 +02:00
<span class="purpose">A library for adapting words or short phrases for linguistic purposes.</span></p>
</li>
<li>
2020-01-13 13:02:57 +02:00
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="inflections-test/index.html"><spon class="sectiontitle">inflections-test</span></a> -
2020-03-11 02:21:09 +02:00
<span class="purpose"><i>Unit tests for the inflections module. (A stand-alone program.)</i></span></p>
2019-03-17 14:40:57 +02:00
</li>
<li>
2020-01-13 13:02:57 +02:00
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="problems-module/index.html"><spon class="sectiontitle">problems</span></a> (module of inform7) -
2019-03-17 14:40:57 +02:00
<span class="purpose">The issuing mechanism for problem messages used by Inform.</span></p>
</li>
<li>
2020-01-13 13:02:57 +02:00
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="problems-test/index.html"><spon class="sectiontitle">problems-test</span></a> -
2020-03-11 02:21:09 +02:00
<span class="purpose"><i>Unit tests for the problems module. (A stand-alone program.)</i></span></p>
2019-03-17 14:40:57 +02:00
</li>
<li>
2020-01-13 13:02:57 +02:00
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="linguistics-module/index.html"><spon class="sectiontitle">linguistics</span></a> (module of inform7) -
2019-03-17 14:40:57 +02:00
<span class="purpose">A library of code to store grammatical categories of vocabulary.</span></p>
</li>
<li>
2020-01-13 13:02:57 +02:00
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="linguistics-test/index.html"><spon class="sectiontitle">linguistics-test</span></a> -
2020-03-11 02:21:09 +02:00
<span class="purpose"><i>Unit tests for the linguistics module. (A stand-alone program.)</i></span></p>
2019-03-17 14:40:57 +02:00
</li>
<li>
2020-01-13 13:02:57 +02:00
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="kinds-module/index.html"><spon class="sectiontitle">kinds</span></a> (module of inform7) -
2019-03-17 14:40:57 +02:00
<span class="purpose">The type system used by Inform.</span></p>
</li>
<li>
2020-01-13 13:02:57 +02:00
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="kinds-test/index.html"><spon class="sectiontitle">kinds-test</span></a> -
2020-03-11 02:21:09 +02:00
<span class="purpose"><i>Unit tests for the kinds module. (A stand-alone program.)</i></span></p>
2019-03-17 14:40:57 +02:00
</li>
<li>
2020-01-13 13:02:57 +02:00
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="core-module/index.html"><spon class="sectiontitle">core</span></a> (module of inform7) -
2019-03-17 14:40:57 +02:00
<span class="purpose">The core of the Inform compiler, as a module.</span></p>
</li>
<li>
2020-01-13 13:02:57 +02:00
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="if-module/index.html"><spon class="sectiontitle">if</span></a> (module of inform7) -
2019-03-17 14:40:57 +02:00
<span class="purpose">The interactive-fiction specific layer of Inform, as a module.</span></p>
</li>
<li>
2020-01-13 13:02:57 +02:00
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="multimedia-module/index.html"><spon class="sectiontitle">multimedia</span></a> (module of inform7) -
2019-03-17 14:40:57 +02:00
<span class="purpose">A multimedia extension module for Inform.</span></p>
</li>
<li>
2020-01-13 13:02:57 +02:00
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="index-module/index.html"><spon class="sectiontitle">index</span></a> (module of inform7) -
2019-03-17 14:40:57 +02:00
<span class="purpose">Indexing tools needed by Inform, as a module.</span></p>
2020-02-27 13:18:25 +02:00
</li>
<li>
<p>&#9733; <a href="inbuild/index.html"><spon class="sectiontitle">inbuild</span></a> -
version 1 'Avignon'
- <span class="purpose">A simple build and package manager for the Inform tools.</span>
Documentation is <a href="inbuild/P-ui.html">here</a>.</p>
</li>
<li>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="arch-module/index.html"><spon class="sectiontitle">arch</span></a> (module of both inform7 and inbuild) -
<span class="purpose">Definitions of Inter and final VM architectures.</span></p>
</li>
<li>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="inbuild-module/index.html"><spon class="sectiontitle">inbuild</span></a> (module of both inform7 and inbuild) -
<span class="purpose">The functional part of the build manager.</span></p>
</li>
<li>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="html-module/index.html"><spon class="sectiontitle">html</span></a> (module of both inform7 and inbuild) -
<span class="purpose">HTML and Javascript generation tools.</span></p>
2020-03-11 02:21:09 +02:00
</li>
<li>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="words-module/index.html"><spon class="sectiontitle">words</span></a> (module of both inform7 and inbuild) -
<span class="purpose">A library of code for reading natural language into a stream of words.</span></p>
</li>
<li>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="words-test/index.html"><spon class="sectiontitle">words-test</span></a> -
<span class="purpose"><i>Unit tests for the words module. (A stand-alone program.)</i></span></p>
</li>
<li>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="syntax-module/index.html"><spon class="sectiontitle">syntax</span></a> (module of both inform7 and inbuild) -
<span class="purpose">A library of code to build a parse tree and break text into sentences.</span></p>
</li>
<li>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="syntax-test/index.html"><spon class="sectiontitle">syntax-test</span></a> -
<span class="purpose"><i>Unit tests for the syntax module. (A stand-alone program.)</i></span></p>
2019-03-17 14:40:57 +02:00
</li>
<li>
<p>&#9733; <a href="inter/index.html"><spon class="sectiontitle">inter</span></a> -
version 1 'Axion'
- <span class="purpose">For handling intermediate Inform code.</span>
Documentation is <a href="inter/P-ui.html">here</a>.</p>
</li>
<li>
2020-01-13 13:02:57 +02:00
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="inter-module/index.html"><spon class="sectiontitle">inter</span></a> (module of both inform7 and inter) -
<span class="purpose">Code for dealing with intermediate-level Inform.</span></p>
</li>
<li>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="building-module/index.html"><spon class="sectiontitle">building</span></a> (module of both inform7 and inter) -
<span class="purpose">An intermediate layer for building code in Inter.</span></p>
2019-03-17 14:40:57 +02:00
</li>
<li>
2020-01-13 13:02:57 +02:00
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9733; <a href="codegen-module/index.html"><spon class="sectiontitle">codegen</span></a> (module of both inform7 and inter) -
2019-08-28 12:35:44 +03:00
<span class="purpose">The code generation pipeline.</span></p>
2019-03-17 14:40:57 +02:00
</li>
</ul>
<hr>
2020-01-13 13:02:57 +02:00
<p class="chapter">The two extensions (though their use is compulsory) which, though themselves written in Inform, create the Inform language:</p>
<ul class="sectionlist">
<li>
2020-01-27 03:22:21 +02:00
<p>&#9733; <a href="basic_inform/index.html"><spon class="sectiontitle">basic_inform</span></a> -
2020-01-13 13:02:57 +02:00
version 1
- <span class="purpose">The Basic Inform extension, included in all projects.</span></p>
</li>
<li>
2020-01-27 03:22:21 +02:00
<p>&#9733; <a href="standard_rules/index.html"><spon class="sectiontitle">standard_rules</span></a> -
2020-01-13 13:02:57 +02:00
version 6
- <span class="purpose">The Standard Rules extension, included in all interactive fiction projects.</span></p>
</li>
</ul>
<hr>
2020-01-27 03:22:21 +02:00
<p class="chapter">The kits of Inter code which support low-level features of the language:</p>
<ul class="sectionlist">
<li>
2020-01-27 03:22:21 +02:00
<p>&#9733; <a href="BasicInformKit/index.html"><spon class="sectiontitle">BasicInformKit</span></a> -
2020-01-13 13:02:57 +02:00
<span class="purpose">support for Inform as a programming language.</span></p>
</li>
<li>
2020-01-27 03:22:21 +02:00
<p>&#9733; <a href="WorldModelKit/index.html"><spon class="sectiontitle">WorldModelKit</span></a> -
<span class="purpose">support for modelling space, time and actions in interactive fiction.</span></p>
2020-01-27 23:54:07 +02:00
</li>
<li>
<p>&#9733; <a href="EnglishLanguageKit/index.html"><spon class="sectiontitle">EnglishLanguageKit</span></a> -
<span class="purpose">support for English as the natural language used.</span></p>
2020-01-27 03:22:21 +02:00
</li>
<li>
<p>&#9733; <a href="CommandParserKit/index.html"><spon class="sectiontitle">CommandParserKit</span></a> -
<span class="purpose">support for parsing turn-by-turn commands in interactive fiction.</span></p>
</li>
<li>
2020-01-27 03:22:21 +02:00
<p>&#9733; <a href="BasicInformExtrasKit/index.html"><spon class="sectiontitle">BasicInformExtrasKit</span></a> -
2020-01-13 13:02:57 +02:00
<span class="purpose">additional support needed only if the Standard Rules are not used.</span></p>
</li>
</ul>
<hr>
2019-03-17 14:40:57 +02:00
<p class="chapter">Other webs in this repository:</p>
<ul class="sectionlist">
<li>
<p>&#9733; <a href="inblorb/index.html"><spon class="sectiontitle">inblorb</span></a> -
version 4 'Duralumin'
- <span class="purpose">The packaging stage of the Inform 7 system, which releases a story file in the blorbed format.</span>
Documentation is <a href="inblorb/P-ui.html">here</a>.</p>
</li>
<li>
<p>&#9733; <a href="indoc/index.html"><spon class="sectiontitle">indoc</span></a> -
version 4 'Didache'
- <span class="purpose">The documentation-formatter for the Inform 7 system.</span>
Documentation is <a href="indoc/P-iti.html">here</a>.</p>
</li>
<li>
<p>&#9733; <a href="inpolicy/index.html"><spon class="sectiontitle">inpolicy</span></a> -
version 1 'Plan A'
- <span class="purpose">A lint-like tool to check up on various policies used in Inform source code.</span>
Documentation is <a href="inpolicy/P-ui.html">here</a>.</p>
</li>
<li>
<p>&#9733; <a href="inrtps/index.html"><spon class="sectiontitle">inrtps</span></a> -
version 2 'Benefactive'
- <span class="purpose">A generator of HTML pages to show for run-time problem messages in Inform.</span>
Documentation is <a href="inrtps/P-ui.html">here</a>.</p>
</li>
</ul>
<hr>
<p class="chapter">Rekated webs in other repositories:</p>
<ul class="sectionlist">
<li>
<p>&#9733; <a href="../../intest/docs/webs.html"><spon class="sectiontitle">intest</span></a> -
A tool used for testing some of the above.</p>
</li>
<li>
<p>&#9733; <a href="../../inweb/docs/webs.html"><spon class="sectiontitle">inweb</span></a> -
The literate programming tool needed to compile the above: also includes the Foundation module of standard code used in all the above.</p>
</li>
</ul>
<hr>
</body>
</html>