43aec0af4386

bones: Update site.
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Fri, 18 Mar 2016 13:51:28 +0000
parents 1098446b3fc9
children 621ae61499ab
branches/tags (none)
files bones/index.html bones/reference/index.html

Changes

--- a/bones/index.html	Mon Mar 07 13:39:46 2016 +0000
+++ b/bones/index.html	Fri Mar 18 13:51:28 2016 +0000
@@ -23,7 +23,7 @@
 <li><strong>Issues:</strong> <a href="http://bitbucket.org/sjl/bones/issues/">http://bitbucket.org/sjl/bones/issues/</a></li>
 </ul>
 <p><img src="https://i.imgur.com/EWPGAHa.gif"
-     style="border: 1px solid #222; margin: 15px 0px 10px; width: 100%;"/></p><h2>Table of Contents</h2><ol class="toc"><li><a href="installation/">Installation</a></li><li><a href="overview/">Overview</a></li><li><a href="reference/">Reference</a></li><li><a href="changelog/">Changelog</a></li></ol>
+     style="border: 1px solid #222; margin: 15px 0px 10px; width: 100%;"/></p><h2>Table of Contents</h2><ol class="toc"><li><a href="installation/">Installation</a></li><li><a href="overview/">Overview</a></li><li><a href="reference/"> API Reference</a></li><li><a href="changelog/">Changelog</a></li></ol>
                 </div>
             <footer><p><i>Made with Lisp and love by <a href="http://stevelosh.com/">Steve Losh</a> in Reykjavík, Iceland.</i></p>
 <script>
--- a/bones/reference/index.html	Mon Mar 07 13:39:46 2016 +0000
+++ b/bones/reference/index.html	Fri Mar 18 13:51:28 2016 +0000
@@ -2,7 +2,7 @@
 <html>
     <head>
         <meta charset="utf-8"/>
-        <title>Reference / Bones</title>
+        <title> API Reference / Bones</title>
         <link rel="stylesheet" href="../_dmedia/bootstrap.css"/>
         <link rel="stylesheet" href="../_dmedia/tango.css"/>
         <link rel="stylesheet/less" type="text/css" href="../_dmedia/style.less"/>
@@ -13,7 +13,85 @@
         <div class="wrap">
             <header><h1><a href="..">Bones</a></h1></header>
                 <div class="markdown">
-<h1 id="reference"><a href="">Reference</a></h1></div>
+<h1 id="api-reference"><a href="">API Reference</a></h1><p>The following is a list of all user-facing parts of Bones.</p>
+<p>If there are backwards-incompatible changes to anything listed here, they will be noted in the changelog and the author will feel bad.</p>
+<p>Anything not listed here is subject to change at any time with no warning, so don't touch it.</p>
+<div class="toc">
+<ul>
+<li><a href="#package-bonespaip">Package BONES.PAIP</a><ul>
+<li><a href="#42check-occurs42-variable">*CHECK-OCCURS* (variable)</a></li>
+<li><a href="#clear-db-function">CLEAR-DB (function)</a></li>
+<li><a href="#fact-macro">FACT (macro)</a></li>
+<li><a href="#fail-variable">FAIL (variable)</a></li>
+<li><a href="#no-bindings-variable">NO-BINDINGS (variable)</a></li>
+<li><a href="#query-macro">QUERY (macro)</a></li>
+<li><a href="#query-all-macro">QUERY-ALL (macro)</a></li>
+<li><a href="#query-one-macro">QUERY-ONE (macro)</a></li>
+<li><a href="#return-all-macro">RETURN-ALL (macro)</a></li>
+<li><a href="#return-one-macro">RETURN-ONE (macro)</a></li>
+<li><a href="#rule-macro">RULE (macro)</a></li>
+<li><a href="#unify-function">UNIFY (function)</a></li>
+</ul>
+</li>
+</ul></div>
+<h2 id="package-bonespaip">Package BONES.PAIP</h2>
+<p>Test?</p>
+<h3 id="42check-occurs42-variable">*CHECK-OCCURS* (variable)</h3>
+<p>Whether to perform an occurs check.</p>
+<h3 id="clear-db-function">CLEAR-DB (function)</h3>
+<div class="codehilite"><pre>(CLEAR-DB)
+</pre></div>
+
+
+<h3 id="fact-macro">FACT (macro)</h3>
+<div class="codehilite"><pre>(FACT &amp;REST BODY)
+</pre></div>
+
+
+<h3 id="fail-variable">FAIL (variable)</h3>
+<p>Failure to unify</p>
+<h3 id="no-bindings-variable">NO-BINDINGS (variable)</h3>
+<p>A succesful unification, with no bindings.</p>
+<h3 id="query-macro">QUERY (macro)</h3>
+<div class="codehilite"><pre>(QUERY &amp;REST GOALS)
+</pre></div>
+
+
+<p>Perform the query interactively.</p>
+<h3 id="query-all-macro">QUERY-ALL (macro)</h3>
+<div class="codehilite"><pre>(QUERY-ALL &amp;REST GOALS)
+</pre></div>
+
+
+<p>Perform the query and automatically show all results.</p>
+<h3 id="query-one-macro">QUERY-ONE (macro)</h3>
+<div class="codehilite"><pre>(QUERY-ONE &amp;REST GOALS)
+</pre></div>
+
+
+<p>Perform the query and just show the first result.</p>
+<h3 id="return-all-macro">RETURN-ALL (macro)</h3>
+<div class="codehilite"><pre>(RETURN-ALL &amp;REST GOALS)
+</pre></div>
+
+
+<h3 id="return-one-macro">RETURN-ONE (macro)</h3>
+<div class="codehilite"><pre>(RETURN-ONE &amp;REST GOALS)
+</pre></div>
+
+
+<h3 id="rule-macro">RULE (macro)</h3>
+<div class="codehilite"><pre>(RULE &amp;REST CLAUSE)
+</pre></div>
+
+
+<h3 id="unify-function">UNIFY (function)</h3>
+<div class="codehilite"><pre>(UNIFY X Y &amp;OPTIONAL (BINDINGS NO-BINDINGS))
+</pre></div>
+
+
+<p>Unify the two terms and return bindings necessary to do so (or FAIL).</p>
+                </div>
             <footer><p><i>Made with Lisp and love by <a href="http://stevelosh.com/">Steve Losh</a> in Reykjavík, Iceland.</i></p>
 <script>
   (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){