commit f034631227cefb6e5dd879eb9ab1744af7a78dbe
parent 318a579199102a50ed436bbcbf4db14d2fea0bc2
Author: lash <dev@holbrook.no>
Date: Tue, 2 May 2023 07:53:11 +0100
Put features into texinfo doc, example implementation in readme
Diffstat:
3 files changed, 28 insertions(+), 30 deletions(-)
diff --git a/doc/build/index.html b/doc/build/index.html
@@ -47,10 +47,6 @@ Next: <a href="overview.html" accesskey="n" rel="next">Overview</a> [<a h
<li><a id="toc-Overview" href="overview.html">1 Overview</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Features" href="overview.html#Features">1.1 Features</a></li>
- <li><a id="toc-Contents" href="overview.html#Contents">1.2 Contents</a>
- <ul class="toc-numbered-mark">
- <li><a id="toc-Virtual-machine" href="overview.html#Virtual-machine">1.2.1 Virtual machine</a></li>
- </ul></li>
</ul></li>
<li><a id="toc-An-example-vise-implementation" href="sim.html">2 An example vise implementation</a>
<ul class="toc-numbered-mark">
diff --git a/doc/build/overview.html b/doc/build/overview.html
@@ -42,29 +42,26 @@ Next: <a href="sim.html" accesskey="n" rel="next">An example vise implementation
</p>
<ul class="mini-toc">
<li><a href="#Features" accesskey="1">Features</a></li>
-<li><a href="#Contents" accesskey="2">Contents</a></li>
</ul>
<div class="section-level-extent" id="Features">
<h3 class="section">1.1 Features</h3>
-</div>
-<div class="section-level-extent" id="Contents">
-<h3 class="section">1.2 Contents</h3>
-
-<ul class="mini-toc">
-<li><a href="#Virtual-machine" accesskey="1">Virtual machine</a></li>
-</ul>
-<div class="subsection-level-extent" id="Virtual-machine">
-<h4 class="subsection">1.2.1 Virtual machine</h4>
-
-<p>This component processes menu navigation from client input, and executes
-</p>
<ul class="itemize mark-bullet">
-<li>Virtual machine to handle menu navigation.
-</li><li>Assembly mini-language to script for the virtual machine.
-</li><li>Code interface for external calls.
+<li>Define and enforce max output size for every individual output.
+</li><li>Allow one single data entry to fill remaining available size capacity.
+</li><li>An assembly-like mini-language to define:
+<ul class="itemize mark-bullet">
+<li>external code execution.
+</li><li>input validation and routing.
+</li><li>menu definitions.
+</li><li>flow control.
+</li><li>exception handling.
+</li></ul>
+</li><li>templated output from results of external code execution.
+</li><li>generate and navigate pages where data symbol contents are too long to display on a single page.
+</li><li>pluggable function design for handling external code execution calls.
+</li><li>Dedicated error string to prepend to template (e.g. on catch)
</li></ul>
-</div>
</div>
</div>
diff --git a/doc/texinfo/overview.texi b/doc/texinfo/overview.texi
@@ -7,14 +7,19 @@ Specifically, the original target enviromnent was USSD menu navigation and sessi
@section Features
-@section Contents
-
-@subsection Virtual machine
-
-This component processes menu navigation from client input, and executes
-
@itemize
-@item Virtual machine to handle menu navigation.
-@item Assembly mini-language to script for the virtual machine.
-@item Code interface for external calls.
+@item Define and enforce max output size for every individual output.
+@item Allow one single data entry to fill remaining available size capacity.
+@item An assembly-like mini-language to define:
+@itemize
+@item external code execution.
+@item input validation and routing.
+@item menu definitions.
+@item flow control.
+@item exception handling.
+@end itemize
+@item templated output from results of external code execution.
+@item generate and navigate pages where data symbol contents are too long to display on a single page.
+@item pluggable function design for handling external code execution calls.
+@item Dedicated error string to prepend to template (e.g. on catch)
@end itemize
