浏览代码

Update HTML docs on redlinernotes.

Should I remove these? At least add a note at some point directing
people to Quickdocs.
Brit Butler 11 年之前
父节点
当前提交
0ea460529a
共有 1 个文件被更改,包括 36 次插入25 次删除
  1. 36 25
      docs/coleslaw.html

+ 36 - 25
docs/coleslaw.html

@@ -73,13 +73,6 @@ else
73 73
 <div id="classes">
74 74
 <div class="symboldecl">
75 75
 <div class="definition">
76
-<a class="symbolname" name="blog_class" href="#blog_class">blog</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 76
 <a class="symbolname" name="content_class" href="#content_class">content</a>
84 77
 <span class="lambdalist">(standard-object)</span>
85 78
 <span class="symboltype">class</span></div>
@@ -91,7 +84,12 @@ else
91 84
 <span class="lambdalist">(standard-object)</span>
92 85
 <span class="symboltype">class</span></div>
93 86
 <div class="documentation">
94
-<pre></pre></div></div>
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>
95 93
 <div class="symboldecl">
96 94
 <div class="definition">
97 95
 <a class="symbolname" name="post_class" href="#post_class">post</a>
@@ -105,6 +103,13 @@ else
105 103
 <div id="functions">
106 104
 <div class="symboldecl">
107 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">
108 113
 <a class="symbolname" name="add-injection_func" href="#add-injection_func">add-injection</a>
109 114
 <span class="lambdalist">injection location</span>
110 115
 <span class="symboltype">function</span></div>
@@ -116,25 +121,31 @@ any return value other than nil indicates the injection should be added.</pre></
116 121
 <div class="symboldecl">
117 122
 <div class="definition">
118 123
 <a class="symbolname" name="discover_func" href="#discover_func">discover</a>
119
-<span class="lambdalist">content-type</span>
124
+<span class="lambdalist">doc-type</span>
120 125
 <span class="symboltype">standard-generic-function</span></div>
121 126
 <div class="documentation">
122
-<pre>Load all content of the given CONTENT-TYPE from disk.</pre></div></div>
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>
123 135
 <div class="symboldecl">
124 136
 <div class="definition">
125 137
 <a class="symbolname" name="main_func" href="#main_func">main</a>
126
-<span class="lambdalist">config-key</span>
138
+<span class="lambdalist">&optional config-key</span>
127 139
 <span class="symboltype">function</span></div>
128 140
 <div class="documentation">
129
-<pre>Load the user's config section corresponding to CONFIG-KEY, then
130
-compile and deploy the blog.</pre></div></div>
141
+<pre>Load the user's config file, then compile and deploy the site.</pre></div></div>
131 142
 <div class="symboldecl">
132 143
 <div class="definition">
133
-<a class="symbolname" name="page-path_func" href="#page-path_func">page-path</a>
134
-<span class="lambdalist">object</span>
144
+<a class="symbolname" name="page-url_func" href="#page-url_func">page-url</a>
145
+<span class="lambdalist">document</span>
135 146
 <span class="symboltype">standard-generic-function</span></div>
136 147
 <div class="documentation">
137
-<pre>The path to store OBJECT at once rendered.</pre></div></div>
148
+<pre>The url to the document, without the domain.</pre></div></div>
138 149
 <div class="symboldecl">
139 150
 <div class="definition">
140 151
 <a class="symbolname" name="preview_func" href="#preview_func">preview</a>
@@ -146,30 +157,30 @@ compile and deploy the blog.</pre></div></div>
146 157
 <div class="symboldecl">
147 158
 <div class="definition">
148 159
 <a class="symbolname" name="publish_func" href="#publish_func">publish</a>
149
-<span class="lambdalist">content-type</span>
160
+<span class="lambdalist">doc-type</span>
150 161
 <span class="symboltype">standard-generic-function</span></div>
151 162
 <div class="documentation">
152
-<pre>Write pages to disk for all content of the given CONTENT-TYPE.</pre></div></div>
163
+<pre>Write pages to disk for all documents of the given DOC-TYPE.</pre></div></div>
153 164
 <div class="symboldecl">
154 165
 <div class="definition">
155
-<a class="symbolname" name="read-content_func" href="#read-content_func">read-content</a>
156
-<span class="lambdalist">file</span>
166
+<a class="symbolname" name="purge-all_func" href="#purge-all_func">purge-all</a>
167
+<span class="lambdalist">doc-type</span>
157 168
 <span class="symboltype">function</span></div>
158 169
 <div class="documentation">
159
-<pre>Returns a plist of metadata from FILE with :text holding the content as a string.</pre></div></div>
170
+<pre>Remove all instances of DOC-TYPE from memory.</pre></div></div>
160 171
 <div class="symboldecl">
161 172
 <div class="definition">
162 173
 <a class="symbolname" name="render_func" href="#render_func">render</a>
163
-<span class="lambdalist">object &key next prev &allow-other-keys</span>
174
+<span class="lambdalist">document &key next prev &allow-other-keys</span>
164 175
 <span class="symboltype">standard-generic-function</span></div>
165 176
 <div class="documentation">
166
-<pre>Render the given OBJECT to HTML.</pre></div></div>
177
+<pre>Render the given DOCUMENT to HTML.</pre></div></div>
167 178
 <div class="symboldecl">
168 179
 <div class="definition">
169
-<a class="symbolname" name="render-content_func" href="#render-content_func">render-content</a>
180
+<a class="symbolname" name="render-text_func" href="#render-text_func">render-text</a>
170 181
 <span class="lambdalist">text format</span>
171 182
 <span class="symboltype">standard-generic-function</span></div>
172 183
 <div class="documentation">
173
-<pre>Compile TEXT from the given FORMAT to HTML for display.</pre></div></div></div></div>
184
+<pre>Render TEXT of the given FORMAT to HTML for display.</pre></div></div></div></div>
174 185
 <div class="footer">Generated by: 
175 186
 <a href="http://common-lisp.net/project/cl-api">CL-API</a></div></body></html>