Documented new collation features

This commit is contained in:
Graham Nelson 2020-05-03 00:22:24 +01:00
parent f06ec6100d
commit 069e6db6dc
16 changed files with 1181 additions and 1103 deletions

View file

@ -53,7 +53,7 @@ typedef struct collater_state {
struct linked_list_item *repeat_stack_variable[CI_STACK_CAPACITY];
struct linked_list_item *repeat_stack_threshold[CI_STACK_CAPACITY];
int repeat_stack_startpos[CI_STACK_CAPACITY];
int stack_pointer; /* And this is our stack pointer for tracking of loops */
int sp; /* And this is our stack pointer for tracking of loops */
struct text_stream *restrict_to_range;
struct weave_pattern *nav_pattern;
struct filename *nav_file;
@ -76,7 +76,7 @@ collater_state Collater::initial_state(web *W, text_stream *range,
collater_state cls;
cls.no_tlines = 0;
cls.restrict_to_range = Str::duplicate(range);
cls.stack_pointer = 0;
cls.sp = 0;
cls.inside_navigation_submenu = FALSE;
cls.for_web = W;
cls.nav_pattern = pattern;
@ -155,7 +155,7 @@ This is used only for debugging:
@<Print line and contents of repeat stack@> =
PRINT("%04d: %S\nStack:", lpos-1, tl);
for (int j=0; j<cls->stack_pointer; j++) {
for (int j=0; j<cls->sp; j++) {
if (cls->repeat_stack_level[j] == CHAPTER_LEVEL)
PRINT(" %d: %S/%S",
j, ((chapter *)
@ -210,6 +210,23 @@ chapter as its value during the sole iteration.
} else if (Str::eq(condition, I"Modules")) {
if (LinkedLists::len(cls->modules) > 0)
level = IF_TRUE_LEVEL;
} else if (Str::eq(condition, I"Module Page")) {
module *M = CONTENT_IN_ITEM(
Collater::heading_topmost_on_stack(cls, MODULE_LEVEL), module);
if ((M) && (Colonies::find(M->module_name)))
level = IF_TRUE_LEVEL;
} else if (Str::eq(condition, I"Module Purpose")) {
module *M = CONTENT_IN_ITEM(
Collater::heading_topmost_on_stack(cls, MODULE_LEVEL), module);
if (M) {
TEMPORARY_TEXT(url);
TEMPORARY_TEXT(purpose);
WRITE_TO(url, "%p", M->module_location);
Readme::write_var(purpose, url, I"Purpose");
if (Str::len(purpose) > 0) level = IF_TRUE_LEVEL;
DISCARD_TEXT(url);
DISCARD_TEXT(purpose);
}
} else if (Str::eq(condition, I"Chapter Purpose")) {
chapter *C = CONTENT_IN_ITEM(
Collater::heading_topmost_on_stack(cls, CHAPTER_LEVEL), chapter);
@ -229,19 +246,19 @@ chapter as its value during the sole iteration.
@<Deal with an Else command@> =
if (Regexp::match(&mr, command, L"Else")) {
if (cls->stack_pointer <= 0) {
if (cls->sp <= 0) {
Errors::at_position("Else without If",
cls->errors_at, lpos);
goto CYCLE;
}
switch (cls->repeat_stack_level[cls->stack_pointer-1]) {
switch (cls->repeat_stack_level[cls->sp-1]) {
case SECTION_LEVEL:
case CHAPTER_LEVEL:
Errors::at_position("Else not matched with If",
cls->errors_at, lpos);
break;
case IF_TRUE_LEVEL: cls->repeat_stack_level[cls->stack_pointer-1] = IF_FALSE_LEVEL; break;
case IF_FALSE_LEVEL: cls->repeat_stack_level[cls->stack_pointer-1] = IF_TRUE_LEVEL; break;
case IF_TRUE_LEVEL: cls->repeat_stack_level[cls->sp-1] = IF_FALSE_LEVEL; break;
case IF_FALSE_LEVEL: cls->repeat_stack_level[cls->sp-1] = IF_TRUE_LEVEL; break;
}
Regexp::dispose_of(&mr);
goto CYCLE;
@ -306,12 +323,12 @@ chapter as its value during the sole iteration.
if (Regexp::match(&mr, command, L"End Select")) end_form = 2;
if (Regexp::match(&mr, command, L"End If")) end_form = 3;
if (end_form > 0) {
if (cls->stack_pointer <= 0) {
if (cls->sp <= 0) {
Errors::at_position("stack underflow on contents template",
cls->errors_at, lpos);
goto CYCLE;
}
switch (cls->repeat_stack_level[cls->stack_pointer-1]) {
switch (cls->repeat_stack_level[cls->sp-1]) {
case MODULE_LEVEL:
case CHAPTER_LEVEL:
case SECTION_LEVEL:
@ -330,7 +347,7 @@ chapter as its value during the sole iteration.
}
break;
}
switch (cls->repeat_stack_level[cls->stack_pointer-1]) {
switch (cls->repeat_stack_level[cls->sp-1]) {
case MODULE_LEVEL: @<End a module repeat@>; break;
case CHAPTER_LEVEL: @<End a chapter repeat@>; break;
case SECTION_LEVEL: @<End a section repeat@>; break;
@ -341,34 +358,34 @@ chapter as its value during the sole iteration.
}
@<End a module repeat@> =
linked_list_item *CI = cls->repeat_stack_variable[cls->stack_pointer-1];
if (CI == cls->repeat_stack_threshold[cls->stack_pointer-1])
linked_list_item *CI = cls->repeat_stack_variable[cls->sp-1];
if (CI == cls->repeat_stack_threshold[cls->sp-1])
Collater::end_CI_loop(cls);
else {
cls->repeat_stack_variable[cls->stack_pointer-1] =
cls->repeat_stack_variable[cls->sp-1] =
NEXT_ITEM_IN_LINKED_LIST(CI, chapter);
lpos = cls->repeat_stack_startpos[cls->stack_pointer-1]; /* Back round loop */
lpos = cls->repeat_stack_startpos[cls->sp-1]; /* Back round loop */
}
@<End a chapter repeat@> =
linked_list_item *CI = cls->repeat_stack_variable[cls->stack_pointer-1];
if (CI == cls->repeat_stack_threshold[cls->stack_pointer-1])
linked_list_item *CI = cls->repeat_stack_variable[cls->sp-1];
if (CI == cls->repeat_stack_threshold[cls->sp-1])
Collater::end_CI_loop(cls);
else {
cls->repeat_stack_variable[cls->stack_pointer-1] =
cls->repeat_stack_variable[cls->sp-1] =
NEXT_ITEM_IN_LINKED_LIST(CI, chapter);
lpos = cls->repeat_stack_startpos[cls->stack_pointer-1]; /* Back round loop */
lpos = cls->repeat_stack_startpos[cls->sp-1]; /* Back round loop */
}
@<End a section repeat@> =
linked_list_item *SI = cls->repeat_stack_variable[cls->stack_pointer-1];
if ((SI == cls->repeat_stack_threshold[cls->stack_pointer-1]) ||
linked_list_item *SI = cls->repeat_stack_variable[cls->sp-1];
if ((SI == cls->repeat_stack_threshold[cls->sp-1]) ||
(NEXT_ITEM_IN_LINKED_LIST(SI, section) == NULL))
Collater::end_CI_loop(cls);
else {
cls->repeat_stack_variable[cls->stack_pointer-1] =
cls->repeat_stack_variable[cls->sp-1] =
NEXT_ITEM_IN_LINKED_LIST(SI, section);
lpos = cls->repeat_stack_startpos[cls->stack_pointer-1]; /* Back round loop */
lpos = cls->repeat_stack_startpos[cls->sp-1]; /* Back round loop */
}
@<End an If@> =
@ -377,52 +394,52 @@ chapter as its value during the sole iteration.
@ It can happen that a section loop, at least, is empty:
@<Skip line if inside an empty loop@> =
for (int rstl = cls->stack_pointer-1; rstl >= 0; rstl--)
if (cls->repeat_stack_level[cls->stack_pointer-1] == SECTION_LEVEL) {
linked_list_item *SI = cls->repeat_stack_threshold[cls->stack_pointer-1];
for (int rstl = cls->sp-1; rstl >= 0; rstl--)
if (cls->repeat_stack_level[cls->sp-1] == SECTION_LEVEL) {
linked_list_item *SI = cls->repeat_stack_threshold[cls->sp-1];
if (NEXT_ITEM_IN_LINKED_LIST(SI, section) ==
cls->repeat_stack_variable[cls->stack_pointer-1])
cls->repeat_stack_variable[cls->sp-1])
goto CYCLE;
}
@<Skip line if inside a failed conditional@> =
for (int j=cls->stack_pointer-1; j>=0; j--)
for (int j=cls->sp-1; j>=0; j--)
if (cls->repeat_stack_level[j] == IF_FALSE_LEVEL)
goto CYCLE;
@ If called with the non-conditional levels, the following function returns
the topmost item. It's never called for |IF_TRUE_LEVEL| or |IF_FALSE_LEVEL|.
=
linked_list_item *Collater::heading_topmost_on_stack(collater_state *cls, int level) {
for (int rstl = cls->sp-1; rstl >= 0; rstl--)
if (cls->repeat_stack_level[rstl] == level)
return cls->repeat_stack_variable[rstl];
return NULL;
}
@ This is the function for starting a loop or code block, which stacks up the
details, and similarly for ending it by popping them again:
@d MODULE_LEVEL 1
@d CHAPTER_LEVEL 2
@d SECTION_LEVEL 3
@d IF_TRUE_LEVEL 4
@d IF_FALSE_LEVEL 5
=
linked_list_item *Collater::heading_topmost_on_stack(collater_state *cls, int level) {
for (int rstl = cls->stack_pointer-1; rstl >= 0; rstl--)
if (cls->repeat_stack_level[rstl] == level)
return cls->repeat_stack_variable[rstl];
return NULL;
}
@ This is the code for starting a loop, which stacks up the details, and
similarly for ending it by popping them again:
=
void Collater::start_CI_loop(collater_state *cls, int level,
linked_list_item *from, linked_list_item *to, int pos) {
if (cls->stack_pointer < CI_STACK_CAPACITY) {
cls->repeat_stack_level[cls->stack_pointer] = level;
cls->repeat_stack_variable[cls->stack_pointer] = from;
cls->repeat_stack_threshold[cls->stack_pointer] = to;
cls->repeat_stack_startpos[cls->stack_pointer++] = pos;
if (cls->sp < CI_STACK_CAPACITY) {
cls->repeat_stack_level[cls->sp] = level;
cls->repeat_stack_variable[cls->sp] = from;
cls->repeat_stack_threshold[cls->sp] = to;
cls->repeat_stack_startpos[cls->sp++] = pos;
}
}
void Collater::end_CI_loop(collater_state *cls) {
cls->stack_pointer--;
cls->sp--;
}
@h Variable substitutions.
@ -455,8 +472,6 @@ used by the HTML renderer, would cause a modest-sized explosion on some pages.
@<Substitute Breadcrumbs@>;
} else if (Str::eq_wide_string(varname, L"Plugins")) {
@<Substitute Plugins@>;
} else if (Regexp::match(&mr, varname, L"Modules")) {
@<Substitute Modules@>;
} else if (Regexp::match(&mr, varname, L"Complete (%c+)")) {
text_stream *detail = mr.exp[0];
@<Substitute a detail about the complete PDF@>;
@ -538,11 +553,6 @@ this will recursively call The Collater, in fact.
Assets::include_relevant_plugins(OUT, cls->nav_pattern, cls->for_web,
cls->wv, cls->into_file);
@ A list of all modules in the current web.
@<Substitute Modules@> =
Collater::list_module(substituted, cls->for_web->md->as_module, FALSE);
@ We store little about the complete-web-in-one-file PDF:
@<Substitute a detail about the complete PDF@> =
@ -565,8 +575,8 @@ this will recursively call The Collater, in fact.
if (Str::eq_wide_string(detail, L"Title")) {
Str::copy(substituted, M->module_name);
} else if (Str::eq_wide_string(detail, L"Page")) {
section_md *Sm = FIRST_IN_LINKED_LIST(section_md, M->sections_md);
Colonies::section_URL(substituted, Sm);
if (Colonies::find(M->module_name))
Colonies::reference_URL(substituted, M->module_name, cls->into_file);
} else if (Str::eq_wide_string(detail, L"Purpose")) {
TEMPORARY_TEXT(url);
WRITE_TO(url, "%p", M->module_location);
@ -713,18 +723,3 @@ navigation purposes.
WRITE_TO(substituted, "%S\" height=18> ", icon_text);
}
WRITE_TO(substituted, "%S", item_name);
@ =
void Collater::list_module(OUTPUT_STREAM, module *M, int list_this) {
if (list_this) {
WRITE("<li><p>%S - ", M->module_name);
TEMPORARY_TEXT(url);
WRITE_TO(url, "%p", M->module_location);
Readme::write_var(OUT, url, I"Purpose");
DISCARD_TEXT(url);
WRITE("</p></li>");
}
module *N;
LOOP_OVER_LINKED_LIST(N, module, M->dependencies)
Collater::list_module(OUT, N, TRUE);
}

View file

@ -348,11 +348,10 @@ sometimes useful case to know is |[[Capitalized Title]]|, which is the title
in BLOCK CAPITAL LETTERS.
@ Other placeholders, not used in the example above, include:
(a) |[[Template X]]| expands to an insertion of the template file |X|.
(b) |[[Navigation]]| expands to the navigation sidebar in use when weaving
(a) |[[Navigation]]| expands to the navigation sidebar in use when weaving
a colony of webs -- see //Making Weaves into Websites// for more, and for
syntaxes to do with links and URLs.
(c) |[[Breadcrumbs]]| expands to the HTML for the breadcrumb trail.
(b) |[[Breadcrumbs]]| expands to the HTML for the breadcrumb trail.
@ The |template-index.html| file has access to additional placeholders
enabling it to generate contents pages:
@ -383,10 +382,20 @@ is rather raw and literate programming is not being used to the full.
@ |[[Repeat Chapter]]| and |[[Repeat Section]]| begin blocks of lines which
are repeated for each chapter or section: the material to be repeated
continues to the matching |[[End Repeat]| line. The ``current chapter or
section'' mentioned above is the one selected in the current innermost
continues to the matching |[[End Repeat]| line. The "current chapter or
section" mentioned above is the one selected in the current innermost
loop of that description.
|[[Repeat Module]]|, similarly, begins a repeat through the imported
modules of the current web. (The main module, containing the actual material
of the current web, does not count.) Within such a loop,
= (text as Inweb)
[[Module Title]] [[Module Purpose]] [[Module Page]]
=
can all be used to refer to the current module. |[[Module Page]]| expands
to the relative URL of the module's own woven HTML form, provided that
the module is listed as a member of the current colony file.
|[[Select ...]]| and |[[End Select]| form a block which behaves like
a repetition, but happens just once, for the named chapter or section.
@ -409,3 +418,22 @@ weaves a report somewhat like this:
Section Vocabulary, 3/vocab, 338 lines.
Section Built-In Words, 3/words, 1207 lines.
=
@ Finally, there is very limited support for conditionals with
|[[If CONDITION]]|, an optional |Else|, and a compulsory |Endif|.
Very few conditions are in fact allowed:
|[[If Chapters]]| tests whether the current web is divided into chapters,
the alternative being that all the sections are in a notional chapter just
called |Sections|.
|[[If Modules]]| tests whether the current web imports any modules.
|[[If Chapter Purpose]]|, inside a |[[Repeat Chapter]]|, tests whether the
current chapter has a (non-empty) purpose text. Similarly for |[[If Section Purpose]]|
and |[[If Module Purpose]].
|[[If Module Page]]|, inside a |[[Repeat Module]]|, tests whether the module
appears (under its own name, i.e., not by a different name) as a member in
the colony file, if there is one. In effect, this can be used to test whether
it is safe to make a link to the module's own woven pages using |[[Module Page]]|.

View file

@ -35,10 +35,10 @@
</ul>
[[Else]]
[[Repeat Chapter]]
<ul class="sectionlist">
<ul class="chapterlist">
[[Repeat Section]]
<li>
<p class="sectionentry"><a href="[[Section Page]]">
<p class="chapterentry"><a href="[[Section Page]]">
<spon class="sectiontitle">[[Section Title]]</span></a> -
<span class="sectionpurpose">[[Section Purpose]]</span></p>
</li>
@ -52,8 +52,13 @@
<ul class="chapterlist">
[[Repeat Module]]
<li>
<p class="chapterentry"><a href="[[Module Page]]"><spon class="sectiontitle">[[Module Title]]</span></a> -
<span class="sectionpurpose">[[Module Purpose]]</span></p>
<p class="chapterentry">
[[If Module Page]]
<a href="[[Module Page]]"><spon class="sectiontitle">[[Module Title]]</span></a>
[[Else]]
<spon class="sectiontitle">[[Module Title]]</span>
[[End If]]
- <span class="sectionpurpose">[[Module Purpose]]</span></p>
</li>
[[End Repeat]]
</ul>

View file

@ -1,6 +1,6 @@
# Inweb 7
v7-alpha.1+1A36 'Escape to Danger' (2 May 2020)
v7-alpha.1+1A37 'Escape to Danger' (3 May 2020)
## About Inweb

File diff suppressed because it is too large Load diff

View file

@ -1,3 +1,3 @@
Prerelease: alpha.1
Build Date: 2 May 2020
Build Number: 1A36
Build Date: 3 May 2020
Build Number: 1A37

View file

@ -39,9 +39,9 @@
<p class="purpose">An example of using Foundation to write a simple command-line tool: in this case, for calculating the dates of Easter. This is version 1.</p>
<hr>
<div class="contentspage">
<ul class="sectionlist">
<ul class="chapterlist">
<li>
<p class="sectionentry"><a href="S-rtd.html">
<p class="chapterentry"><a href="S-rtd.html">
<spon class="sectiontitle">Reporting the Date</span></a> -
<span class="sectionpurpose">This is really the whole Eastertide program, in a single section.</span></p>
</li>
@ -50,8 +50,9 @@
<p class="purpose">Importing:</p>
<ul class="chapterlist">
<li>
<p class="chapterentry"><a href="P-abgtf.html"><spon class="sectiontitle">foundation</span></a> -
<span class="sectionpurpose">A library of common code used by all of the Inform tools.</span></p>
<p class="chapterentry">
<a href="../foundation-module/index.html"><spon class="sectiontitle">foundation</span></a>
- <span class="sectionpurpose">A library of common code used by all of the Inform tools.</span></p>
</li>
</ul>
</div>

View file

@ -39,14 +39,14 @@
<p class="purpose">Unit tests for the foundation module. This is version 1.</p>
<hr>
<div class="contentspage">
<ul class="sectionlist">
<ul class="chapterlist">
<li>
<p class="sectionentry"><a href="S-pc.html">
<p class="chapterentry"><a href="S-pc.html">
<spon class="sectiontitle">Program Control</span></a> -
<span class="sectionpurpose">Choosing which unit test to run on the basis of the command-line arguments.</span></p>
</li>
<li>
<p class="sectionentry"><a href="S-ut.html">
<p class="chapterentry"><a href="S-ut.html">
<spon class="sectiontitle">Unit Tests</span></a> -
<span class="sectionpurpose">A selection of tests for, or demonstrations of, foundation features.</span></p>
</li>
@ -55,8 +55,9 @@
<p class="purpose">Importing:</p>
<ul class="chapterlist">
<li>
<p class="chapterentry"><a href="P-abgtf.html"><spon class="sectiontitle">foundation</span></a> -
<span class="sectionpurpose">A library of common code used by all of the Inform tools.</span></p>
<p class="chapterentry">
<a href="../foundation-module/index.html"><spon class="sectiontitle">foundation</span></a>
- <span class="sectionpurpose">A library of common code used by all of the Inform tools.</span></p>
</li>
</ul>
</div>

Binary file not shown.

View file

@ -39,14 +39,14 @@
<p class="purpose">This example of using inweb is a simple program to test Goldbach's Conjecture, a classic problem in number theory. This is version 1.</p>
<hr>
<div class="contentspage">
<ul class="sectionlist">
<ul class="chapterlist">
<li>
<p class="sectionentry"><a href="S-sp.html">
<p class="chapterentry"><a href="S-sp.html">
<spon class="sectiontitle">Summing Primes</span></a> -
<span class="sectionpurpose">Here we verify the conjecture for small numbers.</span></p>
</li>
<li>
<p class="sectionentry"><a href="S-tsoe.html">
<p class="chapterentry"><a href="S-tsoe.html">
<spon class="sectiontitle">The Sieve of Eratosthenes</span></a> -
<span class="sectionpurpose">A fairly fast way to determine if small numbers are prime, given storage.</span></p>
</li>

View file

@ -105,7 +105,7 @@ directly.
<span class="plain-syntax"> </span><span class="reserved-syntax">struct</span><span class="plain-syntax"> </span><span class="reserved-syntax">linked_list_item</span><span class="plain-syntax"> *</span><span class="identifier-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="constant-syntax">CI_STACK_CAPACITY</span><span class="plain-syntax">];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">struct</span><span class="plain-syntax"> </span><span class="reserved-syntax">linked_list_item</span><span class="plain-syntax"> *</span><span class="identifier-syntax">repeat_stack_threshold</span><span class="plain-syntax">[</span><span class="constant-syntax">CI_STACK_CAPACITY</span><span class="plain-syntax">];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">repeat_stack_startpos</span><span class="plain-syntax">[</span><span class="constant-syntax">CI_STACK_CAPACITY</span><span class="plain-syntax">];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">stack_pointer</span><span class="plain-syntax">; </span><span class="comment-syntax"> And this is our stack pointer for tracking of loops</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">sp</span><span class="plain-syntax">; </span><span class="comment-syntax"> And this is our stack pointer for tracking of loops</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">struct</span><span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">restrict_to_range</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">struct</span><span class="plain-syntax"> </span><span class="reserved-syntax">weave_pattern</span><span class="plain-syntax"> *</span><span class="identifier-syntax">nav_pattern</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">struct</span><span class="plain-syntax"> </span><span class="reserved-syntax">filename</span><span class="plain-syntax"> *</span><span class="identifier-syntax">nav_file</span><span class="plain-syntax">;</span>
@ -130,7 +130,7 @@ if so, they can always be subdivided.
<span class="plain-syntax"> </span><span class="reserved-syntax">collater_state</span><span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">.</span><span class="element-syntax">no_tlines</span><span class="plain-syntax"> = </span><span class="constant-syntax">0</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">.</span><span class="element-syntax">restrict_to_range</span><span class="plain-syntax"> = </span><a href="../foundation-module/4-sm.html#SP3" class="function-link"><span class="function-syntax">Str::duplicate</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">range</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">.</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax"> = </span><span class="constant-syntax">0</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">.</span><span class="element-syntax">sp</span><span class="plain-syntax"> = </span><span class="constant-syntax">0</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">.</span><span class="element-syntax">inside_navigation_submenu</span><span class="plain-syntax"> = </span><span class="constant-syntax">FALSE</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">.</span><span class="element-syntax">for_web</span><span class="plain-syntax"> = </span><span class="identifier-syntax">W</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">.</span><span class="element-syntax">nav_pattern</span><span class="plain-syntax"> = </span><span class="identifier-syntax">pattern</span><span class="plain-syntax">;</span>
@ -223,7 +223,7 @@ if so, they can always be subdivided.
<pre class="displayed-code all-displayed-code code-font">
<span class="plain-syntax"> </span><span class="identifier-syntax">PRINT</span><span class="plain-syntax">(</span><span class="string-syntax">"%04d: %S\nStack:"</span><span class="plain-syntax">, </span><span class="identifier-syntax">lpos</span><span class="plain-syntax">-1, </span><span class="identifier-syntax">tl</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">for</span><span class="plain-syntax"> (</span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">j</span><span class="plain-syntax">=0; </span><span class="identifier-syntax">j</span><span class="plain-syntax">&lt;</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">; </span><span class="identifier-syntax">j</span><span class="plain-syntax">++) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">for</span><span class="plain-syntax"> (</span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">j</span><span class="plain-syntax">=0; </span><span class="identifier-syntax">j</span><span class="plain-syntax">&lt;</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">; </span><span class="identifier-syntax">j</span><span class="plain-syntax">++) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">j</span><span class="plain-syntax">] == </span><span class="constant-syntax">CHAPTER_LEVEL</span><span class="plain-syntax">)</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">PRINT</span><span class="plain-syntax">(</span><span class="string-syntax">" %d: %S/%S"</span><span class="plain-syntax">,</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">j</span><span class="plain-syntax">, ((</span><span class="reserved-syntax">chapter</span><span class="plain-syntax"> *)</span>
@ -288,6 +288,23 @@ chapter as its value during the sole iteration.
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-sm.html#SP19" class="function-link"><span class="function-syntax">Str::eq</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">condition</span><span class="plain-syntax">, </span><span class="identifier-syntax">I</span><span class="string-syntax">"Modules"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/2-llas.html#SP6" class="function-link"><span class="function-syntax">LinkedLists::len</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">modules</span><span class="plain-syntax">) &gt; </span><span class="constant-syntax">0</span><span class="plain-syntax">)</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">level</span><span class="plain-syntax"> = </span><span class="constant-syntax">IF_TRUE_LEVEL</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-sm.html#SP19" class="function-link"><span class="function-syntax">Str::eq</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">condition</span><span class="plain-syntax">, </span><span class="identifier-syntax">I</span><span class="string-syntax">"Module Page"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">module</span><span class="plain-syntax"> *</span><span class="identifier-syntax">M</span><span class="plain-syntax"> = </span><span class="identifier-syntax">CONTENT_IN_ITEM</span><span class="plain-syntax">(</span>
<span class="plain-syntax"> </span><a href="3-tc.html#SP5_1_9" class="function-link"><span class="function-syntax">Collater::heading_topmost_on_stack</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">cls</span><span class="plain-syntax">, </span><span class="constant-syntax">MODULE_LEVEL</span><span class="plain-syntax">), </span><span class="reserved-syntax">module</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> ((</span><span class="identifier-syntax">M</span><span class="plain-syntax">) &amp;&amp; (</span><a href="6-cln.html#SP7" class="function-link"><span class="function-syntax">Colonies::find</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">M</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">module_name</span><span class="plain-syntax">)))</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">level</span><span class="plain-syntax"> = </span><span class="constant-syntax">IF_TRUE_LEVEL</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-sm.html#SP19" class="function-link"><span class="function-syntax">Str::eq</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">condition</span><span class="plain-syntax">, </span><span class="identifier-syntax">I</span><span class="string-syntax">"Module Purpose"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">module</span><span class="plain-syntax"> *</span><span class="identifier-syntax">M</span><span class="plain-syntax"> = </span><span class="identifier-syntax">CONTENT_IN_ITEM</span><span class="plain-syntax">(</span>
<span class="plain-syntax"> </span><a href="3-tc.html#SP5_1_9" class="function-link"><span class="function-syntax">Collater::heading_topmost_on_stack</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">cls</span><span class="plain-syntax">, </span><span class="constant-syntax">MODULE_LEVEL</span><span class="plain-syntax">), </span><span class="reserved-syntax">module</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">M</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">TEMPORARY_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">TEMPORARY_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">purpose</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">, </span><span class="string-syntax">"%p"</span><span class="plain-syntax">, </span><span class="identifier-syntax">M</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">module_location</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><a href="6-rw.html#SP8" class="function-link"><span class="function-syntax">Readme::write_var</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">purpose</span><span class="plain-syntax">, </span><span class="identifier-syntax">url</span><span class="plain-syntax">, </span><span class="identifier-syntax">I</span><span class="string-syntax">"Purpose"</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-sm.html#SP8" class="function-link"><span class="function-syntax">Str::len</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">purpose</span><span class="plain-syntax">) &gt; </span><span class="constant-syntax">0</span><span class="plain-syntax">) </span><span class="identifier-syntax">level</span><span class="plain-syntax"> = </span><span class="constant-syntax">IF_TRUE_LEVEL</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">DISCARD_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">DISCARD_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">purpose</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> }</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-sm.html#SP19" class="function-link"><span class="function-syntax">Str::eq</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">condition</span><span class="plain-syntax">, </span><span class="identifier-syntax">I</span><span class="string-syntax">"Chapter Purpose"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">chapter</span><span class="plain-syntax"> *</span><span class="identifier-syntax">C</span><span class="plain-syntax"> = </span><span class="identifier-syntax">CONTENT_IN_ITEM</span><span class="plain-syntax">(</span>
<span class="plain-syntax"> </span><a href="3-tc.html#SP5_1_9" class="function-link"><span class="function-syntax">Collater::heading_topmost_on_stack</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">cls</span><span class="plain-syntax">, </span><span class="constant-syntax">CHAPTER_LEVEL</span><span class="plain-syntax">), </span><span class="reserved-syntax">chapter</span><span class="plain-syntax">);</span>
@ -311,19 +328,19 @@ chapter as its value during the sole iteration.
<pre class="displayed-code all-displayed-code code-font">
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">command</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Else"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax"> &lt;= </span><span class="constant-syntax">0</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax"> &lt;= </span><span class="constant-syntax">0</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><a href="../foundation-module/3-em.html#SP6" class="function-link"><span class="function-syntax">Errors::at_position</span></a><span class="plain-syntax">(</span><span class="string-syntax">"Else without If"</span><span class="plain-syntax">,</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">errors_at</span><span class="plain-syntax">, </span><span class="identifier-syntax">lpos</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">goto</span><span class="plain-syntax"> </span><span class="identifier-syntax">CYCLE</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> }</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">switch</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1]) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">switch</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1]) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">case</span><span class="plain-syntax"> </span><span class="identifier-syntax">SECTION_LEVEL:</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">case</span><span class="plain-syntax"> </span><span class="identifier-syntax">CHAPTER_LEVEL:</span>
<span class="plain-syntax"> </span><a href="../foundation-module/3-em.html#SP6" class="function-link"><span class="function-syntax">Errors::at_position</span></a><span class="plain-syntax">(</span><span class="string-syntax">"Else not matched with If"</span><span class="plain-syntax">,</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">errors_at</span><span class="plain-syntax">, </span><span class="identifier-syntax">lpos</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">break</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">case</span><span class="plain-syntax"> </span><span class="identifier-syntax">IF_TRUE_LEVEL:</span><span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1] = </span><span class="constant-syntax">IF_FALSE_LEVEL</span><span class="plain-syntax">; </span><span class="reserved-syntax">break</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">case</span><span class="plain-syntax"> </span><span class="identifier-syntax">IF_FALSE_LEVEL:</span><span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1] = </span><span class="constant-syntax">IF_TRUE_LEVEL</span><span class="plain-syntax">; </span><span class="reserved-syntax">break</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">case</span><span class="plain-syntax"> </span><span class="identifier-syntax">IF_TRUE_LEVEL:</span><span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1] = </span><span class="constant-syntax">IF_FALSE_LEVEL</span><span class="plain-syntax">; </span><span class="reserved-syntax">break</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">case</span><span class="plain-syntax"> </span><span class="identifier-syntax">IF_FALSE_LEVEL:</span><span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1] = </span><span class="constant-syntax">IF_TRUE_LEVEL</span><span class="plain-syntax">; </span><span class="reserved-syntax">break</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> }</span>
<span class="plain-syntax"> </span><a href="../foundation-module/4-pm.html#SP9" class="function-link"><span class="function-syntax">Regexp::dispose_of</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">goto</span><span class="plain-syntax"> </span><span class="identifier-syntax">CYCLE</span><span class="plain-syntax">;</span>
@ -410,12 +427,12 @@ chapter as its value during the sole iteration.
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">command</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"End Select"</span><span class="plain-syntax">)) </span><span class="identifier-syntax">end_form</span><span class="plain-syntax"> = </span><span class="constant-syntax">2</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">command</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"End If"</span><span class="plain-syntax">)) </span><span class="identifier-syntax">end_form</span><span class="plain-syntax"> = </span><span class="constant-syntax">3</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">end_form</span><span class="plain-syntax"> &gt; </span><span class="constant-syntax">0</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax"> &lt;= </span><span class="constant-syntax">0</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax"> &lt;= </span><span class="constant-syntax">0</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><a href="../foundation-module/3-em.html#SP6" class="function-link"><span class="function-syntax">Errors::at_position</span></a><span class="plain-syntax">(</span><span class="string-syntax">"stack underflow on contents template"</span><span class="plain-syntax">,</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">errors_at</span><span class="plain-syntax">, </span><span class="identifier-syntax">lpos</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">goto</span><span class="plain-syntax"> </span><span class="identifier-syntax">CYCLE</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> }</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">switch</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1]) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">switch</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1]) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">case</span><span class="plain-syntax"> </span><span class="identifier-syntax">MODULE_LEVEL:</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">case</span><span class="plain-syntax"> </span><span class="identifier-syntax">CHAPTER_LEVEL:</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">case</span><span class="plain-syntax"> </span><span class="identifier-syntax">SECTION_LEVEL:</span>
@ -434,7 +451,7 @@ chapter as its value during the sole iteration.
<span class="plain-syntax"> }</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">break</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> }</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">switch</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1]) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">switch</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1]) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">case</span><span class="plain-syntax"> </span><span class="identifier-syntax">MODULE_LEVEL:</span><span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_6_1" class="named-paragraph-link"><span class="named-paragraph">End a module repeat</span><span class="named-paragraph-number">5.1.6.1</span></a></span><span class="plain-syntax">; </span><span class="reserved-syntax">break</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">case</span><span class="plain-syntax"> </span><span class="identifier-syntax">CHAPTER_LEVEL:</span><span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_6_2" class="named-paragraph-link"><span class="named-paragraph">End a chapter repeat</span><span class="named-paragraph-number">5.1.6.2</span></a></span><span class="plain-syntax">; </span><span class="reserved-syntax">break</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">case</span><span class="plain-syntax"> </span><span class="identifier-syntax">SECTION_LEVEL:</span><span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_6_3" class="named-paragraph-link"><span class="named-paragraph">End a section repeat</span><span class="named-paragraph-number">5.1.6.3</span></a></span><span class="plain-syntax">; </span><span class="reserved-syntax">break</span><span class="plain-syntax">;</span>
@ -449,13 +466,13 @@ chapter as its value during the sole iteration.
</p>
<pre class="displayed-code all-displayed-code code-font">
<span class="plain-syntax"> </span><span class="reserved-syntax">linked_list_item</span><span class="plain-syntax"> *</span><span class="identifier-syntax">CI</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">CI</span><span class="plain-syntax"> == </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_threshold</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1])</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">linked_list_item</span><span class="plain-syntax"> *</span><span class="identifier-syntax">CI</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">CI</span><span class="plain-syntax"> == </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_threshold</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1])</span>
<span class="plain-syntax"> </span><a href="3-tc.html#SP5_1_10" class="function-link"><span class="function-syntax">Collater::end_CI_loop</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">cls</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">else</span><span class="plain-syntax"> {</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1] =</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1] =</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">NEXT_ITEM_IN_LINKED_LIST</span><span class="plain-syntax">(</span><span class="identifier-syntax">CI</span><span class="plain-syntax">, </span><span class="reserved-syntax">chapter</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">lpos</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_startpos</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1]; </span><span class="comment-syntax"> Back round loop</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">lpos</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_startpos</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1]; </span><span class="comment-syntax"> Back round loop</span>
<span class="plain-syntax"> }</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_6">&#167;5.1.6</a>.</li></ul>
@ -463,13 +480,13 @@ chapter as its value during the sole iteration.
</p>
<pre class="displayed-code all-displayed-code code-font">
<span class="plain-syntax"> </span><span class="reserved-syntax">linked_list_item</span><span class="plain-syntax"> *</span><span class="identifier-syntax">CI</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">CI</span><span class="plain-syntax"> == </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_threshold</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1])</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">linked_list_item</span><span class="plain-syntax"> *</span><span class="identifier-syntax">CI</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">CI</span><span class="plain-syntax"> == </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_threshold</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1])</span>
<span class="plain-syntax"> </span><a href="3-tc.html#SP5_1_10" class="function-link"><span class="function-syntax">Collater::end_CI_loop</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">cls</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">else</span><span class="plain-syntax"> {</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1] =</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1] =</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">NEXT_ITEM_IN_LINKED_LIST</span><span class="plain-syntax">(</span><span class="identifier-syntax">CI</span><span class="plain-syntax">, </span><span class="reserved-syntax">chapter</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">lpos</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_startpos</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1]; </span><span class="comment-syntax"> Back round loop</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">lpos</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_startpos</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1]; </span><span class="comment-syntax"> Back round loop</span>
<span class="plain-syntax"> }</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_6">&#167;5.1.6</a>.</li></ul>
@ -477,14 +494,14 @@ chapter as its value during the sole iteration.
</p>
<pre class="displayed-code all-displayed-code code-font">
<span class="plain-syntax"> </span><span class="reserved-syntax">linked_list_item</span><span class="plain-syntax"> *</span><span class="identifier-syntax">SI</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> ((</span><span class="identifier-syntax">SI</span><span class="plain-syntax"> == </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_threshold</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1]) ||</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">linked_list_item</span><span class="plain-syntax"> *</span><span class="identifier-syntax">SI</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> ((</span><span class="identifier-syntax">SI</span><span class="plain-syntax"> == </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_threshold</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1]) ||</span>
<span class="plain-syntax"> (</span><span class="identifier-syntax">NEXT_ITEM_IN_LINKED_LIST</span><span class="plain-syntax">(</span><span class="identifier-syntax">SI</span><span class="plain-syntax">, </span><span class="reserved-syntax">section</span><span class="plain-syntax">) == </span><span class="identifier-syntax">NULL</span><span class="plain-syntax">))</span>
<span class="plain-syntax"> </span><a href="3-tc.html#SP5_1_10" class="function-link"><span class="function-syntax">Collater::end_CI_loop</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">cls</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">else</span><span class="plain-syntax"> {</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1] =</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1] =</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">NEXT_ITEM_IN_LINKED_LIST</span><span class="plain-syntax">(</span><span class="identifier-syntax">SI</span><span class="plain-syntax">, </span><span class="reserved-syntax">section</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">lpos</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_startpos</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1]; </span><span class="comment-syntax"> Back round loop</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">lpos</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_startpos</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1]; </span><span class="comment-syntax"> Back round loop</span>
<span class="plain-syntax"> }</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_6">&#167;5.1.6</a>.</li></ul>
@ -502,11 +519,11 @@ chapter as its value during the sole iteration.
</p>
<pre class="displayed-code all-displayed-code code-font">
<span class="plain-syntax"> </span><span class="reserved-syntax">for</span><span class="plain-syntax"> (</span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">rstl</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1; </span><span class="identifier-syntax">rstl</span><span class="plain-syntax"> &gt;= </span><span class="constant-syntax">0</span><span class="plain-syntax">; </span><span class="identifier-syntax">rstl</span><span class="plain-syntax">--)</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1] == </span><span class="constant-syntax">SECTION_LEVEL</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">linked_list_item</span><span class="plain-syntax"> *</span><span class="identifier-syntax">SI</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_threshold</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">for</span><span class="plain-syntax"> (</span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">rstl</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1; </span><span class="identifier-syntax">rstl</span><span class="plain-syntax"> &gt;= </span><span class="constant-syntax">0</span><span class="plain-syntax">; </span><span class="identifier-syntax">rstl</span><span class="plain-syntax">--)</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1] == </span><span class="constant-syntax">SECTION_LEVEL</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">linked_list_item</span><span class="plain-syntax"> *</span><span class="identifier-syntax">SI</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_threshold</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">NEXT_ITEM_IN_LINKED_LIST</span><span class="plain-syntax">(</span><span class="identifier-syntax">SI</span><span class="plain-syntax">, </span><span class="reserved-syntax">section</span><span class="plain-syntax">) ==</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1])</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1])</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">goto</span><span class="plain-syntax"> </span><span class="identifier-syntax">CYCLE</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> }</span>
</pre>
@ -515,7 +532,7 @@ chapter as its value during the sole iteration.
</p>
<pre class="displayed-code all-displayed-code code-font">
<span class="plain-syntax"> </span><span class="reserved-syntax">for</span><span class="plain-syntax"> (</span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">j</span><span class="plain-syntax">=</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1; </span><span class="identifier-syntax">j</span><span class="plain-syntax">&gt;=0; </span><span class="identifier-syntax">j</span><span class="plain-syntax">--)</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">for</span><span class="plain-syntax"> (</span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">j</span><span class="plain-syntax">=</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1; </span><span class="identifier-syntax">j</span><span class="plain-syntax">&gt;=0; </span><span class="identifier-syntax">j</span><span class="plain-syntax">--)</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">j</span><span class="plain-syntax">] == </span><span class="constant-syntax">IF_FALSE_LEVEL</span><span class="plain-syntax">)</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">goto</span><span class="plain-syntax"> </span><span class="identifier-syntax">CYCLE</span><span class="plain-syntax">;</span>
</pre>
@ -524,37 +541,37 @@ chapter as its value during the sole iteration.
the topmost item. It's never called for <span class="extract"><span class="extract-syntax">IF_TRUE_LEVEL</span></span> or <span class="extract"><span class="extract-syntax">IF_FALSE_LEVEL</span></span>.
</p>
<pre class="displayed-code all-displayed-code code-font">
<span class="reserved-syntax">linked_list_item</span><span class="plain-syntax"> *</span><span class="function-syntax">Collater::heading_topmost_on_stack</span><button class="popup" onclick="togglePopup('usagePopup7')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup7">Usage of <span class="code-font"><span class="function-syntax">Collater::heading_topmost_on_stack</span></span>:<br/><a href="3-tc.html#SP5_1_3">&#167;5.1.3</a>, <a href="3-tc.html#SP5_1_5_3">&#167;5.1.5.3</a>, <a href="3-tc.html#SP5_1_11_6">&#167;5.1.11.6</a>, <a href="3-tc.html#SP5_1_11_7">&#167;5.1.11.7</a>, <a href="3-tc.html#SP5_1_11_8">&#167;5.1.11.8</a></span></button><span class="plain-syntax">(</span><span class="reserved-syntax">collater_state</span><span class="plain-syntax"> *</span><span class="identifier-syntax">cls</span><span class="plain-syntax">, </span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">level</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">for</span><span class="plain-syntax"> (</span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">rstl</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">-1; </span><span class="identifier-syntax">rstl</span><span class="plain-syntax"> &gt;= </span><span class="constant-syntax">0</span><span class="plain-syntax">; </span><span class="identifier-syntax">rstl</span><span class="plain-syntax">--)</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">rstl</span><span class="plain-syntax">] == </span><span class="identifier-syntax">level</span><span class="plain-syntax">)</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">return</span><span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">rstl</span><span class="plain-syntax">];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">return</span><span class="plain-syntax"> </span><span class="identifier-syntax">NULL</span><span class="plain-syntax">;</span>
<span class="plain-syntax">}</span>
</pre>
<p class="commentary firstcommentary"><a id="SP5_1_10"></a><b>&#167;5.1.10. </b>This is the function for starting a loop or code block, which stacks up the
details, and similarly for ending it by popping them again:
</p>
<pre class="definitions code-font"><span class="definition-keyword">define</span> <span class="constant-syntax">MODULE_LEVEL</span><span class="plain-syntax"> </span><span class="constant-syntax">1</span>
<span class="definition-keyword">define</span> <span class="constant-syntax">CHAPTER_LEVEL</span><span class="plain-syntax"> </span><span class="constant-syntax">2</span>
<span class="definition-keyword">define</span> <span class="constant-syntax">SECTION_LEVEL</span><span class="plain-syntax"> </span><span class="constant-syntax">3</span>
<span class="definition-keyword">define</span> <span class="constant-syntax">IF_TRUE_LEVEL</span><span class="plain-syntax"> </span><span class="constant-syntax">4</span>
<span class="definition-keyword">define</span> <span class="constant-syntax">IF_FALSE_LEVEL</span><span class="plain-syntax"> </span><span class="constant-syntax">5</span>
</pre>
<pre class="displayed-code all-displayed-code code-font">
<span class="reserved-syntax">linked_list_item</span><span class="plain-syntax"> *</span><span class="function-syntax">Collater::heading_topmost_on_stack</span><button class="popup" onclick="togglePopup('usagePopup7')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup7">Usage of <span class="code-font"><span class="function-syntax">Collater::heading_topmost_on_stack</span></span>:<br/><a href="3-tc.html#SP5_1_3">&#167;5.1.3</a>, <a href="3-tc.html#SP5_1_5_3">&#167;5.1.5.3</a>, <a href="3-tc.html#SP5_1_11_7">&#167;5.1.11.7</a>, <a href="3-tc.html#SP5_1_11_8">&#167;5.1.11.8</a>, <a href="3-tc.html#SP5_1_11_9">&#167;5.1.11.9</a></span></button><span class="plain-syntax">(</span><span class="reserved-syntax">collater_state</span><span class="plain-syntax"> *</span><span class="identifier-syntax">cls</span><span class="plain-syntax">, </span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">level</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">for</span><span class="plain-syntax"> (</span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">rstl</span><span class="plain-syntax"> = </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">-1; </span><span class="identifier-syntax">rstl</span><span class="plain-syntax"> &gt;= </span><span class="constant-syntax">0</span><span class="plain-syntax">; </span><span class="identifier-syntax">rstl</span><span class="plain-syntax">--)</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">rstl</span><span class="plain-syntax">] == </span><span class="identifier-syntax">level</span><span class="plain-syntax">)</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">return</span><span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">rstl</span><span class="plain-syntax">];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">return</span><span class="plain-syntax"> </span><span class="identifier-syntax">NULL</span><span class="plain-syntax">;</span>
<span class="plain-syntax">}</span>
</pre>
<p class="commentary firstcommentary"><a id="SP5_1_10"></a><b>&#167;5.1.10. </b>This is the code for starting a loop, which stacks up the details, and
similarly for ending it by popping them again:
</p>
<pre class="displayed-code all-displayed-code code-font">
<span class="reserved-syntax">void</span><span class="plain-syntax"> </span><span class="function-syntax">Collater::start_CI_loop</span><button class="popup" onclick="togglePopup('usagePopup8')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup8">Usage of <span class="code-font"><span class="function-syntax">Collater::start_CI_loop</span></span>:<br/><a href="3-tc.html#SP5_1_2">&#167;5.1.2</a>, <a href="3-tc.html#SP5_1_3">&#167;5.1.3</a>, <a href="3-tc.html#SP5_1_5">&#167;5.1.5</a></span></button><span class="plain-syntax">(</span><span class="reserved-syntax">collater_state</span><span class="plain-syntax"> *</span><span class="identifier-syntax">cls</span><span class="plain-syntax">, </span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">level</span><span class="plain-syntax">,</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">linked_list_item</span><span class="plain-syntax"> *</span><span class="identifier-syntax">from</span><span class="plain-syntax">, </span><span class="reserved-syntax">linked_list_item</span><span class="plain-syntax"> *</span><span class="identifier-syntax">to</span><span class="plain-syntax">, </span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">pos</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax"> &lt; </span><span class="constant-syntax">CI_STACK_CAPACITY</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">] = </span><span class="identifier-syntax">level</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">] = </span><span class="identifier-syntax">from</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_threshold</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">] = </span><span class="identifier-syntax">to</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_startpos</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">++] = </span><span class="identifier-syntax">pos</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax"> &lt; </span><span class="constant-syntax">CI_STACK_CAPACITY</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_level</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">] = </span><span class="identifier-syntax">level</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_variable</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">] = </span><span class="identifier-syntax">from</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_threshold</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">] = </span><span class="identifier-syntax">to</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">repeat_stack_startpos</span><span class="plain-syntax">[</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">++] = </span><span class="identifier-syntax">pos</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> }</span>
<span class="plain-syntax">}</span>
<span class="reserved-syntax">void</span><span class="plain-syntax"> </span><span class="function-syntax">Collater::end_CI_loop</span><button class="popup" onclick="togglePopup('usagePopup9')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup9">Usage of <span class="code-font"><span class="function-syntax">Collater::end_CI_loop</span></span>:<br/><a href="3-tc.html#SP5_1_6_1">&#167;5.1.6.1</a>, <a href="3-tc.html#SP5_1_6_2">&#167;5.1.6.2</a>, <a href="3-tc.html#SP5_1_6_3">&#167;5.1.6.3</a>, <a href="3-tc.html#SP5_1_6_4">&#167;5.1.6.4</a></span></button><span class="plain-syntax">(</span><span class="reserved-syntax">collater_state</span><span class="plain-syntax"> *</span><span class="identifier-syntax">cls</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">stack_pointer</span><span class="plain-syntax">--;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sp</span><span class="plain-syntax">--;</span>
<span class="plain-syntax">}</span>
</pre>
<p class="commentary firstcommentary"><a id="SP5_1_11"></a><b>&#167;5.1.11. Variable substitutions. </b>We can now forget about this tiny stack machine: the one task left is to
@ -591,43 +608,41 @@ used by the HTML renderer, would cause a modest-sized explosion on some pages.
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_3" class="named-paragraph-link"><span class="named-paragraph">Substitute Breadcrumbs</span><span class="named-paragraph-number">5.1.11.3</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-sm.html#SP22" class="function-link"><span class="function-syntax">Str::eq_wide_string</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Plugins"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_4" class="named-paragraph-link"><span class="named-paragraph">Substitute Plugins</span><span class="named-paragraph-number">5.1.11.4</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Modules"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_5" class="named-paragraph-link"><span class="named-paragraph">Substitute Modules</span><span class="named-paragraph-number">5.1.11.5</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Complete (%c+)"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">detail</span><span class="plain-syntax"> = </span><span class="identifier-syntax">mr</span><span class="plain-syntax">.</span><span class="element-syntax">exp</span><span class="plain-syntax">[0];</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_6" class="named-paragraph-link"><span class="named-paragraph">Substitute a detail about the complete PDF</span><span class="named-paragraph-number">5.1.11.6</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_5" class="named-paragraph-link"><span class="named-paragraph">Substitute a detail about the complete PDF</span><span class="named-paragraph-number">5.1.11.5</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Module (%c+)"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">detail</span><span class="plain-syntax"> = </span><span class="identifier-syntax">mr</span><span class="plain-syntax">.</span><span class="element-syntax">exp</span><span class="plain-syntax">[0];</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_7" class="named-paragraph-link"><span class="named-paragraph">Substitute a Module</span><span class="named-paragraph-number">5.1.11.7</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_6" class="named-paragraph-link"><span class="named-paragraph">Substitute a Module</span><span class="named-paragraph-number">5.1.11.6</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Chapter (%c+)"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">detail</span><span class="plain-syntax"> = </span><span class="identifier-syntax">mr</span><span class="plain-syntax">.</span><span class="element-syntax">exp</span><span class="plain-syntax">[0];</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_8" class="named-paragraph-link"><span class="named-paragraph">Substitute a Chapter</span><span class="named-paragraph-number">5.1.11.8</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_7" class="named-paragraph-link"><span class="named-paragraph">Substitute a Chapter</span><span class="named-paragraph-number">5.1.11.7</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Section (%c+)"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">detail</span><span class="plain-syntax"> = </span><span class="identifier-syntax">mr</span><span class="plain-syntax">.</span><span class="element-syntax">exp</span><span class="plain-syntax">[0];</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_9" class="named-paragraph-link"><span class="named-paragraph">Substitute a Section</span><span class="named-paragraph-number">5.1.11.9</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_8" class="named-paragraph-link"><span class="named-paragraph">Substitute a Section</span><span class="named-paragraph-number">5.1.11.8</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Docs"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_10" class="named-paragraph-link"><span class="named-paragraph">Substitute a Docs</span><span class="named-paragraph-number">5.1.11.10</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_9" class="named-paragraph-link"><span class="named-paragraph">Substitute a Docs</span><span class="named-paragraph-number">5.1.11.9</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"URL \"(%c+)\""</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">link_text</span><span class="plain-syntax"> = </span><span class="identifier-syntax">mr</span><span class="plain-syntax">.</span><span class="element-syntax">exp</span><span class="plain-syntax">[0];</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_11" class="named-paragraph-link"><span class="named-paragraph">Substitute a URL</span><span class="named-paragraph-number">5.1.11.11</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_10" class="named-paragraph-link"><span class="named-paragraph">Substitute a URL</span><span class="named-paragraph-number">5.1.11.10</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Link \"(%c+)\""</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">link_text</span><span class="plain-syntax"> = </span><span class="identifier-syntax">mr</span><span class="plain-syntax">.</span><span class="element-syntax">exp</span><span class="plain-syntax">[0];</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_12" class="named-paragraph-link"><span class="named-paragraph">Substitute a Link</span><span class="named-paragraph-number">5.1.11.12</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_11" class="named-paragraph-link"><span class="named-paragraph">Substitute a Link</span><span class="named-paragraph-number">5.1.11.11</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Menu \"(%c+)\""</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">menu_name</span><span class="plain-syntax"> = </span><span class="identifier-syntax">mr</span><span class="plain-syntax">.</span><span class="element-syntax">exp</span><span class="plain-syntax">[0];</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_13" class="named-paragraph-link"><span class="named-paragraph">Substitute a Menu</span><span class="named-paragraph-number">5.1.11.13</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_12" class="named-paragraph-link"><span class="named-paragraph">Substitute a Menu</span><span class="named-paragraph-number">5.1.11.12</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Item \"(%c+)\""</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">item_name</span><span class="plain-syntax"> = </span><span class="identifier-syntax">mr</span><span class="plain-syntax">.</span><span class="element-syntax">exp</span><span class="plain-syntax">[0];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">icon_text</span><span class="plain-syntax"> = </span><span class="identifier-syntax">NULL</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_14" class="named-paragraph-link"><span class="named-paragraph">Look for icon text</span><span class="named-paragraph-number">5.1.11.14</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_13" class="named-paragraph-link"><span class="named-paragraph">Look for icon text</span><span class="named-paragraph-number">5.1.11.13</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">link_text</span><span class="plain-syntax"> = </span><span class="identifier-syntax">item_name</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_15" class="named-paragraph-link"><span class="named-paragraph">Substitute a member Item</span><span class="named-paragraph-number">5.1.11.15</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_14" class="named-paragraph-link"><span class="named-paragraph">Substitute a member Item</span><span class="named-paragraph-number">5.1.11.14</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Item \"(%c+)\" -&gt; (%c+)"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">item_name</span><span class="plain-syntax"> = </span><span class="identifier-syntax">mr</span><span class="plain-syntax">.</span><span class="element-syntax">exp</span><span class="plain-syntax">[0];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">link_text</span><span class="plain-syntax"> = </span><span class="identifier-syntax">mr</span><span class="plain-syntax">.</span><span class="element-syntax">exp</span><span class="plain-syntax">[1];</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">icon_text</span><span class="plain-syntax"> = </span><span class="identifier-syntax">NULL</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_14" class="named-paragraph-link"><span class="named-paragraph">Look for icon text</span><span class="named-paragraph-number">5.1.11.14</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_16" class="named-paragraph-link"><span class="named-paragraph">Substitute a general Item</span><span class="named-paragraph-number">5.1.11.16</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_13" class="named-paragraph-link"><span class="named-paragraph">Look for icon text</span><span class="named-paragraph-number">5.1.11.13</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_15" class="named-paragraph-link"><span class="named-paragraph">Substitute a general Item</span><span class="named-paragraph-number">5.1.11.15</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> {</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"%S"</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"%i+%c*"</span><span class="plain-syntax">))</span>
@ -694,20 +709,10 @@ this will recursively call The Collater, in fact.
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">wv</span><span class="plain-syntax">, </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">into_file</span><span class="plain-syntax">);</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11">&#167;5.1.11</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_5"></a><b>&#167;5.1.11.5. </b>A list of all modules in the current web.
<p class="commentary firstcommentary"><a id="SP5_1_11_5"></a><b>&#167;5.1.11.5. </b>We store little about the complete-web-in-one-file PDF:
</p>
<p class="commentary"><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute Modules</span><span class="named-paragraph-number">5.1.11.5</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
<span class="plain-syntax"> </span><a href="3-tc.html#SP6" class="function-link"><span class="function-syntax">Collater::list_module</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">for_web</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">md</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">as_module</span><span class="plain-syntax">, </span><span class="constant-syntax">FALSE</span><span class="plain-syntax">);</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11">&#167;5.1.11</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_6"></a><b>&#167;5.1.11.6. </b>We store little about the complete-web-in-one-file PDF:
</p>
<p class="commentary"><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a detail about the complete PDF</span><span class="named-paragraph-number">5.1.11.6</span></span><span class="comment-syntax"> =</span>
<p class="commentary"><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a detail about the complete PDF</span><span class="named-paragraph-number">5.1.11.5</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
@ -717,10 +722,10 @@ this will recursively call The Collater, in fact.
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"%S for complete web"</span><span class="plain-syntax">, </span><span class="identifier-syntax">detail</span><span class="plain-syntax">);</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11">&#167;5.1.11</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_7"></a><b>&#167;5.1.11.7. </b>And here for Modules:
<p class="commentary firstcommentary"><a id="SP5_1_11_6"></a><b>&#167;5.1.11.6. </b>And here for Modules:
</p>
<p class="commentary"><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a Module</span><span class="named-paragraph-number">5.1.11.7</span></span><span class="comment-syntax"> =</span>
<p class="commentary"><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a Module</span><span class="named-paragraph-number">5.1.11.6</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
@ -729,18 +734,18 @@ this will recursively call The Collater, in fact.
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">M</span><span class="plain-syntax"> == </span><span class="identifier-syntax">NULL</span><span class="plain-syntax">)</span>
<span class="plain-syntax"> </span><a href="../foundation-module/3-em.html#SP6" class="function-link"><span class="function-syntax">Errors::at_position</span></a><span class="plain-syntax">(</span><span class="string-syntax">"no module is currently selected"</span><span class="plain-syntax">,</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">errors_at</span><span class="plain-syntax">, </span><span class="identifier-syntax">lpos</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_7_1" class="named-paragraph-link"><span class="named-paragraph">Substitute a detail about the currently selected Module</span><span class="named-paragraph-number">5.1.11.7.1</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_6_1" class="named-paragraph-link"><span class="named-paragraph">Substitute a detail about the currently selected Module</span><span class="named-paragraph-number">5.1.11.6.1</span></a></span><span class="plain-syntax">;</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11">&#167;5.1.11</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_7_1"></a><b>&#167;5.1.11.7.1. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a detail about the currently selected Module</span><span class="named-paragraph-number">5.1.11.7.1</span></span><span class="comment-syntax"> =</span>
<p class="commentary firstcommentary"><a id="SP5_1_11_6_1"></a><b>&#167;5.1.11.6.1. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a detail about the currently selected Module</span><span class="named-paragraph-number">5.1.11.6.1</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-sm.html#SP22" class="function-link"><span class="function-syntax">Str::eq_wide_string</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">detail</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Title"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><a href="../foundation-module/4-sm.html#SP17" class="function-link"><span class="function-syntax">Str::copy</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="identifier-syntax">M</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">module_name</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-sm.html#SP22" class="function-link"><span class="function-syntax">Str::eq_wide_string</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">detail</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Page"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">section_md</span><span class="plain-syntax"> *</span><span class="identifier-syntax">Sm</span><span class="plain-syntax"> = </span><span class="identifier-syntax">FIRST_IN_LINKED_LIST</span><span class="plain-syntax">(</span><span class="reserved-syntax">section_md</span><span class="plain-syntax">, </span><span class="identifier-syntax">M</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sections_md</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><a href="6-cln.html#SP11" class="function-link"><span class="function-syntax">Colonies::section_URL</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="identifier-syntax">Sm</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="6-cln.html#SP7" class="function-link"><span class="function-syntax">Colonies::find</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">M</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">module_name</span><span class="plain-syntax">))</span>
<span class="plain-syntax"> </span><a href="6-cln.html#SP11" class="function-link"><span class="function-syntax">Colonies::reference_URL</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="identifier-syntax">M</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">module_name</span><span class="plain-syntax">, </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">into_file</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-sm.html#SP22" class="function-link"><span class="function-syntax">Str::eq_wide_string</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">detail</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">"Purpose"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">TEMPORARY_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">, </span><span class="string-syntax">"%p"</span><span class="plain-syntax">, </span><span class="identifier-syntax">M</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">module_location</span><span class="plain-syntax">);</span>
@ -750,11 +755,11 @@ this will recursively call The Collater, in fact.
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"%S for %S"</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">M</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">module_name</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> }</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11_7">&#167;5.1.11.7</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_8"></a><b>&#167;5.1.11.8. </b>And here for Chapters:
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11_6">&#167;5.1.11.6</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_7"></a><b>&#167;5.1.11.7. </b>And here for Chapters:
</p>
<p class="commentary"><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a Chapter</span><span class="named-paragraph-number">5.1.11.8</span></span><span class="comment-syntax"> =</span>
<p class="commentary"><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a Chapter</span><span class="named-paragraph-number">5.1.11.7</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
@ -763,10 +768,10 @@ this will recursively call The Collater, in fact.
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">C</span><span class="plain-syntax"> == </span><span class="identifier-syntax">NULL</span><span class="plain-syntax">)</span>
<span class="plain-syntax"> </span><a href="../foundation-module/3-em.html#SP6" class="function-link"><span class="function-syntax">Errors::at_position</span></a><span class="plain-syntax">(</span><span class="string-syntax">"no chapter is currently selected"</span><span class="plain-syntax">,</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">errors_at</span><span class="plain-syntax">, </span><span class="identifier-syntax">lpos</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_8_1" class="named-paragraph-link"><span class="named-paragraph">Substitute a detail about the currently selected Chapter</span><span class="named-paragraph-number">5.1.11.8.1</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_7_1" class="named-paragraph-link"><span class="named-paragraph">Substitute a detail about the currently selected Chapter</span><span class="named-paragraph-number">5.1.11.7.1</span></a></span><span class="plain-syntax">;</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11">&#167;5.1.11</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_8_1"></a><b>&#167;5.1.11.8.1. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a detail about the currently selected Chapter</span><span class="named-paragraph-number">5.1.11.8.1</span></span><span class="comment-syntax"> =</span>
<p class="commentary firstcommentary"><a id="SP5_1_11_7_1"></a><b>&#167;5.1.11.7.1. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a detail about the currently selected Chapter</span><span class="named-paragraph-number">5.1.11.7.1</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
@ -783,11 +788,11 @@ this will recursively call The Collater, in fact.
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"%S for %S"</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">C</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">md</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">ch_title</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> }</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11_8">&#167;5.1.11.8</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_9"></a><b>&#167;5.1.11.9. </b>And this is a very similar construction for Sections.
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11_7">&#167;5.1.11.7</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_8"></a><b>&#167;5.1.11.8. </b>And this is a very similar construction for Sections.
</p>
<p class="commentary"><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a Section</span><span class="named-paragraph-number">5.1.11.9</span></span><span class="comment-syntax"> =</span>
<p class="commentary"><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a Section</span><span class="named-paragraph-number">5.1.11.8</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
@ -796,10 +801,10 @@ this will recursively call The Collater, in fact.
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">S</span><span class="plain-syntax"> == </span><span class="identifier-syntax">NULL</span><span class="plain-syntax">)</span>
<span class="plain-syntax"> </span><a href="../foundation-module/3-em.html#SP6" class="function-link"><span class="function-syntax">Errors::at_position</span></a><span class="plain-syntax">(</span><span class="string-syntax">"no section is currently selected"</span><span class="plain-syntax">,</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">errors_at</span><span class="plain-syntax">, </span><span class="identifier-syntax">lpos</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_9_1" class="named-paragraph-link"><span class="named-paragraph">Substitute a detail about the currently selected Section</span><span class="named-paragraph-number">5.1.11.9.1</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_8_1" class="named-paragraph-link"><span class="named-paragraph">Substitute a detail about the currently selected Section</span><span class="named-paragraph-number">5.1.11.8.1</span></a></span><span class="plain-syntax">;</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11">&#167;5.1.11</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_9_1"></a><b>&#167;5.1.11.9.1. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a detail about the currently selected Section</span><span class="named-paragraph-number">5.1.11.9.1</span></span><span class="comment-syntax"> =</span>
<p class="commentary firstcommentary"><a id="SP5_1_11_8_1"></a><b>&#167;5.1.11.8.1. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a detail about the currently selected Section</span><span class="named-paragraph-number">5.1.11.8.1</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
@ -828,12 +833,12 @@ this will recursively call The Collater, in fact.
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"%S for %S"</span><span class="plain-syntax">, </span><span class="identifier-syntax">varname</span><span class="plain-syntax">, </span><span class="identifier-syntax">S</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">md</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sect_title</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> }</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11_9">&#167;5.1.11.9</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_10"></a><b>&#167;5.1.11.10. </b>These commands are all used in constructing relative URLs, especially for
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11_8">&#167;5.1.11.8</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_9"></a><b>&#167;5.1.11.9. </b>These commands are all used in constructing relative URLs, especially for
navigation purposes.
</p>
<p class="commentary"><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a Docs</span><span class="named-paragraph-number">5.1.11.10</span></span><span class="comment-syntax"> =</span>
<p class="commentary"><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a Docs</span><span class="named-paragraph-number">5.1.11.9</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
@ -842,7 +847,7 @@ navigation purposes.
<span class="plain-syntax"> </span><a href="../foundation-module/3-pth.html#SP5" class="function-link"><span class="function-syntax">Pathnames::from_text</span></a><span class="plain-syntax">(</span><a href="6-cln.html#SP9" class="function-link"><span class="function-syntax">Colonies::home</span></a><span class="plain-syntax">()));</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11">&#167;5.1.11</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_11"></a><b>&#167;5.1.11.11. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a URL</span><span class="named-paragraph-number">5.1.11.11</span></span><span class="comment-syntax"> =</span>
<p class="commentary firstcommentary"><a id="SP5_1_11_10"></a><b>&#167;5.1.11.10. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a URL</span><span class="named-paragraph-number">5.1.11.10</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
@ -851,7 +856,7 @@ navigation purposes.
<span class="plain-syntax"> </span><a href="../foundation-module/3-pth.html#SP5" class="function-link"><span class="function-syntax">Pathnames::from_text</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">link_text</span><span class="plain-syntax">));</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11">&#167;5.1.11</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_12"></a><b>&#167;5.1.11.12. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a Link</span><span class="named-paragraph-number">5.1.11.12</span></span><span class="comment-syntax"> =</span>
<p class="commentary firstcommentary"><a id="SP5_1_11_11"></a><b>&#167;5.1.11.11. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a Link</span><span class="named-paragraph-number">5.1.11.11</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
@ -860,7 +865,7 @@ navigation purposes.
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"\"&gt;"</span><span class="plain-syntax">);</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11">&#167;5.1.11</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_13"></a><b>&#167;5.1.11.13. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a Menu</span><span class="named-paragraph-number">5.1.11.13</span></span><span class="comment-syntax"> =</span>
<p class="commentary firstcommentary"><a id="SP5_1_11_12"></a><b>&#167;5.1.11.12. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a Menu</span><span class="named-paragraph-number">5.1.11.12</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
@ -869,7 +874,7 @@ navigation purposes.
<span class="plain-syntax"> </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">inside_navigation_submenu</span><span class="plain-syntax"> = </span><span class="constant-syntax">TRUE</span><span class="plain-syntax">;</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11">&#167;5.1.11</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_14"></a><b>&#167;5.1.11.14. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Look for icon text</span><span class="named-paragraph-number">5.1.11.14</span></span><span class="comment-syntax"> =</span>
<p class="commentary firstcommentary"><a id="SP5_1_11_13"></a><b>&#167;5.1.11.13. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Look for icon text</span><span class="named-paragraph-number">5.1.11.13</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
@ -884,27 +889,27 @@ navigation purposes.
<span class="plain-syntax"> </span><a href="../foundation-module/4-pm.html#SP9" class="function-link"><span class="function-syntax">Regexp::dispose_of</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">);</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11">&#167;5.1.11</a> (twice).</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_15"></a><b>&#167;5.1.11.15. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a member Item</span><span class="named-paragraph-number">5.1.11.15</span></span><span class="comment-syntax"> =</span>
<p class="commentary firstcommentary"><a id="SP5_1_11_14"></a><b>&#167;5.1.11.14. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a member Item</span><span class="named-paragraph-number">5.1.11.14</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
<span class="plain-syntax"> </span><span class="identifier-syntax">TEMPORARY_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><a href="6-cln.html#SP11" class="function-link"><span class="function-syntax">Colonies::reference_URL</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">, </span><span class="identifier-syntax">link_text</span><span class="plain-syntax">, </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">into_file</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_15_1" class="named-paragraph-link"><span class="named-paragraph">Substitute an item at this URL</span><span class="named-paragraph-number">5.1.11.15.1</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_14_1" class="named-paragraph-link"><span class="named-paragraph">Substitute an item at this URL</span><span class="named-paragraph-number">5.1.11.14.1</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">DISCARD_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">);</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11">&#167;5.1.11</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_16"></a><b>&#167;5.1.11.16. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a general Item</span><span class="named-paragraph-number">5.1.11.16</span></span><span class="comment-syntax"> =</span>
<p class="commentary firstcommentary"><a id="SP5_1_11_15"></a><b>&#167;5.1.11.15. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute a general Item</span><span class="named-paragraph-number">5.1.11.15</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
<span class="plain-syntax"> </span><span class="identifier-syntax">TEMPORARY_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><a href="6-cln.html#SP11" class="function-link"><span class="function-syntax">Colonies::link_URL</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">, </span><span class="identifier-syntax">link_text</span><span class="plain-syntax">, </span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">into_file</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_15_1" class="named-paragraph-link"><span class="named-paragraph">Substitute an item at this URL</span><span class="named-paragraph-number">5.1.11.15.1</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_14_1" class="named-paragraph-link"><span class="named-paragraph">Substitute an item at this URL</span><span class="named-paragraph-number">5.1.11.14.1</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">DISCARD_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">);</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11">&#167;5.1.11</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_15_1"></a><b>&#167;5.1.11.15.1. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute an item at this URL</span><span class="named-paragraph-number">5.1.11.15.1</span></span><span class="comment-syntax"> =</span>
<p class="commentary firstcommentary"><a id="SP5_1_11_14_1"></a><b>&#167;5.1.11.14.1. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute an item at this URL</span><span class="named-paragraph-number">5.1.11.14.1</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
@ -913,23 +918,23 @@ navigation purposes.
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"&lt;li&gt;"</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-sm.html#SP19" class="function-link"><span class="function-syntax">Str::eq</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">, </span><a href="../foundation-module/3-fln.html#SP7" class="function-link"><span class="function-syntax">Filenames::get_leafname</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">cls</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">into_file</span><span class="plain-syntax">))) {</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"&lt;span class=\"unlink\"&gt;"</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_15_1_1" class="named-paragraph-link"><span class="named-paragraph">Substitute icon and name</span><span class="named-paragraph-number">5.1.11.15.1.1</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_14_1_1" class="named-paragraph-link"><span class="named-paragraph">Substitute icon and name</span><span class="named-paragraph-number">5.1.11.14.1.1</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"&lt;/span&gt;"</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-sm.html#SP19" class="function-link"><span class="function-syntax">Str::eq</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">, </span><span class="identifier-syntax">I</span><span class="string-syntax">"index.html"</span><span class="plain-syntax">)) {</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"&lt;a href=\"%S\"&gt;"</span><span class="plain-syntax">, </span><span class="identifier-syntax">url</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"&lt;span class=\"selectedlink\"&gt;"</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_15_1_1" class="named-paragraph-link"><span class="named-paragraph">Substitute icon and name</span><span class="named-paragraph-number">5.1.11.15.1.1</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_14_1_1" class="named-paragraph-link"><span class="named-paragraph">Substitute icon and name</span><span class="named-paragraph-number">5.1.11.14.1.1</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"&lt;/span&gt;"</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"&lt;/a&gt;"</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> } </span><span class="reserved-syntax">else</span><span class="plain-syntax"> {</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"&lt;a href=\"%S\"&gt;"</span><span class="plain-syntax">, </span><span class="identifier-syntax">url</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_15_1_1" class="named-paragraph-link"><span class="named-paragraph">Substitute icon and name</span><span class="named-paragraph-number">5.1.11.15.1.1</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="named-paragraph-container code-font"><a href="3-tc.html#SP5_1_11_14_1_1" class="named-paragraph-link"><span class="named-paragraph">Substitute icon and name</span><span class="named-paragraph-number">5.1.11.14.1.1</span></a></span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"&lt;/a&gt;"</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> }</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"&lt;/li&gt;"</span><span class="plain-syntax">);</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11_15">&#167;5.1.11.15</a>, <a href="3-tc.html#SP5_1_11_16">&#167;5.1.11.16</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_15_1_1"></a><b>&#167;5.1.11.15.1.1. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute icon and name</span><span class="named-paragraph-number">5.1.11.15.1.1</span></span><span class="comment-syntax"> =</span>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11_14">&#167;5.1.11.14</a>, <a href="3-tc.html#SP5_1_11_15">&#167;5.1.11.15</a>.</li></ul>
<p class="commentary firstcommentary"><a id="SP5_1_11_14_1_1"></a><b>&#167;5.1.11.14.1.1. </b><span class="named-paragraph-container code-font"><span class="named-paragraph-defn">Substitute icon and name</span><span class="named-paragraph-number">5.1.11.14.1.1</span></span><span class="comment-syntax"> =</span>
</p>
<pre class="displayed-code all-displayed-code code-font">
@ -943,24 +948,7 @@ navigation purposes.
<span class="plain-syntax"> }</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">substituted</span><span class="plain-syntax">, </span><span class="string-syntax">"%S"</span><span class="plain-syntax">, </span><span class="identifier-syntax">item_name</span><span class="plain-syntax">);</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11_15_1">&#167;5.1.11.15.1</a> (three times).</li></ul>
<p class="commentary firstcommentary"><a id="SP6"></a><b>&#167;6. </b></p>
<pre class="displayed-code all-displayed-code code-font">
<span class="reserved-syntax">void</span><span class="plain-syntax"> </span><span class="function-syntax">Collater::list_module</span><button class="popup" onclick="togglePopup('usagePopup10')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup10">Usage of <span class="code-font"><span class="function-syntax">Collater::list_module</span></span>:<br/><a href="3-tc.html#SP5_1_11_5">&#167;5.1.11.5</a></span></button><span class="plain-syntax">(</span><span class="constant-syntax">OUTPUT_STREAM</span><span class="plain-syntax">, </span><span class="reserved-syntax">module</span><span class="plain-syntax"> *</span><span class="identifier-syntax">M</span><span class="plain-syntax">, </span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">list_this</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">list_this</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE</span><span class="plain-syntax">(</span><span class="string-syntax">"&lt;li&gt;&lt;p&gt;%S - "</span><span class="plain-syntax">, </span><span class="identifier-syntax">M</span><span class="plain-syntax">-&gt;</span><span class="identifier-syntax">module_name</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">TEMPORARY_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE_TO</span><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">, </span><span class="string-syntax">"%p"</span><span class="plain-syntax">, </span><span class="identifier-syntax">M</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">module_location</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><a href="6-rw.html#SP8" class="function-link"><span class="function-syntax">Readme::write_var</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">OUT</span><span class="plain-syntax">, </span><span class="identifier-syntax">url</span><span class="plain-syntax">, </span><span class="identifier-syntax">I</span><span class="string-syntax">"Purpose"</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">DISCARD_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">WRITE</span><span class="plain-syntax">(</span><span class="string-syntax">"&lt;/p&gt;&lt;/li&gt;"</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> }</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">module</span><span class="plain-syntax"> *</span><span class="identifier-syntax">N</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">LOOP_OVER_LINKED_LIST</span><span class="plain-syntax">(</span><span class="identifier-syntax">N</span><span class="plain-syntax">, </span><span class="reserved-syntax">module</span><span class="plain-syntax">, </span><span class="identifier-syntax">M</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">dependencies</span><span class="plain-syntax">)</span>
<span class="plain-syntax"> </span><a href="3-tc.html#SP6" class="function-link"><span class="function-syntax">Collater::list_module</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">OUT</span><span class="plain-syntax">, </span><span class="identifier-syntax">N</span><span class="plain-syntax">, </span><span class="constant-syntax">TRUE</span><span class="plain-syntax">);</span>
<span class="plain-syntax">}</span>
</pre>
<ul class="endnotetexts"><li>This code is used in <a href="3-tc.html#SP5_1_11_14_1">&#167;5.1.11.14.1</a> (three times).</li></ul>
<nav role="progress"><div class="progresscontainer">
<ul class="progressbar"><li class="progressprev"><a href="3-ta.html">&#10094;</a></li><li class="progresschapter"><a href="M-iti.html">M</a></li><li class="progresschapter"><a href="P-htpw.html">P</a></li><li class="progresschapter"><a href="1-bsc.html">1</a></li><li class="progresschapter"><a href="2-tr.html">2</a></li><li class="progresscurrentchapter">3</li><li class="progresssection"><a href="3-ta.html">ta</a></li><li class="progresscurrent">tc</li><li class="progresssection"><a href="3-tw.html">tw</a></li><li class="progresssection"><a href="3-twot.html">twot</a></li><li class="progresssection"><a href="3-tt.html">tt</a></li><li class="progresschapter"><a href="4-pl.html">4</a></li><li class="progresschapter"><a href="5-wt.html">5</a></li><li class="progresschapter"><a href="6-mkf.html">6</a></li><li class="progressnext"><a href="3-tw.html">&#10095;</a></li></ul></div>
</nav><!--End of weave-->

View file

@ -219,7 +219,7 @@ placeholder text in the template file.
<pre class="displayed-code all-displayed-code code-font">
<span class="identifier-syntax">IMETHOD_TYPE</span><span class="plain-syntax">(</span><span class="constant-syntax">POST_PROCESS_SUBSTITUTE_POS_MTID</span><span class="plain-syntax">, </span><span class="reserved-syntax">weave_format</span><span class="plain-syntax"> *</span><span class="identifier-syntax">wf</span><span class="plain-syntax">, </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">OUT</span><span class="plain-syntax">,</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">weave_order</span><span class="plain-syntax"> *</span><span class="identifier-syntax">wv</span><span class="plain-syntax">, </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">detail</span><span class="plain-syntax">, </span><span class="reserved-syntax">weave_pattern</span><span class="plain-syntax"> *</span><span class="identifier-syntax">pattern</span><span class="plain-syntax">)</span>
<span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="function-syntax">Formats::substitute_post_processing_data</span><button class="popup" onclick="togglePopup('usagePopup11')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup11">Usage of <span class="code-font"><span class="function-syntax">Formats::substitute_post_processing_data</span></span>:<br/>The Collater - <a href="3-tc.html#SP5_1_11_6">&#167;5.1.11.6</a>, <a href="3-tc.html#SP5_1_11_8_1">&#167;5.1.11.8.1</a>, <a href="3-tc.html#SP5_1_11_9_1">&#167;5.1.11.9.1</a></span></button><span class="plain-syntax">(</span><span class="constant-syntax">OUTPUT_STREAM</span><span class="plain-syntax">, </span><span class="reserved-syntax">weave_order</span><span class="plain-syntax"> *</span><span class="identifier-syntax">wv</span><span class="plain-syntax">,</span>
<span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="function-syntax">Formats::substitute_post_processing_data</span><button class="popup" onclick="togglePopup('usagePopup11')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup11">Usage of <span class="code-font"><span class="function-syntax">Formats::substitute_post_processing_data</span></span>:<br/>The Collater - <a href="3-tc.html#SP5_1_11_5">&#167;5.1.11.5</a>, <a href="3-tc.html#SP5_1_11_7_1">&#167;5.1.11.7.1</a>, <a href="3-tc.html#SP5_1_11_8_1">&#167;5.1.11.8.1</a></span></button><span class="plain-syntax">(</span><span class="constant-syntax">OUTPUT_STREAM</span><span class="plain-syntax">, </span><span class="reserved-syntax">weave_order</span><span class="plain-syntax"> *</span><span class="identifier-syntax">wv</span><span class="plain-syntax">,</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">detail</span><span class="plain-syntax">, </span><span class="reserved-syntax">weave_pattern</span><span class="plain-syntax"> *</span><span class="identifier-syntax">pattern</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">int</span><span class="plain-syntax"> </span><span class="identifier-syntax">rv</span><span class="plain-syntax"> = </span><a href="5-tu.html#SP6" class="function-link"><span class="function-syntax">TeXUtilities::substitute_post_processing_data</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">OUT</span><span class="plain-syntax">, </span><span class="identifier-syntax">wv</span><span class="plain-syntax">, </span><span class="identifier-syntax">detail</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">IMETHOD_CALL</span><span class="plain-syntax">(</span><span class="identifier-syntax">rv</span><span class="plain-syntax">, </span><span class="identifier-syntax">wv</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">format</span><span class="plain-syntax">, </span><span class="constant-syntax">POST_PROCESS_SUBSTITUTE_POS_MTID</span><span class="plain-syntax">, </span><span class="identifier-syntax">OUT</span><span class="plain-syntax">, </span><span class="identifier-syntax">wv</span><span class="plain-syntax">, </span><span class="identifier-syntax">detail</span><span class="plain-syntax">, </span><span class="identifier-syntax">pattern</span><span class="plain-syntax">);</span>

View file

@ -297,7 +297,7 @@ first we find.
</p>
<pre class="displayed-code all-displayed-code code-font">
<span class="reserved-syntax">colony_member</span><span class="plain-syntax"> *</span><span class="function-syntax">Colonies::find</span><button class="popup" onclick="togglePopup('usagePopup7')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup7">Usage of <span class="code-font"><span class="function-syntax">Colonies::find</span></span>:<br/><a href="6-cln.html#SP10_2">&#167;10.2</a>, <a href="6-cln.html#SP10_3">&#167;10.3</a>, <a href="6-cln.html#SP11">&#167;11</a><br/>Configuration - <a href="1-cnf.html#SP4">&#167;4</a></span></button><span class="plain-syntax">(</span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">T</span><span class="plain-syntax">) {</span>
<span class="reserved-syntax">colony_member</span><span class="plain-syntax"> *</span><span class="function-syntax">Colonies::find</span><button class="popup" onclick="togglePopup('usagePopup7')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup7">Usage of <span class="code-font"><span class="function-syntax">Colonies::find</span></span>:<br/><a href="6-cln.html#SP10_2">&#167;10.2</a>, <a href="6-cln.html#SP10_3">&#167;10.3</a>, <a href="6-cln.html#SP11">&#167;11</a><br/>Configuration - <a href="1-cnf.html#SP4">&#167;4</a><br/>The Collater - <a href="3-tc.html#SP5_1_3">&#167;5.1.3</a>, <a href="3-tc.html#SP5_1_11_6_1">&#167;5.1.11.6.1</a></span></button><span class="plain-syntax">(</span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">T</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">colony</span><span class="plain-syntax"> *</span><span class="identifier-syntax">C</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">LOOP_OVER</span><span class="plain-syntax">(</span><span class="identifier-syntax">C</span><span class="plain-syntax">, </span><span class="reserved-syntax">colony</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">colony_member</span><span class="plain-syntax"> *</span><span class="identifier-syntax">CM</span><span class="plain-syntax">;</span>
@ -370,14 +370,14 @@ the data we already have; but if not, we read it in.
</p>
<pre class="displayed-code all-displayed-code code-font">
<span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="function-syntax">Colonies::home</span><button class="popup" onclick="togglePopup('usagePopup9')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup9">Usage of <span class="code-font"><span class="function-syntax">Colonies::home</span></span>:<br/>The Collater - <a href="3-tc.html#SP5_1_11_10">&#167;5.1.11.10</a>, <a href="3-tc.html#SP5_1_11_15_1_1">&#167;5.1.11.15.1.1</a></span></button><span class="plain-syntax">(</span><span class="reserved-syntax">void</span><span class="plain-syntax">) {</span>
<span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="function-syntax">Colonies::home</span><button class="popup" onclick="togglePopup('usagePopup9')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup9">Usage of <span class="code-font"><span class="function-syntax">Colonies::home</span></span>:<br/>The Collater - <a href="3-tc.html#SP5_1_11_9">&#167;5.1.11.9</a>, <a href="3-tc.html#SP5_1_11_14_1_1">&#167;5.1.11.14.1.1</a></span></button><span class="plain-syntax">(</span><span class="reserved-syntax">void</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">colony</span><span class="plain-syntax"> *</span><span class="identifier-syntax">C</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">LOOP_OVER</span><span class="plain-syntax">(</span><span class="identifier-syntax">C</span><span class="plain-syntax">, </span><span class="reserved-syntax">colony</span><span class="plain-syntax">)</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">return</span><span class="plain-syntax"> </span><span class="identifier-syntax">C</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">home</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">return</span><span class="plain-syntax"> </span><span class="identifier-syntax">I</span><span class="string-syntax">"docs"</span><span class="plain-syntax">;</span>
<span class="plain-syntax">}</span>
<span class="reserved-syntax">pathname</span><span class="plain-syntax"> *</span><span class="function-syntax">Colonies::assets_path</span><button class="popup" onclick="togglePopup('usagePopup10')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup10">Usage of <span class="code-font"><span class="function-syntax">Colonies::assets_path</span></span>:<br/>Assets, Plugins and Colour Schemes - <a href="1-apacs.html#SP12">&#167;12</a><br/>The Collater - <a href="3-tc.html#SP5_1_11_15_1_1">&#167;5.1.11.15.1.1</a></span></button><span class="plain-syntax">(</span><span class="reserved-syntax">void</span><span class="plain-syntax">) {</span>
<span class="reserved-syntax">pathname</span><span class="plain-syntax"> *</span><span class="function-syntax">Colonies::assets_path</span><button class="popup" onclick="togglePopup('usagePopup10')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup10">Usage of <span class="code-font"><span class="function-syntax">Colonies::assets_path</span></span>:<br/>Assets, Plugins and Colour Schemes - <a href="1-apacs.html#SP12">&#167;12</a><br/>The Collater - <a href="3-tc.html#SP5_1_11_14_1_1">&#167;5.1.11.14.1.1</a></span></button><span class="plain-syntax">(</span><span class="reserved-syntax">void</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">colony</span><span class="plain-syntax"> *</span><span class="identifier-syntax">C</span><span class="plain-syntax">;</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">LOOP_OVER</span><span class="plain-syntax">(</span><span class="identifier-syntax">C</span><span class="plain-syntax">, </span><span class="reserved-syntax">colony</span><span class="plain-syntax">)</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">return</span><span class="plain-syntax"> </span><span class="identifier-syntax">C</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">assets_path</span><span class="plain-syntax">;</span>
@ -590,7 +590,7 @@ the main one, and suffixed by <span class="extract"><span class="extract-syntax"
<p class="commentary firstcommentary"><a id="SP11"></a><b>&#167;11. URL management. </b></p>
<pre class="displayed-code all-displayed-code code-font">
<span class="reserved-syntax">void</span><span class="plain-syntax"> </span><span class="function-syntax">Colonies::link_URL</span><button class="popup" onclick="togglePopup('usagePopup13')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup13">Usage of <span class="code-font"><span class="function-syntax">Colonies::link_URL</span></span>:<br/><a href="6-cln.html#SP6">&#167;6</a><br/>The Collater - <a href="3-tc.html#SP5_1_11_16">&#167;5.1.11.16</a></span></button><span class="plain-syntax">(</span><span class="constant-syntax">OUTPUT_STREAM</span><span class="plain-syntax">, </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">link_text</span><span class="plain-syntax">, </span><span class="reserved-syntax">filename</span><span class="plain-syntax"> *</span><span class="identifier-syntax">F</span><span class="plain-syntax">) {</span>
<span class="reserved-syntax">void</span><span class="plain-syntax"> </span><span class="function-syntax">Colonies::link_URL</span><button class="popup" onclick="togglePopup('usagePopup13')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup13">Usage of <span class="code-font"><span class="function-syntax">Colonies::link_URL</span></span>:<br/><a href="6-cln.html#SP6">&#167;6</a><br/>The Collater - <a href="3-tc.html#SP5_1_11_15">&#167;5.1.11.15</a></span></button><span class="plain-syntax">(</span><span class="constant-syntax">OUTPUT_STREAM</span><span class="plain-syntax">, </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">link_text</span><span class="plain-syntax">, </span><span class="reserved-syntax">filename</span><span class="plain-syntax"> *</span><span class="identifier-syntax">F</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">match_results</span><span class="plain-syntax"> </span><span class="identifier-syntax">mr</span><span class="plain-syntax"> = </span><a href="../foundation-module/4-pm.html#SP9" class="function-link"><span class="function-syntax">Regexp::create_mr</span></a><span class="plain-syntax">();</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-pm.html#SP10" class="function-link"><span class="function-syntax">Regexp::match</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">, </span><span class="identifier-syntax">link_text</span><span class="plain-syntax">, </span><span class="identifier-syntax">L</span><span class="string-syntax">" *//(%c+)// *"</span><span class="plain-syntax">))</span>
<span class="plain-syntax"> </span><a href="6-cln.html#SP11" class="function-link"><span class="function-syntax">Colonies::reference_URL</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">OUT</span><span class="plain-syntax">, </span><span class="identifier-syntax">mr</span><span class="plain-syntax">.</span><span class="element-syntax">exp</span><span class="plain-syntax">[0], </span><span class="identifier-syntax">F</span><span class="plain-syntax">);</span>
@ -599,7 +599,7 @@ the main one, and suffixed by <span class="extract"><span class="extract-syntax"
<span class="plain-syntax"> </span><a href="../foundation-module/4-pm.html#SP9" class="function-link"><span class="function-syntax">Regexp::dispose_of</span></a><span class="plain-syntax">(&amp;</span><span class="identifier-syntax">mr</span><span class="plain-syntax">);</span>
<span class="plain-syntax">}</span>
<span class="reserved-syntax">void</span><span class="plain-syntax"> </span><span class="function-syntax">Colonies::reference_URL</span><button class="popup" onclick="togglePopup('usagePopup14')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup14">Usage of <span class="code-font"><span class="function-syntax">Colonies::reference_URL</span></span>:<br/>The Collater - <a href="3-tc.html#SP5_1_11_12">&#167;5.1.11.12</a>, <a href="3-tc.html#SP5_1_11_15">&#167;5.1.11.15</a></span></button><span class="plain-syntax">(</span><span class="constant-syntax">OUTPUT_STREAM</span><span class="plain-syntax">, </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">link_text</span><span class="plain-syntax">, </span><span class="reserved-syntax">filename</span><span class="plain-syntax"> *</span><span class="identifier-syntax">F</span><span class="plain-syntax">) {</span>
<span class="reserved-syntax">void</span><span class="plain-syntax"> </span><span class="function-syntax">Colonies::reference_URL</span><button class="popup" onclick="togglePopup('usagePopup14')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup14">Usage of <span class="code-font"><span class="function-syntax">Colonies::reference_URL</span></span>:<br/>The Collater - <a href="3-tc.html#SP5_1_11_6_1">&#167;5.1.11.6.1</a>, <a href="3-tc.html#SP5_1_11_11">&#167;5.1.11.11</a>, <a href="3-tc.html#SP5_1_11_14">&#167;5.1.11.14</a></span></button><span class="plain-syntax">(</span><span class="constant-syntax">OUTPUT_STREAM</span><span class="plain-syntax">, </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">link_text</span><span class="plain-syntax">, </span><span class="reserved-syntax">filename</span><span class="plain-syntax"> *</span><span class="identifier-syntax">F</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">TEMPORARY_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">title</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">TEMPORARY_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="6-cln.html#SP10" class="function-link"><span class="function-syntax">Colonies::resolve_reference_in_weave</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">, </span><span class="identifier-syntax">title</span><span class="plain-syntax">, </span><span class="identifier-syntax">F</span><span class="plain-syntax">, </span><span class="identifier-syntax">link_text</span><span class="plain-syntax">, </span><span class="identifier-syntax">NULL</span><span class="plain-syntax">, </span><span class="identifier-syntax">NULL</span><span class="plain-syntax">, </span><span class="identifier-syntax">NULL</span><span class="plain-syntax">))</span>
@ -610,7 +610,7 @@ the main one, and suffixed by <span class="extract"><span class="extract-syntax"
<span class="plain-syntax"> </span><span class="identifier-syntax">DISCARD_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">url</span><span class="plain-syntax">);</span>
<span class="plain-syntax">}</span>
<span class="reserved-syntax">void</span><span class="plain-syntax"> </span><span class="function-syntax">Colonies::section_URL</span><button class="popup" onclick="togglePopup('usagePopup15')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup15">Usage of <span class="code-font"><span class="function-syntax">Colonies::section_URL</span></span>:<br/><a href="6-cln.html#SP10_6_1">&#167;10.6.1</a>, <a href="6-cln.html#SP10_6_2">&#167;10.6.2</a><br/>The Collater - <a href="3-tc.html#SP5_1_11_7_1">&#167;5.1.11.7.1</a>, <a href="3-tc.html#SP5_1_11_9_1">&#167;5.1.11.9.1</a><br/>HTML Formats - <a href="5-hf.html#SP5_3">&#167;5.3</a>, <a href="5-hf.html#SP5_3_1">&#167;5.3.1</a>, <a href="5-hf.html#SP5_3_2">&#167;5.3.2</a></span></button><span class="plain-syntax">(</span><span class="constant-syntax">OUTPUT_STREAM</span><span class="plain-syntax">, </span><span class="reserved-syntax">section_md</span><span class="plain-syntax"> *</span><span class="identifier-syntax">Sm</span><span class="plain-syntax">) {</span>
<span class="reserved-syntax">void</span><span class="plain-syntax"> </span><span class="function-syntax">Colonies::section_URL</span><button class="popup" onclick="togglePopup('usagePopup15')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup15">Usage of <span class="code-font"><span class="function-syntax">Colonies::section_URL</span></span>:<br/><a href="6-cln.html#SP10_6_1">&#167;10.6.1</a>, <a href="6-cln.html#SP10_6_2">&#167;10.6.2</a><br/>The Collater - <a href="3-tc.html#SP5_1_11_8_1">&#167;5.1.11.8.1</a><br/>HTML Formats - <a href="5-hf.html#SP5_3">&#167;5.3</a>, <a href="5-hf.html#SP5_3_1">&#167;5.3.1</a>, <a href="5-hf.html#SP5_3_2">&#167;5.3.2</a></span></button><span class="plain-syntax">(</span><span class="constant-syntax">OUTPUT_STREAM</span><span class="plain-syntax">, </span><span class="reserved-syntax">section_md</span><span class="plain-syntax"> *</span><span class="identifier-syntax">Sm</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">Sm</span><span class="plain-syntax"> == </span><span class="identifier-syntax">NULL</span><span class="plain-syntax">) </span><span class="identifier-syntax">internal_error</span><span class="plain-syntax">(</span><span class="string-syntax">"unwoven section"</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="identifier-syntax">LOOP_THROUGH_TEXT</span><span class="plain-syntax">(</span><span class="identifier-syntax">pos</span><span class="plain-syntax">, </span><span class="identifier-syntax">Sm</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">sect_range</span><span class="plain-syntax">)</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> ((</span><a href="../foundation-module/4-sm.html#SP13" class="function-link"><span class="function-syntax">Str::get</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">pos</span><span class="plain-syntax">) == </span><span class="character-syntax">'/'</span><span class="plain-syntax">) || (</span><a href="../foundation-module/4-sm.html#SP13" class="function-link"><span class="function-syntax">Str::get</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">pos</span><span class="plain-syntax">) == </span><span class="character-syntax">' '</span><span class="plain-syntax">))</span>

View file

@ -337,7 +337,7 @@ assume that the version complies with any format).
<span class="plain-syntax"> </span><span class="constant-syntax">MEMORY_MANAGEMENT</span>
<span class="plain-syntax">} </span><span class="reserved-syntax">writeme_asset</span><span class="plain-syntax">;</span>
<span class="reserved-syntax">void</span><span class="plain-syntax"> </span><span class="function-syntax">Readme::write_var</span><button class="popup" onclick="togglePopup('usagePopup8')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup8">Usage of <span class="code-font"><span class="function-syntax">Readme::write_var</span></span>:<br/><a href="6-rw.html#SP7_1">&#167;7.1</a>, <a href="6-rw.html#SP7_2">&#167;7.2</a>, <a href="6-rw.html#SP7_3">&#167;7.3</a><br/>The Collater - <a href="3-tc.html#SP5_1_11_7_1">&#167;5.1.11.7.1</a>, <a href="3-tc.html#SP6">&#167;6</a></span></button><span class="plain-syntax">(</span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">OUT</span><span class="plain-syntax">, </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">program</span><span class="plain-syntax">, </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">datum</span><span class="plain-syntax">) {</span>
<span class="reserved-syntax">void</span><span class="plain-syntax"> </span><span class="function-syntax">Readme::write_var</span><button class="popup" onclick="togglePopup('usagePopup8')"><span class="comment-syntax">?</span><span class="popuptext" id="usagePopup8">Usage of <span class="code-font"><span class="function-syntax">Readme::write_var</span></span>:<br/><a href="6-rw.html#SP7_1">&#167;7.1</a>, <a href="6-rw.html#SP7_2">&#167;7.2</a>, <a href="6-rw.html#SP7_3">&#167;7.3</a><br/>The Collater - <a href="3-tc.html#SP5_1_3">&#167;5.1.3</a>, <a href="3-tc.html#SP5_1_11_6_1">&#167;5.1.11.6.1</a></span></button><span class="plain-syntax">(</span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">OUT</span><span class="plain-syntax">, </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">program</span><span class="plain-syntax">, </span><span class="reserved-syntax">text_stream</span><span class="plain-syntax"> *</span><span class="identifier-syntax">datum</span><span class="plain-syntax">) {</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">writeme_asset</span><span class="plain-syntax"> *</span><span class="identifier-syntax">A</span><span class="plain-syntax"> = </span><a href="6-rw.html#SP9" class="function-link"><span class="function-syntax">Readme::find_asset</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">program</span><span class="plain-syntax">);</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><span class="identifier-syntax">A</span><span class="plain-syntax">-&gt;</span><span class="identifier-syntax">if_web</span><span class="plain-syntax">) </span><span class="identifier-syntax">WRITE</span><span class="plain-syntax">(</span><span class="string-syntax">"%S"</span><span class="plain-syntax">, </span><a href="../foundation-module/8-bdfw.html#SP6" class="function-link"><span class="function-syntax">Bibliographic::get_datum</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">A</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">if_web</span><span class="plain-syntax">, </span><span class="identifier-syntax">datum</span><span class="plain-syntax">));</span>
<span class="plain-syntax"> </span><span class="reserved-syntax">else</span><span class="plain-syntax"> </span><span class="reserved-syntax">if</span><span class="plain-syntax"> (</span><a href="../foundation-module/4-sm.html#SP19" class="function-link"><span class="function-syntax">Str::eq</span></a><span class="plain-syntax">(</span><span class="identifier-syntax">datum</span><span class="plain-syntax">, </span><span class="identifier-syntax">I</span><span class="string-syntax">"Build Date"</span><span class="plain-syntax">)) </span><span class="identifier-syntax">WRITE</span><span class="plain-syntax">(</span><span class="string-syntax">"%S"</span><span class="plain-syntax">, </span><span class="identifier-syntax">A</span><span class="plain-syntax">-&gt;</span><span class="element-syntax">date</span><span class="plain-syntax">);</span>

View file

@ -458,11 +458,10 @@ in BLOCK CAPITAL LETTERS.
<p class="commentary firstcommentary"><a id="SP17"></a><b>&#167;17. </b>Other placeholders, not used in the example above, include:
</p>
<ul class="items"><li>(a) <span class="extract"><span class="extract-syntax">[[Template X]]</span></span> expands to an insertion of the template file <span class="extract"><span class="extract-syntax">X</span></span>.
</li><li>(b) <span class="extract"><span class="extract-syntax">[[Navigation]]</span></span> expands to the navigation sidebar in use when weaving
<ul class="items"><li>(a) <span class="extract"><span class="extract-syntax">[[Navigation]]</span></span> expands to the navigation sidebar in use when weaving
a colony of webs &mdash; see <a href="M-mwiw.html" class="internal">Making Weaves into Websites</a> for more, and for
syntaxes to do with links and URLs.
</li><li>(c) <span class="extract"><span class="extract-syntax">[[Breadcrumbs]]</span></span> expands to the HTML for the breadcrumb trail.
</li><li>(b) <span class="extract"><span class="extract-syntax">[[Breadcrumbs]]</span></span> expands to the HTML for the breadcrumb trail.
</li></ul>
<p class="commentary firstcommentary"><a id="SP18"></a><b>&#167;18. </b>The <span class="extract"><span class="extract-syntax">template-index.html</span></span> file has access to additional placeholders
enabling it to generate contents pages:
@ -496,11 +495,24 @@ is rather raw and literate programming is not being used to the full.
</li></ul>
<p class="commentary firstcommentary"><a id="SP19"></a><b>&#167;19. </b><span class="extract"><span class="extract-syntax">[[Repeat Chapter]]</span></span> and <span class="extract"><span class="extract-syntax">[[Repeat Section]]</span></span> begin blocks of lines which
are repeated for each chapter or section: the material to be repeated
continues to the matching <span class="extract"><span class="extract-syntax">[[End Repeat]</span></span> line. The ``current chapter or
section'' mentioned above is the one selected in the current innermost
continues to the matching <span class="extract"><span class="extract-syntax">[[End Repeat]</span></span> line. The "current chapter or
section" mentioned above is the one selected in the current innermost
loop of that description.
</p>
<p class="commentary"><span class="extract"><span class="extract-syntax">[[Repeat Module]]</span></span>, similarly, begins a repeat through the imported
modules of the current web. (The main module, containing the actual material
of the current web, does not count.) Within such a loop,
</p>
<pre class="displayed-code all-displayed-code code-font">
<span class="plain-syntax"> </span><span class="function-syntax">[[Module Title]]</span><span class="plain-syntax"> </span><span class="function-syntax">[[Module Purpose]]</span><span class="plain-syntax"> </span><span class="function-syntax">[[Module Page]]</span>
</pre>
<p class="commentary">can all be used to refer to the current module. <span class="extract"><span class="extract-syntax">[[Module Page]]</span></span> expands
to the relative URL of the module's own woven HTML form, provided that
the module is listed as a member of the current colony file.
</p>
<p class="commentary"><span class="extract"><span class="extract-syntax">[[Select ...]]</span></span> and <span class="extract"><span class="extract-syntax">[[End Select]</span></span> form a block which behaves like
a repetition, but happens just once, for the named chapter or section.
</p>
@ -528,6 +540,30 @@ a repetition, but happens just once, for the named chapter or section.
<span class="plain-syntax"> Section Vocabulary, 3/vocab, 338 lines.</span>
<span class="plain-syntax"> Section Built-In Words, 3/words, 1207 lines.</span>
</pre>
<p class="commentary firstcommentary"><a id="SP20"></a><b>&#167;20. </b>Finally, there is very limited support for conditionals with
<span class="extract"><span class="extract-syntax">[[If CONDITION]]</span></span>, an optional <span class="extract"><span class="extract-syntax">Else</span></span>, and a compulsory <span class="extract"><span class="extract-syntax">Endif</span></span>.
Very few conditions are in fact allowed:
</p>
<p class="commentary"><span class="extract"><span class="extract-syntax">[[If Chapters]]</span></span> tests whether the current web is divided into chapters,
the alternative being that all the sections are in a notional chapter just
called <span class="extract"><span class="extract-syntax">Sections</span></span>.
</p>
<p class="commentary"><span class="extract"><span class="extract-syntax">[[If Modules]]</span></span> tests whether the current web imports any modules.
</p>
<p class="commentary"><span class="extract"><span class="extract-syntax">[[If Chapter Purpose]]</span></span>, inside a <span class="extract"><span class="extract-syntax">[[Repeat Chapter]]</span></span>, tests whether the
current chapter has a (non-empty) purpose text. Similarly for <span class="extract"><span class="extract-syntax">[[If Section Purpose]]</span></span>
and <span class="extract"><span class="extract-syntax">[[If Module Purpose]].
</span></span></p>
<p class="commentary"><span class="extract"><span class="extract-syntax">[[If Module Page]]</span></span>, inside a <span class="extract"><span class="extract-syntax">[[Repeat Module]]</span></span>, tests whether the module
appears (under its own name, i.e., not by a different name) as a member in
the colony file, if there is one. In effect, this can be used to test whether
it is safe to make a link to the module's own woven pages using <span class="extract"><span class="extract-syntax">[[Module Page]]</span></span>.
</p>
<nav role="progress"><div class="progresscontainer">
<ul class="progressbar"><li class="progressprev"><a href="M-mwiw.html">&#10094;</a></li><li class="progresscurrentchapter">M</li><li class="progresssection"><a href="M-iti.html">iti</a></li><li class="progresssection"><a href="M-wtaw.html">wtaw</a></li><li class="progresssection"><a href="M-htwaw.html">htwaw</a></li><li class="progresssection"><a href="M-mwiw.html">mwiw</a></li><li class="progresscurrent">awwp</li><li class="progresssection"><a href="M-spl.html">spl</a></li><li class="progresssection"><a href="M-tid.html">tid</a></li><li class="progresssection"><a href="M-rc.html">rc</a></li><li class="progresschapter"><a href="P-htpw.html">P</a></li><li class="progresschapter"><a href="1-bsc.html">1</a></li><li class="progresschapter"><a href="2-tr.html">2</a></li><li class="progresschapter"><a href="3-ta.html">3</a></li><li class="progresschapter"><a href="4-pl.html">4</a></li><li class="progresschapter"><a href="5-wt.html">5</a></li><li class="progresschapter"><a href="6-mkf.html">6</a></li><li class="progressnext"><a href="M-spl.html">&#10095;</a></li></ul></div>
</nav><!--End of weave-->

View file

@ -324,8 +324,9 @@
<p class="purpose">Importing:</p>
<ul class="chapterlist">
<li>
<p class="chapterentry"><a href="P-abgtf.html"><spon class="sectiontitle">foundation</span></a> -
<span class="sectionpurpose">A library of common code used by all of the Inform tools.</span></p>
<p class="chapterentry">
<a href="../foundation-module/index.html"><spon class="sectiontitle">foundation</span></a>
- <span class="sectionpurpose">A library of common code used by all of the Inform tools.</span></p>
</li>
</ul>
</div>