hg.stevelosh.com > docs.stevelosh.com

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8"/>
        <title> API Reference / Chancery</title>
        <link rel="stylesheet" href="../_dmedia/pygments-clean.css"/>
        <link rel="stylesheet/less" type="text/css" href="../_dmedia/style.less"/>
        <script src="../_dmedia/less.js" type="text/javascript">
        </script>
    </head>
    <body class="content">
        <div class="wrap">
            <header><h1><a href="..">Chancery</a></h1></header>
                <div class="markdown">
<h1 id="api-reference"><a href="">API Reference</a></h1><p>The following is a list of all user-facing parts of Chancery.</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-chancery">Package CHANCERY</a><ul>
<li><a href="#a-function">A (function)</a></li>
<li><a href="#cap-function">CAP (function)</a></li>
<li><a href="#cap-all-function">CAP-ALL (function)</a></li>
<li><a href="#define-rule-macro">DEFINE-RULE (macro)</a></li>
<li><a href="#define-string-macro">DEFINE-STRING (macro)</a></li>
<li><a href="#gen-macro">GEN (macro)</a></li>
<li><a href="#gen-string-macro">GEN-STRING (macro)</a></li>
<li><a href="#pos-function">POS (function)</a></li>
<li><a href="#s-function">S (function)</a></li>
</ul>
</li>
</ul></div>
<h2 id="package-chancery">Package <code>CHANCERY</code></h2>
<h3 id="a-function"><code>A</code> (function)</h3>
<div class="codehilite"><pre><span/>(A STRING)
</pre></div>


<p>Add an indefinite article (a or an) to the front of <code>string</code>.</p>
<h3 id="cap-function"><code>CAP</code> (function)</h3>
<div class="codehilite"><pre><span/>(CAP STRING)
</pre></div>


<p>Capitalize the first character of <code>string</code>.</p>
<h3 id="cap-all-function"><code>CAP-ALL</code> (function)</h3>
<div class="codehilite"><pre><span/>(CAP-ALL STRING)
</pre></div>


<p>Capitalize each word of <code>string</code>.</p>
<h3 id="define-rule-macro"><code>DEFINE-RULE</code> (macro)</h3>
<div class="codehilite"><pre><span/>(DEFINE-RULE NAME-AND-OPTIONS &amp;REST EXPRESSIONS)
</pre></div>


<h3 id="define-string-macro"><code>DEFINE-STRING</code> (macro)</h3>
<div class="codehilite"><pre><span/>(DEFINE-STRING NAME-AND-OPTIONS &amp;REST EXPRESSIONS)
</pre></div>


<h3 id="gen-macro"><code>GEN</code> (macro)</h3>
<div class="codehilite"><pre><span/>(GEN EXPRESSION)
</pre></div>


<p>Generate a single Chancery expression.</p>
<h3 id="gen-string-macro"><code>GEN-STRING</code> (macro)</h3>
<div class="codehilite"><pre><span/>(GEN-STRING EXPRESSION)
</pre></div>


<p>Generate a single Chancery string expression.</p>
<h3 id="pos-function"><code>POS</code> (function)</h3>
<div class="codehilite"><pre><span/>(POS STRING)
</pre></div>


<p>Make <code>string</code> posessive by adding an apostrophe (and possibly an s).</p>
<h3 id="s-function"><code>S</code> (function)</h3>
<div class="codehilite"><pre><span/>(S STRING)
</pre></div>


<p>Pluralize <code>string</code>.</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(){
  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

  ga('create', 'UA-15328874-3', 'auto');
  ga('send', 'pageview');

</script></footer>
        </div>
    </body>
</html>
author	Steve Losh <steve@stevelosh.com>
date	Thu, 23 Mar 2017 13:56:10 +0000
parents	c448037d3088
children	c8d216ae9ab0