TRANE-BB

From 10c3e420c4b9c088f0e7b4d8f799a36ef891f909 Mon Sep 17 00:00:00 2001 From: Maciej Pasternacki Date: Wed, 22 Oct 2008 19:37:57 +0200 Subject: [PATCH] - HTML apidocs --- doc/TRANE-BB.html | 6 ++++ doc/TRANE-COMMON.html | 43 ++++++++++++++++++++++++++++ doc/TRANE-PASSENGERS.html | 40 ++++++++++++++++++++++++++ doc/TRANE-TAXONOMY.html | 71 +++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 160 insertions(+) create mode 100644 doc/TRANE-BB.html create mode 100644 doc/TRANE-COMMON.html create mode 100644 doc/TRANE-PASSENGERS.html create mode 100644 doc/TRANE-TAXONOMY.html diff --git a/doc/TRANE-BB.html b/doc/TRANE-BB.html new file mode 100644 index 0000000..91ce718 --- /dev/null +++ b/doc/TRANE-BB.html @@ -0,0 +1,6 @@ +TRANE-BB

API for package TRANE-BB

UNDOCUMENTED

(bb input &optional stream) function

Parse INPUT (either string or input stream) as BBCode, format +resulting HTML to STREAM or return it as string if STREAM is not +given or NIL.

Documentation generated by lispdoc running on Clozure Common Lisp

\ No newline at end of file diff --git a/doc/TRANE-COMMON.html b/doc/TRANE-COMMON.html new file mode 100644 index 0000000..01944c3 --- /dev/null +++ b/doc/TRANE-COMMON.html @@ -0,0 +1,43 @@ +TRANE-COMMON

API for package TRANE-COMMON

UNDOCUMENTED

*config* variable

Parsed configuration file.

Initial value: #S(PY-CONFIGPARSER:CONFIG :DEFAULTS #S(PY-CONFIGPARSER::SECTION :NAME "DEFAULT" :OPTIONS NIL) :SECTIONS (#S(PY-CONFIGPARSER::SECTION :NAME "db" :OPTIONS (("host" . "127.0.0.1") ("password" . "") ("username" . "japhy") ("database" . "kuchennik"))) #S(PY-CONFIGPARSER::SECTION :NAME "project" :OPTIONS (("version" . "0.alpha") ("name" . "kuchennik")))) :OPTION-NAME-TRANSFORM-FN # :SECTION-NAME-TRANSFORM-FN #)

*db* variable

Database connection specification

Initial value: ("kuchennik" "japhy" "" "127.0.0.1" :POOLED-P T)

*init-functions* variable

Functions (symbols) that are FUNCALLed on initialization. + +No assumption about init function order should be made.

Initial value: (KUCHENNIK::KUCHENNIK-INIT-HT-DISPATCHER KUCHENNIK::KUCHENNIK-INIT-HT-ENCODING TRANE-COMMON::INIT-DB-CONNECTION)

*setup-functions* variable

Functions (symbols) that are FUNCALLed on setup. + +No assumption about setup function order should be made.

Initial value: NIL

DIRTINESS-MIXIN

undocumented

DIRTY-P

undocumented

(execute* statements &optional query-log) function

Execute a possibly nested list of sql STATEMENTS. + +STATEMENTS may be either S-SQL expressions, literal SQL strings, or +lists of statements.

(id object) 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.

(make-keyword str) function

Convert a string or symbol to a keyword.

MARK-AS-DIRTY

undocumented

(named-lambda name args &body body) function

Version of LAMBDA that returns anonymous function defined with +FLET and named NAME, which it's PRINTed with a name in most Lisp +implementations.

(on-init &body body) function

BODY should be sequence of DEFUN forms containing functions +that are to be executed on initialization.

(on-setup &body body) function

BODY should be sequence of DEFUN forms containing functions +that are to be executed on setup.

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

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

(salted-password salt password) function

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

(slug object) 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

UPDATE-DAO-IF-DIRTY

undocumented

Documentation generated by lispdoc running on Clozure Common Lisp

\ No newline at end of file diff --git a/doc/TRANE-PASSENGERS.html b/doc/TRANE-PASSENGERS.html new file mode 100644 index 0000000..494b0f4 --- /dev/null +++ b/doc/TRANE-PASSENGERS.html @@ -0,0 +1,40 @@ +TRANE-PASSENGERS

API for package TRANE-PASSENGERS

UNDOCUMENTED

(activate-passenger class ticket) function

Activate passenger of CLASS, using TICKET. + +Thin wrapper on CONFIRM-ACTIVATION-TICKET, returns passenger DAO +instead of numerical ID, and signals UNAUTHORIZED-ERROR on invalid +TICKET.

(confirm-activation-ticket class ticket &optional activation-info) function

Confirm activation ticket TICKET for passenger class CLASS. + +Returns valiated user ID (integer), or NIL if ticket is +invalid (i.e. nonexistent, already used, or more than 5 days old).

(cookie-passenger cookie class) function

Authorize passenger of CLASS, based on authentication cookie COOKIE.

(create-activation-ticket passenger &optional count) function

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

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.

passenger class

A basic, user-like object.

Class precedence list: passenger dirtiness-mixin standard-object t

Class init args: :name :active-p :parent :email :password-base64 :confirmed-p :invitations

PASSENGER-ACTIVE-P

undocumented

PASSENGER-CONFIRMED-P

undocumented

(passenger-cookie passenger) function

Return authentication cookie for PASSENGER.

PASSENGER-EMAIL

undocumented

PASSENGER-NAME

undocumented

PASSENGER-PARENT

undocumented

PASSENGER-PASSWORD

undocumented

passenger-unauthorized-error condition

Error raised on authorization failure.

Class precedence list: passenger-unauthorized-error error serious-condition condition standard-object t

(register-passenger class &rest initargs) function

Register new passenger of CLASS. + +Thin wrapper arount MAKE-INSTANCE+INSERT-DAO. INITARGS are +MAKE-INSTANCE keyword arguments; if :PARENT initarg is given, parent's +ID is automatically calculated, so user DAO can be directly provided. +Returns new passenger's activation ticket and created DAO (already +inserted into database).

(setup-passenger-class-sql class) function

SQL statement list to initialize passenger class CLASS.

Documentation generated by lispdoc running on Clozure Common Lisp

\ No newline at end of file diff --git a/doc/TRANE-TAXONOMY.html b/doc/TRANE-TAXONOMY.html new file mode 100644 index 0000000..3381823 --- /dev/null +++ b/doc/TRANE-TAXONOMY.html @@ -0,0 +1,71 @@ +TRANE-TAXONOMY

API for package TRANE-TAXONOMY

UNDOCUMENTED

(apply-term item term &optional value) 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

(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. + +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

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.

SITE-DAO-CLASS

undocumented

(slug object) 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

(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

(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

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

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

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

Documentation generated by lispdoc running on Clozure Common Lisp

\ No newline at end of file -- 2.11.4.GIT