|
|
@@ -1,186 +0,0 @@
|
|
1
|
|
-
|
|
2
|
|
-<html lang="en">
|
|
3
|
|
-<head>
|
|
4
|
|
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
5
|
|
-<title>API for COLESLAW</title>
|
|
6
|
|
-<style type="text/css" media="all">
|
|
7
|
|
-body {margin: 0 2em .5em 2em;font-family: Verdana,Arial,sans-serif;}
|
|
8
|
|
-.package {background: #efefef;
|
|
9
|
|
- padding: 1.5em 0 1em 0;
|
|
10
|
|
- text-align: center;
|
|
11
|
|
- font-size: x-large;}
|
|
12
|
|
-.definition {background: #efefef; padding: .3em 1em;}
|
|
13
|
|
-a.symbolname, a:visited.symbolname {font-weight: bold;}
|
|
14
|
|
-.initargs {font-size: small;}
|
|
15
|
|
-.slots {font-size: small;}
|
|
16
|
|
-div.label {border-bottom: 1px solid #efefef; margin-bottom: .5em}
|
|
17
|
|
-.symboldecl, .footer {margin: 0 2em 2em 2em;}
|
|
18
|
|
-.symbolname {font-weight: bold; color: gray;}
|
|
19
|
|
-.symboltype {font-style: italic;margin-left: 1.5em; font-size: smaller;}
|
|
20
|
|
-.documentation {color: gray; font-family: Fixed,monospace;margin: 0 0 1.5em 0.5em;}
|
|
21
|
|
-.packagedocumentation {color: gray;
|
|
22
|
|
- font-family: Fixed,monospace;
|
|
23
|
|
- margin: 0 0 1.5em 0;
|
|
24
|
|
- border: 1px solid #efefef;
|
|
25
|
|
- padding-left: 1.5em;}
|
|
26
|
|
-.symbolcomments span {font-weight: bold;}
|
|
27
|
|
-.footer {font-size: x-small; text-align: right; margin-top: 2em; padding-top: 1em; border-top: 1px solid gray;}
|
|
28
|
|
-.undocumented {color: red; font-weight: bold;}
|
|
29
|
|
-a, a:visited {font-weight: bold; color: gray; text-decoration: none; font-weight: normal;}
|
|
30
|
|
-a:hover {border-bottom: 1px solid gray; }
|
|
31
|
|
-.label {font-weight: bold; font-style: italic;color: gray;}
|
|
32
|
|
-.labeltitle {font-weight: bold; font-style: italic;color: gray; border: 1px solid #efefef; padding: .25em;margin-bottom: .5em}
|
|
33
|
|
-.frame {marin-top: 1.5em}
|
|
34
|
|
-.expander {border: 2px solid #efefef; color: gray;
|
|
35
|
|
- font-weight: bold;
|
|
36
|
|
- font-family: Fixed,monospace;
|
|
37
|
|
- margin-right: .25em; padding: 0 .25em;cursor: pointer;}
|
|
38
|
|
-</style>
|
|
39
|
|
-<script type="text/javascript">
|
|
40
|
|
-function expand (expander, id) {
|
|
41
|
|
-var text = expander.innerHTML;
|
|
42
|
|
-if (text == '-')
|
|
43
|
|
-{
|
|
44
|
|
- expander.innerHTML = '+';
|
|
45
|
|
- document.getElementById(id).style.display = 'none';
|
|
46
|
|
-}
|
|
47
|
|
-else
|
|
48
|
|
-{
|
|
49
|
|
- expander.innerHTML = '-';
|
|
50
|
|
- document.getElementById(id).style.display = '';
|
|
51
|
|
-}
|
|
52
|
|
-}</script></head>
|
|
53
|
|
-<body>
|
|
54
|
|
-<div class="package">
|
|
55
|
|
-<div class="definition">API for package:
|
|
56
|
|
-<a class="symbolname" name="coleslaw_package" href="#coleslaw_package">coleslaw</a></div></div>
|
|
57
|
|
-<div class="packagedocumentation">
|
|
58
|
|
-<pre>Homepage: <a href="http://github.com/redline6561/coleslaw">Github</a></pre></div>
|
|
59
|
|
-<div class="frame">
|
|
60
|
|
-<div class="labeltitle">
|
|
61
|
|
-<span class="expander" onclick="expand(this, 'vars');">-</span>Variables</div>
|
|
62
|
|
-<div id="vars">
|
|
63
|
|
-<div class="symboldecl">
|
|
64
|
|
-<div class="definition">
|
|
65
|
|
-<a class="symbolname" name="*config*_vars" href="#*config*_vars">*config*</a>:
|
|
66
|
|
-<span class="value">NIL</span>
|
|
67
|
|
-<span class="symboltype">variable</span></div>
|
|
68
|
|
-<div class="documentation">
|
|
69
|
|
-<pre>A variable to store the blog configuration and plugin settings.</pre></div></div></div></div>
|
|
70
|
|
-<div class="frame">
|
|
71
|
|
-<div class="labeltitle">
|
|
72
|
|
-<span class="expander" onclick="expand(this, 'classes');">-</span>Classes</div>
|
|
73
|
|
-<div id="classes">
|
|
74
|
|
-<div class="symboldecl">
|
|
75
|
|
-<div class="definition">
|
|
76
|
|
-<a class="symbolname" name="content_class" href="#content_class">content</a>
|
|
77
|
|
-<span class="lambdalist">(standard-object)</span>
|
|
78
|
|
-<span class="symboltype">class</span></div>
|
|
79
|
|
-<div class="documentation">
|
|
80
|
|
-<pre></pre></div></div>
|
|
81
|
|
-<div class="symboldecl">
|
|
82
|
|
-<div class="definition">
|
|
83
|
|
-<a class="symbolname" name="index_class" href="#index_class">index</a>
|
|
84
|
|
-<span class="lambdalist">(standard-object)</span>
|
|
85
|
|
-<span class="symboltype">class</span></div>
|
|
86
|
|
-<div class="documentation">
|
|
87
|
|
-<pre></pre></div>
|
|
88
|
|
-<div class="slots">
|
|
89
|
|
-<div class="label">SLOTS</div>
|
|
90
|
|
-<span class="symbolname">content</span>
|
|
91
|
|
-<div class="documentation">
|
|
92
|
|
-<pre>UNDOCUMENTED</pre></div></div></div>
|
|
93
|
|
-<div class="symboldecl">
|
|
94
|
|
-<div class="definition">
|
|
95
|
|
-<a class="symbolname" name="post_class" href="#post_class">post</a>
|
|
96
|
|
-<span class="lambdalist">(content)</span>
|
|
97
|
|
-<span class="symboltype">class</span></div>
|
|
98
|
|
-<div class="documentation">
|
|
99
|
|
-<pre></pre></div></div></div></div>
|
|
100
|
|
-<div class="frame">
|
|
101
|
|
-<div class="labeltitle">
|
|
102
|
|
-<span class="expander" onclick="expand(this, 'functions');">-</span>Functions</div>
|
|
103
|
|
-<div id="functions">
|
|
104
|
|
-<div class="symboldecl">
|
|
105
|
|
-<div class="definition">
|
|
106
|
|
-<a class="symbolname" name="add-document_func" href="#add-document_func">add-document</a>
|
|
107
|
|
-<span class="lambdalist">doc</span>
|
|
108
|
|
-<span class="symboltype">function</span></div>
|
|
109
|
|
-<div class="documentation">
|
|
110
|
|
-<pre>Add DOC to the in-memory database. Error if a matching entry is present.</pre></div></div>
|
|
111
|
|
-<div class="symboldecl">
|
|
112
|
|
-<div class="definition">
|
|
113
|
|
-<a class="symbolname" name="add-injection_func" href="#add-injection_func">add-injection</a>
|
|
114
|
|
-<span class="lambdalist">injection location</span>
|
|
115
|
|
-<span class="symboltype">function</span></div>
|
|
116
|
|
-<div class="documentation">
|
|
117
|
|
-<pre>Adds an INJECTION to a given LOCATION for rendering. The INJECTION should be
|
|
118
|
|
-a string which will always be added or a (string . lambda). In the latter case,
|
|
119
|
|
-the lambda takes a single argument, a content object, i.e. a POST or INDEX, and
|
|
120
|
|
-any return value other than nil indicates the injection should be added.</pre></div></div>
|
|
121
|
|
-<div class="symboldecl">
|
|
122
|
|
-<div class="definition">
|
|
123
|
|
-<a class="symbolname" name="discover_func" href="#discover_func">discover</a>
|
|
124
|
|
-<span class="lambdalist">doc-type</span>
|
|
125
|
|
-<span class="symboltype">standard-generic-function</span></div>
|
|
126
|
|
-<div class="documentation">
|
|
127
|
|
-<pre>Load all documents of the given DOC-TYPE into memory.</pre></div></div>
|
|
128
|
|
-<div class="symboldecl">
|
|
129
|
|
-<div class="definition">
|
|
130
|
|
-<a class="symbolname" name="find-all_func" href="#find-all_func">find-all</a>
|
|
131
|
|
-<span class="lambdalist">doc-type</span>
|
|
132
|
|
-<span class="symboltype">function</span></div>
|
|
133
|
|
-<div class="documentation">
|
|
134
|
|
-<pre>Return a list of all instances of a given DOC-TYPE.</pre></div></div>
|
|
135
|
|
-<div class="symboldecl">
|
|
136
|
|
-<div class="definition">
|
|
137
|
|
-<a class="symbolname" name="main_func" href="#main_func">main</a>
|
|
138
|
|
-<span class="lambdalist">&optional config-key</span>
|
|
139
|
|
-<span class="symboltype">function</span></div>
|
|
140
|
|
-<div class="documentation">
|
|
141
|
|
-<pre>Load the user's config file, then compile and deploy the site.</pre></div></div>
|
|
142
|
|
-<div class="symboldecl">
|
|
143
|
|
-<div class="definition">
|
|
144
|
|
-<a class="symbolname" name="page-url_func" href="#page-url_func">page-url</a>
|
|
145
|
|
-<span class="lambdalist">document</span>
|
|
146
|
|
-<span class="symboltype">standard-generic-function</span></div>
|
|
147
|
|
-<div class="documentation">
|
|
148
|
|
-<pre>The url to the document, without the domain.</pre></div></div>
|
|
149
|
|
-<div class="symboldecl">
|
|
150
|
|
-<div class="definition">
|
|
151
|
|
-<a class="symbolname" name="preview_func" href="#preview_func">preview</a>
|
|
152
|
|
-<span class="lambdalist">path &optional (content-type 'post)</span>
|
|
153
|
|
-<span class="symboltype">function</span></div>
|
|
154
|
|
-<div class="documentation">
|
|
155
|
|
-<pre>Render the content at PATH under user's configured repo and save it to
|
|
156
|
|
-~/tmp.html. Load the user's config and theme if necessary.</pre></div></div>
|
|
157
|
|
-<div class="symboldecl">
|
|
158
|
|
-<div class="definition">
|
|
159
|
|
-<a class="symbolname" name="publish_func" href="#publish_func">publish</a>
|
|
160
|
|
-<span class="lambdalist">doc-type</span>
|
|
161
|
|
-<span class="symboltype">standard-generic-function</span></div>
|
|
162
|
|
-<div class="documentation">
|
|
163
|
|
-<pre>Write pages to disk for all documents of the given DOC-TYPE.</pre></div></div>
|
|
164
|
|
-<div class="symboldecl">
|
|
165
|
|
-<div class="definition">
|
|
166
|
|
-<a class="symbolname" name="purge-all_func" href="#purge-all_func">purge-all</a>
|
|
167
|
|
-<span class="lambdalist">doc-type</span>
|
|
168
|
|
-<span class="symboltype">function</span></div>
|
|
169
|
|
-<div class="documentation">
|
|
170
|
|
-<pre>Remove all instances of DOC-TYPE from memory.</pre></div></div>
|
|
171
|
|
-<div class="symboldecl">
|
|
172
|
|
-<div class="definition">
|
|
173
|
|
-<a class="symbolname" name="render_func" href="#render_func">render</a>
|
|
174
|
|
-<span class="lambdalist">document &key next prev &allow-other-keys</span>
|
|
175
|
|
-<span class="symboltype">standard-generic-function</span></div>
|
|
176
|
|
-<div class="documentation">
|
|
177
|
|
-<pre>Render the given DOCUMENT to HTML.</pre></div></div>
|
|
178
|
|
-<div class="symboldecl">
|
|
179
|
|
-<div class="definition">
|
|
180
|
|
-<a class="symbolname" name="render-text_func" href="#render-text_func">render-text</a>
|
|
181
|
|
-<span class="lambdalist">text format</span>
|
|
182
|
|
-<span class="symboltype">standard-generic-function</span></div>
|
|
183
|
|
-<div class="documentation">
|
|
184
|
|
-<pre>Render TEXT of the given FORMAT to HTML for display.</pre></div></div></div></div>
|
|
185
|
|
-<div class="footer">Generated by:
|
|
186
|
|
-<a href="http://common-lisp.net/project/cl-api">CL-API</a></div></body></html>
|
Brit Butler