Skip to content

Commit 22d0fba

Browse files
committed
Update documentation for release
1 parent 89418c8 commit 22d0fba

File tree

2 files changed

+53
-11
lines changed

2 files changed

+53
-11
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ embedded in a native template application.)
2222
[CLOG - Technical Overview and Purpose](CONCEPT.md)
2323
[CLOG - Reference Manual](https://rabbibotton.github.io/clog/clog-manual.html)
2424

25-
STATUS: CLOG and CLOG Builder 1.8 released.
25+
STATUS: CLOG and CLOG Builder 1.9 released.
2626

2727
CLOG is actually based on GNOGA, a framework I wrote for Ada in 2013
2828
and used in commercial production code for the last 10+ years. CLOG
@@ -263,7 +263,7 @@ CLOG Tutorials
263263
- [19-tutorial.lisp](tutorial/19-tutorial.lisp) - Using JavaScript components
264264
- [20-tutorial.lisp](tutorial/20-tutorial.lisp) - New CLOG plugin from JavaScript component
265265
- [21-tutorial.lisp](tutorial/21-tutorial.lisp) - New CLOG plugin in Common-Lisp
266-
- [22-tutorial.lisp](tutorial/22-tutorial.lisp) - CLOG GUI Menus and Desktop Look and Feel
266+
- [22-tutorial.lisp](tutorial/22-tutorial.lisp) - CLOG GUI Menus and Desktop Look and Feel, and popups
267267
- [23-tutorial.lisp](tutorial/23-tutorial.lisp) - Using semaphores to wait for input
268268
- [24-tutorial.lisp](tutorial/24-tutorial.lisp) - CLOG WEB containers
269269
- [25-tutorial.lisp](tutorial/25-tutorial.lisp) - A "local" web app using CLOG WEB

doc/clog-manual.html

Lines changed: 51 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -367,10 +367,10 @@ <h2><a href="#CLOG:@CLOG-SYSTEM%20MGL-PAX:SECTION">4 CLOG System</a></h2>
367367
<p><span class="outer-navigation"><span class="navigation"> <a href="#CLOG:@CLOG-SYSTEM%20MGL-PAX:SECTION" title="CLOG System">&#8592;</a> <a href="clog-manual.html" title="The CLOG manual">&#8593;</a> <a href="#CLOG:@CLOG-OBJ%20MGL-PAX:SECTION" title="CLOG Objects">&#8594;</a> <a href="#CLOG:@CLOG-UTILITIES%20MGL-PAX:SECTION" title="CLOG Utilities">&#8634;</a></span></span></p>
368368
<h2><a href="#CLOG:@CLOG-UTILITIES%20MGL-PAX:SECTION">5 CLOG Utilities</a></h2>
369369
<p>Concurrent Hash Tables</p>
370-
<p><a id="x-28CLOG-3AMAKE-HASH-TABLE-2A-20FUNCTION-29"></a>
371-
<a id="CLOG:MAKE-HASH-TABLE*%20FUNCTION"></a></p>
370+
<p><a id="x-28CLOG-CONNECTION-3AMAKE-HASH-TABLE-2A-20FUNCTION-29"></a>
371+
<a id="CLOG-CONNECTION:MAKE-HASH-TABLE*%20FUNCTION"></a></p>
372372
<ul>
373-
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#CLOG:MAKE-HASH-TABLE*%20FUNCTION" >MAKE-HASH-TABLE*</a></span></span> <span class="locative-args">&amp;REST ARGS</span></span></p>
373+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#CLOG-CONNECTION:MAKE-HASH-TABLE*%20FUNCTION" >MAKE-HASH-TABLE*</a></span></span> <span class="locative-args">&amp;REST ARGS</span></span></p>
374374

375375
<p>Use native concurrent hash tables</p></li>
376376
</ul>
@@ -388,6 +388,21 @@ <h2><a href="#CLOG:@CLOG-UTILITIES%20MGL-PAX:SECTION">5 CLOG Utilities</a></h2>
388388
and 22 for examples. All create- symbols must be in or used by
389389
package.</p></li>
390390
</ul>
391+
<p>CLOG ID utilities</p>
392+
<p><a id="x-28CLOG-CONNECTION-3AGENERATE-ID-20FUNCTION-29"></a>
393+
<a id="CLOG-CONNECTION:GENERATE-ID%20FUNCTION"></a></p>
394+
<ul>
395+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#CLOG-CONNECTION:GENERATE-ID%20FUNCTION" >GENERATE-ID</a></span></span></span></p>
396+
397+
<p>Generate unique ids for use in scripts.</p></li>
398+
</ul>
399+
<p><a id="x-28CLOG-CONNECTION-3ARANDOM-HEX-STRING-20FUNCTION-29"></a>
400+
<a id="CLOG-CONNECTION:RANDOM-HEX-STRING%20FUNCTION"></a></p>
401+
<ul>
402+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#CLOG-CONNECTION:RANDOM-HEX-STRING%20FUNCTION" >RANDOM-HEX-STRING</a></span></span></span></p>
403+
404+
<p>Generate cryptographic grade random ids for use in connections.</p></li>
405+
</ul>
391406
<p>CLOG-Group - Utility Class for CLOG-Obj storage</p>
392407
<p><a id="x-28CLOG-3ACLOG-GROUP-20CLASS-29"></a>
393408
<a id="CLOG:CLOG-GROUP%20CLASS"></a></p>
@@ -446,10 +461,10 @@ <h2><a href="#CLOG:@CLOG-UTILITIES%20MGL-PAX:SECTION">5 CLOG Utilities</a></h2>
446461

447462
<p>Return &quot;on&quot; if <code>VALUE</code> t or return &quot;off&quot;</p></li>
448463
</ul>
449-
<p><a id="x-28CLOG-3AESCAPE-STRING-20FUNCTION-29"></a>
450-
<a id="CLOG:ESCAPE-STRING%20FUNCTION"></a></p>
464+
<p><a id="x-28CLOG-CONNECTION-3AESCAPE-STRING-20FUNCTION-29"></a>
465+
<a id="CLOG-CONNECTION:ESCAPE-STRING%20FUNCTION"></a></p>
451466
<ul>
452-
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#CLOG:ESCAPE-STRING%20FUNCTION" >ESCAPE-STRING</a></span></span> <span class="locative-args">STR &amp;KEY (NO-NIL <code>NIL</code>) (HTML <code>NIL</code>)</span></span></p>
467+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#CLOG-CONNECTION:ESCAPE-STRING%20FUNCTION" >ESCAPE-STRING</a></span></span> <span class="locative-args">STR &amp;KEY (NO-NIL <code>NIL</code>) (HTML <code>NIL</code>)</span></span></p>
453468

454469
<p>Escape <code>STR</code> for sending to browser script. If no-nil is t (default is nil)
455470
if str is <code>NIL</code> returns empty string otherwise returns nil. If html is t the
@@ -7694,6 +7709,32 @@ <h2><a href="#CLOG:@CLOG-BODY%20MGL-PAX:SECTION">23 CLOG Body Objects</a></h2>
76947709
<a id="CLOG:@CLOG-WINDOW%20MGL-PAX:SECTION"></a></p>
76957710
<p><span class="outer-navigation"><span class="navigation"> <a href="#CLOG:@CLOG-BODY%20MGL-PAX:SECTION" title="CLOG Body Objects">&#8592;</a> <a href="clog-manual.html" title="The CLOG manual">&#8593;</a> <a href="#CLOG:@CLOG-DOCUMENT%20MGL-PAX:SECTION" title="CLOG Document Objects">&#8594;</a> <a href="#CLOG:@CLOG-WINDOW%20MGL-PAX:SECTION" title="CLOG Window Objects">&#8634;</a></span></span></p>
76967711
<h2><a href="#CLOG:@CLOG-WINDOW%20MGL-PAX:SECTION">24 CLOG Window Objects</a></h2>
7712+
<p>CLOG Popups</p>
7713+
<p><a id="x-28CLOG-3AENABLE-CLOG-POPUP-20FUNCTION-29"></a>
7714+
<a id="CLOG:ENABLE-CLOG-POPUP%20FUNCTION"></a></p>
7715+
<ul>
7716+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#CLOG:ENABLE-CLOG-POPUP%20FUNCTION" >ENABLE-CLOG-POPUP</a></span></span> <span class="locative-args">&amp;KEY (PATH <code>*CLOG-POPUP-PATH*</code>)</span></span></p>
7717+
7718+
<p>Enable handling of clog enabled popups</p></li>
7719+
</ul>
7720+
<p><a id="x-28CLOG-3AOPEN-CLOG-POPUP-20FUNCTION-29"></a>
7721+
<a id="CLOG:OPEN-CLOG-POPUP%20FUNCTION"></a></p>
7722+
<ul>
7723+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#CLOG:OPEN-CLOG-POPUP%20FUNCTION" >OPEN-CLOG-POPUP</a></span></span> <span class="locative-args">OBJ &amp;KEY (PATH <code>*CLOG-POPUP-PATH*</code>) (ADD-SYNC-TO-PATH <code>T</code>) (SYNC-KEY (<a href="#CLOG-CONNECTION:RANDOM-HEX-STRING%20FUNCTION" title="CLOG-CONNECTION:RANDOM-HEX-STRING FUNCTION"><code>RANDOM-HEX-STRING</code></a>)) (NAME &quot;_blank&quot;) (SPECS &quot;&quot;) (WAIT-TIMEOUT 10)</span></span></p>
7724+
7725+
<p>Open a new browser window/popup in most cases a tab. Since they are controlled
7726+
by clog you have full control of the new popups and are more flexible than using
7727+
open-windo. Returns the clog-body and the clog-window in the same connnection as
7728+
obj of the new window on the new connection or nil if failed within <code>:WAIT-TIMEOUT</code></p></li>
7729+
</ul>
7730+
<p><a id="x-28CLOG-3ACLOG-POPUP-OPENNED-20FUNCTION-29"></a>
7731+
<a id="CLOG:CLOG-POPUP-OPENNED%20FUNCTION"></a></p>
7732+
<ul>
7733+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#CLOG:CLOG-POPUP-OPENNED%20FUNCTION" >CLOG-POPUP-OPENNED</a></span></span> <span class="locative-args">OBJ SYNC-KEY</span></span></p>
7734+
7735+
<p>Used to notify open-clog-popup the new popup window is ready for custom
7736+
clog-popup handlers.</p></li>
7737+
</ul>
76977738
<p>CLOG-Window - CLOG Window Objects</p>
76987739
<p><a id="x-28CLOG-3ACLOG-WINDOW-20CLASS-29"></a>
76997740
<a id="CLOG:CLOG-WINDOW%20CLASS"></a></p>
@@ -7878,11 +7919,12 @@ <h2><a href="#CLOG:@CLOG-WINDOW%20MGL-PAX:SECTION">24 CLOG Window Objects</a></h
78787919
<p><a id="x-28CLOG-3AOPEN-WINDOW-20GENERIC-FUNCTION-29"></a>
78797920
<a id="CLOG:OPEN-WINDOW%20GENERIC-FUNCTION"></a></p>
78807921
<ul>
7881-
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#CLOG:OPEN-WINDOW%20GENERIC-FUNCTION" >OPEN-WINDOW</a></span></span> <span class="locative-args">CLOG-WINDOW URL &amp;KEY NAME SPECS REPLACE</span></span></p>
7922+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#CLOG:OPEN-WINDOW%20GENERIC-FUNCTION" >OPEN-WINDOW</a></span></span> <span class="locative-args">CLOG-WINDOW URL &amp;KEY NAME SPECS</span></span></p>
78827923

78837924
<p>This will launch a new window of current browser where
7884-
<code>CLOG-WINDOW</code> is displayed (remote or local). In modern browsers it is
7885-
very limitted to just open a new tab with url unless is a localhost url.</p></li>
7925+
<code>CLOG-WINDOW</code> is displayed (remote or local) and returns a new clog-window.
7926+
In modern browsers it is very limitted to just open a new tab with url
7927+
unless is a localhost url.</p></li>
78867928
</ul>
78877929
<p><a id="x-28CLOG-3ACLOSE-WINDOW-20GENERIC-FUNCTION-29"></a>
78887930
<a id="CLOG:CLOSE-WINDOW%20GENERIC-FUNCTION"></a></p>

0 commit comments

Comments
 (0)