123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149 |
- <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, 'classes');">-</span>Classes</div>
- <div id="classes">
- <div class="symboldecl">
- <div class="definition">
- <a class="symbolname" name="blog_class" href="#blog_class">blog</a>
- <span class="lambdalist">(standard-object)</span>
- <span class="symboltype">class</span></div>
- <div class="documentation">
- <pre></pre></div></div>
- <div class="symboldecl">
- <div class="definition">
- <a class="symbolname" name="content_class" href="#content_class">content</a>
- <span class="lambdalist">(standard-object)</span>
- <span class="symboltype">class</span></div>
- <div class="documentation">
- <pre></pre></div></div>
- <div class="symboldecl">
- <div class="definition">
- <a class="symbolname" name="index_class" href="#index_class">index</a>
- <span class="lambdalist">(standard-object)</span>
- <span class="symboltype">class</span></div>
- <div class="documentation">
- <pre></pre></div></div>
- <div class="symboldecl">
- <div class="definition">
- <a class="symbolname" name="post_class" href="#post_class">post</a>
- <span class="lambdalist">(content)</span>
- <span class="symboltype">class</span></div>
- <div class="documentation">
- <pre></pre></div></div></div></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">injection location</span>
- <span class="symboltype">function</span></div>
- <div class="documentation">
- <pre>Adds an INJECTION to a given LOCATION for rendering. The INJECTION should be
- a string which will always be added or a (string . lambda). In the latter case,
- the lambda takes a single argument, a content object, i.e. a POST or INDEX, and
- any return value other than nil indicates the injection should be added.</pre></div></div>
- <div class="symboldecl">
- <div class="definition">
- <a class="symbolname" name="discover_func" href="#discover_func">discover</a>
- <span class="lambdalist">content-type</span>
- <span class="symboltype">standard-generic-function</span></div>
- <div class="documentation">
- <pre>Load all content of the given CONTENT-TYPE from disk.</pre></div></div>
- <div class="symboldecl">
- <div class="definition">
- <a class="symbolname" name="main_func" href="#main_func">main</a>
- <span class="lambdalist">config-key</span>
- <span class="symboltype">function</span></div>
- <div class="documentation">
- <pre>Load the user's config section corresponding to CONFIG-KEY, then
- compile and deploy the blog.</pre></div></div>
- <div class="symboldecl">
- <div class="definition">
- <a class="symbolname" name="page-path_func" href="#page-path_func">page-path</a>
- <span class="lambdalist">object</span>
- <span class="symboltype">standard-generic-function</span></div>
- <div class="documentation">
- <pre>The path to store OBJECT at once rendered.</pre></div></div>
- <div class="symboldecl">
- <div class="definition">
- <a class="symbolname" name="publish_func" href="#publish_func">publish</a>
- <span class="lambdalist">content-type</span>
- <span class="symboltype">standard-generic-function</span></div>
- <div class="documentation">
- <pre>Write pages to disk for all content of the given CONTENT-TYPE.</pre></div></div>
- <div class="symboldecl">
- <div class="definition">
- <a class="symbolname" name="render_func" href="#render_func">render</a>
- <span class="lambdalist">object &key next prev &allow-other-keys</span>
- <span class="symboltype">standard-generic-function</span></div>
- <div class="documentation">
- <pre>Render the given OBJECT to HTML.</pre></div></div>
- <div class="symboldecl">
- <div class="definition">
- <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>
- <div class="documentation">
- <pre>Compile TEXT from the given FORMAT to HTML for display.</pre></div></div></div></div>
- <div class="footer">Generated by:
- <a href="http://common-lisp.net/project/cl-api">CL-API</a></div></body></html>
|