61 lines
3.2 KiB
HTML
61 lines
3.2 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>How This Program Works</title>
|
|
<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="../inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
|
|
</head>
|
|
<body>
|
|
<nav role="navigation">
|
|
<h1><a href="../index.html">
|
|
<img src="../docs-src/Figures/Octagram184x184.png" width=72 height=72">
|
|
</a></h1>
|
|
<ul><li><a href="index.html"><span class="selectedlink">inweb</span></a></li>
|
|
</ul><h2>Foundation Module</h2><ul>
|
|
<li><a href="../foundation-module/index.html">foundation</a></li>
|
|
<li><a href="../foundation-test/index.html">foundation-test</a></li>
|
|
</ul><h2>Example Webs</h2><ul>
|
|
<li><a href="../goldbach/index.html">goldbach</a></li>
|
|
<li><a href="../twinprimes/twinprimes.html">twinprimes</a></li>
|
|
<li><a href="../eastertide/index.html">eastertide</a></li>
|
|
</ul><h2>Repository</h2><ul>
|
|
<li><a href="https://github.com/ganelson/inweb"><img src="../github.png" height=18> github</a></li>
|
|
</ul><h2>Related Projects</h2><ul>
|
|
<li><a href="../../../inform/docs/index.html">inform</a></li>
|
|
<li><a href="../../../intest/docs/index.html">intest</a></li>
|
|
|
|
</ul>
|
|
</nav>
|
|
<main role="main">
|
|
|
|
<!--Weave of 'How This Program Works' generated by 7-->
|
|
<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="index.html">inweb</a></li><li><a href="index.html#P">Preliminaries</a></li><li><b>How This Program Works</b></li></ul><p class="purpose">An overview of how Inweb works, with links to all of its important functions.</p>
|
|
|
|
<ul class="toc"><li><a href="P-htpw.html#SP1">§1. How to read this web</a></li></ul><hr class="tocbar">
|
|
|
|
<p class="inwebparagraph"><a id="SP1"></a><b>§1. How to read this web. </b>Inweb is a program for weaving and tangling literate programs, or "webs",
|
|
and it is a web itself. Webs are easy to read, which is really the point
|
|
of them, but they take getting used to, and it may be easiest to begin by
|
|
skimming the two (deliberately minimal) examples here, <a href="../goldbach/index.html" class="internal">goldbach</a> and
|
|
<a href="../twinprimes/twinprimes.html" class="internal">twinprimes</a>.
|
|
</p>
|
|
|
|
<p class="inwebparagraph">Inweb is a command-line program written in a modest extension of C. See
|
|
<a href="M-tid.html" class="internal">The InC Dialect</a> for full details, but essentially: it's C without
|
|
function predeclarations or header files, and where functions are organised
|
|
into namespaces, having names like <code class="display"><span class="extract">Parser::begin()</span></code> rather than just <code class="display"><span class="extract">begin()</span></code>.
|
|
</p>
|
|
|
|
<p class="inwebparagraph">Programs like Inweb are divided into "modules", each of which is a web in its
|
|
own right. Inweb has two: the main part of the program, and <a href="../foundation-module/index.html" class="internal">foundation</a>,
|
|
a library of utility functions. See <a href="../foundation-module/P-abgtf.html" class="internal">A Brief Guide to Foundation (in foundation)</a>.
|
|
</p>
|
|
|
|
<!--End of weave-->
|
|
</main>
|
|
</body>
|
|
</html>
|
|
|