Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Dec 10, 2023
0 parents commit 9ef513c
Show file tree
Hide file tree
Showing 17 changed files with 2,780 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
2 changes: 2 additions & 0 deletions METADATA
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
languages: bash, css, json, lisp, markdown, plaintext, xml, yaml
theme: a11y-dark
54 changes: 54 additions & 0 deletions changelog.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<rss version="2.0">
<channel>
<title>reblocks-websocket-docs ChangeLog</title>
<link>https://40ants.com/reblocks-websocket/</link>
<generator>xml-emitter</generator>
<language>en-us</language>
<item>
<title>0.5.0 (2022-12-10)</title>
<description>&lt;ul&gt;&lt;li&gt;&lt;p&gt;Support new Reblocks version where &lt;code&gt;REMOVED&lt;/code&gt; argument was added to &lt;a href=&quot;https://40ants.com/reblocks/widgets/#x-28REBLOCKS-2FWIDGET-3AUPDATE-20GENERIC-FUNCTION-29&quot;&gt;&lt;code&gt;reblocks/widget:update&lt;/code&gt;&lt;/a&gt; generic-function.&lt;/p&gt;&lt;/li&gt;&lt;/ul&gt;</description>
<pubDate>Sat, 10 Dec 2022 00:00:00 +0000</pubDate>
</item>
<item>
<title>0.4.0 (2019-08-02)</title>
<description>&lt;ul&gt;&lt;li&gt;&lt;p&gt;Library was fixed to work with latest &lt;code&gt;Woo&lt;/code&gt;.&lt;/p&gt;&lt;/li&gt;&lt;/ul&gt;</description>
<pubDate>Fri, 02 Aug 2019 00:00:00 +0000</pubDate>
</item>
<item>
<title>0.3.0 (2018-05-18)</title>
<description>&lt;ul&gt;&lt;li&gt;&lt;p&gt;Added &lt;code&gt;send-command&lt;/code&gt; function, which can be used to call custom
functions on the frontend.&lt;/p&gt;&lt;/li&gt;&lt;/ul&gt;&lt;p&gt;For example, you can update some progress bar&apos;s text with such code.&lt;/p&gt;&lt;p&gt;Add this as a dependency for your widget:&lt;/p&gt;&lt;pre&gt;&lt;code class=&quot;lisp&quot;&gt;(weblocks-parenscript:make-dependency*
`(setf (@ window command-handlers update-progress)
(lambda (params)
(let ((new-text (@ params new-text)))

;; Updating the text of the progress-bar
(chain (j-query &amp;quot;.loading-progress&amp;quot;)
(html new-text))))))&lt;/code&gt;&lt;/pre&gt;&lt;p&gt;After that, you can call this handler from the server-side:&lt;/p&gt;&lt;pre&gt;&lt;code class=&quot;lisp&quot;&gt;(weblocks.websocket:send-command &apos;update-progress
:new-text &amp;quot;Processed 100500 items&amp;quot;)&lt;/code&gt;&lt;/pre&gt;</description>
<pubDate>Fri, 18 May 2018 00:00:00 +0000</pubDate>
</item>
<item>
<title>0.2.0 (2018-05-05)</title>
<description>&lt;ul&gt;&lt;li&gt;&lt;p&gt;Fixed to work under the Woo server (but others aren&apos;t supported for
now), because this version of weblocks-websocket depends on a hack
from the
https://github.com/svetlyak40wt/websocket-driver/tree/make-woo-work-from-separate-threads
branch, made in the
https://github.com/svetlyak40wt/websocket-driver/commit/f9955b1fd99bac6cb744b72c734c7d845922ff6a commit.&lt;/p&gt;&lt;/li&gt;&lt;/ul&gt;</description>
<pubDate>Sat, 05 May 2018 00:00:00 +0000</pubDate>
</item>
<item>
<title>0.1.1 (2017-10-07)</title>
<description>&lt;ul&gt;&lt;li&gt;&lt;p&gt;Now macro &lt;code&gt;in-thread&lt;/code&gt; removes header &lt;code&gt;X-Requested-With&lt;/code&gt; from
captured request object. This requires &lt;code&gt;weblocks &amp;gt;= 0.14.4&lt;/code&gt;.&lt;/p&gt;&lt;/li&gt;&lt;/ul&gt;</description>
<pubDate>Sat, 07 Oct 2017 00:00:00 +0000</pubDate>
</item>
<item>
<title>0.1.0 (2017-09-20)</title>
<description>&lt;ul&gt;&lt;li&gt;&lt;p&gt;Initial version.&lt;/p&gt;&lt;/li&gt;&lt;/ul&gt;</description>
<pubDate>Wed, 20 Sep 2017 00:00:00 +0000</pubDate>
</item>
</channel>
</rss>
102 changes: 102 additions & 0 deletions changelog/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
<html lang=en>
<head>
<meta charset=UTF-8><meta name=viewport
content="width=device-width, initial-scale=1">
<title>ChangeLog</title>
<link rel=alternate
href=https://40ants.com/reblocks-websocket/changelog.xml
type=application/rss+xml>
<link rel=stylesheet type=text/css
href=../theme.css>
<script type=text/javascript src=../jquery.js></script>
<script type=text/javascript src=../toc.js></script>
<link rel=stylesheet type=text/css
href=../highlight.min.css>
<script type=text/javascript
src=../highlight.min.js></script>
<script type=text/javascript>hljs.highlightAll();</script>
<script type=text/javascript>
MathJax = {
tex: {
inlineMath: [['$','$']],
processEscapes: true
}
};
</script>
<script type=text/javascript
src=https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-svg.js></script>
<script type=text/javascript>$(document).ready(function() {$('a:has(img)').css('border-bottom', 'none')})</script>
</head>
<body>
<div class=page><a id=fork-me href=https://github.com/40ants/reblocks-websocket>Fork me on GitHub</a>
<div class=navbar>
<div class=navbar-inner>
<a class=brand href="/">
<img class=logo
src=https://40ants.com/img/logo.svg></a>
<ul class=nav>
<li><a href=/about.html>Who We Are</a>
<li><a href=https://gitter.im/40ants/team>Chat With Us</a>
<li><a href=/tips.html>Lisp Tips</a>
<li><a href=/projects.html>Our Projects</a>
</ul>
</div>
</div>
<input type=checkbox id=sidebar-check>
<label for=sidebar-check>
<div id=sidebar-trigger>
<span></span><span></span><span></span>
</div></label><div class=sidebar><div class=header><form class=search method=GET
action="../search/">
<input type=text name=q>
<input type=submit value=Search><span id=search-progress></span>
</form>
</div><div class=content><div class=page-toc><ul><li><p><a href="../#x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-40INDEX-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29" data-document="../" data-node="x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-40INDEX-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29">reblocks-websocket - Reblocks extension adding a bidirectional communication via Websocket.</a></p><ul><li><p><a href="../#reblocks-websocket-asdf-system-details" data-document="../" data-node="reblocks-websocket-asdf-system-details">REBLOCKS-WEBSOCKET ASDF System Details</a></p></li><li><p><a href="../#x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-40INSTALLATION-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29" data-document="../" data-node="x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-40INSTALLATION-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29">Installation</a></p></li><li><p><a href="../#x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-40USAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29" data-document="../" data-node="x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-40USAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29">Usage</a></p></li><li><p><a href="../#x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-40API-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29" data-document="../" data-node="x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-40API-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29">API</a></p><ul><li><p><a href="../#x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-40REBLOCKS-WEBSOCKET-3FPACKAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29" data-document="../" data-node="x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-40REBLOCKS-WEBSOCKET-3FPACKAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29">REBLOCKS-WEBSOCKET</a></p><ul><li><p><a href="../#x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-WEBSOCKET-3FClasses-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29" data-document="../" data-node="x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-WEBSOCKET-3FClasses-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29">Classes</a></p><ul><li><p><a href="../#x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-40REBLOCKS-WEBSOCKET-24NO-ACTIVE-WEBSOCKETS-3FCLASS-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29" data-document="../" data-node="x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-40REBLOCKS-WEBSOCKET-24NO-ACTIVE-WEBSOCKETS-3FCLASS-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29">NO-ACTIVE-WEBSOCKETS</a></p></li><li><p><a href="../#x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-40REBLOCKS-WEBSOCKET-24WEBSOCKET-WIDGET-3FCLASS-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29" data-document="../" data-node="x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-40REBLOCKS-WEBSOCKET-24WEBSOCKET-WIDGET-3FCLASS-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29">WEBSOCKET-WIDGET</a></p></li></ul></li><li><p><a href="../#x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-WEBSOCKET-3FFunctions-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29" data-document="../" data-node="x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-WEBSOCKET-3FFunctions-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29">Functions</a></p></li><li><p><a href="../#x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-WEBSOCKET-3FMacros-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29" data-document="../" data-node="x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-WEBSOCKET-3FMacros-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29">Macros</a></p></li><li><p><a href="../#x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-WEBSOCKET-3FVariables-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29" data-document="../" data-node="x-28REBLOCKS-WEBSOCKET-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-WEBSOCKET-3FVariables-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29">Variables</a></p></li></ul></li></ul></li></ul></li><li><p><a href="#x-28REBLOCKS-WEBSOCKET-DOCS-2FCHANGELOG-3A-40CHANGELOG-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29" data-document="" data-node="x-28REBLOCKS-WEBSOCKET-DOCS-2FCHANGELOG-3A-40CHANGELOG-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29">ChangeLog</a></p></li></ul>
</div>
</div><div class=footer>
<a href=https://40ants.com/doc>[generated by 40ANTS-DOC]</a>
</div>
</div><div class=content role=main><h1>ChangeLog<a class=rss-icon href=https://40ants.com/reblocks-websocket/changelog.xml></a></h1><h2>0.5.0 (2022-12-10)<a class=header-link
href=#x-28REBLOCKS-WEBSOCKET-DOCS-2FCHANGELOG-3A-3A-7C0-2E5-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29
title="Permalink to this headline"
id=x-28REBLOCKS-WEBSOCKET-DOCS-2FCHANGELOG-3A-3A-7C0-2E5-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29></a></h2><ul><li><p>Support new Reblocks version where <code>REMOVED</code> argument was added to <a href="https://40ants.com/reblocks/widgets/#x-28REBLOCKS-2FWIDGET-3AUPDATE-20GENERIC-FUNCTION-29"><code>reblocks/widget:update</code></a> generic-function.</p></li></ul><h2>0.4.0 (2019-08-02)<a class=header-link
href=#x-28REBLOCKS-WEBSOCKET-DOCS-2FCHANGELOG-3A-3A-7C0-2E4-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29
title="Permalink to this headline"
id=x-28REBLOCKS-WEBSOCKET-DOCS-2FCHANGELOG-3A-3A-7C0-2E4-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29></a></h2><ul><li><p>Library was fixed to work with latest <code>Woo</code>.</p></li></ul><h2>0.3.0 (2018-05-18)<a class=header-link
href=#x-28REBLOCKS-WEBSOCKET-DOCS-2FCHANGELOG-3A-3A-7C0-2E3-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29
title="Permalink to this headline"
id=x-28REBLOCKS-WEBSOCKET-DOCS-2FCHANGELOG-3A-3A-7C0-2E3-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29></a></h2><ul><li><p>Added <code>send-command</code> function, which can be used to call custom
functions on the frontend.</p></li></ul><p>For example, you can update some progress bar's text with such code.</p><p>Add this as a dependency for your widget:</p><pre><code class="lisp">(weblocks-parenscript:make-dependency*
`(setf (@ window command-handlers update-progress)
(lambda (params)
(let ((new-text (@ params new-text)))

;; Updating the text of the progress-bar
(chain (j-query &quot;.loading-progress&quot;)
(html new-text))))))</code></pre><p>After that, you can call this handler from the server-side:</p><pre><code class="lisp">(weblocks.websocket:send-command 'update-progress
:new-text &quot;Processed 100500 items&quot;)</code></pre><h2>0.2.0 (2018-05-05)<a class=header-link
href=#x-28REBLOCKS-WEBSOCKET-DOCS-2FCHANGELOG-3A-3A-7C0-2E2-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29
title="Permalink to this headline"
id=x-28REBLOCKS-WEBSOCKET-DOCS-2FCHANGELOG-3A-3A-7C0-2E2-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29></a></h2><ul><li><p>Fixed to work under the Woo server (but others aren't supported for
now), because this version of weblocks-websocket depends on a hack
from the
https://github.com/svetlyak40wt/websocket-driver/tree/make-woo-work-from-separate-threads
branch, made in the
https://github.com/svetlyak40wt/websocket-driver/commit/f9955b1fd99bac6cb744b72c734c7d845922ff6a commit.</p></li></ul><h2>0.1.1 (2017-10-07)<a class=header-link
href=#x-28REBLOCKS-WEBSOCKET-DOCS-2FCHANGELOG-3A-3A-7C0-2E1-2E1-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29
title="Permalink to this headline"
id=x-28REBLOCKS-WEBSOCKET-DOCS-2FCHANGELOG-3A-3A-7C0-2E1-2E1-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29></a></h2><ul><li><p>Now macro <code>in-thread</code> removes header <code>X-Requested-With</code> from
captured request object. This requires <code>weblocks &gt;= 0.14.4</code>.</p></li></ul><h2>0.1.0 (2017-09-20)<a class=header-link
href=#x-28REBLOCKS-WEBSOCKET-DOCS-2FCHANGELOG-3A-3A-7C0-2E1-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29
title="Permalink to this headline"
id=x-28REBLOCKS-WEBSOCKET-DOCS-2FCHANGELOG-3A-3A-7C0-2E1-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29></a></h2><ul><li><p>Initial version.</p></li></ul>
</div><div class=footer>
<hr class=separator>
<p class=fineprint>Created with passion by <em>40Ants</em><a class=lisp-logo
href="http://lisp-lang.org/">
<img
src=https://40ants.com/img/made-with-lisp.svg></a>
</div>
</div>
</body>
</html>
Loading

0 comments on commit 9ef513c

Please sign in to comment.