code.H3RALD.com — min: 6864ca1b051fd9e73bd154d1d666481dbe99bd52

Docs.

h3rald h3rald@h3rald.com

Sun, 09 Oct 2016 20:36:11 +0200

commit

6864ca1b051fd9e73bd154d1d666481dbe99bd52

parent

45e2a02e15b99998d16ae534f63e0541a41e557f

3 files changed, 68 insertions(+), 3 deletions(-)

jump to

doc/MiNiM_UserGuide.htm

doc/MiNiM_UserGuide.md

doc/reference.md

M doc/MiNiM_UserGuide.htm → doc/MiNiM_UserGuide.htm

@@ -82,19 +82,24 @@ <ul>
    <li><a href="#L.code.lang..code..Module"><code>lang</code> Module</a>
    <ul>
     <li><a href="#bind">bind</a></li>
+    <li><a href="#call">call</a></li>
     <li><a href="#debug">debug</a></li>
     <li><a href="#debug.">debug?</a></li>
     <li><a href="#define">define</a></li>
     <li><a href="#delete">delete</a></li>
+    <li><a href="#eval">eval</a></li>
     <li><a href="#exit">exit</a></li>
     <li><a href="#from-json">from-json</a></li>
     <li><a href="#import">import</a></li>
+    <li><a href="#load">load</a></li>
     <li><a href="#module">module</a></li>
     <li><a href="#scope">scope</a></li>
     <li><a href="#scope.">scope?</a></li>
     <li><a href="#sigils">sigils</a></li>
+    <li><a href="#source">source</a></li>
     <li><a href="#symbols">symbols</a></li>
     <li><a href="#to-json">to-json</a></li>
+    <li><a href="#with">with</a></li>
    </ul>
    </li>
    <li><a href="#L.code.io..code..Module"><code>io</code> Module</a></li>
@@ -126,6 +131,12 @@ <p><em>Signature:</em> <span class="kwd"> * § <strong>&rArr;</strong> &#x2205;</span></p>
 
 <p>Binds the specified value (auto-quoted) to an existing symbol <span class="kwd">§</span>.</p>
 
+<h4 id="call">call<a href="#document-top" title="Go to top"></a></h4>
+
+<p><em>Signature:</em> <span class="kwd"> (*) § <strong>&rArr;</strong> *?</span></p>
+
+<p>Calls operator <span class="kwd">§</span> defined in scope <span class="kwd">(*)</span>.</p>
+
 <h4 id="debug">debug<a href="#document-top" title="Go to top"></a></h4>
 
 <p><em>Signature:</em> <span class="kwd"> &#x2205; <strong>&rArr;</strong> &#x2205;</span></p>
@@ -150,6 +161,12 @@ <p><em>Signature:</em> <span class="kwd"> § <strong>&rArr;</strong> &#x2205;</span></p>
 
 <p>Deletes the specified symbol <span class="kwd">§</span>.</p>
 
+<h4 id="eval">eval<a href="#document-top" title="Go to top"></a></h4>
+
+<p><em>Signature:</em> <span class="kwd"> S <strong>&rArr;</strong> *?</span></p>
+
+<p>Parses and interprets <span class="kwd">S</span>.</p>
+
 <h4 id="exit">exit<a href="#document-top" title="Go to top"></a></h4>
 
 <p><em>Signature:</em> <span class="kwd"> &#x2205; <strong>&rArr;</strong> &#x2205;</span></p>
@@ -168,6 +185,12 @@ <p><em>Signature:</em> <span class="kwd"> § <strong>&rArr;</strong> &#x2205;</span></p>
 
 <p>Imports the a previously-loaded module <span class="kwd">§</span>, defining all its symbols in the current scope.</p>
 
+<h4 id="load">load<a href="#document-top" title="Go to top"></a></h4>
+
+<p><em>Signature:</em> <span class="kwd"> S <strong>&rArr;</strong> *?</span></p>
+
+<p>Parses and interprets the specified MiNiM file <span class="kwd">S</span>, adding <span class="ext">.min</span> if not specified.</p>
+
 <h4 id="module">module<a href="#document-top" title="Go to top"></a></h4>
 
 <p><em>Signature:</em> <span class="kwd"> (*) § <strong>&rArr;</strong> &#x2205;</span></p>
@@ -192,6 +215,12 @@ <p><em>Signature:</em> <span class="kwd"> &#x2205; <strong>&rArr;</strong> (S+)</span></p>
 
 <p>Returns a list of all sigils defined in the <span class="kwd">ROOT</span> scope.</p>
 
+<h4 id="source">source<a href="#document-top" title="Go to top"></a></h4>
+
+<p><em>Signature:</em> <span class="kwd"> § <strong>&rArr;</strong> (*)</span></p>
+
+<p>Display the source code of symbol <span class="kwd">§</span> (if it has been implemented a MiNiM quotation).</p>
+
 <h4 id="symbols">symbols<a href="#document-top" title="Go to top"></a></h4>
 
 <p><em>Signature:</em> <span class="kwd"> &#x2205; <strong>&rArr;</strong> (S+)</span></p>
@@ -202,7 +231,13 @@ <h4 id="to-json">to-json<a href="#document-top" title="Go to top"></a></h4>
 
 <p><em>Signature:</em> <span class="kwd"> (*) <strong>&rArr;</strong> S</span></p>
 
-<p>Converts a quotation into a JSON string.</p>
+<p>Converts a quotation into a JSON string <span class="kwd">S</span>.</p>
+
+<h4 id="with">with<a href="#document-top" title="Go to top"></a></h4>
+
+<p><em>Signature:</em> <span class="kwd"> (2) (1) <strong>&rArr;</strong> *?</span></p>
+
+<p>Applies quotation <span class="kwd">(2)</span> within the scope of <span class="kwd">(1)</span>.</p>
 
 <h3 id="L.code.io..code..Module"><code>io</code> Module<a href="#document-top" title="Go to top"></a></h3>

M doc/MiNiM_UserGuide.md → doc/MiNiM_UserGuide.md

@@ -20,6 +20,9 @@ 
 {#op||bind||\* §||{{null}}||
 Binds the specified value (auto-quoted) to an existing symbol {{sl -> [§](class:kwd)}}.#}
 
+{#op||call||(\*) §||\*?||
+Calls operator {{sl}} defined in scope [(\*)](class:kwd). #}
+
 {#op||debug||{{null}}||{{null}}||
 Toggles debug mode. #}
 
@@ -32,6 +35,9 @@ 
 {#op||delete||§||{{null}}||
 Deletes the specified symbol {{sl}}.#}
 
+{#op||eval||S||\*?||
+Parses and interprets {{s -> [S](class:kwd)}}. #}
+
 {#op||exit||{{null -> &#x2205;}}||{{null}}||
 Exits the program or shell. #}
 
@@ -40,6 +46,9 @@ Converts a JSON string into {{M -> MiNiM}} data.#}
 
 {#op||import||§||{{null}}||
 Imports the a previously-loaded module {{sl}}, defining all its symbols in the current scope. #}
+
+{#op||load||S||\*?||
+Parses and interprets the specified {{M}} file {{s -> [S](class:kwd)}}, adding [.min](class:ext) if not specified. #}
 
 {#op||module||(\*) §||{{null}}||
 Creates a new module {{sl}} based on quotation {{q}}. #}
@@ -53,11 +62,17 @@ 
 {#op||sigils||{{null}}||(S+)||
 Returns a list of all sigils defined in the [ROOT](class:kwd) scope.#}
 
+{#op||source||§||(\*)||
+Display the source code of symbol {{sl}} (if it has been implemented a {{M}} quotation). #}
+
 {#op||symbols||{{null}}||(S+)||
 Returns a list of all symbols defined in the [ROOT](class:kwd) scope.#}
 
 {#op||to-json||(\*)||S||
-Converts a quotation into a JSON string.#}
+Converts a quotation into a JSON string {{s}}.#}
+
+{#op||with||(2) (1)||\*?||
+Applies quotation [(2)](class:kwd) within the scope of [(1)](class:kwd). #}
 
 ### `io` Module

M doc/reference.md → doc/reference.md

@@ -14,6 +14,9 @@ 
 {#op||bind||\* §||{{null}}||
 Binds the specified value (auto-quoted) to an existing symbol {{sl -> [§](class:kwd)}}.#}
 
+{#op||call||(\*) §||\*?||
+Calls operator {{sl}} defined in scope [(\*)](class:kwd). #}
+
 {#op||debug||{{null}}||{{null}}||
 Toggles debug mode. #}
 
@@ -26,6 +29,9 @@ 
 {#op||delete||§||{{null}}||
 Deletes the specified symbol {{sl}}.#}
 
+{#op||eval||S||\*?||
+Parses and interprets {{s -> [S](class:kwd)}}. #}
+
 {#op||exit||{{null -> &#x2205;}}||{{null}}||
 Exits the program or shell. #}
 
@@ -34,6 +40,9 @@ Converts a JSON string into {{M -> MiNiM}} data.#}
 
 {#op||import||§||{{null}}||
 Imports the a previously-loaded module {{sl}}, defining all its symbols in the current scope. #}
+
+{#op||load||S||\*?||
+Parses and interprets the specified {{M}} file {{s -> [S](class:kwd)}}, adding [.min](class:ext) if not specified. #}
 
 {#op||module||(\*) §||{{null}}||
 Creates a new module {{sl}} based on quotation {{q}}. #}
@@ -47,11 +56,17 @@ 
 {#op||sigils||{{null}}||(S+)||
 Returns a list of all sigils defined in the [ROOT](class:kwd) scope.#}
 
+{#op||source||§||(\*)||
+Display the source code of symbol {{sl}} (if it has been implemented a {{M}} quotation). #}
+
 {#op||symbols||{{null}}||(S+)||
 Returns a list of all symbols defined in the [ROOT](class:kwd) scope.#}
 
 {#op||to-json||(\*)||S||
-Converts a quotation into a JSON string.#}
+Converts a quotation into a JSON string {{s}}.#}
+
+{#op||with||(2) (1)||\*?||
+Applies quotation [(2)](class:kwd) within the scope of [(1)](class:kwd). #}
 
 ### `io` Module

all repos — min @ 6864ca1b051fd9e73bd154d1d666481dbe99bd52

A small but practical concatenative programming language.