Eidetic is a CGI program and as such takes parameters as inputs and
emits its output to stdout. Inputs can be specified in several ways:
the URL or or as part of an HTML form or even from the commandline.
This document describes how to use Eidetic with each of these
approaches, and how to retrieve data from it in several different ways.
Here is a summary of the most common parameters that Eidetic accepts as
modulename: This is the name of a module, such as "projects", or
"colors", or "users". Eidetic uses this information to figure out
which table(s) to operate on, what commands are available, and so
command: This determines what code should be activated to handle the
request. Common commands include 'display', 'edit', and 'store'.
Some modules have additional commands available to them.
on: This parameter determines the set of records to be operated on.
It corresponds to the ID#'s of the records in the module's primary
table. You can specify a particular entity (on=42) or a range
(on=10-20 or on=2,4,6 or even on=2,4,6,10-20,42). Eidetic will also
support an "open" range, such as on=42-, which takes all records
after 42, and on=0-, which matches all records in the database.
maxitems: This controls the number of records returned in a
listing. By default, maxitems=25. Also by default, the *first*
'maxitem' items are returned. You can request to get the *last*
maxitems in a set by appending an exclamation mark to the on
parameter. For example: on=-42!&maxitems=5
sort: By default, Eidetic sorts by ID#, but you can specify any
column to sort on. For example, sort=descriptor will sort the
set alphabetically by the descriptor field. To reverse a sort,
simply stick a '!' on the end; for example, sort=uid! will sort by
uid in reverse (highest first).
filter: This allows narrowing the selection via filtering for
desired parameter values.
query: This is a module-specific parameter; use this to call up
special 'canned' filter/sort sets.