2020-02-27 13:18:25 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
2020-04-14 19:56:54 +03:00
< title > Extension Documentation< / title >
2020-03-19 02:11:25 +02:00
< meta name = "viewport" content = "width=device-width initial-scale=1" >
2020-02-27 13:18:25 +02:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
2020-03-19 02:11:25 +02:00
< link href = "../inweb.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-14 19:56:54 +03:00
2020-02-27 13:18:25 +02:00
< / head >
< body >
2020-03-19 02:11:25 +02:00
< nav role = "navigation" >
2020-04-14 19:56:54 +03:00
< h1 > < a href = "../index.html" >
< img src = "../docs-src/Figures/Inform.png" height = 72" >
< / a > < / h1 >
< ul > < li > < a href = "../compiler.html" > compiler tools< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../other.html" > other tools< / a > < / li >
< li > < a href = "../extensions.html" > extensions and kits< / a > < / li >
< li > < a href = "../units.html" > unit test tools< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Compiler Webs< / h2 > < ul >
2020-03-19 02:11:25 +02:00
< li > < a href = "../inbuild/index.html" > inbuild< / a > < / li >
< li > < a href = "../inform7/index.html" > inform7< / a > < / li >
< li > < a href = "../inter/index.html" > inter< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Inbuild Modules< / h2 > < ul >
< li > < a href = "index.html" > < span class = "selectedlink" > supervisor< / span > < / a > < / li >
< / ul > < h2 > Inform7 Modules< / h2 > < ul >
2020-03-19 02:11:25 +02:00
< li > < a href = "../core-module/index.html" > core< / a > < / li >
< li > < a href = "../inflections-module/index.html" > inflections< / a > < / li >
< li > < a href = "../linguistics-module/index.html" > linguistics< / a > < / li >
< li > < a href = "../kinds-module/index.html" > kinds< / a > < / li >
< li > < a href = "../if-module/index.html" > if< / a > < / li >
< li > < a href = "../multimedia-module/index.html" > multimedia< / a > < / li >
2020-04-14 19:56:54 +03:00
< li > < a href = "../problems-module/index.html" > problems< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../index-module/index.html" > index< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Inter Modules< / h2 > < ul >
< li > < a href = "../bytecode-module/index.html" > bytecode< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../building-module/index.html" > building< / a > < / li >
< li > < a href = "../codegen-module/index.html" > codegen< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Shared Modules< / h2 > < ul >
< li > < a href = "../arch-module/index.html" > arch< / a > < / li >
< li > < a href = "../syntax-module/index.html" > syntax< / a > < / li >
< li > < a href = "../words-module/index.html" > words< / a > < / li >
< li > < a href = "../html-module/index.html" > html< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../../../inweb/docs/foundation-module/index.html" > foundation< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul >
2020-03-19 02:11:25 +02:00
< / nav >
< main role = "main" >
2020-04-14 19:56:54 +03:00
<!-- Weave of 'Extension Documentation' generated by 7 -->
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "../compiler.html" > Inbuild Modules< / a > < / li > < li > < a href = "index.html" > supervisor< / a > < / li > < li > < a href = "index.html#7" > Chapter 7: Extension Indexing< / a > < / li > < li > < b > Extension Documentation< / b > < / li > < / ul > < p class = "purpose" > To generate HTML documentation for extensions.< / p >
2020-02-27 13:18:25 +02:00
< 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" >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::Documentation::write_detailed< button class = "popup" onclick = "togglePopup('usagePopup373')" > ...< span class = "popuptext" id = "usagePopup373" > Usage of < b > Extensions::Documentation::write_detailed< / b > :< br > Extension Census - < a href = "7-ec.html#SP11" > § 11< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > ) {< / span >
2020-04-16 01:49:59 +03:00
< span class = "functiontext" > < a href = "7-ed2.html#SP2" > Extensions::Documentation::write_extension_documentation< / a > < / 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 >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::Documentation::write_sketchy< button class = "popup" onclick = "togglePopup('usagePopup374')" > ...< span class = "popuptext" id = "usagePopup374" > Usage of < b > Extensions::Documentation::write_sketchy< / b > :< br > Extension Census - < a href = "7-ec.html#SP12" > § 12< / a > < / span > < / button > < / 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 >
2020-04-16 01:49:59 +03:00
< span class = "functiontext" > < a href = "7-ed2.html#SP2" > Extensions::Documentation::write_extension_documentation< / a > < / 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 >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / 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 >
< 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" >
2020-04-16 01:49:59 +03:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::Documentation::write_extension_documentation< button class = "popup" onclick = "togglePopup('usagePopup375')" > ...< span class = "popuptext" id = "usagePopup375" > Usage of < b > Extensions::Documentation::write_extension_documentation< / b > :< br > < a href = "7-ed2.html#SP1" > § 1< / a > , < a href = "7-ed2.html#SP3_1" > § 3.1< / a > < / span > < / button > < / 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 >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > eg_count< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "7-ed2.html#SP3" > Extensions::Documentation::write_extension_documentation_page< / a > < / 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 >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-16 01:49:59 +03:00
< span class = "functiontext" > < a href = "7-ed2.html#SP3" > Extensions::Documentation::write_extension_documentation_page< / a > < / 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 >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / 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" >
2020-04-16 01:49:59 +03:00
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::Documentation::write_extension_documentation_page< button class = "popup" onclick = "togglePopup('usagePopup376')" > ...< span class = "popuptext" id = "usagePopup376" > Usage of < b > Extensions::Documentation::write_extension_documentation_page< / b > :< br > < a href = "7-ed2.html#SP2" > § 2< / a > < / span > < / button > < / 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 >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-07 03:06:09 +03:00
< 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" > = < / span > < span class = "constant" > 0< / span > < span class = "plain" > ;< / span >
2020-02-27 13:18:25 +02:00
2020-04-07 03:06:09 +03:00
< 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 >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-07 03:06:09 +03:00
< 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\n"< / 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 >
2020-02-27 13:18:25 +02:00
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > leaf< / span > < span class = "plain" > );< / span >
2020-04-07 03:06:09 +03:00
< 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" > > < / span > < span class = "constant" > 0< / 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" > "-eg%d"< / span > < span class = "plain" > , < / span > < span class = "identifier" > eg_number< / span > < span class = "plain" > );< / span >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > name< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "7-ed2.html#SP3" > Extensions::Documentation::location< / a > < / 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 >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-07 03:06:09 +03:00
< 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\n"< / 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 >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "constant" > 0< / span > < span class = "plain" > ; < / span > < span class = "comment" > ensure no requests sent for further pages about the ECD: see below< / span >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > pathname< / span > < span class = "plain" > *< / span > < span class = "identifier" > P< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "7-ed2.html#SP3" > Extensions::Documentation::path< / a > < / span > < span class = "plain" > ();< / span >
2020-04-07 03:06:09 +03:00
< 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 = "constant" > 0< / span > < span class = "plain" > ;< / span >
2020-04-16 01:49:59 +03:00
< 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::down< / 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" > )) == < / span > < span class = "constant" > 0< / span > < span class = "plain" > )< / span >
2020-04-07 03:06:09 +03:00
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "constant" > 0< / span > < span class = "plain" > ;< / span >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "constant" > 0< / span > < span class = "plain" > ; < / span > < span class = "comment" > if we lack permissions, e.g., then write no documentation< / span >
2020-02-27 13:18:25 +02:00
< < 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 >
2020-04-14 19:56:54 +03:00
< span class = "identifier" > pathname< / span > < span class = "plain" > *< / span > < span class = "functiontext" > Extensions::Documentation::path< button class = "popup" onclick = "togglePopup('usagePopup377')" > ...< span class = "popuptext" id = "usagePopup377" > Usage of < b > Extensions::Documentation::path< / b > :< br > none< / span > < / button > < / 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" > < a href = "1-ic.html#SP16" > Inbuild::transient< / a > < / span > < span class = "plain" > ();< / span >
2020-04-07 03:06:09 +03:00
< 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" > ) == < / span > < span class = "constant" > 0< / span > < span class = "plain" > )) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > P< / span > < span class = "plain" > = < / span > < span class = "identifier" > Pathnames::down< / 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 >
2020-04-07 03:06:09 +03:00
< 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" > ) == < / span > < span class = "constant" > 0< / span > < span class = "plain" > ) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > P< / span > < span class = "plain" > = < / span > < span class = "identifier" > Pathnames::down< / 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 >
2020-04-07 03:06:09 +03:00
< 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" > ) == < / span > < span class = "constant" > 0< / span > < span class = "plain" > ) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
2020-02-27 13:18:25 +02:00
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > P< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
2020-04-14 19:56:54 +03:00
< span class = "identifier" > filename< / span > < span class = "plain" > *< / span > < span class = "functiontext" > Extensions::Documentation::location< button class = "popup" onclick = "togglePopup('usagePopup378')" > ...< span class = "popuptext" id = "usagePopup378" > Usage of < b > Extensions::Documentation::location< / b > :< br > none< / span > < / button > < / 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 >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > pathname< / span > < span class = "plain" > *< / span > < span class = "identifier" > P< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "7-ed2.html#SP3" > Extensions::Documentation::path< / a > < / span > < span class = "plain" > ();< / span >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > F< / span > < span class = "plain" > = < / span > < span class = "identifier" > Filenames::in< / span > < span class = "plain" > (< / span > < span class = "identifier" > Pathnames::down< / 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 >
2020-02-27 13:18:25 +02:00
< 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 = "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 >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > E< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "7-ed2.html#SP4" > Extensions::Documentation::load< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > work< / span > < span class = "plain" > );< / span >
2020-04-14 19:56:54 +03:00
< 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" > < / span > < span class = "constant" > 0< / span > < span class = "plain" > ; < / span > < span class = "comment" > shouldn't happen: it was there only moments ago< / span >
< span class = "functiontext" > < a href = "2-cps.html#SP7" > Copies::get_source_text< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > -> < / span > < span class = "element" > as_copy< / span > < span class = "plain" > );< / span >
2020-04-16 01:49:59 +03:00
< span class = "functiontext" > < a href = "7-ed2.html#SP2" > Extensions::Documentation::write_extension_documentation< / a > < / 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 >
2020-02-27 13:18:25 +02:00
< / pre >
< p class = "inwebparagraph" > < / p >
2020-04-16 01:49:59 +03:00
< p class = "endnote" > This code is used in < a href = "7-ed2.html#SP3" > § 3< / a > .< / p >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-14 19:56:54 +03:00
< span class = "functiontext" > < a href = "1-ic.html#SP23" > Inbuild::file_from_installation< / a > < / 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" > < a href = "1-ic.html#SP23" > Inbuild::file_from_installation< / a > < / span > < span class = "plain" > (< / span > < span class = "constant" > CSS_FOR_STANDARD_PAGES_IRES< / span > < span class = "plain" > ));< / span >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-14 19:56:54 +03:00
< span class = "identifier" > HTML::incorporate_HTML< / span > < span class = "plain" > (< / span > < span class = "identifier" > OUT< / span > < span class = "plain" > , < / span > < span class = "functiontext" > < a href = "1-ic.html#SP23" > Inbuild::file_from_installation< / a > < / span > < span class = "plain" > (< / span > < span class = "constant" > EXTENSION_DOCUMENTATION_MODEL_IRES< / span > < span class = "plain" > ));< / span >
2020-02-27 13:18:25 +02:00
< < 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 >
2020-04-16 01:49:59 +03:00
< p class = "endnote" > This code is used in < a href = "7-ed2.html#SP3" > § 3< / a > .< / p >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > < a href = "2-wrk.html#SP10" > Works::is_standard_rules< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > work< / span > < span class = "plain" > ) == < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > )< / span >
2020-02-27 13:18:25 +02:00
< < 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 >
2020-04-14 19:56:54 +03:00
< span class = "functiontext" > < a href = "2-wrk.html#SP5" > Works::write_to_HTML_file< / a > < / 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 >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-07 03:06:09 +03:00
< span class = "identifier" > HTML_OPEN_WITH< / span > < span class = "plain" > (< / span > < span class = "string" > "span"< / span > < span class = "plain" > , < / span > < span class = "string" > "class=\"smaller\""< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< < 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 >
2020-04-16 01:49:59 +03:00
< p class = "endnote" > This code is used in < a href = "7-ed2.html#SP3_2" > § 3.2< / a > .< / p >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-07 03:06:09 +03:00
< 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.\n\n\n"< / span > < span class = "plain" > , < / span > < span class = "identifier" > work< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-16 01:49:59 +03:00
< p class = "endnote" > This code is used in < a href = "7-ed2.html#SP3_2_1" > § 3.2.1< / a > .< / p >
2020-02-27 13:18:25 +02:00
< 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" >
2020-04-07 03:06:09 +03:00
< 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" > ) > < / span > < span class = "constant" > 0< / span > < span class = "plain" > ) {< / span >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-14 19:56:54 +03:00
< span class = "functiontext" > < a href = "7-ec.html#SP10" > Extensions::Census::write_icons< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > OUT< / span > < span class = "plain" > , < / span > < span class = "identifier" > C< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
2020-04-16 01:49:59 +03:00
< p class = "endnote" > This code is used in < a href = "7-ed2.html#SP3_2_1" > § 3.2.1< / a > .< / p >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-07 03:06:09 +03:00
< 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 >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-07 03:06:09 +03:00
< 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 >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-16 01:49:59 +03:00
< p class = "endnote" > This code is used in < a href = "7-ed2.html#SP3_2_1" > § 3.2.1< / a > .< / p >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-07 03:06:09 +03:00
< 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" > ) > < / span > < span class = "constant" > 0< / 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" > "%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 >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
2020-04-07 03:06:09 +03:00
< 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" > ) > < / span > < span class = "constant" > 0< / 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" > "< 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 >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
2020-04-16 01:49:59 +03:00
< p class = "endnote" > This code is used in < a href = "7-ed2.html#SP3_2_1" > § 3.2.1< / a > .< / p >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-07 03:06:09 +03:00
< 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 >
2020-02-27 13:18:25 +02:00
< span class = "identifier" > HTML_OPEN< / span > < span class = "plain" > (< / span > < span class = "string" > "p"< / span > < span class = "plain" > );< / span >
2020-04-07 03:06:09 +03:00
< 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 >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-16 01:49:59 +03:00
< p class = "endnote" > This code is used in < a href = "7-ed2.html#SP3_2_1" > § 3.2.1< / a > .< / p >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-07 03:06:09 +03:00
< 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 >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-16 01:49:59 +03:00
< p class = "endnote" > This code is used in < a href = "7-ed2.html#SP3_2_1" > § 3.2.1< / a > .< / p >
2020-02-27 13:18:25 +02:00
< p class = "inwebparagraph" > < a id = "SP4" > < / a > < b > § 4. < / b > < / p >
< pre class = "display" >
2020-04-16 01:49:59 +03:00
< span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "functiontext" > Extensions::Documentation::load< button class = "popup" onclick = "togglePopup('usagePopup379')" > ...< span class = "popuptext" id = "usagePopup379" > Usage of < b > Extensions::Documentation::load< / b > :< br > < a href = "7-ed2.html#SP3_1" > § 3.1< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > inbuild_work< / span > < span class = "plain" > *< / span > < span class = "identifier" > work< / span > < span class = "plain" > ) {< / span >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > inbuild_requirement< / span > < span class = "plain" > *< / span > < span class = "identifier" > req< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "2-rqr.html#SP2" > Requirements::any_version_of< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > work< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > < a href = "2-rqr.html#SP7" > Requirements::meets< / a > < / 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" > < a href = "5-es.html#SP7" > Extensions::must_satisfy< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > , < / span > < span class = "identifier" > req< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-14 19:56:54 +03:00
< span class = "functiontext" > < a href = "2-nst.html#SP7" > Nests::search_for< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > req< / span > < span class = "plain" > , < / span > < span class = "functiontext" > < a href = "1-ic.html#SP15" > Inbuild::nest_list< / a > < / span > < span class = "plain" > (), < / span > < span class = "identifier" > L< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< 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 >
2020-04-14 19:56:54 +03:00
< span class = "identifier" > E< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "4-em.html#SP4" > ExtensionManager::from_copy< / a > < / 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" > < a href = "2-nst.html#SP2" > Nests::get_tag< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > search_result< / span > < span class = "plain" > -> < / span > < span class = "element" > nest< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "reserved" > switch< / span > < span class = "plain" > (< / span > < span class = "identifier" > origin< / span > < span class = "plain" > ) {< / span >
2020-04-07 03:06:09 +03:00
< span class = "reserved" > case< / span > < span class = "plain" > < / span > < span class = "identifier" > MATERIALS_NEST_TAG:< / span >
< span class = "reserved" > case< / span > < span class = "plain" > < / span > < span class = "identifier" > EXTERNAL_NEST_TAG:< / 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 = "identifier" > INTERNAL_NEST_TAG:< / 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 >
2020-02-27 13:18:25 +02:00
< 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 >
< hr class = "tocbar" >
2020-03-31 02:17:21 +03:00
< ul class = "toc" > < li > < a href = "7-ed.html" > Back to 'Extension Dictionary'< / a > < / li > < li > < a href = "7-ec.html" > Continue with 'Extension Census'< / a > < / li > < / ul > < hr class = "tocbar" >
2020-02-27 13:18:25 +02:00
<!-- End of weave -->
2020-04-14 19:56:54 +03:00
< script >
function togglePopup(material_id) {
var popup = document.getElementById(material_id);
popup.classList.toggle("show");
}
< / script >
< link href = "Popups.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-03-19 02:11:25 +02:00
< / main >
2020-02-27 13:18:25 +02:00
< / body >
< / html >
