mirror of
https://github.com/ganelson/inform.git
synced 2024-07-18 06:54:26 +03:00
432 lines
49 KiB
HTML
432 lines
49 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>5/ed</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 '5/ed2' generated by 7-->
|
|
<ul class="crumbs"><li><a href="../webs.html">★</a></li><li><a href="index.html">inbuild</a></li><li><a href="index.html#5">Chapter 5: Services for the Inform Compiler</a></li><li><b>Extension Documentation</b></li></ul><p class="purpose">To generate HTML documentation for extensions.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP1"></a><b>§1. </b>Each extension gets its own page in the external documentation area, but
|
|
this page can have two forms: the deluxe version, only produced if an
|
|
extension is successfully used, and a cut-down placeholder version, used
|
|
if Inform has detected the extension but never used it (and so does not really
|
|
understand what it entails). The following routine writes both kinds of page.
|
|
</p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Extensions::Documentation::write_detailed</span><span class="plain">(</span><span class="reserved">inform_extension</span><span class="plain"> *</span><span class="identifier">E</span><span class="plain">) {</span>
|
|
<span class="functiontext">Extensions::Documentation::write_extension_documentation</span><span class="plain">(</span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">E</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Extensions::Documentation::write_sketchy</span><span class="plain">(</span><span class="reserved">extension_census_datum</span><span class="plain"> *</span><span class="identifier">ecd</span><span class="plain">, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">census_mode</span><span class="plain">) {</span>
|
|
<span class="functiontext">Extensions::Documentation::write_extension_documentation</span><span class="plain">(</span><span class="identifier">ecd</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">census_mode</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Extensions::Documentation::write_detailed is used in 5/ec (<a href="5-ec.html#SP11">§11</a>).</p>
|
|
|
|
<p class="endnote">The function Extensions::Documentation::write_sketchy is used in 5/ec (<a href="5-ec.html#SP12">§12</a>).</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP2"></a><b>§2. </b>Thus we pass two arguments, <code class="display"><span class="extract">ecd</span></code> and <code class="display"><span class="extract">ef</span></code>, to <code class="display"><span class="extract">Extensions::Documentation::write_extension_documentation</span></code>:
|
|
one is a valid pointer, the other null. If <code class="display"><span class="extract">ef</span></code> is valid, we can write a full
|
|
page: if <code class="display"><span class="extract">ecd</span></code> is valid, only a sketchy one.
|
|
</p>
|
|
|
|
<p class="inwebparagraph">The outer shell routine calls the inner one first to generate the main
|
|
page of the documentation (where <code class="display"><span class="extract">eg_number</span></code> is <code class="display"><span class="extract">-1</span></code>), then uses its return
|
|
value (the number of examples provided, which may be 0) to generate
|
|
associated files for each example. For instance, we might end up making,
|
|
in sequence,
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">Documentation/Extensions/Emily Short/Locksmith.html</span>
|
|
<span class="plain">Documentation/Extensions/Emily Short/Locksmith-eg1.html</span>
|
|
<span class="plain">Documentation/Extensions/Emily Short/Locksmith-eg2.html</span>
|
|
<span class="plain">Documentation/Extensions/Emily Short/Locksmith-eg3.html</span>
|
|
<span class="plain">Documentation/Extensions/Emily Short/Locksmith-eg4.html</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">where these are pathnames relative to the external resources area.
|
|
</p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Extensions::Documentation::write_extension_documentation</span><span class="plain">(</span><span class="reserved">extension_census_datum</span><span class="plain"> *</span><span class="identifier">ecd</span><span class="plain">, </span><span class="reserved">inform_extension</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">census_mode</span><span class="plain">) {</span>
|
|
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">c</span><span class="plain">, </span><span class="identifier">eg_count</span><span class="plain">;</span>
|
|
<span class="identifier">eg_count</span><span class="plain"> = </span><span class="functiontext">Extensions::Documentation::write_extension_documentation_page</span><span class="plain">(</span><span class="identifier">ecd</span><span class="plain">, </span><span class="identifier">E</span><span class="plain">, -1, </span><span class="identifier">census_mode</span><span class="plain">);</span>
|
|
<span class="reserved">for</span><span class="plain"> (</span><span class="identifier">c</span><span class="plain">=1; </span><span class="identifier">c</span><span class="plain"><=</span><span class="identifier">eg_count</span><span class="plain">; </span><span class="identifier">c</span><span class="plain">++)</span>
|
|
<span class="functiontext">Extensions::Documentation::write_extension_documentation_page</span><span class="plain">(</span><span class="identifier">ecd</span><span class="plain">, </span><span class="identifier">E</span><span class="plain">, </span><span class="identifier">c</span><span class="plain">, </span><span class="identifier">census_mode</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Extensions::Documentation::write_extension_documentation is used in <a href="#SP1">§1</a>, <a href="#SP3_1">§3.1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3"></a><b>§3. </b>Here then is the nub of it. An ECD is not really enough information to go on.
|
|
We are not always obliged to make a sketchy page from an ECD: we decide against
|
|
in a normal run where a page exists for it already, as otherwise a user with
|
|
many extensions installed would detect an annoying slight delay on every run
|
|
of Inform — whereas a slight delay on each census-mode run is acceptable, since
|
|
census-mode runs are made only when extensions are installed or uninstalled.
|
|
If we do decide to make a page from an ECD, we in fact read the extension into
|
|
the lexer so as to make an EF of it. Of course, it won't be a very interesting
|
|
EF — since it wasn't used in compilation there will be no definitions arising
|
|
from it, so the top half of its documentation page will be vacant — but it
|
|
will at least provide the extension author's supplied documentation, if there
|
|
is any, as well as the correct identifying headings and requirements.
|
|
</p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">Extensions::Documentation::write_extension_documentation_page</span><span class="plain">(</span><span class="reserved">extension_census_datum</span><span class="plain"> *</span><span class="identifier">ecd</span><span class="plain">, </span><span class="reserved">inform_extension</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">eg_number</span><span class="plain">, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">census_mode</span><span class="plain">) {</span>
|
|
<span class="reserved">inbuild_work</span><span class="plain"> *</span><span class="identifier">work</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
|
|
<span class="identifier">text_stream</span><span class="plain"> </span><span class="identifier">DOCF_struct</span><span class="plain">;</span>
|
|
<span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">DOCF</span><span class="plain"> = &</span><span class="identifier">DOCF_struct</span><span class="plain">;</span>
|
|
<span class="reserved">FILE</span><span class="plain"> *</span><span class="identifier">TEST_DOCF</span><span class="plain">;</span>
|
|
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">page_exists_already</span><span class="plain">, </span><span class="identifier">no_egs</span><span class="plain"> = 0;</span>
|
|
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">ecd</span><span class="plain">) </span><span class="identifier">work</span><span class="plain"> = </span><span class="identifier">ecd</span><span class="plain">-</span><span class="element">>found_as</span><span class="plain">-</span><span class="element">>copy</span><span class="plain">-</span><span class="element">>edition</span><span class="plain">-</span><span class="element">>work</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">E</span><span class="plain">) </span><span class="identifier">work</span><span class="plain"> = </span><span class="identifier">E</span><span class="plain">-</span><span class="element">>as_copy</span><span class="plain">-</span><span class="element">>edition</span><span class="plain">-</span><span class="element">>work</span><span class="plain">;</span>
|
|
<span class="reserved">else</span><span class="plain"> </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"WEDP incorrectly called"</span><span class="plain">);</span>
|
|
<span class="identifier">LOGIF</span><span class="plain">(</span><span class="identifier">EXTENSIONS_CENSUS</span><span class="plain">, </span><span class="string">"WEDP %s (%X)/%d\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, (</span><span class="identifier">ecd</span><span class="plain">)?</span><span class="string">"ecd"</span><span class="plain">:</span><span class="string">" ef"</span><span class="plain">, </span><span class="identifier">work</span><span class="plain">, </span><span class="identifier">eg_number</span><span class="plain">);</span>
|
|
|
|
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">leaf</span><span class="plain">);</span>
|
|
<span class="identifier">Str::copy</span><span class="plain">(</span><span class="identifier">leaf</span><span class="plain">, </span><span class="identifier">work</span><span class="plain">-</span><span class="element">>title</span><span class="plain">);</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">eg_number</span><span class="plain"> > 0) </span><span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">leaf</span><span class="plain">, </span><span class="string">"-eg%d"</span><span class="plain">, </span><span class="identifier">eg_number</span><span class="plain">);</span>
|
|
<span class="identifier">filename</span><span class="plain"> *</span><span class="identifier">name</span><span class="plain"> = </span><span class="functiontext">Extensions::Documentation::location</span><span class="plain">(</span><span class="identifier">leaf</span><span class="plain">, </span><span class="identifier">work</span><span class="plain">-</span><span class="element">>author_name</span><span class="plain">);</span>
|
|
|
|
<span class="identifier">page_exists_already</span><span class="plain"> = </span><span class="identifier">FALSE</span><span class="plain">;</span>
|
|
<span class="identifier">TEST_DOCF</span><span class="plain"> = </span><span class="identifier">Filenames::fopen</span><span class="plain">(</span><span class="identifier">name</span><span class="plain">, </span><span class="string">"r"</span><span class="plain">);</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">TEST_DOCF</span><span class="plain">) { </span><span class="identifier">page_exists_already</span><span class="plain"> = </span><span class="identifier">TRUE</span><span class="plain">; </span><span class="identifier">fclose</span><span class="plain">(</span><span class="identifier">TEST_DOCF</span><span class="plain">); }</span>
|
|
<span class="identifier">LOGIF</span><span class="plain">(</span><span class="identifier">EXTENSIONS_CENSUS</span><span class="plain">, </span><span class="string">"WEDP %s: %f\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, (</span><span class="identifier">page_exists_already</span><span class="plain">)?</span><span class="string">"exists"</span><span class="plain">:</span><span class="string">"does not exist"</span><span class="plain">,</span>
|
|
<span class="identifier">name</span><span class="plain">);</span>
|
|
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">ecd</span><span class="plain">) {</span>
|
|
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">page_exists_already</span><span class="plain"> == </span><span class="identifier">FALSE</span><span class="plain">) || (</span><span class="identifier">census_mode</span><span class="plain">))</span>
|
|
<<span class="cwebmacro">Convert ECD to a text-only EF</span> <span class="cwebmacronumber">3.1</span>><span class="plain">;</span>
|
|
<span class="reserved">return</span><span class="plain"> 0; </span> <span class="comment">ensure no requests sent for further pages about the ECD: see below</span>
|
|
<span class="plain">}</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">E</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"null E in extension documentation writer"</span><span class="plain">);</span>
|
|
|
|
<span class="identifier">pathname</span><span class="plain"> *</span><span class="identifier">P</span><span class="plain"> = </span><span class="functiontext">Extensions::Documentation::path</span><span class="plain">();</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">P</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> 0;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Pathnames::create_in_file_system</span><span class="plain">(</span><span class="identifier">Pathnames::subfolder</span><span class="plain">(</span><span class="identifier">P</span><span class="plain">, </span><span class="identifier">work</span><span class="plain">-</span><span class="element">>author_name</span><span class="plain">)) == 0)</span>
|
|
<span class="reserved">return</span><span class="plain"> 0;</span>
|
|
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">STREAM_OPEN_TO_FILE</span><span class="plain">(</span><span class="identifier">DOCF</span><span class="plain">, </span><span class="identifier">name</span><span class="plain">, </span><span class="identifier">UTF8_ENC</span><span class="plain">) == </span><span class="identifier">FALSE</span><span class="plain">)</span>
|
|
<span class="reserved">return</span><span class="plain"> 0; </span> <span class="comment">if we lack permissions, e.g., then write no documentation</span>
|
|
|
|
<<span class="cwebmacro">Write the actual extension documentation page to DOCF</span> <span class="cwebmacronumber">3.2</span>><span class="plain">;</span>
|
|
<span class="identifier">STREAM_CLOSE</span><span class="plain">(</span><span class="identifier">DOCF</span><span class="plain">);</span>
|
|
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">leaf</span><span class="plain">);</span>
|
|
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">no_egs</span><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
|
|
<span class="identifier">pathname</span><span class="plain"> *</span><span class="functiontext">Extensions::Documentation::path</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
|
|
<span class="identifier">pathname</span><span class="plain"> *</span><span class="identifier">P</span><span class="plain"> = </span><span class="functiontext">Inbuild::transient</span><span class="plain">();</span>
|
|
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">P</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) || (</span><span class="identifier">Pathnames::create_in_file_system</span><span class="plain">(</span><span class="identifier">P</span><span class="plain">) == 0)) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">NULL</span><span class="plain">;</span>
|
|
<span class="identifier">P</span><span class="plain"> = </span><span class="identifier">Pathnames::subfolder</span><span class="plain">(</span><span class="identifier">P</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Documentation"</span><span class="plain">);</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Pathnames::create_in_file_system</span><span class="plain">(</span><span class="identifier">P</span><span class="plain">) == 0) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">NULL</span><span class="plain">;</span>
|
|
<span class="identifier">P</span><span class="plain"> = </span><span class="identifier">Pathnames::subfolder</span><span class="plain">(</span><span class="identifier">P</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Extensions"</span><span class="plain">);</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Pathnames::create_in_file_system</span><span class="plain">(</span><span class="identifier">P</span><span class="plain">) == 0) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">NULL</span><span class="plain">;</span>
|
|
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">P</span><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
|
|
<span class="identifier">filename</span><span class="plain"> *</span><span class="functiontext">Extensions::Documentation::location</span><span class="plain">(</span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">title</span><span class="plain">, </span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">author</span><span class="plain">) {</span>
|
|
<span class="identifier">pathname</span><span class="plain"> *</span><span class="identifier">P</span><span class="plain"> = </span><span class="functiontext">Extensions::Documentation::path</span><span class="plain">();</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">P</span><span class="plain"> == </span><span class="identifier">NULL</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="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">leaf</span><span class="plain">);</span>
|
|
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">leaf</span><span class="plain">, </span><span class="string">"%S.html"</span><span class="plain">, </span><span class="identifier">title</span><span class="plain">);</span>
|
|
<span class="identifier">filename</span><span class="plain"> *</span><span class="identifier">F</span><span class="plain"> = </span><span class="identifier">Filenames::in_folder</span><span class="plain">(</span><span class="identifier">Pathnames::subfolder</span><span class="plain">(</span><span class="identifier">P</span><span class="plain">, </span><span class="identifier">author</span><span class="plain">), </span><span class="identifier">leaf</span><span class="plain">);</span>
|
|
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">leaf</span><span class="plain">);</span>
|
|
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">F</span><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Extensions::Documentation::write_extension_documentation_page is used in <a href="#SP2">§2</a>.</p>
|
|
|
|
<p class="endnote">The function Extensions::Documentation::path appears nowhere else.</p>
|
|
|
|
<p class="endnote">The function Extensions::Documentation::location appears nowhere else.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3_1"></a><b>§3.1. </b>The reader may wonder why we perform the conversion in this slightly recursive
|
|
way, by calling our parent routine again. Wouldn't it be simpler just to set
|
|
<code class="display"><span class="extract">ecd</span></code> to null and let events take their course? The answer is that this would
|
|
fail if there were examples, because we would return (say) 3 for the number
|
|
of examples, and then the routine would be called 3 more times — but with
|
|
the original ECD as argument each time: that would mean reading the file
|
|
thrice more, reconverting to EF each time. So we restart the process from
|
|
our EF, and return 0 in response to the ECD call to prevent any further ECD
|
|
calls.
|
|
</p>
|
|
|
|
|
|
<p class="macrodefinition"><code class="display">
|
|
<<span class="cwebmacrodefn">Convert ECD to a text-only EF</span> <span class="cwebmacronumber">3.1</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="identifier">Feeds::feed_text</span><span class="plain">(</span><span class="identifier">L</span><span class="string">"This sentence provides a firebreak, no more. "</span><span class="plain">);</span>
|
|
<span class="identifier">E</span><span class="plain"> = </span><span class="functiontext">Extensions::Documentation::load</span><span class="plain">(</span><span class="identifier">work</span><span class="plain">);</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">E</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> 0; </span> <span class="comment">shouldn't happen: it was there only moments ago</span>
|
|
<span class="functiontext">Copies::read_source_text_for</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">-</span><span class="element">>as_copy</span><span class="plain">);</span>
|
|
<span class="functiontext">Extensions::Documentation::write_extension_documentation</span><span class="plain">(</span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">E</span><span class="plain">, </span><span class="identifier">census_mode</span><span class="plain">);</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP3">§3</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3_2"></a><b>§3.2. </b>We now make much the same "paste into the gap in the template" copying
|
|
exercise as when generating the home pages for extensions, though with a
|
|
different template:
|
|
</p>
|
|
|
|
|
|
<p class="macrodefinition"><code class="display">
|
|
<<span class="cwebmacrodefn">Write the actual extension documentation page to DOCF</span> <span class="cwebmacronumber">3.2</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</span><span class="plain"> = </span><span class="identifier">DOCF</span><span class="plain">;</span>
|
|
<span class="identifier">HTML::declare_as_HTML</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
|
|
|
|
<span class="identifier">HTML::begin_head</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">);</span>
|
|
<span class="identifier">HTML::title</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Extension"</span><span class="plain">);</span>
|
|
<span class="identifier">HTML::incorporate_javascript</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">TRUE</span><span class="plain">,</span>
|
|
<span class="functiontext">Inbuild::file_from_installation</span><span class="plain">(</span><span class="constant">JAVASCRIPT_FOR_ONE_EXTENSION_IRES</span><span class="plain">));</span>
|
|
<span class="identifier">HTML::incorporate_CSS</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="functiontext">Inbuild::file_from_installation</span><span class="plain">(</span><span class="constant">CSS_FOR_STANDARD_PAGES_IRES</span><span class="plain">));</span>
|
|
<span class="identifier">HTML::end_head</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">);</span>
|
|
|
|
<span class="identifier">HTML::begin_body</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">);</span>
|
|
<span class="identifier">HTML::incorporate_HTML</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="functiontext">Inbuild::file_from_installation</span><span class="plain">(</span><span class="constant">EXTENSION_DOCUMENTATION_MODEL_IRES</span><span class="plain">));</span>
|
|
<<span class="cwebmacro">Write documentation for a specific extension into the page</span> <span class="cwebmacronumber">3.2.1</span>><span class="plain">;</span>
|
|
<span class="identifier">HTML::end_body</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">);</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP3">§3</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3_2_1"></a><b>§3.2.1. </b>And this is the body:
|
|
</p>
|
|
|
|
|
|
<p class="macrodefinition"><code class="display">
|
|
<<span class="cwebmacrodefn">Write documentation for a specific extension into the page</span> <span class="cwebmacronumber">3.2.1</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="identifier">HTML_OPEN</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">);</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Works::is_standard_rules</span><span class="plain">(</span><span class="identifier">work</span><span class="plain">) == </span><span class="identifier">FALSE</span><span class="plain">)</span>
|
|
<<span class="cwebmacro">Write Javascript paste icon for source text to include this extension</span> <span class="cwebmacronumber">3.2.1.1</span>><span class="plain">;</span>
|
|
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"<b>"</span><span class="plain">);</span>
|
|
<span class="functiontext">Works::write_to_HTML_file</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">work</span><span class="plain">, </span><span class="identifier">TRUE</span><span class="plain">);</span>
|
|
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"</b>"</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="identifier">HTML_OPEN</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">);</span>
|
|
<span class="identifier">HTML_OPEN_WITH</span><span class="plain">(</span><span class="string">"span"</span><span class="plain">, </span><span class="string">"class=\</span><span class="plain">"</span><span class="string">smaller\</span><span class="plain">"</span><span class="string">"</span><span class="plain">);</span>
|
|
<<span class="cwebmacro">Write up any restrictions on VM usage</span> <span class="cwebmacronumber">3.2.1.2</span>><span class="plain">;</span>
|
|
<<span class="cwebmacro">Write up the version number, if any, and location</span> <span class="cwebmacronumber">3.2.1.3</span>><span class="plain">;</span>
|
|
<span class="identifier">HTML_CLOSE</span><span class="plain">(</span><span class="string">"span"</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="cwebmacro">Write up the rubric, if any</span> <span class="cwebmacronumber">3.2.1.4</span>><span class="plain">;</span>
|
|
<<span class="cwebmacro">Write up the table of contents for the extension author's supplied documentation, if any</span> <span class="cwebmacronumber">3.2.1.5</span>><span class="character">;</span>
|
|
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">CORE_MODULE</span>
|
|
<span class="identifier">Extensions::Files::document_in_detail</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">E</span><span class="plain">);</span>
|
|
<span class="plain">#</span><span class="identifier">endif</span>
|
|
<span class="identifier">HTML_TAG</span><span class="plain">(</span><span class="string">"hr"</span><span class="plain">);</span>
|
|
<<span class="cwebmacro">Write up the extension author's supplied documentation, if any</span> <span class="cwebmacronumber">3.2.1.6</span>><span class="character">;</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP3_2">§3.2</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3_2_1_1"></a><b>§3.2.1.1. </b>UTF-8 transcoding in the following is delegated to <code class="display"><span class="extract">HTML::Javascript::paste</span></code>:
|
|
</p>
|
|
|
|
|
|
<p class="macrodefinition"><code class="display">
|
|
<<span class="cwebmacrodefn">Write Javascript paste icon for source text to include this extension</span> <span class="cwebmacronumber">3.2.1.1</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">inclusion_text</span><span class="plain">);</span>
|
|
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">inclusion_text</span><span class="plain">, </span><span class="string">"Include %X.\</span><span class="plain">n</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">work</span><span class="plain">);</span>
|
|
<span class="identifier">HTML::Javascript::paste_stream</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">inclusion_text</span><span class="plain">);</span>
|
|
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">inclusion_text</span><span class="plain">);</span>
|
|
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"&nbsp;"</span><span class="plain">);</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP3_2_1">§3.2.1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3_2_1_2"></a><b>§3.2.1.2. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Write up any restrictions on VM usage</span> <span class="cwebmacronumber">3.2.1.2</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="identifier">compatibility_specification</span><span class="plain"> *</span><span class="identifier">C</span><span class="plain"> = </span><span class="identifier">E</span><span class="plain">-</span><span class="element">>as_copy</span><span class="plain">-</span><span class="element">>edition</span><span class="plain">-</span><span class="element">>compatibility</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Str::len</span><span class="plain">(</span><span class="identifier">C</span><span class="plain">-></span><span class="identifier">parsed_from</span><span class="plain">) > 0) {</span>
|
|
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"%S&nbsp;"</span><span class="plain">, </span><span class="identifier">C</span><span class="plain">-></span><span class="identifier">parsed_from</span><span class="plain">);</span>
|
|
<span class="functiontext">Extensions::Census::write_icons</span><span class="plain">(</span><span class="identifier">OUT</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="#SP3_2_1">§3.2.1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3_2_1_3"></a><b>§3.2.1.3. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Write up the version number, if any, and location</span> <span class="cwebmacronumber">3.2.1.3</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">E</span><span class="plain">) {</span>
|
|
<span class="identifier">semantic_version_number</span><span class="plain"> </span><span class="identifier">V</span><span class="plain"> = </span><span class="identifier">E</span><span class="plain">-</span><span class="element">>as_copy</span><span class="plain">-</span><span class="element">>edition</span><span class="plain">-</span><span class="element">>version</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">VersionNumbers::is_null</span><span class="plain">(</span><span class="identifier">V</span><span class="plain">) == </span><span class="identifier">FALSE</span><span class="plain">) </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"Version %v"</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">E</span><span class="plain">-</span><span class="element">>loaded_from_built_in_area</span><span class="plain">) {</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">VersionNumbers::is_null</span><span class="plain">(</span><span class="identifier">V</span><span class="plain">)) { </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"Extension"</span><span class="plain">); }</span>
|
|
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">" built in to Inform"</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP3_2_1">§3.2.1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3_2_1_4"></a><b>§3.2.1.4. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Write up the rubric, if any</span> <span class="cwebmacronumber">3.2.1.4</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">E</span><span class="plain">) {</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Str::len</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">-</span><span class="element">>rubric_as_lexed</span><span class="plain">) > 0) {</span>
|
|
<span class="identifier">HTML_OPEN</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">); </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"%S"</span><span class="plain">, </span><span class="identifier">E</span><span class="plain">-</span><span class="element">>rubric_as_lexed</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">if</span><span class="plain"> (</span><span class="identifier">Str::len</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">-</span><span class="element">>extra_credit_as_lexed</span><span class="plain">) > 0) {</span>
|
|
<span class="identifier">HTML_OPEN</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">); </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"<i>%S</i>"</span><span class="plain">, </span><span class="identifier">E</span><span class="plain">-</span><span class="element">>extra_credit_as_lexed</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="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP3_2_1">§3.2.1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3_2_1_5"></a><b>§3.2.1.5. </b>This appears above the definition paragraphs because it tends to be only
|
|
large extensions which provide TOCs: and they, ipso facto, make many definitions.
|
|
If the TOC were directly at the top of the supplied documentation, it might
|
|
easily be scrolled down off screen when the user first visits the page.
|
|
</p>
|
|
|
|
|
|
<p class="macrodefinition"><code class="display">
|
|
<<span class="cwebmacrodefn">Write up the table of contents for the extension author's supplied documentation, if any</span> <span class="cwebmacronumber">3.2.1.5</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">E</span><span class="plain">) {</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Wordings::nonempty</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">-</span><span class="element">>documentation_text</span><span class="plain">)) {</span>
|
|
<span class="identifier">HTML_OPEN</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">);</span>
|
|
<span class="identifier">HTML::Documentation::set_table_of_contents</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">-</span><span class="element">>documentation_text</span><span class="plain">, </span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">leaf</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="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP3_2_1">§3.2.1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3_2_1_6"></a><b>§3.2.1.6. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Write up the extension author's supplied documentation, if any</span> <span class="cwebmacronumber">3.2.1.6</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">E</span><span class="plain">) {</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Wordings::nonempty</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">-</span><span class="element">>documentation_text</span><span class="plain">))</span>
|
|
<span class="identifier">no_egs</span><span class="plain"> = </span><span class="identifier">HTML::Documentation::set_body_text</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">-</span><span class="element">>documentation_text</span><span class="plain">, </span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">eg_number</span><span class="plain">, </span><span class="identifier">leaf</span><span class="plain">);</span>
|
|
<span class="reserved">else</span><span class="plain"> {</span>
|
|
<span class="identifier">HTML_OPEN</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">);</span>
|
|
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"The extension provides no documentation."</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="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP3_2_1">§3.2.1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP4"></a><b>§4. </b></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="reserved">inform_extension</span><span class="plain"> *</span><span class="functiontext">Extensions::Documentation::load</span><span class="plain">(</span><span class="reserved">inbuild_work</span><span class="plain"> *</span><span class="identifier">work</span><span class="plain">) {</span>
|
|
<span class="reserved">inbuild_requirement</span><span class="plain"> *</span><span class="identifier">req</span><span class="plain"> = </span><span class="functiontext">Requirements::any_version_of</span><span class="plain">(</span><span class="identifier">work</span><span class="plain">);</span>
|
|
|
|
<span class="reserved">inform_extension</span><span class="plain"> *</span><span class="identifier">E</span><span class="plain">;</span>
|
|
<span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">, </span><span class="reserved">inform_extension</span><span class="plain">)</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Requirements::meets</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">-</span><span class="element">>as_copy</span><span class="plain">-</span><span class="element">>edition</span><span class="plain">, </span><span class="identifier">req</span><span class="plain">)) {</span>
|
|
<span class="functiontext">Extensions::must_satisfy</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">, </span><span class="identifier">req</span><span class="plain">);</span>
|
|
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">E</span><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
|
|
<span class="identifier">linked_list</span><span class="plain"> *</span><span class="identifier">L</span><span class="plain"> = </span><span class="identifier">NEW_LINKED_LIST</span><span class="plain">(</span><span class="reserved">inbuild_search_result</span><span class="plain">);</span>
|
|
<span class="functiontext">Nests::search_for</span><span class="plain">(</span><span class="identifier">req</span><span class="plain">, </span><span class="functiontext">Inbuild::nest_list</span><span class="plain">(), </span><span class="identifier">L</span><span class="plain">);</span>
|
|
<span class="reserved">inbuild_search_result</span><span class="plain"> *</span><span class="identifier">search_result</span><span class="plain">;</span>
|
|
<span class="identifier">LOOP_OVER_LINKED_LIST</span><span class="plain">(</span><span class="identifier">search_result</span><span class="plain">, </span><span class="reserved">inbuild_search_result</span><span class="plain">, </span><span class="identifier">L</span><span class="plain">) {</span>
|
|
<span class="identifier">E</span><span class="plain"> = </span><span class="functiontext">ExtensionManager::from_copy</span><span class="plain">(</span><span class="identifier">search_result</span><span class="plain">-</span><span class="element">>copy</span><span class="plain">);</span>
|
|
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">origin</span><span class="plain"> = </span><span class="functiontext">Nests::get_tag</span><span class="plain">(</span><span class="identifier">search_result</span><span class="plain">-</span><span class="element">>nest</span><span class="plain">);</span>
|
|
<span class="reserved">switch</span><span class="plain"> (</span><span class="identifier">origin</span><span class="plain">) {</span>
|
|
<span class="reserved">case</span><span class="plain"> </span><span class="constant">MATERIALS_NEST_TAG</span><span class="plain">:</span>
|
|
<span class="reserved">case</span><span class="plain"> </span><span class="constant">EXTERNAL_NEST_TAG</span><span class="plain">:</span>
|
|
<span class="identifier">E</span><span class="plain">-</span><span class="element">>loaded_from_built_in_area</span><span class="plain"> = </span><span class="identifier">FALSE</span><span class="plain">; </span><span class="reserved">break</span><span class="plain">;</span>
|
|
<span class="reserved">case</span><span class="plain"> </span><span class="constant">INTERNAL_NEST_TAG</span><span class="plain">:</span>
|
|
<span class="identifier">E</span><span class="plain">-</span><span class="element">>loaded_from_built_in_area</span><span class="plain"> = </span><span class="identifier">TRUE</span><span class="plain">; </span><span class="reserved">break</span><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">E</span><span class="plain">;</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 Extensions::Documentation::load is used in <a href="#SP3_1">§3.1</a>.</p>
|
|
|
|
<hr class="tocbar">
|
|
<ul class="toc"><li><a href="5-ed.html">Back to 'Extension Dictionary'</a></li><li><a href="5-ec.html">Continue with 'Extension Census'</a></li></ul><hr class="tocbar">
|
|
<!--End of weave-->
|
|
</body>
|
|
</html>
|
|
|