ifhub/inform7
1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-08 10:04:21 +03:00
Code Issues Projects Releases Wiki Activity
inform7/docs/indoc/4-nd.html

318 lines
40 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>3/ei</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 '4/nd' 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#4">Chapter 4: Navigation Styles</a></li><li><b>Navigational Designs</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. </a></li><li><a href="#SP2">&#167;2. Top</a></li><li><a href="#SP3">&#167;3. Index top</a></li><li><a href="#SP4">&#167;4. Middle</a></li><li><a href="#SP5">&#167;5. Example top</a></li><li><a href="#SP6">&#167;6. Example bottom</a></li><li><a href="#SP7">&#167;7. Bottom</a></li><li><a href="#SP8">&#167;8. Contents page</a></li></ul><hr class="tocbar">
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. </b></p>
<pre class="display">
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">navigation_design</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">codename</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">ebook_friendly</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">plain_friendly</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">columnar</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">simplified_examples</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">simplified_letter_rows</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">contents_body_class</span><span class="plain">;</span>
<span class="constant">METHOD_CALLS</span>
<span class="constant">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">navigation_design</span><span class="plain">;</span>
<span class="reserved">navigation_design</span><span class="plain"> *</span><span class="functiontext">Nav::new</span><span class="plain">(</span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">code</span><span class="plain">, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">e</span><span class="plain">, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">p</span><span class="plain">) {</span>
<span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">ND</span><span class="plain"> = </span><span class="identifier">CREATE</span><span class="plain">(</span><span class="reserved">navigation_design</span><span class="plain">);</span>
<span class="identifier">ND</span><span class="plain">-</span><span class="element">&gt;codename</span><span class="plain"> = </span><span class="functiontext">Str::duplicate</span><span class="plain">(</span><span class="identifier">code</span><span class="plain">);</span>
<span class="identifier">ND</span><span class="plain">-</span><span class="element">&gt;ebook_friendly</span><span class="plain"> = </span><span class="identifier">e</span><span class="plain">;</span>
<span class="identifier">ND</span><span class="plain">-</span><span class="element">&gt;plain_friendly</span><span class="plain"> = </span><span class="identifier">p</span><span class="plain">;</span>
<span class="identifier">ND</span><span class="plain">-</span><span class="element">&gt;columnar</span><span class="plain"> = </span><span class="constant">FALSE</span><span class="plain">;</span>
<span class="identifier">ND</span><span class="plain">-</span><span class="element">&gt;simplified_examples</span><span class="plain"> = </span><span class="constant">FALSE</span><span class="plain">;</span>
<span class="identifier">ND</span><span class="plain">-</span><span class="element">&gt;simplified_letter_rows</span><span class="plain"> = </span><span class="constant">FALSE</span><span class="plain">;</span>
<span class="identifier">ND</span><span class="plain">-</span><span class="element">&gt;contents_body_class</span><span class="plain"> = </span><span class="identifier">I</span><span class="string">"paper midnightpapertint"</span><span class="plain">;</span>
<span class="identifier">ND</span><span class="plain">-&gt;</span><span class="identifier">methods</span><span class="plain"> = </span><span class="functiontext">Methods::new_set</span><span class="plain">();</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">ND</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Nav::start</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="functiontext">Midnight::create</span><span class="plain">(); </span> <span class="comment">needs to be created first</span>
<span class="functiontext">Twilight::create</span><span class="plain">();</span>
<span class="functiontext">Architect::create</span><span class="plain">();</span>
<span class="functiontext">Roadsign::create</span><span class="plain">(); </span> <span class="comment">needs to be created before unsigned</span>
<span class="functiontext">Unsigned::create</span><span class="plain">();</span>
<span class="functiontext">Lacuna::create</span><span class="plain">();</span>
<span class="plain">}</span>
<span class="reserved">navigation_design</span><span class="plain"> *</span><span class="functiontext">Nav::default</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">FIRST_OBJECT</span><span class="plain">(</span><span class="reserved">navigation_design</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">navigation_design</span><span class="plain"> *</span><span class="functiontext">Nav::for_ebook</span><span class="plain">(</span><span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">current</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">current</span><span class="plain">-</span><span class="element">&gt;ebook_friendly</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">current</span><span class="plain">;</span>
<span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">ND</span><span class="plain">;</span>
<span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">ND</span><span class="plain">, </span><span class="reserved">navigation_design</span><span class="plain">)</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">ND</span><span class="plain">-</span><span class="element">&gt;ebook_friendly</span><span class="plain">)</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">ND</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">navigation_design</span><span class="plain"> *</span><span class="functiontext">Nav::for_plain_text</span><span class="plain">(</span><span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">current</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">current</span><span class="plain">-</span><span class="element">&gt;plain_friendly</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">current</span><span class="plain">;</span>
<span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">ND</span><span class="plain">;</span>
<span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">ND</span><span class="plain">, </span><span class="reserved">navigation_design</span><span class="plain">)</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">ND</span><span class="plain">-</span><span class="element">&gt;plain_friendly</span><span class="plain">)</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">ND</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">navigation_design</span><span class="plain"> *</span><span class="functiontext">Nav::parse</span><span class="plain">(</span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">val</span><span class="plain">) {</span>
<span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">ND</span><span class="plain">;</span>
<span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">ND</span><span class="plain">, </span><span class="reserved">navigation_design</span><span class="plain">)</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Str::eq</span><span class="plain">(</span><span class="identifier">val</span><span class="plain">, </span><span class="identifier">ND</span><span class="plain">-</span><span class="element">&gt;codename</span><span class="plain">))</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">ND</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Nav::new is used in 4/cl (<a href="4-cl.html#SP1">&#167;1</a>), 4/cm (<a href="4-cm.html#SP1">&#167;1</a>), 4/ca (<a href="4-ca.html#SP1">&#167;1</a>), 4/ct (<a href="4-ct.html#SP1">&#167;1</a>), 4/cr (<a href="4-cr.html#SP1">&#167;1</a>), 4/cu (<a href="4-cu.html#SP1">&#167;1</a>).</p>
<p class="endnote">The function Nav::start is used in 1/mn (<a href="1-mn.html#SP1_1">&#167;1.1</a>).</p>
<p class="endnote">The function Nav::default is used in 1/ins (<a href="1-ins.html#SP2">&#167;2</a>).</p>
<p class="endnote">The function Nav::for_ebook is used in 1/ins (<a href="1-ins.html#SP3_1">&#167;3.1</a>).</p>
<p class="endnote">The function Nav::for_plain_text is used in 1/ins (<a href="1-ins.html#SP3_1">&#167;3.1</a>).</p>
<p class="endnote">The function Nav::parse is used in 1/ins (<a href="1-ins.html#SP5_1_5_2">&#167;5.1.5.2</a>).</p>
<p class="endnote">The structure navigation_design is accessed in 2/exm, 3/iu, 4/cm, 4/ca, 4/ct and here.</p>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. Top. </b>At the front end of a section, before any of its text.
</p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">RENDER_VOLUME_TITLE_MTID</span>
<span class="definitionkeyword">enum</span> <span class="constant">RENDER_CHAPTER_TITLE_MTID</span>
<span class="definitionkeyword">enum</span> <span class="constant">RENDER_SECTION_TITLE_MTID</span>
</pre>
<pre class="display">
<span class="identifier">VMETHOD_TYPE</span><span class="plain">(</span><span class="constant">RENDER_VOLUME_TITLE_MTID</span><span class="plain">, </span><span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">ND</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</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">VMETHOD_TYPE</span><span class="plain">(</span><span class="constant">RENDER_CHAPTER_TITLE_MTID</span><span class="plain">, </span><span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">ND</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</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">chapter</span><span class="plain"> *</span><span class="identifier">C</span><span class="plain">)</span>
<span class="identifier">VMETHOD_TYPE</span><span class="plain">(</span><span class="constant">RENDER_SECTION_TITLE_MTID</span><span class="plain">, </span><span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">ND</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</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">chapter</span><span class="plain"> *</span><span class="identifier">C</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">void</span><span class="plain"> </span><span class="functiontext">Nav::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><span class="identifier">VMETHOD_CALL</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">&gt;navigation</span><span class="plain">, </span><span class="constant">RENDER_VOLUME_TITLE_MTID</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="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><span class="identifier">VMETHOD_CALL</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">&gt;navigation</span><span class="plain">, </span><span class="constant">RENDER_CHAPTER_TITLE_MTID</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="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">&gt;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">2.1</span>&gt;<span class="plain">;</span>
<span class="identifier">VMETHOD_CALL</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">&gt;navigation</span><span class="plain">, </span><span class="constant">RENDER_SECTION_TITLE_MTID</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="identifier">S</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Nav::render_navigation_top is used in 2/rnd (<a href="2-rnd.html#SP9">&#167;9</a>).</p>
<p class="inwebparagraph"><a id="SP2_1"></a><b>&#167;2.1. </b><code class="display">
&lt;<span class="cwebmacrodefn">Write HTML comments giving the Inform user interface search assistance</span> <span class="cwebmacronumber">2.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="#SP2">&#167;2</a>.</p>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. Index top. </b>And this is a variant for index pages, such as the index of examples.
</p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">RENDER_INDEX_TOP_MTID</span>
</pre>
<pre class="display">
<span class="identifier">VMETHOD_TYPE</span><span class="plain">(</span><span class="constant">RENDER_INDEX_TOP_MTID</span><span class="plain">, </span><span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">ND</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</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">void</span><span class="plain"> </span><span class="functiontext">Nav::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="identifier">VMETHOD_CALL</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">&gt;navigation</span><span class="plain">, </span><span class="constant">RENDER_INDEX_TOP_MTID</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>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Nav::render_navigation_index_top is used in 3/iu (<a href="3-iu.html#SP1">&#167;1</a>).</p>
<p class="inwebparagraph"><a id="SP4"></a><b>&#167;4. Middle. </b>At the middle part, when the text is over, but before any example cues.
</p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">RENDER_NAV_MIDDLE_MTID</span>
</pre>
<pre class="display">
<span class="identifier">VMETHOD_TYPE</span><span class="plain">(</span><span class="constant">RENDER_NAV_MIDDLE_MTID</span><span class="plain">, </span><span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">ND</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</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">void</span><span class="plain"> </span><span class="functiontext">Nav::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="identifier">VMETHOD_CALL</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">&gt;navigation</span><span class="plain">, </span><span class="constant">RENDER_NAV_MIDDLE_MTID</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">The function Nav::render_navigation_middle is used in 2/rnd (<a href="2-rnd.html#SP9">&#167;9</a>).</p>
<p class="inwebparagraph"><a id="SP5"></a><b>&#167;5. Example top. </b>This is reached before the first example is rendered, provided at least
one example will be:
</p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">RENDER_EXAMPLE_TOP_MTID</span>
</pre>
<pre class="display">
<span class="identifier">VMETHOD_TYPE</span><span class="plain">(</span><span class="constant">RENDER_EXAMPLE_TOP_MTID</span><span class="plain">, </span><span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">ND</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</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">void</span><span class="plain"> </span><span class="functiontext">Nav::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">indoc_settings</span><span class="plain">-</span><span class="element">&gt;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">indoc_settings</span><span class="plain">-</span><span class="element">&gt;examples_granularity</span><span class="plain"> == </span><span class="constant">CHAPTER_GRANULARITY</span><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;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">indoc_settings</span><span class="plain">-</span><span class="element">&gt;examples_granularity</span><span class="plain"> == </span><span class="constant">BOOK_GRANULARITY</span><span class="plain">) {</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">indoc_settings</span><span class="plain">-</span><span class="element">&gt;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="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="identifier">VMETHOD_CALL</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">&gt;navigation</span><span class="plain">, </span><span class="constant">RENDER_EXAMPLE_TOP_MTID</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">The function Nav::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="SP6"></a><b>&#167;6. 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="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">RENDER_EXAMPLE_BOTTOM_MTID</span>
</pre>
<pre class="display">
<span class="identifier">VMETHOD_TYPE</span><span class="plain">(</span><span class="constant">RENDER_EXAMPLE_BOTTOM_MTID</span><span class="plain">, </span><span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">ND</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</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">void</span><span class="plain"> </span><span class="functiontext">Nav::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">indoc_settings</span><span class="plain">-</span><span class="element">&gt;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="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">&gt;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">indoc_settings</span><span class="plain">-</span><span class="element">&gt;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="identifier">VMETHOD_CALL</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">&gt;navigation</span><span class="plain">, </span><span class="constant">RENDER_EXAMPLE_BOTTOM_MTID</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">The function Nav::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="SP7"></a><b>&#167;7. 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="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">RENDER_NAV_BOTTOM_MTID</span>
</pre>
<pre class="display">
<span class="identifier">VMETHOD_TYPE</span><span class="plain">(</span><span class="constant">RENDER_NAV_BOTTOM_MTID</span><span class="plain">, </span><span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">ND</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</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">void</span><span class="plain"> </span><span class="functiontext">Nav::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">indoc_settings</span><span class="plain">-</span><span class="element">&gt;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="identifier">VMETHOD_CALL</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">&gt;navigation</span><span class="plain">, </span><span class="constant">RENDER_NAV_BOTTOM_MTID</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="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">&gt;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>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Nav::render_navigation_bottom is used in 2/rnd (<a href="2-rnd.html#SP9">&#167;9</a>).</p>
<p class="inwebparagraph"><a id="SP8"></a><b>&#167;8. Contents page. </b>Midnight provides a contents page of its very own.
</p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">RENDER_CONTENTS_MTID</span>
<span class="definitionkeyword">enum</span> <span class="constant">RENDER_CONTENTS_HEADING_MTID</span>
</pre>
<pre class="display">
<span class="identifier">VMETHOD_TYPE</span><span class="plain">(</span><span class="constant">RENDER_CONTENTS_MTID</span><span class="plain">, </span><span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">ND</span><span class="plain">)</span>
<span class="identifier">VMETHOD_TYPE</span><span class="plain">(</span><span class="constant">RENDER_CONTENTS_HEADING_MTID</span><span class="plain">, </span><span class="reserved">navigation_design</span><span class="plain"> *</span><span class="identifier">ND</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</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">void</span><span class="plain"> </span><span class="functiontext">Nav::render_navigation_contents_files</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="identifier">VMETHOD_CALLV</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">&gt;navigation</span><span class="plain">, </span><span class="constant">RENDER_CONTENTS_MTID</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Nav::navigation_contents_heading</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="identifier">VMETHOD_CALL</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">&gt;navigation</span><span class="plain">, </span><span class="constant">RENDER_CONTENTS_HEADING_MTID</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">The function Nav::render_navigation_contents_files is used in 1/mn (<a href="1-mn.html#SP1_3">&#167;1.3</a>).</p>
<p class="endnote">The function Nav::navigation_contents_heading is used in 4/cm (<a href="4-cm.html#SP9">&#167;9</a>).</p>
<hr class="tocbar">
<ul class="toc"><li><i>(This section begins Chapter 4: Navigation Styles.)</i></li><li><a href="4-cl.html">Continue with 'Codename Lacuna'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</body>
</html>
Reference in a new issue View git blame Copy permalink