Skip to content

Commit

Permalink
DOC: Issue#89: document chunking of .swish
Browse files Browse the repository at this point in the history
  • Loading branch information
Jan Wielemaker authored and Jan Wielemaker committed Jul 27, 2018
1 parent a472279 commit d084e7c
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions examples/htmlcell.swinb
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
</p>

<style>
dl.htmlcell-doc dt { text-align: left; }
dt.htmlcell-doc-title { color: blue; margin-top: 5px;}
dl.htmlcell-doc dt { text-align: left; margin-top: 1ex;}
dl.htmlcell-doc dt.htmlcell-doc-title { color: blue; margin-top: 2ex;}
</style>
<div class="list-group">
<dl class="dl-horizontal htmlcell-doc">
Expand All @@ -38,7 +38,12 @@
</dd><dt>.run(query, parameters)</dt><dd>Run the named query cell. <var>Parameters</var> is an object
binding Prolog variables in the query to specified values.
</dd><dt>.swish(options)</dt><dd>Wrapper around <code>new Pengine()</code> that fetches the sources
using the same algorithm as a query cell and sets the <code>application</code> to <code>swish</code>.
using the same algorithm as a query cell and provides the defaults below:
<ul>
<li>Set <code>application</code> to <code>swish</code>.</li>
<li>Set <code>chunk</code> to <code>5</code>. This should be set to <code>1</code> for code
that acts on <b>both</b> <code>onprompt</code> and <code>onsuccess.</code></li>
</ul>
</dd><dt>.submit(form, options)</dt><dd>Submit a (Bootstrap) form to a predicate. This provides a
wrapper around <code>.swish</code> that collects the content of the indicated <code>form</code> (a
jQuery selector), calls <code>options.predicate</code> with a single argument that is a dict that
Expand Down

0 comments on commit d084e7c

Please sign in to comment.