# HG changeset patch # User Steve Losh # Date 1471994796 0 # Node ID 551c9d5d47d4467acddf04cfd79f34039fe9b898 # Parent 9b00a02e889da811eb2d1734d9e3d99caa90aa09 Sketch out a documentation plan diff -r 9b00a02e889d -r 551c9d5d47d4 docs/01-installation.markdown --- a/docs/01-installation.markdown Tue Aug 23 23:12:27 2016 +0000 +++ b/docs/01-installation.markdown Tue Aug 23 23:26:36 2016 +0000 @@ -1,2 +1,8 @@ Installation ============ + +Temperance is compatible with Quicklisp, but not *in* Quicklisp (yet?). You can +clone the repository into your [Quicklisp local-projects directory][local] for +now. + +[local]: https://www.quicklisp.org/beta/faq.html#local-project diff -r 9b00a02e889d -r 551c9d5d47d4 docs/02-overview.markdown --- a/docs/02-overview.markdown Tue Aug 23 23:12:27 2016 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,2 +0,0 @@ -Overview -======== diff -r 9b00a02e889d -r 551c9d5d47d4 docs/02-usage.markdown --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/02-usage.markdown Tue Aug 23 23:26:36 2016 +0000 @@ -0,0 +1,14 @@ +Usage +===== + +[TOC] + +## Hello, Temperance +## Databases +## Rules +## Queries +## Lists +## Logic Frames +## Cut +## Dynamic Queries and Rules +## Built-In Predicates diff -r 9b00a02e889d -r 551c9d5d47d4 docs/03-reference.markdown --- a/docs/03-reference.markdown Tue Aug 23 23:12:27 2016 +0000 +++ b/docs/03-reference.markdown Tue Aug 23 23:26:36 2016 +0000 @@ -10,119 +10,5 @@ [TOC] -## Package `TEMPERANCE.WAM` - -### `FACT` (macro) - - (FACT FACT) - -### `FACTS` (macro) - - (FACTS - &BODY - FACTS) - -### `FINALIZE-LOGIC-FRAME` (function) - - (FINALIZE-LOGIC-FRAME) - -### `INVOKE-FACT` (function) - - (INVOKE-FACT FACT) - -### `INVOKE-FACTS` (function) - - (INVOKE-FACTS &REST FACTS) - -### `INVOKE-PROVE` (function) - - (INVOKE-PROVE &REST TERMS438) - -### `INVOKE-QUERY` (function) - - (INVOKE-QUERY &REST TERMS262) - -### `INVOKE-QUERY-ALL` (function) - - (INVOKE-QUERY-ALL &REST TERMS296) - -### `INVOKE-QUERY-DO` (function) - - (INVOKE-QUERY-DO FUNCTION &REST TERMS366) - -### `INVOKE-QUERY-FIND` (function) - - (INVOKE-QUERY-FIND PREDICATE &REST TERMS402) - -### `INVOKE-QUERY-MAP` (function) - - (INVOKE-QUERY-MAP FUNCTION &REST TERMS330) - -### `INVOKE-RULE` (function) - - (INVOKE-RULE HEAD &REST BODY) - -### `MAKE-DATABASE` (function) - - (MAKE-DATABASE) - -### `POP-LOGIC-FRAME` (function) +## Package `TEMPERANCE` - (POP-LOGIC-FRAME) - -### `PROVE` (macro) - - (PROVE &REST TERMS) - -### `PUSH-LOGIC-FRAME` (function) - - (PUSH-LOGIC-FRAME) - -### `PUSH-LOGIC-FRAME-WITH` (macro) - - (PUSH-LOGIC-FRAME-WITH - &BODY - BODY) - -### `QUERY` (macro) - - (QUERY &REST TERMS) - -### `QUERY-ALL` (macro) - - (QUERY-ALL &REST TERMS) - -### `QUERY-DO` (macro) - - (QUERY-DO FUNCTION &REST TERMS) - -### `QUERY-FIND` (macro) - - (QUERY-FIND PREDICATE &REST TERMS) - -### `QUERY-MAP` (macro) - - (QUERY-MAP FUNCTION &REST TERMS) - -### `RESET-DATABASE` (function) - - (RESET-DATABASE) - -### `RULE` (macro) - - (RULE HEAD - &BODY - BODY) - -### `WITH-DATABASE` (macro) - - (WITH-DATABASE DATABASE - &BODY - BODY) - -### `WITH-FRESH-DATABASE` (macro) - - (WITH-FRESH-DATABASE - &BODY - BODY) - diff -r 9b00a02e889d -r 551c9d5d47d4 docs/api.lisp --- a/docs/api.lisp Tue Aug 23 23:12:27 2016 +0000 +++ b/docs/api.lisp Tue Aug 23 23:26:36 2016 +0000 @@ -1,7 +1,7 @@ (ql:quickload "cl-d-api") (defparameter *document-packages* - (list "TEMPERANCE.WAM")) + (list "TEMPERANCE")) (defparameter *output-path* #p"docs/03-reference.markdown" )