From: Maciej Pasternacki Date: Wed, 17 Dec 2008 23:25:29 +0000 (+0100) Subject: - Documentation update. X-Git-Url: https://repo.or.cz/w/cl-trane.git/commitdiff_plain/702fe35a9ea660709fa668affc3067c1c533092f - Documentation update. --- diff --git a/doc/TRANE-COMMON.html b/doc/TRANE-COMMON.html index 92ad8bd..0f0c8e1 100644 --- a/doc/TRANE-COMMON.html +++ b/doc/TRANE-COMMON.html @@ -23,7 +23,9 @@ Defaults to "error" in *DEFAULT-PATHNAME-DEFAULTS*. When NIL, *PACKAGE* is assumed, which is probably not what you want.
Initial value: NIL

(cache-dao dao)   function

-
Manually add DAO to cache used by WITH-DAO-CACHE.

DIRTINESS-MIXIN

   undocumented

+
Manually add DAO to cache used by WITH-DAO-CACHE. + +Returns DAO

DIRTINESS-MIXIN

   undocumented

DIRTY-P

   undocumented

(execute* statements &optional query-log)   function

Execute a possibly nested list of sql STATEMENTS. @@ -40,7 +42,8 @@ and for NIL :XYZZY it's //XYZZY. If symbol with such name exists in *HANDLER-PACKAGE* (or in *PACKAGE*, if *HANDLER-PACKAGE* is NIL, but probably it's not what you want), and -it names a function, this function is returned.

(id object)   generic-function

+it names a function, this function is returned.

(hex-md5 sequence)   function

+
Return MD5 checksum of SEQUENCE as a hexadecimal string.

(id x)   generic-function

Numeric ID or :NULL for DAOs and, if it makes sense, other objects. Usually it will be a reader method automatically defined for ID column of a DAO.

(init-config &rest files)   function

@@ -60,12 +63,13 @@ full path to sendmail binary, as a string, default is taken from
Version of LAMBDA that returns anonymous function defined with FLET and named NAME, which it's PRINTed with a name in most Lisp implementations.

(null-or v)   function

-
If V is NIL or an empty string, return :NULL, otherwise return V.

(random-string &key alphabet min-length max-length)   function

+
If V is NIL or an empty string, return :NULL, otherwise return V.

(qp-utf8 string)   function

+
Encode STRING as quoted-printable UTF-8

(random-string &key alphabet min-length max-length)   function

Simple random string for initial password to use in account activation process.

REPORT-ERROR

   undocumented

REPORT-ERROR-BY-EMAIL

   undocumented

REPORT-ERROR-TO-FILE

   undocumented

(salted-password salt password)   function

-
Return Base64-encoded MD5 checksum of SALT concatenated with PASSWORD.

(slug object)   generic-function

+
Return Base64-encoded MD5 checksum of SALT concatenated with PASSWORD.

(slug x)   generic-function

Get short, unique, urlified name of OBJECT.

(slug-dao class slug)   function

Select DAO of CLASS having "slug" column set to SLUG.

SLUGIFY

   undocumented

START-HUNCHENTOOT

   undocumented

diff --git a/doc/TRANE-PASSENGERS.html b/doc/TRANE-PASSENGERS.html index 54ea08d..c7e36f6 100644 --- a/doc/TRANE-PASSENGERS.html +++ b/doc/TRANE-PASSENGERS.html @@ -14,7 +14,7 @@ invalid (i.e. nonexistent, already used, or more than 5 days old).<
Create new activation ticket for PASSENGER. Used in new user registration and in password recovery process. -Returns activation ticket as string.

(id object)   generic-function

+Returns activation ticket as string.

(id x)   generic-function

Numeric ID or :NULL for DAOs and, if it makes sense, other objects. Usually it will be a reader method automatically defined for ID column of a DAO.

(invite-passenger parent email &rest initargs)   function

diff --git a/doc/TRANE-TAXONOMY.html b/doc/TRANE-TAXONOMY.html index 24caae3..76f38cb 100644 --- a/doc/TRANE-TAXONOMY.html +++ b/doc/TRANE-TAXONOMY.html @@ -3,81 +3,83 @@

(apply-term item term &key value order)   function

Apply TERM to ITEM, optionally setting its value to VALUE.

cl-store-valued-taxonomy   class

Valued taxonomy that by default encodes/decodes almost any Lisp object with CL-STORE as BASE64 string.
Class precedence list: cl-store-valued-taxonomy valued-taxonomy taxonomy standard-object t
-
Class init args: :name :site-dao-class :item-dao-class :encoder :decoder
+
Class init args: :name :item-dao-class :encoder :decoder

(deftaxonomy name (&optional (class (quote taxonomy))) &rest args)   function

Defines taxonomy named NAME, with class CLASS and initargs ARGS, and remembers it in *TAXONOMIES*. NAME is symbol or string, which will be transformed to a keyword anyway.

DESCRIPTION

   undocumented

(ensure-taxonomy taxonomy)   function

-
If TAXONOMY is a taxonomy object, return it, otherwise find and return taxonomy named TAXONOMY.

(ensure-term taxonomy site &key text slug create-p)   function

-
Find or create term in taxonomy TAXONOMY for site SITE. +
If TAXONOMY is a taxonomy object, return it, otherwise find and return taxonomy named TAXONOMY.

(ensure-term taxonomy &key text slug create-p)   function

+
Find or create term in taxonomy TAXONOMY. TEXT is a full text of term; if TEXT is given, CREATE-P is non-NIL and term is not found, new term is inserted into database. If SLUG is given instead of TEXT, only search is possible, not -creation.

(find-terms &key taxonomy site text slug)   function

-
Find list of terms satisfying given keywords.

(id object)   generic-function

+creation.

(find-terms &key taxonomy text slug)   function

+
Find list of terms satisfying given keywords.

(id x)   generic-function

Numeric ID or :NULL for DAOs and, if it makes sense, other objects. Usually it will be a reader method automatically defined for ID column of a DAO.

ITEM-DAO-CLASS

   undocumented

(item-terms item &optional taxonomy)   function

List TERMs associated with ITEM in given TAXONOMY. -If TAXONOMY is not given, returns terms in all taxonomies.

(new-term taxonomy site text &optional parent)   function

-
Create new term in SITE for TAXONOMY, with full name TEXT.

(order-item-terms item terms &key taxonomy null-other-terms)   function

+If TAXONOMY is not given, returns terms in all taxonomies.

(new-term taxonomy text &optional parent)   function

+
Create new term in TAXONOMY, with full name TEXT.

(order-item-terms item terms &key taxonomy null-other-terms)   function

Set TERMS (a list of terms or term IDs), associated with ITEM, in given order. If NULL-OTHER-TERMS is not NIL, terms not listed in TERMS get their order column set to NULL. If TAXONOMY is given, restrict changes to -terms of given taxonomy.

(setup-taxonomy-sql &key site item)   function

+terms of given taxonomy.

(setup-taxonomy-sql &key item)   function

List of SQL statements, suitable for TRANE-COMMON:EXECUTE*, to initialize database for Trane Taxonomy module. -SITE and ITEM are optional arguments that, if given, specify foreign -key reference on term's site and associated item_id columns. Any of -those can be a DAO class or a symbol naming one, or a list literally -specifying S-SQL's foreign key (as for :CREATE-TABLE -sql-op :REFERENCES constraint).

SITE-DAO-CLASS

   undocumented

-

(slug object)   generic-function

+ITEM is an optional arguments that, if given, specifies foreign key +reference on term's associated item_id columns. It can be a DAO +class, a symbol naming one, or a list literally specifying S-SQL's +foreign key (as for :CREATE-TABLE sql-op :REFERENCES constraint).

(slug x)   generic-function

Get short, unique, urlified name of OBJECT.

taxonomy   class

Base taxonomy class. Taxonomy has a name (symbol or string, which is transformed to a -keyword by DEFTAXONOMY), and refers to DAO classes of taxonomy's -SITE and ITEM. DAO classes are required to have an integer -primary key, accessible by reader named ID.
Class precedence list: taxonomy standard-object t
-
Class init args: :name :site-dao-class :item-dao-class
+keyword by DEFTAXONOMY), and refers to DAO classes of taxonomy's ITEM. +DAO classes are required to have an integer primary key, accessible by +reader named ID.
Class precedence list: taxonomy standard-object t
+
Class init args: :name :item-dao-class

(taxonomy term)   function

TERM's taxonomy object

TAXONOMY-NAME

   undocumented

(taxonomy-slug taxonomy)   function

Return name of taxonomy for database or URL (lowercased string). Applicable to taxonomy objects, symbols and strings.

term   class

-
Class for a term associated with taxonomy and a site.
Class precedence list: term standard-object t
-
Class init args: :text :site-id :taxonomy-name :description
+
Class for a term associated with taxonomy.
Class precedence list: term standard-object t
+
Class init args: :text :taxonomy-name :description

(term-item-ids term)   function

IDs of items associated with given TERM.

(term-items term)   function

-
Items associated with given TERM.

(term-site term)   function

-
TERM's site object, if TERM is associated with a SITE.

TERM-SITE-ID

   undocumented

-

TERM-TAXONOMY-NAME

   undocumented

+
Items associated with given TERM.

(term-taxonomy term)   function

+
TERM's taxonomy object

TERM-TAXONOMY-NAME

   undocumented

TERM-TEXT

   undocumented

(term-value item term)   function

Returns value that association of ITEM and TERM is set to. As a second value returns T if an association was found at all, NIL otherwise. This makes it possible to tell between an -association with a NIL value and no association at all.

(setf (term-value item term) new-value)   function

+association with a NIL value and no association at all. + +Third value is a term ordering value, if ordering is set.

(setf (term-value item term) new-value)   function

Set new value for association of ITEM and TERM. New association between ITEM and TERM is established if it was not present before.

(unbind-term item term)   function

-
Deletes association between ITEM and TERM.

valued-taxonomy   class

+
Deletes association between ITEM and TERM. + +If PURGE-EMPTY is non-NIL (default), deletes also from TERM table if +no more items refer to this term.

valued-taxonomy   class

Taxonomy where items applied to terms may have values. Defines encoder and decoder function slots, which are responsible for translating value from a Lisp value to DB-safe string. By default it is identity function, which means values need to be strings.
Class precedence list: valued-taxonomy taxonomy standard-object t
-
Class init args: :name :site-dao-class :item-dao-class :encoder :decoder
+
Class init args: :name :item-dao-class :encoder :decoder

Documentation generated by lispdoc running on Clozure Common Lisp

 \ No newline at end of file diff --git a/doc/dependency-graph.dot b/doc/dependency-graph.dot index 996eb45..689a322 100644 --- a/doc/dependency-graph.dot +++ b/doc/dependency-graph.dot @@ -16,6 +16,7 @@ digraph "cl-trane" { "postmodern" -> "cl-postgres"; "trane-passengers" -> "trane-common"; "trane-common" -> "md5"; + "trane-common" -> "cl-qprint"; "trane-common" -> "cl-base64"; "trane-common" -> "py-configparser"; "py-configparser" -> "parse-number"; @@ -58,6 +59,7 @@ digraph "cl-trane" { "puri" [style=solid]; "iterate" [style=solid]; "py-configparser" [style=solid]; + "cl-qprint" [style=solid]; "trane-common" [penwidth=2,style=solid,fontsize=12]; "postmodern" [style=solid]; "trane-passengers" [penwidth=2,style=solid,fontsize=12]; diff --git a/doc/dependency-graph.pdf b/doc/dependency-graph.pdf index 92692b7..f09b376 100644 Binary files a/doc/dependency-graph.pdf and b/doc/dependency-graph.pdf differ diff --git a/doc/dependency-graph.png b/doc/dependency-graph.png dissimilarity index 96% index c5085f0..77ece4e 100644 Binary files a/doc/dependency-graph.png and b/doc/dependency-graph.png differ