This is the cl-notebook Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 04:24:52 2025 GMT+0.
cl-notebook/cl-notebook.asdcl-notebook/src/package.lispcl-notebook/src/model.lispcl-notebook/src/util.lispcl-notebook/src/publish-update.lispcl-notebook/src/ui/http-api/system.lispcl-notebook/src/ui/http-api/notebook.lispcl-notebook/src/ui/http-api/cell.lispcl-notebook/src/ui/http-front-end/macros.lispcl-notebook/src/ui/http-front-end/css.lispcl-notebook/src/ui/http-front-end/core.lispcl-notebook/src/ui/http-front-end/base.lispcl-notebook/src/ui/http-front-end/templates.lispcl-notebook/src/ui/http-front-end/api.lispcl-notebook/src/ui/http-front-end/notebook-selector.lispcl-notebook/src/ui/http-front-end/pareditesque.lispcl-notebook/src/evaluators.lispcl-notebook/src/exporters.lispcl-notebook/src/main.lispThe main system appears first, followed by any subsystem dependency.
cl-notebookA notebook-style in-browser editor for Common Lisp
Inaimathi <leo.zovic@gmail.com>
AGPL3
sb-introspect (system).
qlot (system).
quri (system).
alexandria (system).
anaphora (system).
cl-fad (system).
closer-mop (system).
cl-who (system).
cl-css (system).
parenscript (system).
house (system).
fact-base (system).
src (module).
Modules are listed depth-first from the system components tree.
cl-notebook/srccl-notebook (system).
package.lisp (file).
model.lisp (file).
util.lisp (file).
publish-update.lisp (file).
ui (module).
evaluators.lisp (file).
exporters.lisp (file).
main.lisp (file).
cl-notebook/src/uisrc (module).
http-api (module).
http-front-end (module).
cl-notebook/src/ui/http-apiui (module).
system.lisp (file).
notebook.lisp (file).
cell.lisp (file).
cl-notebook/src/ui/http-front-endui (module).
macros.lisp (file).
css.lisp (file).
core.lisp (file).
base.lisp (file).
templates.lisp (file).
api.lisp (file).
notebook-selector.lisp (file).
pareditesque.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-notebook/cl-notebook.asdcl-notebook/src/package.lispcl-notebook/src/model.lispcl-notebook/src/util.lispcl-notebook/src/publish-update.lispcl-notebook/src/ui/http-api/system.lispcl-notebook/src/ui/http-api/notebook.lispcl-notebook/src/ui/http-api/cell.lispcl-notebook/src/ui/http-front-end/macros.lispcl-notebook/src/ui/http-front-end/css.lispcl-notebook/src/ui/http-front-end/core.lispcl-notebook/src/ui/http-front-end/base.lispcl-notebook/src/ui/http-front-end/templates.lispcl-notebook/src/ui/http-front-end/api.lispcl-notebook/src/ui/http-front-end/notebook-selector.lispcl-notebook/src/ui/http-front-end/pareditesque.lispcl-notebook/src/evaluators.lispcl-notebook/src/exporters.lispcl-notebook/src/main.lispcl-notebook/src/package.lispsrc (module).
*books* (special variable).
*default-indices* (special variable).
*ql* (special variable).
*static* (special variable).
*static-files* (special variable).
*storage* (special variable).
>>existing-directory (function).
>>existing-filepath (function).
>>export-format (function).
>>nonexistent-file (function).
>>notebook (function).
>>package (function).
cl-notebook/src/model.lispsrc (module).
*notebooks* (special variable).
default-package (method).
do-cells (function).
fork-at! (function).
get-notebook! (method).
load-dependencies! (method).
load-notebook! (method).
load-package (function).
loaded-books! (function).
make-notebook (function).
map-cells (function).
namespace (reader method).
(setf namespace) (writer method).
new-cell! (method).
new-notebook! (function).
notebook (class).
notebook-cell (function).
notebook-cell-order (method).
notebook-id (method).
notebook-name (method).
notebook-package! (method).
notebook-package-spec (method).
notebook-package-spec-string (method).
register-notebook! (method).
rename-notebook! (method).
reorder-cells! (function).
repackage-notebook! (method).
cl-notebook/src/util.lispsrc (module).
aget (function).
alist (function).
arglist (method).
capturing-eval (method).
capturing-eval (method).
first-char (method).
front-end-error (function).
get-param (function).
hash (function).
html-to-str (macro).
ignored-error-prop? (function).
instance->alist (function).
last-char (method).
last-char (method).
make-unique-name-in (method).
parse-args! (function).
printable-readably? (function).
read-all (method).
read-all (method).
stem-path (method).
stringified-error-prop? (function).
sys-dir (function).
type-tag (function).
cl-notebook/src/publish-update.lispsrc (module).
publish-update! (method).
publish-update! (method).
publish-update-internal! (function).
cl-notebook/src/ui/http-api/system.lisphttp-api (module).
get-completions (function).
cl-notebook/src/ui/http-front-end/macros.lisphttp-front-end (module).
+key-codes+ (special variable).
+mod-keys+ (special variable).
cl-notebook/src/ui/http-front-end/css.lisphttp-front-end (module).
define-css (function).
*addon-css-rules* (special variable).
*notebook-css* (special variable).
+css-input+ (special variable).
cl-notebook/src/ui/http-front-end/base.lisphttp-front-end (module).
*base-js* (special variable).
cl-notebook/src/ui/http-front-end/templates.lisphttp-front-end (module).
cl-notebook/src/ui/http-front-end/notebook-selector.lisphttp-front-end (module).
cl-notebook/src/ui/http-front-end/pareditesque.lisphttp-front-end (module).
cl-notebook/src/evaluators.lispsrc (module).
*front-end-eval-thread* (special variable).
empty-expression? (method).
eval-cell (method).
eval-notebook (method).
eval-package (method).
front-end-eval (method).
front-end-eval (method).
front-end-eval (method).
front-end-eval (method).
front-end-eval (method).
front-end-eval (method).
front-end-eval-formats (function).
cl-notebook/src/exporters.lispsrc (module).
-cell-class (function).
-cell-comment (function).
-html-value (function).
export-as (method).
export-as (method).
export-as (method).
export-book-formats (function).
export-cell (method).
export-cell (method).
export-cell (method).
export-cell (method).
export-cell (method).
export-cell (method).
export-cells (function).
filename-of (method).
filename-of (method).
mimetype-of (method).
mimetype-of (method).
mimetype-of (method).
slurp (function).
cl-notebook/src/main.lispsrc (module).
main (function).
main-dev (function).
read-statics (function).
write-statics (function).
Packages are listed by definition order.
cl-notebookcl-who.
common-lisp.
fact-base.
house.
parenscript.
define-css (function).
main (function).
*addon-css-rules* (special variable).
*base-js* (special variable).
*books* (special variable).
*default-indices* (special variable).
*front-end-eval-thread* (special variable).
*notebook-css* (special variable).
*notebooks* (special variable).
*ql* (special variable).
*static* (special variable).
*static-files* (special variable).
*storage* (special variable).
+css-input+ (special variable).
+key-codes+ (special variable).
+mod-keys+ (special variable).
-cell-class (function).
-cell-comment (function).
-html-value (function).
>>existing-directory (function).
>>existing-filepath (function).
>>export-format (function).
>>nonexistent-file (function).
>>notebook (function).
>>package (function).
aget (function).
alist (function).
arglist (generic function).
capturing-eval (generic function).
default-package (generic function).
do-cells (function).
empty-expression? (generic function).
eval-cell (generic function).
eval-notebook (generic function).
eval-package (generic function).
export-as (generic function).
export-book-formats (function).
export-cell (generic function).
export-cells (function).
filename-of (generic function).
first-char (generic function).
fork-at! (function).
front-end-error (function).
front-end-eval (generic function).
front-end-eval-formats (function).
get-completions (function).
get-notebook! (generic function).
get-param (function).
hash (function).
html-to-str (macro).
ignored-error-prop? (function).
instance->alist (function).
last-char (generic function).
load-dependencies! (generic function).
load-notebook! (generic function).
load-package (function).
loaded-books! (function).
main-dev (function).
make-notebook (function).
make-unique-name-in (generic function).
map-cells (function).
mimetype-of (generic function).
namespace (generic reader).
(setf namespace) (generic writer).
new-cell! (generic function).
new-notebook! (function).
notebook (class).
notebook-cell (function).
notebook-cell-order (generic function).
notebook-id (generic function).
notebook-name (generic function).
notebook-package! (generic function).
notebook-package-spec (generic function).
notebook-package-spec-string (generic function).
parse-args! (function).
printable-readably? (function).
publish-update! (generic function).
publish-update-internal! (function).
read-all (generic function).
read-statics (function).
register-notebook! (generic function).
rename-notebook! (generic function).
reorder-cells! (function).
repackage-notebook! (generic function).
slurp (function).
stem-path (generic function).
stringified-error-prop? (function).
sys-dir (function).
type-tag (function).
write-statics (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Association lists with less consing
Takes a form and an error pertaining to it.
Formats the error for front-end display, including a reference to the form.
Used to read the cl-notebook static files into memory.
Only useful during the build process, where its called with an –eval flag.
Extracts just the type tag from compound type specifications. Returns primitive type specifications as-is.
string)) ¶Evaluates each form in the given string, collecting return values, warnings and *standard-output* emissions.
stream)) ¶Takes the next s-expression from a stream and tries to evaluate it.
Returns either NIL (if there are no further expressions)
or a (:stdout :warnings :values) alist representing
- The *standard-output* emissions
- collected warnings
- return values (which may be errors)
from each expression in turn.
string)) ¶(eql :html)) (cell-language (eql :common-lisp)) (cell-type (eql :parenscript)) cell) ¶(eql :html)) cell-language (cell-type (eql :code)) cell) ¶(eql :html)) cell-language (cell-type (eql :markup)) cell) ¶(eql :lisp)) (cell-language (eql :common-lisp)) (cell-type (eql :code)) cell) ¶(eql :lisp)) (cell-language (eql :common-lisp)) cell-type cell) ¶(eql :common-lisp)) (cell-type (eql :parenscript)) (contents string)) ¶A Common-Lisp:Parenscript cell is evaluated as a ‘ps‘ form
(eql :common-lisp)) (cell-type (eql :markup)) (contents string)) ¶A Common-Lisp:Markup cell is evaluated as a :cl-who tree
(eql :common-lisp)) (cell-type (eql :code)) (contents string)) ¶A Common-Lisp:Code cell is just evaluated, capturing all warnings, stdout emissions and errors.
(eql :common-lisp)) (cell-type (eql :tests)) (contents string)) ¶A Common-Lisp:Test cell is just evaluated, capturing all warnings, stdout emissions and errors. It’s treated differently in export situations.
null)) ¶string)) ¶A cell that fits no other description returns an error
string)) ¶list)) ¶pathname)) ¶fact-base.
default-package.
eval-cell.
eval-notebook.
eval-package.
export-as.
export-as.
export-as.
(setf namespace).
namespace.
new-cell!.
notebook-cell-order.
notebook-id.
notebook-name.
notebook-package!.
notebook-package-spec.
notebook-package-spec-string.
publish-update!.
register-notebook!.
rename-notebook!.
repackage-notebook!.
(find-package :cl-notebook)
:namespace
| Jump to: | (
-
>
A C D E F G H I L M N P R S T W |
|---|
| Jump to: | (
-
>
A C D E F G H I L M N P R S T W |
|---|
| Jump to: | *
+
N S |
|---|
| Jump to: | *
+
N S |
|---|
| Jump to: | A B C E F H M N P S T U |
|---|
| Jump to: | A B C E F H M N P S T U |
|---|