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/2-ng.html
Graham Nelson d969e624cb Incorporated GitHub pages
2019-03-17 12:40:57 +00:00

333 lines
48 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>2/rr</title>
<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>
<!--Weave of '2/ng' generated by 7-->
<ul class="crumbs"><li><a href="../webs.html">&#9733;</a></li><li><a href="index.html">indoc 4</a></li><li><a href="index.html#2">Chapter 2: Processing</a></li><li><b>Navigational Gadgets</b></li></ul><p class="purpose">To render linking gadgets in HTML forms of documentation, so that the reader can navigate from section to section.</p>
<ul class="toc"><li><a href="#SP1">&#167;1. Top</a></li><li><a href="#SP2">&#167;2. Index top</a></li><li><a href="#SP3">&#167;3. Middle</a></li><li><a href="#SP4">&#167;4. Example top</a></li><li><a href="#SP5">&#167;5. Example bottom</a></li><li><a href="#SP6">&#167;6. Bottom</a></li><li><a href="#SP7">&#167;7. Contents page</a></li></ul><hr class="tocbar">
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. Top. </b>At the front end of a section, before any of its text.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Gadgets::render_navigation_top</span><span class="plain">(</span><span class="constant">OUTPUT_STREAM</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">section</span><span class="plain"> *</span><span class="identifier">S</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">V</span><span class="plain">-</span><span class="element">&gt;sections</span><span class="plain">[0] == </span><span class="identifier">S</span><span class="plain">) </span>&lt;<span class="cwebmacro">Render the volume title</span> <span class="cwebmacronumber">1.2</span>&gt;<span class="plain">;</span>
<span class="reserved">chapter</span><span class="plain"> *</span><span class="identifier">C</span><span class="plain"> = </span><span class="identifier">S</span><span class="plain">-</span><span class="element">&gt;begins_which_chapter</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">C</span><span class="plain">) </span>&lt;<span class="cwebmacro">Render the chapter title</span> <span class="cwebmacronumber">1.3</span>&gt;<span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_html_for_Inform_application</span><span class="plain">)</span>
&lt;<span class="cwebmacro">Write HTML comments giving the Inform user interface search assistance</span> <span class="cwebmacronumber">1.1</span>&gt;<span class="plain">;</span>
&lt;<span class="cwebmacro">Render the section title</span> <span class="cwebmacronumber">1.4</span>&gt;<span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Gadgets::render_navigation_top is used in 2/rnd (<a href="2-rnd.html#SP9">&#167;9</a>).</p>
<p class="inwebparagraph"><a id="SP1_1"></a><b>&#167;1.1. </b><code class="display">
&lt;<span class="cwebmacrodefn">Write HTML comments giving the Inform user interface search assistance</span> <span class="cwebmacronumber">1.1</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"\</span><span class="plain">n</span><span class="string">"</span><span class="plain">);</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">comment</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">comment</span><span class="plain">, </span><span class="string">"SEARCH TITLE \</span><span class="plain">"</span><span class="string">%S\</span><span class="plain">"</span><span class="string">"</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">-</span><span class="element">&gt;unlabelled_title</span><span class="plain">);</span>
<span class="functiontext">HTML::comment</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">comment</span><span class="plain">);</span>
<span class="functiontext">Str::clear</span><span class="plain">(</span><span class="identifier">comment</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">comment</span><span class="plain">, </span><span class="string">"SEARCH SECTION \</span><span class="plain">"</span><span class="string">%S\</span><span class="plain">"</span><span class="string">"</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">-</span><span class="element">&gt;label</span><span class="plain">);</span>
<span class="functiontext">HTML::comment</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">comment</span><span class="plain">);</span>
<span class="functiontext">Str::clear</span><span class="plain">(</span><span class="identifier">comment</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">comment</span><span class="plain">, </span><span class="string">"SEARCH SORT \</span><span class="plain">"</span><span class="string">%S\</span><span class="plain">"</span><span class="string">"</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">-</span><span class="element">&gt;sort_code</span><span class="plain">);</span>
<span class="functiontext">HTML::comment</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">comment</span><span class="plain">);</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">comment</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_2"></a><b>&#167;1.2. </b><code class="display">
&lt;<span class="cwebmacrodefn">Render the volume title</span> <span class="cwebmacronumber">1.2</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_midnight</span><span class="plain">) {</span>
<span class="functiontext">Midnight::midnight_volume_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_architect</span><span class="plain">) {</span>
<span class="functiontext">Architect::architect_volume_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_twilight</span><span class="plain">) {</span>
<span class="functiontext">Twilight::twilight_volume_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_roadsign</span><span class="plain">) {</span>
<span class="functiontext">Roadsign::roadsign_volume_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_unsigned</span><span class="plain">) {</span>
<span class="functiontext">Unsigned::unsigned_volume_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_lacuna</span><span class="plain">) {</span>
<span class="functiontext">Lacuna::lacuna_volume_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</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_3"></a><b>&#167;1.3. </b><code class="display">
&lt;<span class="cwebmacrodefn">Render the chapter title</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">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_midnight</span><span class="plain">) {</span>
<span class="functiontext">Midnight::midnight_chapter_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">C</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_architect</span><span class="plain">) {</span>
<span class="functiontext">Architect::architect_chapter_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">C</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_twilight</span><span class="plain">) {</span>
<span class="functiontext">Twilight::twilight_chapter_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">C</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_roadsign</span><span class="plain">) {</span>
<span class="functiontext">Roadsign::roadsign_chapter_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">C</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_unsigned</span><span class="plain">) {</span>
<span class="functiontext">Unsigned::unsigned_chapter_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">C</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_lacuna</span><span class="plain">) {</span>
<span class="functiontext">Lacuna::lacuna_chapter_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">C</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_4"></a><b>&#167;1.4. </b><code class="display">
&lt;<span class="cwebmacrodefn">Render the section title</span> <span class="cwebmacronumber">1.4</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_midnight</span><span class="plain">) {</span>
<span class="functiontext">Midnight::midnight_section_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_architect</span><span class="plain">) {</span>
<span class="functiontext">Architect::architect_section_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_twilight</span><span class="plain">) {</span>
<span class="functiontext">Twilight::twilight_section_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_roadsign</span><span class="plain">) {</span>
<span class="functiontext">Roadsign::roadsign_section_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_unsigned</span><span class="plain">) {</span>
<span class="functiontext">Unsigned::unsigned_section_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_lacuna</span><span class="plain">) {</span>
<span class="functiontext">Lacuna::lacuna_section_title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</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="SP2"></a><b>&#167;2. Index top. </b>And this is a variant for index pages, such as the index of examples.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Gadgets::render_navigation_index_top</span><span class="plain">(</span><span class="constant">OUTPUT_STREAM</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="reserved">filename</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">title</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_midnight</span><span class="plain">) {</span>
<span class="functiontext">Midnight::midnight_navigation_index_top</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="reserved">filename</span><span class="plain">, </span><span class="identifier">title</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_architect</span><span class="plain">) {</span>
<span class="functiontext">Architect::architect_navigation_index_top</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="reserved">filename</span><span class="plain">, </span><span class="identifier">title</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_twilight</span><span class="plain">) {</span>
<span class="functiontext">Twilight::twilight_navigation_index_top</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="reserved">filename</span><span class="plain">, </span><span class="identifier">title</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_roadsign</span><span class="plain">) {</span>
<span class="functiontext">Roadsign::roadsign_navigation_index_top</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="reserved">filename</span><span class="plain">, </span><span class="identifier">title</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_unsigned</span><span class="plain">) {</span>
<span class="functiontext">Unsigned::unsigned_navigation_index_top</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="reserved">filename</span><span class="plain">, </span><span class="identifier">title</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_lacuna</span><span class="plain">) {</span>
<span class="functiontext">Lacuna::lacuna_navigation_index_top</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="reserved">filename</span><span class="plain">, </span><span class="identifier">title</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Gadgets::render_navigation_index_top is used in 3/iu (<a href="3-iu.html#SP1">&#167;1</a>).</p>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. Middle. </b>At the middle part, when the text is over, but before any example cues.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Gadgets::render_navigation_middle</span><span class="plain">(</span><span class="constant">OUTPUT_STREAM</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">section</span><span class="plain"> *</span><span class="identifier">S</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_midnight</span><span class="plain">) {</span>
<span class="functiontext">Midnight::midnight_navigation_middle</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_architect</span><span class="plain">) {</span>
<span class="functiontext">Architect::architect_navigation_middle</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_twilight</span><span class="plain">) {</span>
<span class="functiontext">Twilight::twilight_navigation_middle</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_roadsign</span><span class="plain">) {</span>
<span class="functiontext">Roadsign::roadsign_navigation_middle</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_unsigned</span><span class="plain">) {</span>
<span class="functiontext">Unsigned::unsigned_navigation_middle</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_lacuna</span><span class="plain">) {</span>
<span class="functiontext">Lacuna::lacuna_navigation_middle</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Gadgets::render_navigation_middle is used in 2/rnd (<a href="2-rnd.html#SP9">&#167;9</a>).</p>
<p class="inwebparagraph"><a id="SP4"></a><b>&#167;4. Example top. </b>This is reached before the first example is rendered, provided at least
one example will be:
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Gadgets::render_navigation_example_top</span><span class="plain">(</span><span class="constant">OUTPUT_STREAM</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">section</span><span class="plain"> *</span><span class="identifier">S</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_format</span><span class="plain"> == </span><span class="constant">HTML_FORMAT</span><span class="plain">) {</span>
<span class="functiontext">HTML::begin_div_with_class_S</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"bookexamples"</span><span class="plain">);</span>
<span class="identifier">HTML_OPEN_WITH</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">, </span><span class="string">"class=\</span><span class="plain">"</span><span class="string">chapterheading\</span><span class="plain">"</span><span class="string">"</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_examples_granularity</span><span class="plain"> == 2) {</span>
<span class="reserved">chapter</span><span class="plain"> *</span><span class="identifier">C</span><span class="plain"> = </span><span class="identifier">S</span><span class="plain">-</span><span class="element">&gt;in_which_chapter</span><span class="plain">;</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"Examples from %S"</span><span class="plain">, </span><span class="identifier">C</span><span class="plain">-</span><span class="element">&gt;chapter_full_title</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_examples_granularity</span><span class="plain"> == 1) {</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"Examples"</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_format</span><span class="plain"> == </span><span class="constant">HTML_FORMAT</span><span class="plain">) {</span>
<span class="identifier">HTML_CLOSE</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> { </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"\</span><span class="plain">n</span><span class="string">\</span><span class="plain">n</span><span class="string">"</span><span class="plain">); }</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_midnight</span><span class="plain">) {</span>
<span class="functiontext">Midnight::midnight_navigation_example_top</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_twilight</span><span class="plain">) {</span>
<span class="functiontext">Twilight::twilight_navigation_example_top</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_architect</span><span class="plain">) {</span>
<span class="functiontext">Architect::architect_navigation_example_top</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_roadsign</span><span class="plain">) {</span>
<span class="functiontext">Roadsign::roadsign_navigation_example_top</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_unsigned</span><span class="plain">) {</span>
<span class="functiontext">Unsigned::unsigned_navigation_example_top</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_lacuna</span><span class="plain">) {</span>
<span class="functiontext">Lacuna::lacuna_navigation_example_top</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Gadgets::render_navigation_example_top is used in 2/rnd (<a href="2-rnd.html#SP9_1">&#167;9.1</a>).</p>
<p class="inwebparagraph"><a id="SP5"></a><b>&#167;5. Example bottom. </b>Any closing ornament at the end of examples? This is reached after the
last example is rendered, provided at least one example has been.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Gadgets::render_navigation_example_bottom</span><span class="plain">(</span><span class="constant">OUTPUT_STREAM</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">section</span><span class="plain"> *</span><span class="identifier">S</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_format</span><span class="plain"> == </span><span class="constant">PLAIN_FORMAT</span><span class="plain">) {</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"\</span><span class="plain">n</span><span class="string">\</span><span class="plain">n</span><span class="string">"</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_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">SET_examples_mode</span><span class="plain"> != </span><span class="constant">EXMODE_open_internal</span><span class="plain">) { </span><span class="functiontext">HTMLUtilities::ruled_line</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">); }</span>
<span class="functiontext">HTML::end_div</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_midnight</span><span class="plain">) {</span>
<span class="functiontext">Midnight::midnight_navigation_example_bottom</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_architect</span><span class="plain">) {</span>
<span class="functiontext">Architect::architect_navigation_example_bottom</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_twilight</span><span class="plain">) {</span>
<span class="functiontext">Twilight::twilight_navigation_example_bottom</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_roadsign</span><span class="plain">) {</span>
<span class="functiontext">Roadsign::roadsign_navigation_example_bottom</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_unsigned</span><span class="plain">) {</span>
<span class="functiontext">Unsigned::unsigned_navigation_example_bottom</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_lacuna</span><span class="plain">) {</span>
<span class="functiontext">Lacuna::lacuna_navigation_example_bottom</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Gadgets::render_navigation_example_bottom is used in 2/rnd (<a href="2-rnd.html#SP9_1">&#167;9.1</a>).</p>
<p class="inwebparagraph"><a id="SP6"></a><b>&#167;6. Bottom. </b>At the end of the section, after any example cues and perhaps also example
bodied. (In a section with no examples, this immediately follows the middle.)
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Gadgets::render_navigation_bottom</span><span class="plain">(</span><span class="constant">OUTPUT_STREAM</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">section</span><span class="plain"> *</span><span class="identifier">S</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_format</span><span class="plain"> == </span><span class="constant">HTML_FORMAT</span><span class="plain">) {</span>
<span class="functiontext">HTML::comment</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"START IGNORE"</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_midnight</span><span class="plain">) {</span>
<span class="functiontext">Midnight::midnight_navigation_bottom</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_architect</span><span class="plain">) {</span>
<span class="functiontext">Architect::architect_navigation_bottom</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_twilight</span><span class="plain">) {</span>
<span class="functiontext">Twilight::twilight_navigation_bottom</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_roadsign</span><span class="plain">) {</span>
<span class="functiontext">Roadsign::roadsign_navigation_bottom</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_unsigned</span><span class="plain">) {</span>
<span class="functiontext">Unsigned::unsigned_navigation_bottom</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_lacuna</span><span class="plain">) {</span>
<span class="functiontext">Lacuna::lacuna_navigation_bottom</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_format</span><span class="plain"> == </span><span class="constant">HTML_FORMAT</span><span class="plain">) {</span>
<span class="functiontext">HTML::comment</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"END IGNORE"</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Gadgets::render_navigation_bottom is used in 2/rnd (<a href="2-rnd.html#SP9">&#167;9</a>).</p>
<p class="inwebparagraph"><a id="SP7"></a><b>&#167;7. Contents page. </b>Midnight provides a contents page of its very own.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Gadgets::render_navigation_contents_files</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_midnight</span><span class="plain">) {</span>
<span class="functiontext">Midnight::midnight_navigation_contents_files</span><span class="plain">();</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_architect</span><span class="plain">) {</span>
<span class="functiontext">Architect::architect_navigation_contents_files</span><span class="plain">();</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_twilight</span><span class="plain">) {</span>
<span class="functiontext">Twilight::twilight_navigation_contents_files</span><span class="plain">();</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_roadsign</span><span class="plain">) {</span>
<span class="functiontext">Roadsign::roadsign_navigation_contents_files</span><span class="plain">();</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_unsigned</span><span class="plain">) {</span>
<span class="functiontext">Unsigned::unsigned_navigation_contents_files</span><span class="plain">();</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">SET_navigation</span><span class="plain"> == </span><span class="constant">NAVMODE_lacuna</span><span class="plain">) {</span>
<span class="functiontext">Lacuna::lacuna_navigation_contents_files</span><span class="plain">();</span>
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Gadgets::render_navigation_contents_files is used in 1/mn (<a href="1-mn.html#SP3_3">&#167;3.3</a>).</p>
<!--End of weave: 240 lines from a web of 16058-->
</body>
</html>
Reference in a new issue View git blame Copy permalink