ifhub/inform7
1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-08 18:14:21 +03:00
Code Issues Projects Releases Wiki Activity
inform7/docs/indoc/1-mn.html
Graham Nelson 1268a0f40e Colonised
2020-04-14 17:56:54 +01:00

224 lines
21 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Main</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/Inform.png" height=72">
</a></h1>
<ul><li><a href="../compiler.html">compiler tools</a></li>
<li><a href="../other.html">other tools</a></li>
<li><a href="../extensions.html">extensions and kits</a></li>
<li><a href="../units.html">unit test tools</a></li>
</ul><h2>Other Tools</h2><ul>
<li><a href="../inblorb/index.html">inblorb</a></li>
<li><a href="index.html"><span class="selectedlink">indoc</span></a></li>
<li><a href="../inpolicy/index.html">inpolicy</a></li>
<li><a href="../inrtps/index.html">inrtps</a></li>
</ul><h2>Foundation</h2><ul>
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</a></li>
</ul>
</nav>
<main role="main">
<!--Weave of 'Main' generated by 7-->
<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="../other.html">Other Tools</a></li><li><a href="index.html">indoc</a></li><li><a href="index.html#1">Chapter 1: Setting Up</a></li><li><b>Main</b></li></ul><p class="purpose">The top level of the program.</p>
<ul class="toc"><li><a href="#SP1">&#167;1. Nutshell</a></li><li><a href="#SP1_1">&#167;1.1. Starting up</a></li><li><a href="#SP1_2">&#167;1.2. First and second passes</a></li><li><a href="#SP1_6">&#167;1.6. Shutting down</a></li></ul><hr class="tocbar">
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. Nutshell. </b>We turn the source matter, "rawtext", into a batch of output files using the
chosen format, a process we'll call "rendering". We do this in two passes.
</p>
<pre class="display">
<span class="reserved">pathname</span><span class="plain"> *</span><span class="identifier">path_to_indoc</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">; </span><span class="comment"> where we are installed</span>
<span class="reserved">pathname</span><span class="plain"> *</span><span class="identifier">path_to_indoc_materials</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">; </span><span class="comment"> the materials pathname</span>
<span class="reserved">settings_block</span><span class="plain"> *</span><span class="identifier">indoc_settings</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">no_volumes</span><span class="plain"> = </span><span class="constant">0</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">no_examples</span><span class="plain"> = </span><span class="constant">0</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">main</span><span class="plain">(</span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">argc</span><span class="plain">, </span><span class="reserved">char</span><span class="plain"> **</span><span class="identifier">argv</span><span class="plain">) {</span>
<span class="functiontext"><a href="1-bsc.html#SP1">Basics::start</a></span><span class="plain">();</span>
&lt;<span class="cwebmacro">Start up indoc</span> <span class="cwebmacronumber">1.1</span>&gt;<span class="plain">;</span>
&lt;<span class="cwebmacro">Make a first-pass scan of the rawtext</span> <span class="cwebmacronumber">1.2</span>&gt;<span class="plain">;</span>
&lt;<span class="cwebmacro">Render the rawtext as documentation</span> <span class="cwebmacronumber">1.3</span>&gt;<span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">html_for_Inform_application</span><span class="plain">)</span>
&lt;<span class="cwebmacro">Work out cross-references for the in-application documentation only</span> <span class="cwebmacronumber">1.4</span>&gt;<span class="plain">;</span>
&lt;<span class="cwebmacro">Produce the indexes</span> <span class="cwebmacronumber">1.5</span>&gt;<span class="plain">;</span>
<span class="functiontext"><a href="2-haj.html#SP7">HTMLUtilities::copy_images</a></span><span class="plain">();</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">wrapper</span><span class="plain"> == </span><span class="constant">WRAPPER_epub</span><span class="plain">) {</span>
<span class="functiontext"><a href="2-haj.html#SP5">HTMLUtilities::note_images</a></span><span class="plain">();</span>
<span class="functiontext"><a href="2-ss.html#SP8">Scanner::mark_up_ebook</a></span><span class="plain">();</span>
<span class="functiontext"><a href="5-ee.html#SP7">Epub::end_construction</a></span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">ebook</span><span class="plain">);</span>
<span class="plain">}</span>
&lt;<span class="cwebmacro">Shut down indoc</span> <span class="cwebmacronumber">1.6</span>&gt;<span class="plain">;</span>
<span class="functiontext"><a href="1-bsc.html#SP1">Basics::end</a></span><span class="plain">();</span>
<span class="reserved">return</span><span class="plain"> </span><span class="constant">0</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP1_1"></a><b>&#167;1.1. Starting up. </b></p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Start up indoc</span> <span class="cwebmacronumber">1.1</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">PRINT</span><span class="plain">(</span><span class="string">"indoc [[Version Number]] (Inform Tools Suite)\n"</span><span class="plain">);</span>
<span class="functiontext"><a href="4-nd.html#SP1">Nav::start</a></span><span class="plain">();</span>
<span class="functiontext"><a href="1-cs.html#SP2">Symbols::start_up_symbols</a></span><span class="plain">();</span>
<span class="identifier">indoc_settings</span><span class="plain"> = </span><span class="functiontext"><a href="1-ins.html#SP2">Instructions::clean_slate</a></span><span class="plain">();</span>
<span class="functiontext"><a href="1-cnf.html#SP2">Configuration::read_command_line</a></span><span class="plain">(</span><span class="identifier">argc</span><span class="plain">, </span><span class="identifier">argv</span><span class="plain">, </span><span class="identifier">indoc_settings</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">wrapper</span><span class="plain"> == </span><span class="constant">WRAPPER_epub</span><span class="plain">) {</span>
<span class="functiontext"><a href="2-haj.html#SP4">HTMLUtilities::image_URL</a></span><span class="plain">(</span><span class="identifier">NULL</span><span class="plain">,</span>
<span class="functiontext"><a href="3-fln.html#SP7">Filenames::get_leafname</a></span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">book_cover_image</span><span class="plain">));</span>
<span class="functiontext"><a href="1-ins.html#SP10">Instructions::apply_ebook_metadata</a></span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">ebook</span><span class="plain">);</span>
<span class="reserved">pathname</span><span class="plain"> *</span><span class="identifier">I</span><span class="plain"> = </span><span class="functiontext"><a href="3-pth.html#SP5">Pathnames::from_text</a></span><span class="plain">(</span><span class="identifier">I</span><span class="string">"images"</span><span class="plain">);</span>
<span class="reserved">filename</span><span class="plain"> *</span><span class="identifier">cover_in_situ</span><span class="plain"> = </span><span class="functiontext"><a href="3-fln.html#SP2">Filenames::in_folder</a></span><span class="plain">(</span><span class="identifier">I</span><span class="plain">,</span>
<span class="functiontext"><a href="3-fln.html#SP7">Filenames::get_leafname</a></span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">book_cover_image</span><span class="plain">));</span>
<span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">destination</span><span class="plain"> = </span><span class="functiontext"><a href="5-ee.html#SP6">Epub::begin_construction</a></span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">ebook</span><span class="plain">,</span>
<span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">destination</span><span class="plain">, </span><span class="identifier">cover_in_situ</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">NUMBER_CREATED</span><span class="plain">(</span><span class="reserved">volume</span><span class="plain">) == </span><span class="constant">0</span><span class="plain">) { </span><span class="identifier">PRINT</span><span class="plain">(</span><span class="string">"indoc: nothing to do\n"</span><span class="plain">); </span><span class="identifier">exit</span><span class="plain">(0); }</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">problem_count</span><span class="plain"> &gt; </span><span class="constant">0</span><span class="plain">) </span><span class="identifier">exit</span><span class="plain">(1);</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP1">&#167;1</a>.</p>
<p class="inwebparagraph"><a id="SP1_2"></a><b>&#167;1.2. First and second passes. </b>First we look ahead, so to speak, by scanning the examples we are going
to need to insert; then similarly to find the section titles. At this
point, nothing is being output.
</p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Make a first-pass scan of the rawtext</span> <span class="cwebmacronumber">1.2</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="reserved">volume</span><span class="plain"> *</span><span class="identifier">V</span><span class="plain">;</span>
<span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">V</span><span class="plain">, </span><span class="reserved">volume</span><span class="plain">) </span><span class="functiontext"><a href="2-ss.html#SP6">Scanner::scan_rawtext_for_section_titles</a></span><span class="plain">(</span><span class="identifier">V</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">book_contains_examples</span><span class="plain">) </span><span class="functiontext"><a href="2-exm.html#SP5">Examples::scan_examples</a></span><span class="plain">();</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP1">&#167;1</a>.</p>
<p class="inwebparagraph"><a id="SP1_3"></a><b>&#167;1.3. </b>We then work through each volume's rawtext file in turn, writing the output
section by section.
</p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Render the rawtext as documentation</span> <span class="cwebmacronumber">1.3</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">format</span><span class="plain"> == </span><span class="constant">HTML_FORMAT</span><span class="plain">) </span><span class="functiontext"><a href="2-css.html#SP5">CSS::write_CSS_files</a></span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">css_source_file</span><span class="plain">);</span>
<span class="reserved">volume</span><span class="plain"> *</span><span class="identifier">V</span><span class="plain">;</span>
<span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">TO</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">V</span><span class="plain">, </span><span class="reserved">volume</span><span class="plain">) </span><span class="identifier">TO</span><span class="plain"> = </span><span class="functiontext"><a href="2-rr.html#SP1">Rawtext::process_large_rawtext_file</a></span><span class="plain">(</span><span class="identifier">TO</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">);</span>
<span class="functiontext"><a href="4-nd.html#SP8">Nav::render_navigation_contents_files</a></span><span class="plain">();</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP1">&#167;1</a>.</p>
<p class="inwebparagraph"><a id="SP1_4"></a><b>&#167;1.4. </b>The following functions here are for use only when compiling documentation
to go inside the Inform user interface application.
</p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Work out cross-references for the in-application documentation only</span> <span class="cwebmacronumber">1.4</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="functiontext"><a href="2-ss.html#SP7">Scanner::write_manifest_file</a></span><span class="plain">(</span><span class="identifier">FIRST_OBJECT</span><span class="plain">(</span><span class="reserved">volume</span><span class="plain">));</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">definitions_filename</span><span class="plain">) </span><span class="functiontext"><a href="2-utc.html#SP3">Updater::write_definitions_file</a></span><span class="plain">();</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">xrefs_filename</span><span class="plain">)</span>
<span class="functiontext"><a href="2-utc.html#SP2">Updater::write_xrefs_file</a></span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">xrefs_filename</span><span class="plain">);</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP1">&#167;1</a>.</p>
<p class="inwebparagraph"><a id="SP1_5"></a><b>&#167;1.5. </b>These are automatically generated.
</p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Produce the indexes</span> <span class="cwebmacronumber">1.5</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-&gt;</span><span class="element">format</span><span class="plain"> == </span><span class="constant">HTML_FORMAT</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">no_examples</span><span class="plain"> &gt; </span><span class="constant">0</span><span class="plain">) {</span>
<span class="functiontext"><a href="3-ei.html#SP3">ExamplesIndex::write_alphabetical_examples_index</a></span><span class="plain">();</span>
<span class="functiontext"><a href="3-ei.html#SP6">ExamplesIndex::write_numerical_examples_index</a></span><span class="plain">();</span>
<span class="functiontext"><a href="3-ei.html#SP5">ExamplesIndex::write_thematic_examples_index</a></span><span class="plain">();</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">NUMBER_CREATED</span><span class="plain">(</span><span class="reserved">index_lemma</span><span class="plain">) &gt; </span><span class="constant">0</span><span class="plain">) </span><span class="functiontext"><a href="3-gi.html#SP9">Indexes::write_general_index</a></span><span class="plain">();</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP1">&#167;1</a>.</p>
<p class="inwebparagraph"><a id="SP1_6"></a><b>&#167;1.6. Shutting down. </b></p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Shut down indoc</span> <span class="cwebmacronumber">1.6</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">problem_count</span><span class="plain"> &gt; </span><span class="constant">0</span><span class="plain">) {</span>
<span class="identifier">PRINT</span><span class="plain">(</span><span class="string">"indoc: ended with error%s\n"</span><span class="plain">, (</span><span class="identifier">problem_count</span><span class="plain"> == </span><span class="constant">1</span><span class="plain">)?</span><span class="string">""</span><span class="plain">:</span><span class="string">"s"</span><span class="plain">);</span>
<span class="identifier">exit</span><span class="plain">(1);</span>
<span class="plain">}</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">s</span><span class="plain"> = </span><span class="constant">0</span><span class="plain">;</span>
<span class="reserved">volume</span><span class="plain"> *</span><span class="identifier">V</span><span class="plain">; </span><span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">V</span><span class="plain">, </span><span class="reserved">volume</span><span class="plain">) </span><span class="identifier">s</span><span class="plain"> += </span><span class="identifier">V</span><span class="plain">-&gt;</span><span class="element">vol_section_count</span><span class="plain">;</span>
<span class="identifier">PRINT</span><span class="plain">(</span><span class="string">"indoc: done (%d volume%s, %d section%s, %d example%s)\n"</span><span class="plain">,</span>
<span class="identifier">no_volumes</span><span class="plain">, (</span><span class="identifier">problem_count</span><span class="plain"> == </span><span class="constant">1</span><span class="plain">)?</span><span class="string">""</span><span class="plain">:</span><span class="string">"s"</span><span class="plain">,</span>
<span class="identifier">s</span><span class="plain">, (</span><span class="identifier">s</span><span class="plain"> == </span><span class="constant">1</span><span class="plain">)?</span><span class="string">""</span><span class="plain">:</span><span class="string">"s"</span><span class="plain">,</span>
<span class="identifier">no_examples</span><span class="plain">, (</span><span class="identifier">no_examples</span><span class="plain"> == </span><span class="constant">1</span><span class="plain">)?</span><span class="string">""</span><span class="plain">:</span><span class="string">"s"</span><span class="plain">);</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP1">&#167;1</a>.</p>
<hr class="tocbar">
<ul class="toc"><li><a href="1-bsc.html">Back to 'Basics'</a></li><li><a href="1-cnf.html">Continue with 'Configuration'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>
Reference in a new issue View git blame Copy permalink