mirror of
https://github.com/ganelson/inform.git
synced 2024-06-26 04:00:43 +03:00
92 lines
4.9 KiB
HTML
92 lines
4.9 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>Navigation page for Indoc</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">
|
|
<script src="http://code.jquery.com/jquery-1.12.4.min.js"
|
|
integrity="sha256-ZosEbRLbNQzLpnKIkEdrPv7lOy9C27hHQ+Xp8a4MxAQ=" crossorigin="anonymous"></script>
|
|
|
|
<script src="docs-assets/Bigfoot.js"></script>
|
|
<link href="docs-assets/Bigfoot.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"><span class="selectedlink">home</span></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><span class="unlink">indoc</span></li>
|
|
<li><a href="inform6.html">inform6</a></li>
|
|
<li><a href="inpolicyn.html">inpolicy</a></li>
|
|
<li><a href="inrtpsn.html">inrtps</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 'Navigation page for Indoc' generated by Inweb-->
|
|
<div class="breadcrumbs">
|
|
<ul class="crumbs"><li><a href="index.html">Home</a></li><li><b>Navigation page for Indoc</b></li></ul></div>
|
|
<p class="commentary firstcommentary"><a id="SP1" class="paragraph-anchor"></a><b>§1. </b>Indoc is not part of the main Inform compiler and is not shipped inside the
|
|
Inform apps. Instead, it's used as a stand-alone command-line tool by the
|
|
maintainers of Inform: it generates the formatted documentation about the
|
|
language which is used both inside the apps and on the project website. (So,
|
|
although Indoc is not included in the apps, its output is.)
|
|
</p>
|
|
|
|
<p class="commentary">Indoc is a single literate program, and is not divided into modules.
|
|
</p>
|
|
|
|
<ul class="items"><li>● The contents page for the Indoc web is here: <a href="indoc/index.html" class="internal">indoc</a>.
|
|
</li><li>● See <a href="indoc/M-iti.html" class="internal">Manual (in indoc)</a> and <a href="indoc/M-rc.html" class="internal">Reference Card (in indoc)</a> for usage.
|
|
</li><li>● In particular, <a href="indoc/M-dm.html" class="internal">Documentation Markup (in indoc)</a> explains how the two books
|
|
supplied with Inform are marked up.
|
|
</li></ul>
|
|
<p class="commentary firstcommentary"><a id="SP2" class="paragraph-anchor"></a><b>§2. </b>The texts of the manuals and examples supplied inside the Inform app are
|
|
stored elsewhere in the repository.<sup id="fnref:1"><a href="#fn:1" rel="footnote">1</a></sup>
|
|
</p>
|
|
|
|
<ul class="items"><li>● See: //<a href="https://github.com/ganelson/inform/resources/Documentation/" class="external">https://github.com/ganelson/inform/resources/Documentation/</a>
|
|
</li></ul>
|
|
<ul class="footnotetexts"><li class="footnote" id="fn:1"><p class="inwebfootnote"><sup id="fnref:1"><a href="#fn:1" rel="footnote">1</a></sup> In principle, Indoc could be used with other books entirely, and the author
|
|
has sometimes used it as a quick way to turn text files into ePub ebooks. But
|
|
it's a non-goal to make it a super-duper general purpose documentation maker:
|
|
there are plenty of those in existence already.
|
|
<a href="#fnref:1" title="return to text"> ↩</a></p></li></ul>
|
|
<p class="commentary firstcommentary"><a id="SP3" class="paragraph-anchor"></a><b>§3. </b>Indoc contains the basic <a href="../../inweb/foundation-module/index.html" class="internal">foundation</a> library, but none of the <a href="services.html" class="internal">services</a>.
|
|
</p>
|
|
|
|
<!--End of weave-->
|
|
|
|
</main>
|
|
</body>
|
|
</html>
|
|
|