coleslaw/docs/coleslaw.html

106 lines
4.6 KiB
HTML
Raw Normal View History

2012-08-22 00:11:33 -04:00
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>API for COLESLAW</title>
<style type="text/css" media="all">
body {margin: 0 2em .5em 2em;font-family: Verdana,Arial,sans-serif;}
.package {background: #efefef;
padding: 1.5em 0 1em 0;
text-align: center;
font-size: x-large;}
.definition {background: #efefef; padding: .3em 1em;}
a.symbolname, a:visited.symbolname {font-weight: bold;}
.initargs {font-size: small;}
.slots {font-size: small;}
div.label {border-bottom: 1px solid #efefef; margin-bottom: .5em}
.symboldecl, .footer {margin: 0 2em 2em 2em;}
.symbolname {font-weight: bold; color: gray;}
.symboltype {font-style: italic;margin-left: 1.5em; font-size: smaller;}
.documentation {color: gray; font-family: Fixed,monospace;margin: 0 0 1.5em 0.5em;}
.packagedocumentation {color: gray;
font-family: Fixed,monospace;
margin: 0 0 1.5em 0;
border: 1px solid #efefef;
padding-left: 1.5em;}
.symbolcomments span {font-weight: bold;}
.footer {font-size: x-small; text-align: right; margin-top: 2em; padding-top: 1em; border-top: 1px solid gray;}
.undocumented {color: red; font-weight: bold;}
a, a:visited {font-weight: bold; color: gray; text-decoration: none; font-weight: normal;}
a:hover {border-bottom: 1px solid gray; }
.label {font-weight: bold; font-style: italic;color: gray;}
.labeltitle {font-weight: bold; font-style: italic;color: gray; border: 1px solid #efefef; padding: .25em;margin-bottom: .5em}
.frame {marin-top: 1.5em}
.expander {border: 2px solid #efefef; color: gray;
font-weight: bold;
font-family: Fixed,monospace;
margin-right: .25em; padding: 0 .25em;cursor: pointer;}
</style>
<script type="text/javascript">
function expand (expander, id) {
var text = expander.innerHTML;
if (text == '-')
{
expander.innerHTML = '+';
document.getElementById(id).style.display = 'none';
}
else
{
expander.innerHTML = '-';
document.getElementById(id).style.display = '';
}
}</script></head>
<body>
<div class="package">
<div class="definition">API for package:
<a class="symbolname" name="coleslaw_package" href="#coleslaw_package">coleslaw</a></div></div>
<div class="packagedocumentation">
<pre>Homepage: <a href="http://github.com/redline6561/coleslaw">Github</a></pre></div>
<div class="frame">
<div class="labeltitle">
<span class="expander" onclick="expand(this, 'functions');">-</span>Functions</div>
<div id="functions">
<div class="symboldecl">
<div class="definition">
<a class="symbolname" name="add-injection_func" href="#add-injection_func">add-injection</a>
<span class="lambdalist">str location</span>
<span class="symboltype">standard-generic-function</span></div>
<div class="documentation">
<pre>Add STR to the list of elements injected in LOCATION.</pre></div></div>
<div class="symboldecl">
<div class="definition">
<a class="symbolname" name="deploy_func" href="#deploy_func">deploy</a>
2012-09-12 14:26:25 -04:00
<span class="lambdalist">staging</span>
2012-08-22 00:11:33 -04:00
<span class="symboltype">standard-generic-function</span></div>
<div class="documentation">
2012-09-12 14:26:25 -04:00
<pre>Deploy the STAGING dir, updating the .prev and .curr symlinks.</pre></div></div>
2012-08-22 00:11:33 -04:00
<div class="symboldecl">
<div class="definition">
2012-08-26 14:41:32 -04:00
<a class="symbolname" name="(setf deploy)_func" href="#(setf deploy)_func">(setf deploy)</a>
<span class="lambdalist">new-value object</span>
<span class="symboltype">standard-generic-function</span></div>
<div class="documentation">
<pre>:undocumented</pre></div></div>
<div class="symboldecl">
<div class="definition">
2012-08-22 00:11:33 -04:00
<a class="symbolname" name="main_func" href="#main_func">main</a>
<span class="lambdalist"></span>
<span class="symboltype">function</span></div>
<div class="documentation">
2012-08-26 14:41:32 -04:00
<pre>Load the user's config, then compile and deploy the blog.</pre></div></div>
2012-08-22 00:11:33 -04:00
<div class="symboldecl">
<div class="definition">
2012-09-12 14:26:25 -04:00
<a class="symbolname" name="render_func" href="#render_func">render</a>
<span class="lambdalist">content &key next prev &allow-other-keys</span>
2012-08-22 00:11:33 -04:00
<span class="symboltype">standard-generic-function</span></div>
<div class="documentation">
2012-09-12 14:26:25 -04:00
<pre>Render the given CONTENT to HTML.</pre></div></div>
2012-08-22 00:11:33 -04:00
<div class="symboldecl">
<div class="definition">
2012-09-12 14:26:25 -04:00
<a class="symbolname" name="render-content_func" href="#render-content_func">render-content</a>
<span class="lambdalist">text format</span>
<span class="symboltype">standard-generic-function</span></div>
2012-08-22 00:11:33 -04:00
<div class="documentation">
2012-09-12 14:26:25 -04:00
<pre>Compile TEXT from the given FORMAT to HTML for display.</pre></div></div></div></div>
2012-08-22 00:11:33 -04:00
<div class="footer">Generated by:
<a href="http://common-lisp.net/project/cl-api">CL-API</a></div></body></html>