docs/hyperobject.lml

   1 ;; -*- Mode: Lisp -*-
   2
   3 (page hyperobject
   4   (head
   5    (title "Hyperobject Documentation" )
   6    (meta "Copyright" "Kevin M. Rosenberg (C) 2002")
   7    (meta "Author" "Kevin M. Rosenberg")
   8    (with link :rel "stylesheet" :href "http://kpe.io/main.css" :type "text/css"))
   9
  10   (body
  11    (h1 "Hyperobject Documentation")
  12    (h2 "Overview")
  13    (p (span-c pkgbody "Hyperobject")
  14       " is an Common Lisp object representation library based on the Metaobject Protocol.")
  15
  16    (h2 "Reference")
  17    (h3 "Class options")
  18    (table
  19     (tbody
  20       (tr
  21        (td (b "sql-name"))
  22        (td "Overrides default name of SQL table."))
  23       (tr
  24        (td (b "version"))
  25        (td "Sets the version number of the class. Can be used to convert previous version of the class."))
  26       (tr
  27        (td (b "instanciable"))
  28        (td "If NIL, the class can not be instanciated by the user."))
  29       (tr
  30        (td (b "description"))
  31        (td "The class description."))
  32       ))
  33
  34    (h3 "Slot options")
  35    (table
  36      (tbody
  37       (tr
  38        (td (b "sql-name"))
  39        (td "Override name of the SQL column"))
  40       (tr
  41        (td (b "unique"))
  42        (td "The values in the slot must be unique"))
  43       (tr
  44        (td (b "stored"))
  45        (td "The values in the slot are stored in the database."))
  46       (tr
  47        (td (b "indexed"))
  48        (td "The values of the slot are indexed in the database."))
  49       (tr
  50        (td (b "nil-text"))
  51        (td "The text to print if the slot is NIL"))
  52       (tr
  53        (td (b "value-type"))
  54        (td "Sets the data type for the field. See the next section for complete details"))
  55       (tr
  56        (td (b "inverse"))
  57        (td "Sets the name of an automatically generated lookup function based on a key value for this slot"))
  58       ))
  59
  60    (h3 "Type field")
  61    (p "Valid types for a " (span-c pkgbody "hyperobject") "slot along with their coresponding SQL types are listed in the below table.")
  62    (table-c "font-family:courier"
  63     (tr (td "string")
  64         (td "TEXT"))
  65     (tr (td (div "(string " (i "n") ")")
  66             (div "(varchar " (i "n") ")"))
  67         (td "VARCHAR(n)"))
  68     (tr (td "(char " (i "n") ")")
  69         (td "CHAR(n)"))
  70     (tr (td "character")
  71         (td "CHAR(1)"))
  72     (tr (td (div "float")
  73             (div "single-float"))
  74         (td "float"))
  75     (tr (td "double-float")
  76         (td "double"))
  77     (tr (td "blob")
  78         (td "BLOB")))
  79
  80    (h2 "Subobject field")
  81    (p "This field sets up the storage of a slot of hold a cached object or list of objects. A lookup function and the keys to the function are also specified.")
  82    (p "The format for the subobject field is:")
  83    (p "(<lookup function> keys*)")
  84
  85    ))