mirror of
https://github.com/ganelson/inform.git
synced 2024-06-30 22:14:58 +03:00
137 lines
8.5 KiB
HTML
137 lines
8.5 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>What This Module Does</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">
|
|
<link href="../docs-assets/Colours.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="../index.html">home</a></li>
|
|
</ul><h2>Compiler</h2><ul>
|
|
<li><a href="../structure.html">structure</a></li>
|
|
<li><a href="../inbuildn.html">inbuild</a></li>
|
|
<li><a href="../inform7n.html">inform7</a></li>
|
|
<li><a href="../intern.html">inter</a></li>
|
|
<li><a href="../services.html">services</a></li>
|
|
<li><a href="../secrets.html">secrets</a></li>
|
|
</ul><h2>Other Tools</h2><ul>
|
|
<li><a href="../inblorbn.html">inblorb</a></li>
|
|
<li><a href="../indocn.html">indoc</a></li>
|
|
<li><a href="../inform6.html">inform6</a></li>
|
|
<li><a href="../inpolicyn.html">inpolicy</a></li>
|
|
</ul><h2>Resources</h2><ul>
|
|
<li><a href="../extensions.html">extensions</a></li>
|
|
<li><a href="../kits.html">kits</a></li>
|
|
</ul><h2>Repository</h2><ul>
|
|
<li><a href="https://github.com/ganelson/inform"><img src="../docs-assets/github.png" height=18> github</a></li>
|
|
</ul><h2>Related Projects</h2><ul>
|
|
<li><a href="../../../inweb/index.html">inweb</a></li>
|
|
<li><a href="../../../intest/index.html">intest</a></li>
|
|
|
|
</ul>
|
|
</nav>
|
|
<main role="main">
|
|
<!--Weave of 'What This Module Does' generated by Inweb-->
|
|
<div class="breadcrumbs">
|
|
<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="../intern.html">Inter Modules</a></li><li><a href="index.html">index</a></li><li><a href="index.html#P">Preliminaries</a></li><li><b>What This Module Does</b></li></ul></div>
|
|
<p class="purpose">An overview of the index module's role and abilities.</p>
|
|
|
|
<ul class="toc"><li><a href="P-wtmd.html#SP1">§1. Prerequisites</a></li><li><a href="P-wtmd.html#SP2">§2. The Index</a></li><li><a href="P-wtmd.html#SP4">§4. Localisation</a></li></ul><hr class="tocbar">
|
|
|
|
<p class="commentary firstcommentary"><a id="SP1" class="paragraph-anchor"></a><b>§1. Prerequisites. </b>The index module is a part of the Inform compiler toolset. It is
|
|
presented as a literate program or "web". Before diving in:
|
|
</p>
|
|
|
|
<ul class="items"><li>(a) It helps to have some experience of reading webs: see <a href="../../../inweb/index.html" class="internal">inweb</a> for more.
|
|
</li><li>(b) The module is written in C, in fact ANSI C99, but this is disguised by the
|
|
fact that it uses some extension syntaxes provided by the <a href="../../../inweb/index.html" class="internal">inweb</a> literate
|
|
programming tool, making it a dialect of C called InC. See <a href="../../../inweb/index.html" class="internal">inweb</a> for
|
|
full details, but essentially: it's C without predeclarations or header files,
|
|
and where functions have names like <span class="extract"><span class="extract-syntax">Tags::add_by_name</span></span> rather than just <span class="extract"><span class="extract-syntax">add_by_name</span></span>.
|
|
</li><li>(c) This module uses other modules drawn from the compiler (see <a href="../structure.html" class="internal">structure</a>), and also
|
|
uses a module of utility functions called <a href="../../../inweb/foundation-module/index.html" class="internal">foundation</a>.
|
|
For more, see <a href="../../../inweb/foundation-module/P-abgtf.html" class="internal">A Brief Guide to Foundation (in foundation)</a>.
|
|
</li></ul>
|
|
<p class="commentary firstcommentary"><a id="SP2" class="paragraph-anchor"></a><b>§2. The Index. </b>All users of the Inform GUI app are familiar with the Index: it's a sort of
|
|
mini-website giving a detailed picture of the content of the story being
|
|
created. In the current design, there are seven colour-coded "pages", each
|
|
divided up into two or more parts called "elements".
|
|
</p>
|
|
|
|
<p class="commentary">In fact, this is only one of the possible "index products". It's also possible
|
|
to generate an EPS (encapsulated PostScript) file of a spatial map, for example.
|
|
</p>
|
|
|
|
<p class="commentary">Until 2021 the Index for a project was generated by the main <a href="../inform7/index.html" class="internal">inform7</a> compiler,
|
|
but a radical refactoring then moved the entire <a href="index.html" class="internal">index</a> module into <a href="../inter/index.html" class="internal">inter</a>
|
|
instead. Index products are now generated from trees of Inter code, not from
|
|
Inform projects as such:
|
|
</p>
|
|
|
|
<pre class="displayed-code all-displayed-code code-font">
|
|
<span class="plain-syntax"> source text</span>
|
|
<span class="plain-syntax"> |</span>
|
|
<span class="plain-syntax"> | inform7</span>
|
|
<span class="plain-syntax"> \|/</span>
|
|
<span class="plain-syntax"> inter tree</span>
|
|
<span class="plain-syntax"> / \</span>
|
|
<span class="plain-syntax"> inter / \ inter</span>
|
|
<span class="plain-syntax"> (final module) / \ (index module)</span>
|
|
<span class="plain-syntax"> | |</span>
|
|
<span class="plain-syntax"> \|/ \|/</span>
|
|
<span class="plain-syntax"> generated code Index products</span>
|
|
<span class="plain-syntax"> |</span>
|
|
<span class="plain-syntax"> | inform6 (or similar)</span>
|
|
<span class="plain-syntax"> \|/</span>
|
|
<span class="plain-syntax"> Executable products</span>
|
|
</pre>
|
|
<p class="commentary firstcommentary"><a id="SP3" class="paragraph-anchor"></a><b>§3. </b>The <a href="index.html" class="internal">index</a> module has a very simple API: point it at a tree of Inter code,
|
|
say what sort of index you want, and go. See <a href="1-ia.html" class="internal">Indexing API</a> for the details,
|
|
though the details are not much more than that.
|
|
</p>
|
|
|
|
<p class="commentary firstcommentary"><a id="SP4" class="paragraph-anchor"></a><b>§4. Localisation. </b>A new and somewhat experimental addition in 2021 is the ability to localise the
|
|
Index, that is, to produce an Index in a language other than English. This does
|
|
not of course aim to translate source text: simply to translate subheadings, notes,
|
|
and other fixed-wording text in the Index.
|
|
</p>
|
|
|
|
<p class="commentary">As a demonstration, try running a project with:
|
|
</p>
|
|
|
|
<pre class="displayed-code all-displayed-code code-font">
|
|
<span class="identifier-syntax">Use</span><span class="plain-syntax"> </span><span class="identifier-syntax">French</span><span class="plain-syntax"> </span><span class="identifier-syntax">language</span><span class="plain-syntax"> </span><span class="identifier-syntax">index</span><span class="plain-syntax">.</span>
|
|
</pre>
|
|
<p class="commentary">You should then find that the index has a French-titled Contents section — only
|
|
a couple of strings have been localised at present, and those not localised
|
|
revert to English, so the index still looks basically English. This is all really
|
|
just laying groundwork.
|
|
</p>
|
|
|
|
<p class="commentary">For how to write localisation files, see <a href="../html-module/2-lcl.html" class="internal">Localisation (in html)</a>, or follow
|
|
the example of <span class="extract"><span class="extract-syntax">inform/inform7/Internal/Languages/English/Index.txt</span></span>.
|
|
</p>
|
|
|
|
<nav role="progress"><div class="progresscontainer">
|
|
<ul class="progressbar"><li class="progressprevoff">❮</li><li class="progresscurrentchapter">P</li><li class="progresscurrent">wtmd</li><li class="progresschapter"><a href="1-im.html">1</a></li><li class="progresschapter"><a href="2-il.html">2</a></li><li class="progresschapter"><a href="3-tpt.html">3</a></li><li class="progresschapter"><a href="4-mc.html">4</a></li><li class="progressnext"><a href="1-im.html">❯</a></li></ul></div>
|
|
</nav><!--End of weave-->
|
|
|
|
</main>
|
|
</body>
|
|
</html>
|
|
|