Flexible Lisp Blogware. Fork for personal use. Mirrored from https://github.com/kingcons/coleslaw originally.

coleslaw.html 7.6KB

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