From 48a6a25457ecbd94880d2c744c9c8a5776e52a6c Mon Sep 17 00:00:00 2001
From: David Botton <david@botton.com>
Date: Mon, 30 Sep 2024 18:06:32 -0400
Subject: [PATCH] doc correction

---
 doc/clog-manual.html  | 24 +++++++++++++++++++++++-
 source/clog-base.lisp |  2 +-
 2 files changed, 24 insertions(+), 2 deletions(-)

diff --git a/doc/clog-manual.html b/doc/clog-manual.html
index eb069b9..9119889 100644
--- a/doc/clog-manual.html
+++ b/doc/clog-manual.html
@@ -624,7 +624,7 @@ for internal use of clog.</p>
 <p>The following default keys are set:
 &quot;clog-body&quot;      clog-body of this connection, see <a href="#CLOG:CONNECTION-BODY%20GENERIC-FUNCTION" title="CLOG:CONNECTION-BODY GENERIC-FUNCTION"><code>CONNECTION-BODY</code></a>
 &quot;clog-path&quot;      html path used, see <a href="#CLOG:CONNECTION-PATH%20GENERIC-FUNCTION" title="CLOG:CONNECTION-PATH GENERIC-FUNCTION"><code>CONNECTION-PATH</code></a>
-&quot;clog-sync&quot;      sempaphore used for syncing events, see <a href="#CLOG:CONNECTION-SYNC%20GENERIC-FUNCTION" title="CLOG:CONNECTION-SYNC GENERIC-FUNCTION"><code>CONNECTION-SYNC</code></a></p></li>
+&quot;clog-sync&quot;      mutex used for syncing events, see <a href="#CLOG:CONNECTION-SYNC%20GENERIC-FUNCTION" title="CLOG:CONNECTION-SYNC GENERIC-FUNCTION"><code>CONNECTION-SYNC</code></a></p></li>
 </ul>
 <p><a id="x-28CLOG-3ACONNECTION-DATA-ITEM-20GENERIC-FUNCTION-29"></a>
 <a id="CLOG:CONNECTION-DATA-ITEM%20GENERIC-FUNCTION"></a></p>
@@ -7167,6 +7167,28 @@ result of on-input.</p></li>
 <p>Create a confirmation dialog box with <code>CONTENT</code> centered.
 Calls on-input with t if confirmed or nil if canceled.</p></li>
 </ul>
+<p><a id="x-28CLOG-GUI-3APROMPT-DIALOG-20FUNCTION-29"></a>
+<a id="CLOG-GUI:PROMPT-DIALOG%20FUNCTION"></a></p>
+<ul>
+<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#CLOG-GUI:PROMPT-DIALOG%20FUNCTION" >PROMPT-DIALOG</a></span></span> <span class="locative-args">OBJ CALLBACK &amp;KEY (TITLE &quot;Prompt&quot;) (COMPLETION #'<code>LIST</code>(<a href="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm" title="LIST (MGL-PAX:CLHS CLASS)"><code>0</code></a> <a href="http://www.lispworks.com/documentation/HyperSpec/Body/f_list_.htm" title="LIST (MGL-PAX:CLHS FUNCTION)"><code>1</code></a>)) (VALIDATION (<a href="http://www.lispworks.com/documentation/HyperSpec/Body/f_cons_1.htm" title="CONSTANTLY (MGL-PAX:CLHS FUNCTION)"><code>CONSTANTLY</code></a> <code>T</code>)) (PRESENTATION (<code>LAMBDA</code>(<a href="http://www.lispworks.com/documentation/HyperSpec/Body/s_lambda.htm" title="&quot;s_lambda&quot; (MGL-PAX:CLHS MGL-PAX:SECTION)"><code>0</code></a> <a href="http://www.lispworks.com/documentation/HyperSpec/Body/m_lambda.htm" title="LAMBDA (MGL-PAX:CLHS MGL-PAX:MACRO)"><code>1</code></a>) (IT) (<a href="http://www.lispworks.com/documentation/HyperSpec/Body/f_format.htm" title="FORMAT (MGL-PAX:CLHS FUNCTION)"><code>FORMAT</code></a> <code>NIL</code> &quot;~a&quot; IT))) (INITIAL-VALUE &quot;&quot;) (MODAL <code>T</code>) TIME-OUT LEFT TOP (WIDTH 390) (HEIGHT 425) MAXIMIZE CLIENT-MOVEMENT (KEEP-ON-TOP <code>T</code>) HTML-ID</span></span></p>
+
+<p>Create a prompt dialog box with a selection of items generated by
+the provided <code>COMPLETION</code> function.</p>
+
+<p><code>COMPLETION</code> is a function that takes the current string and returns
+a list of options.</p>
+
+<p><code>VALIDATION</code> is a predicate that you can specify to prevent the user
+from entering a malformed text input.</p>
+
+<p><code>PRESENTATION</code> is used if <code>COMPLETION</code> yields something other than strings.</p>
+
+<p>Pressing <Tab> will replace the input field with the top completion,
+as you might expect in an IDE.  Clicking an item will also put it in
+the input field.</p>
+
+<p>Pressing <Escape> will cancel the prompt.</p></li>
+</ul>
 <p><a id="x-28CLOG-GUI-3AFORM-DIALOG-20FUNCTION-29"></a>
 <a id="CLOG-GUI:FORM-DIALOG%20FUNCTION"></a></p>
 <ul>
diff --git a/source/clog-base.lisp b/source/clog-base.lisp
index 9e55954..a677d38 100644
--- a/source/clog-base.lisp
+++ b/source/clog-base.lisp
@@ -487,7 +487,7 @@ for internal use of clog.
 The following default keys are set:
 \"clog-body\"      clog-body of this connection, see CONNECTION-BODY
 \"clog-path\"      html path used, see CONNECTION-PATH
-\"clog-sync\"      sempaphore used for syncing events, see CONNECTION-SYNC"))
+\"clog-sync\"      mutex used for syncing events, see CONNECTION-SYNC"))
 
 (defmethod connection-data ((obj clog-obj))
   (clog-connection:get-connection-data (connection-id obj)))