The cl-notebook Reference Manual
Table of Contents
The cl-notebook Reference Manual
This is the cl-notebook Reference Manual,
generated automatically by Declt version 3.0 "Montgomery Scott"
on Tue Dec 22 12:35:33 2020 GMT+0.
1 Introduction
cl-notebook
A notebook-style in-browser editor for Common Lisp.

Tools, of course, can be the subtlest of traps.
One day I know I must smash the ~~emerald~~ Emacs.
with apologies to Neil Gaiman
This is now a pre-beta
Use it at your own risk, and expect occasional, minor explosions
Usage
- Install a Common Lisp (I suggest
sbcl
)
- Install
quicklisp
- Hop into a Lisp and do
(ql:quickload :cl-notebook)
, followed by (cl-notebook:main)
Binary
Download this, run it (if you downloaded the tarball instead of the naked binary, unpack it first, obviously)
At the moment, we've only got binaries for 64-bit Linux. Submissions for other architectures welcome.
These help you manage Common Lisp distributions. They are usefull not only for running cl-notebook, but for any other CL project, so consider them regardless of whether you want this project.
In the cl-notebook
directory you cloned to, do:
qlot install
qlot exec roswell/cl-notebook.ros --port 4242
Once cl-notebook
is Running
Hop into a browser and go to localhost:4242/
(or whatever port you chose)
A quick-ish, and now slightly out-of-date video demo is available here to get you sort-of-started.
Sytem Docs
Building the Binary
-
Install roswell
-
Install qlot
-
Run qlot exec ros build roswell/cl-notebook.ros
in the cl-notebook
directory
That will create a binary with the appropriate name that you can directly run on any machine of your OS and processor architecture.
-
Grab your binary at roswell/cl-notebook
.
This should work under the Linux, OSX and Windows.
In order to build the cl-notebook
binary, you need to
- Install a Common Lisp (I suggest, and have only tried this with,
sbcl
)
- Install
quicklisp
- Install and build
buildapp
- Create an appropriate
build.manifest
file for loading cl-notebook
- Call
buildapp
with that build.manifest
file, along with
- a bunch of
--load-system
calls that include everything cl-notebook
needs
- an
--eval
call to cl-notebook::read-statics
to include all the associated static files along with the binary
- an
--entry
of cl-notebook:main
- an
--output
of your choice of binary name (I suggest "cl-notebook
")
That will create a binary with the appropriate name that you can directly run on any machine of your OS and processor architecture.
Linux
If you're on a Debian-based linux distro, there is a build.lisp
and build.sh
included in the build/
subdirectory of this repo that do most of the above for you. All you need to do is make sure to install sbcl
, then call sh build.sh
in the build
directory. This will result in a buildapp
binary and a cl-notebook
binary being generated for you. The cl-notebook
binary can then be run on any linux machine (of the same CPU architecture) without worrying about installing a Lisp.
OS X
TODO - patches welcome, since I'm not an OS X user
Windows
TODO - patches welcome, since I'm not a Windows user
Source Deployment
Usage
Keybindings
Building Programs/Executables
Notebook Exporters
Cell Compilers
License
AGPL3 (also found in the included copying.txt)
Short version:
Do whatever you like, BUT afford the same freedoms to anyone you give this software or derivative works (yes, this includes the new stuff you do) to, and anyone you expose it to as a service.
This project uses CodeMirror as a front-end editor. CodeMirror is released under the MIT Expat license.
Credits
This project uses:
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 cl-notebook
- Author
Inaimathi <leo.zovic@gmail.com>
- License
AGPL3
- Description
A notebook-style in-browser editor for Common Lisp
- Dependencies
- sb-introspect
- qlot
- quri
- alexandria
- anaphora
- cl-fad
- closer-mop
- cl-who
- cl-css
- parenscript
- house
- fact-base
- Source
cl-notebook.asd (file)
- Component
src (module)
3 Modules
Modules are listed depth-first from the system components tree.
3.1 cl-notebook/src
- Parent
cl-notebook (system)
- Location
src/
- Components
-
3.2 cl-notebook/src/ui
- Parent
src (module)
- Location
src/ui/
- Components
-
3.3 cl-notebook/src/ui/http-api
- Parent
ui (module)
- Location
src/ui/http-api/
- Components
-
3.4 cl-notebook/src/ui/http-front-end
- Parent
ui (module)
- Location
src/ui/http-front-end/
- Components
-
4 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
4.1 Lisp
4.1.1 cl-notebook.asd
- Location
cl-notebook.asd
- Systems
cl-notebook (system)
4.1.2 cl-notebook/src/package.lisp
- Parent
src (module)
- Location
src/package.lisp
- Packages
cl-notebook
- Internal Definitions
-
4.1.3 cl-notebook/src/model.lisp
- Parent
src (module)
- Location
src/model.lisp
- Internal Definitions
-
4.1.4 cl-notebook/src/util.lisp
- Parent
src (module)
- Location
src/util.lisp
- Internal Definitions
-
4.1.5 cl-notebook/src/publish-update.lisp
- Parent
src (module)
- Location
src/publish-update.lisp
- Internal Definitions
-
4.1.6 cl-notebook/src/ui/http-api/system.lisp
- Parent
http-api (module)
- Location
src/ui/http-api/system.lisp
- Internal Definitions
get-completions (function)
4.1.7 cl-notebook/src/ui/http-api/notebook.lisp
- Parent
http-api (module)
- Location
src/ui/http-api/notebook.lisp
4.1.8 cl-notebook/src/ui/http-api/cell.lisp
- Parent
http-api (module)
- Location
src/ui/http-api/cell.lisp
4.1.9 cl-notebook/src/ui/http-front-end/macros.lisp
- Parent
http-front-end (module)
- Location
src/ui/http-front-end/macros.lisp
- Internal Definitions
-
4.1.10 cl-notebook/src/ui/http-front-end/css.lisp
- Parent
http-front-end (module)
- Location
src/ui/http-front-end/css.lisp
- Exported Definitions
define-css (function)
- Internal Definitions
-
4.1.11 cl-notebook/src/ui/http-front-end/core.lisp
- Parent
http-front-end (module)
- Location
src/ui/http-front-end/core.lisp
4.1.12 cl-notebook/src/ui/http-front-end/base.lisp
- Parent
http-front-end (module)
- Location
src/ui/http-front-end/base.lisp
- Internal Definitions
*base-js* (special variable)
4.1.13 cl-notebook/src/ui/http-front-end/templates.lisp
- Parent
http-front-end (module)
- Location
src/ui/http-front-end/templates.lisp
4.1.14 cl-notebook/src/ui/http-front-end/api.lisp
- Parent
http-front-end (module)
- Location
src/ui/http-front-end/api.lisp
4.1.15 cl-notebook/src/ui/http-front-end/notebook-selector.lisp
- Parent
http-front-end (module)
- Location
src/ui/http-front-end/notebook-selector.lisp
4.1.16 cl-notebook/src/ui/http-front-end/pareditesque.lisp
- Parent
http-front-end (module)
- Location
src/ui/http-front-end/pareditesque.lisp
4.1.17 cl-notebook/src/evaluators.lisp
- Parent
src (module)
- Location
src/evaluators.lisp
- Internal Definitions
-
4.1.18 cl-notebook/src/exporters.lisp
- Parent
src (module)
- Location
src/exporters.lisp
- Internal Definitions
-
4.1.19 cl-notebook/src/main.lisp
- Parent
src (module)
- Location
src/main.lisp
- Exported Definitions
main (function)
- Internal Definitions
-
5 Packages
Packages are listed by definition order.
5.1 cl-notebook
- Source
package.lisp (file)
- Use List
- fact-base
- cl-who
- parenscript
- house
- common-lisp
- Exported Definitions
-
- Internal Definitions
-
6 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
6.1 Exported definitions
6.1.1 Functions
- Function: define-css NAME RULES
-
- Package
cl-notebook
- Source
css.lisp (file)
- Function: main &optional ARGV &key PORT PUBLIC?
-
- Package
cl-notebook
- Source
main.lisp (file)
6.2 Internal definitions
6.2.1 Special variables
- Special Variable: *addon-css-rules*
-
- Package
cl-notebook
- Source
css.lisp (file)
- Special Variable: *base-js*
-
- Package
cl-notebook
- Source
base.lisp (file)
- Special Variable: *books*
-
- Package
cl-notebook
- Source
package.lisp (file)
- Special Variable: *default-indices*
-
- Package
cl-notebook
- Source
package.lisp (file)
- Special Variable: *front-end-eval-thread*
-
- Package
cl-notebook
- Source
evaluators.lisp (file)
- Special Variable: *notebook-css*
-
- Package
cl-notebook
- Source
css.lisp (file)
- Special Variable: *notebooks*
-
- Package
cl-notebook
- Source
model.lisp (file)
- Special Variable: *ql*
-
- Package
cl-notebook
- Source
package.lisp (file)
- Special Variable: *static*
-
- Package
cl-notebook
- Source
package.lisp (file)
- Special Variable: *static-files*
-
- Package
cl-notebook
- Source
package.lisp (file)
- Special Variable: *storage*
-
- Package
cl-notebook
- Source
package.lisp (file)
- Special Variable: +css-input+
-
- Package
cl-notebook
- Source
css.lisp (file)
- Special Variable: +key-codes+
-
- Package
cl-notebook
- Source
macros.lisp (file)
- Special Variable: +mod-keys+
-
- Package
cl-notebook
- Source
macros.lisp (file)
6.2.2 Macros
- Macro: html-to-str &rest FORMS
-
- Package
cl-notebook
- Source
util.lisp (file)
6.2.3 Functions
- Function: -cell-class CELL
-
- Package
cl-notebook
- Source
exporters.lisp (file)
-
- Package
cl-notebook
- Source
exporters.lisp (file)
- Function: -html-value CELL
-
- Package
cl-notebook
- Source
exporters.lisp (file)
- Function: >>existing-directory PATH
-
- Package
cl-notebook
- Source
package.lisp (file)
- Function: >>existing-filepath PATH
-
- Package
cl-notebook
- Source
package.lisp (file)
- Function: >>export-format FORMAT
-
- Package
cl-notebook
- Source
package.lisp (file)
- Function: >>nonexistent-file PATH
-
- Package
cl-notebook
- Source
package.lisp (file)
- Function: >>notebook BOOK-ID
-
- Package
cl-notebook
- Source
package.lisp (file)
- Function: >>package NAME
-
- Package
cl-notebook
- Source
package.lisp (file)
- Function: aget K ALIST
-
- Package
cl-notebook
- Source
util.lisp (file)
- Function: alist &rest K/V-PAIRS
-
Association lists with less consing
- Package
cl-notebook
- Source
util.lisp (file)
- Function: do-cells FN BOOK
-
- Package
cl-notebook
- Source
model.lisp (file)
- Function: export-book-formats ()
-
- Package
cl-notebook
- Source
exporters.lisp (file)
- Function: export-cells FORMAT BOOK
-
- Package
cl-notebook
- Source
exporters.lisp (file)
- Function: fork-at! BOOK INDEX
-
- Package
cl-notebook
- Source
model.lisp (file)
- Function: front-end-error FORM E
-
Takes a form and an error pertaining to it.
Formats the error for front-end display, including a reference to the form.
- Package
cl-notebook
- Source
util.lisp (file)
- Function: front-end-eval-formats ()
-
- Package
cl-notebook
- Source
evaluators.lisp (file)
- Function: get-completions PARTIAL PACKAGE
-
- Package
cl-notebook
- Source
system.lisp (file)
- Function: get-param NAMES PARAMS
-
- Package
cl-notebook
- Source
util.lisp (file)
- Function: hash &rest ENTRIES
-
- Package
cl-notebook
- Source
util.lisp (file)
- Function: ignored-error-prop? PROP-NAME
-
- Package
cl-notebook
- Source
util.lisp (file)
- Function: instance->alist INSTANCE
-
- Package
cl-notebook
- Source
util.lisp (file)
- Function: load-package PACKAGE
-
- Package
cl-notebook
- Source
model.lisp (file)
- Function: loaded-books! ()
-
- Package
cl-notebook
- Source
model.lisp (file)
- Function: main-dev ()
-
- Package
cl-notebook
- Source
main.lisp (file)
- Function: make-notebook &key FILE-NAME
-
- Package
cl-notebook
- Source
model.lisp (file)
- Function: map-cells FN BOOK
-
- Package
cl-notebook
- Source
model.lisp (file)
- Function: new-notebook! PATH
-
- Package
cl-notebook
- Source
model.lisp (file)
- Function: notebook-cell BOOK CELL-ID
-
- Package
cl-notebook
- Source
model.lisp (file)
- Function: parse-args! RAW
-
- Package
cl-notebook
- Source
util.lisp (file)
- Function: printable-readably? THING
-
- Package
cl-notebook
- Source
util.lisp (file)
- Function: publish-update-internal! BOOK ACTION K/V-PAIRS
-
- Package
cl-notebook
- Source
publish-update.lisp (file)
- Function: read-statics ()
-
Used to read the cl-notebook static files into memory.
Only useful during the build process, where its called with an –eval flag.
- Package
cl-notebook
- Source
main.lisp (file)
- Function: reorder-cells! BOOK CELL-ORDER
-
- Package
cl-notebook
- Source
model.lisp (file)
- Function: slurp FILENAME
-
- Package
cl-notebook
- Source
exporters.lisp (file)
- Function: stringified-error-prop? PROP-NAME
-
- Package
cl-notebook
- Source
util.lisp (file)
- Function: sys-dir PATH
-
- Package
cl-notebook
- Source
util.lisp (file)
- Function: type-tag THING
-
Extracts just the type tag from compound type specifications.
Returns primitive type specifications as-is.
- Package
cl-notebook
- Source
util.lisp (file)
- Function: write-statics &key FORCE?
-
- Package
cl-notebook
- Source
main.lisp (file)
6.2.4 Generic functions
- Generic Function: arglist FN
-
- Package
cl-notebook
- Methods
- Method: arglist (FN symbol)
-
- Source
util.lisp (file)
- Generic Function: capturing-eval STR
-
- Package
cl-notebook
- Methods
- Method: capturing-eval (STR string)
-
Evaluates each form in the given string, collecting return values, warnings and *standard-output* emissions.
- Source
util.lisp (file)
- Method: capturing-eval (STR 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.
- Source
util.lisp (file)
- Generic Function: default-package BOOK
-
- Package
cl-notebook
- Methods
- Method: default-package (BOOK notebook)
-
- Source
model.lisp (file)
- Generic Function: empty-expression? CONTENTS
-
- Package
cl-notebook
- Methods
- Method: empty-expression? (CONTENTS string)
-
- Source
evaluators.lisp (file)
- Generic Function: eval-cell BOOK CELL-ID CONTENTS RES-FACT CELL-LANGUAGE CELL-TYPE
-
- Package
cl-notebook
- Methods
- Method: eval-cell (BOOK notebook) CELL-ID (CONTENTS string) RES-FACT CELL-LANGUAGE CELL-TYPE
-
- Source
evaluators.lisp (file)
- Generic Function: eval-notebook BOOK &key CELL-TYPE
-
- Package
cl-notebook
- Methods
- Method: eval-notebook (BOOK notebook) &key CELL-TYPE
-
- Source
evaluators.lisp (file)
- Generic Function: eval-package BOOK CONTENTS
-
- Package
cl-notebook
- Methods
- Method: eval-package (BOOK notebook) (CONTENTS string)
-
- Source
evaluators.lisp (file)
- Generic Function: export-as FORMAT BOOK
-
- Package
cl-notebook
- Methods
- Method: export-as (FORMAT (eql html)) (BOOK notebook)
-
- Source
exporters.lisp (file)
- Method: export-as (FORMAT (eql lisp)) (BOOK notebook)
-
- Source
exporters.lisp (file)
- Method: export-as FORMAT (BOOK notebook)
-
- Source
exporters.lisp (file)
- Generic Function: export-cell FORMAT CELL-LANGUAGE CELL-TYPE CELL
-
- Package
cl-notebook
- Methods
- Method: export-cell (FORMAT (eql html)) (CELL-LANGUAGE (eql common-lisp)) (CELL-TYPE (eql parenscript)) CELL
-
- Source
exporters.lisp (file)
- Method: export-cell (FORMAT (eql html)) CELL-LANGUAGE (CELL-TYPE (eql code)) CELL
-
- Source
exporters.lisp (file)
- Method: export-cell (FORMAT (eql html)) CELL-LANGUAGE (CELL-TYPE (eql markup)) CELL
-
- Source
exporters.lisp (file)
- Method: export-cell (FORMAT (eql lisp)) (CELL-LANGUAGE (eql common-lisp)) (CELL-TYPE (eql code)) CELL
-
- Source
exporters.lisp (file)
- Method: export-cell (FORMAT (eql lisp)) (CELL-LANGUAGE (eql common-lisp)) CELL-TYPE CELL
-
- Source
exporters.lisp (file)
- Method: export-cell FORMAT CELL-LANGUAGE CELL-TYPE CELL
-
- Source
exporters.lisp (file)
- Generic Function: filename-of FORMAT BOOK
-
- Package
cl-notebook
- Methods
- Method: filename-of (FORMAT (eql html)) BOOK
-
- Source
exporters.lisp (file)
- Method: filename-of (FORMAT (eql lisp)) BOOK
-
- Source
exporters.lisp (file)
- Generic Function: first-char STR
-
- Package
cl-notebook
- Methods
- Method: first-char (STR string)
-
- Source
util.lisp (file)
- Generic Function: front-end-eval CELL-LANGUAGE CELL-TYPE CONTENTS
-
- Package
cl-notebook
- Methods
- Method: front-end-eval (CELL-LANGUAGE (eql common-lisp)) (CELL-TYPE (eql parenscript)) (CONTENTS string)
-
A Common-Lisp:Parenscript cell is evaluated as a ‘ps‘ form
- Source
evaluators.lisp (file)
- Method: front-end-eval (CELL-LANGUAGE (eql common-lisp)) (CELL-TYPE (eql markup)) (CONTENTS string)
-
A Common-Lisp:Markup cell is evaluated as a :cl-who tree
- Source
evaluators.lisp (file)
- Method: front-end-eval (CELL-LANGUAGE (eql common-lisp)) (CELL-TYPE (eql code)) (CONTENTS string)
-
A Common-Lisp:Code cell is just evaluated, capturing all warnings, stdout emissions and errors.
- Source
evaluators.lisp (file)
- Method: front-end-eval (CELL-LANGUAGE (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.
- Source
evaluators.lisp (file)
- Method: front-end-eval CELL-LANGUAGE CELL-TYPE (CONTENTS null)
-
- Source
evaluators.lisp (file)
- Method: front-end-eval CELL-LANGUAGE CELL-TYPE (CONTENTS string)
-
A cell that fits no other description returns an error
- Source
evaluators.lisp (file)
- Generic Function: get-notebook! NAME
-
- Package
cl-notebook
- Methods
- Method: get-notebook! (NAME string)
-
- Source
model.lisp (file)
- Generic Function: last-char PTH
-
- Package
cl-notebook
- Methods
- Method: last-char (STR string)
-
- Source
util.lisp (file)
- Method: last-char (PTH pathname)
-
- Source
util.lisp (file)
- Generic Function: load-dependencies! PACKAGE-FORM
-
- Package
cl-notebook
- Methods
- Method: load-dependencies! (PACKAGE-FORM list)
-
- Source
model.lisp (file)
- Generic Function: load-notebook! FILE-NAME
-
- Package
cl-notebook
- Methods
- Method: load-notebook! (FILE-NAME pathname)
-
- Source
model.lisp (file)
- Generic Function: make-unique-name-in DIR BASE-NAME
-
- Package
cl-notebook
- Methods
- Method: make-unique-name-in (DIR pathname) (BASE-NAME string)
-
- Source
util.lisp (file)
- Generic Function: mimetype-of FORMAT
-
- Package
cl-notebook
- Methods
- Method: mimetype-of (FORMAT (eql html))
-
- Source
exporters.lisp (file)
- Method: mimetype-of (FORMAT (eql lisp))
-
- Source
exporters.lisp (file)
- Method: mimetype-of FORMAT
-
- Source
exporters.lisp (file)
- Generic Function: namespace OBJECT
-
- Generic Function: (setf namespace) NEW-VALUE OBJECT
-
- Package
cl-notebook
- Methods
- Method: namespace (NOTEBOOK notebook)
-
automatically generated reader method
- Source
model.lisp (file)
- Method: (setf namespace) NEW-VALUE (NOTEBOOK notebook)
-
automatically generated writer method
- Source
model.lisp (file)
- Generic Function: new-cell! BOOK &key CELL-LANGUAGE CELL-TYPE
-
- Package
cl-notebook
- Methods
- Method: new-cell! (BOOK notebook) &key CELL-LANGUAGE CELL-TYPE
-
- Source
model.lisp (file)
- Generic Function: notebook-cell-order BOOK
-
- Package
cl-notebook
- Methods
- Method: notebook-cell-order (BOOK notebook)
-
- Source
model.lisp (file)
- Generic Function: notebook-id BOOK
-
- Package
cl-notebook
- Methods
- Method: notebook-id (BOOK notebook)
-
- Source
model.lisp (file)
- Generic Function: notebook-name BOOK
-
- Package
cl-notebook
- Methods
- Method: notebook-name (BOOK notebook)
-
- Source
model.lisp (file)
- Generic Function: notebook-package! BOOK
-
- Package
cl-notebook
- Methods
- Method: notebook-package! (BOOK notebook)
-
- Source
model.lisp (file)
- Generic Function: notebook-package-spec BOOK
-
- Package
cl-notebook
- Methods
- Method: notebook-package-spec (BOOK notebook)
-
- Source
model.lisp (file)
- Generic Function: notebook-package-spec-string BOOK
-
- Package
cl-notebook
- Methods
- Method: notebook-package-spec-string (BOOK notebook)
-
- Source
model.lisp (file)
- Generic Function: publish-update! BOOK ACTION &rest K/V-PAIRS
-
- Package
cl-notebook
- Methods
- Method: publish-update! (BOOK notebook) (ACTION symbol) &rest K/V-PAIRS
-
- Source
publish-update.lisp (file)
- Method: publish-update! BOOK (ACTION symbol) &rest K/V-PAIRS
-
- Source
publish-update.lisp (file)
- Generic Function: read-all STR
-
- Package
cl-notebook
- Methods
- Method: read-all (STR string)
-
- Source
util.lisp (file)
- Method: read-all (STR stream)
-
- Source
util.lisp (file)
- Generic Function: register-notebook! BOOK
-
- Package
cl-notebook
- Methods
- Method: register-notebook! (BOOK notebook)
-
- Source
model.lisp (file)
- Generic Function: rename-notebook! BOOK NEW-NAME
-
- Package
cl-notebook
- Methods
- Method: rename-notebook! (BOOK notebook) (NEW-NAME string)
-
Takes a book and a new name.
Returns two values; the renamed book, and a boolean specifying whether the name was changed.
If the new name passed in is the same as the books’ current name, we don’t insert any new facts.
- Source
model.lisp (file)
- Generic Function: repackage-notebook! BOOK NEW-PACKAGE
-
- Package
cl-notebook
- Methods
- Method: repackage-notebook! (BOOK notebook) (NEW-PACKAGE string)
-
- Source
model.lisp (file)
- Generic Function: stem-path PATH STEM-FROM
-
- Package
cl-notebook
- Methods
- Method: stem-path (PATH pathname) STEM-FROM
-
- Source
util.lisp (file)
6.2.5 Classes
- Class: notebook ()
-
- Package
cl-notebook
- Source
model.lisp (file)
- Direct superclasses
fact-base (class)
- Direct methods
-
- Direct slots
- Slot: namespace
-
- Initargs
:namespace
- Initform
(find-package :cl-notebook)
- Readers
namespace (generic function)
- Writers
(setf namespace) (generic function)
Appendix A Indexes
A.1 Concepts
| Index Entry | | Section |
|
C | | |
| cl-notebook.asd: | | The cl-notebook․asd file |
| cl-notebook/src: | | The cl-notebook/src module |
| cl-notebook/src/evaluators.lisp: | | The cl-notebook/src/evaluators․lisp file |
| cl-notebook/src/exporters.lisp: | | The cl-notebook/src/exporters․lisp file |
| cl-notebook/src/main.lisp: | | The cl-notebook/src/main․lisp file |
| cl-notebook/src/model.lisp: | | The cl-notebook/src/model․lisp file |
| cl-notebook/src/package.lisp: | | The cl-notebook/src/package․lisp file |
| cl-notebook/src/publish-update.lisp: | | The cl-notebook/src/publish-update․lisp file |
| cl-notebook/src/ui: | | The cl-notebook/src/ui module |
| cl-notebook/src/ui/http-api: | | The cl-notebook/src/ui/http-api module |
| cl-notebook/src/ui/http-api/cell.lisp: | | The cl-notebook/src/ui/http-api/cell․lisp file |
| cl-notebook/src/ui/http-api/notebook.lisp: | | The cl-notebook/src/ui/http-api/notebook․lisp file |
| cl-notebook/src/ui/http-api/system.lisp: | | The cl-notebook/src/ui/http-api/system․lisp file |
| cl-notebook/src/ui/http-front-end: | | The cl-notebook/src/ui/http-front-end module |
| cl-notebook/src/ui/http-front-end/api.lisp: | | The cl-notebook/src/ui/http-front-end/api․lisp file |
| cl-notebook/src/ui/http-front-end/base.lisp: | | The cl-notebook/src/ui/http-front-end/base․lisp file |
| cl-notebook/src/ui/http-front-end/core.lisp: | | The cl-notebook/src/ui/http-front-end/core․lisp file |
| cl-notebook/src/ui/http-front-end/css.lisp: | | The cl-notebook/src/ui/http-front-end/css․lisp file |
| cl-notebook/src/ui/http-front-end/macros.lisp: | | The cl-notebook/src/ui/http-front-end/macros․lisp file |
| cl-notebook/src/ui/http-front-end/notebook-selector.lisp: | | The cl-notebook/src/ui/http-front-end/notebook-selector․lisp file |
| cl-notebook/src/ui/http-front-end/pareditesque.lisp: | | The cl-notebook/src/ui/http-front-end/pareditesque․lisp file |
| cl-notebook/src/ui/http-front-end/templates.lisp: | | The cl-notebook/src/ui/http-front-end/templates․lisp file |
| cl-notebook/src/util.lisp: | | The cl-notebook/src/util․lisp file |
|
F | | |
| File, Lisp, cl-notebook.asd: | | The cl-notebook․asd file |
| File, Lisp, cl-notebook/src/evaluators.lisp: | | The cl-notebook/src/evaluators․lisp file |
| File, Lisp, cl-notebook/src/exporters.lisp: | | The cl-notebook/src/exporters․lisp file |
| File, Lisp, cl-notebook/src/main.lisp: | | The cl-notebook/src/main․lisp file |
| File, Lisp, cl-notebook/src/model.lisp: | | The cl-notebook/src/model․lisp file |
| File, Lisp, cl-notebook/src/package.lisp: | | The cl-notebook/src/package․lisp file |
| File, Lisp, cl-notebook/src/publish-update.lisp: | | The cl-notebook/src/publish-update․lisp file |
| File, Lisp, cl-notebook/src/ui/http-api/cell.lisp: | | The cl-notebook/src/ui/http-api/cell․lisp file |
| File, Lisp, cl-notebook/src/ui/http-api/notebook.lisp: | | The cl-notebook/src/ui/http-api/notebook․lisp file |
| File, Lisp, cl-notebook/src/ui/http-api/system.lisp: | | The cl-notebook/src/ui/http-api/system․lisp file |
| File, Lisp, cl-notebook/src/ui/http-front-end/api.lisp: | | The cl-notebook/src/ui/http-front-end/api․lisp file |
| File, Lisp, cl-notebook/src/ui/http-front-end/base.lisp: | | The cl-notebook/src/ui/http-front-end/base․lisp file |
| File, Lisp, cl-notebook/src/ui/http-front-end/core.lisp: | | The cl-notebook/src/ui/http-front-end/core․lisp file |
| File, Lisp, cl-notebook/src/ui/http-front-end/css.lisp: | | The cl-notebook/src/ui/http-front-end/css․lisp file |
| File, Lisp, cl-notebook/src/ui/http-front-end/macros.lisp: | | The cl-notebook/src/ui/http-front-end/macros․lisp file |
| File, Lisp, cl-notebook/src/ui/http-front-end/notebook-selector.lisp: | | The cl-notebook/src/ui/http-front-end/notebook-selector․lisp file |
| File, Lisp, cl-notebook/src/ui/http-front-end/pareditesque.lisp: | | The cl-notebook/src/ui/http-front-end/pareditesque․lisp file |
| File, Lisp, cl-notebook/src/ui/http-front-end/templates.lisp: | | The cl-notebook/src/ui/http-front-end/templates․lisp file |
| File, Lisp, cl-notebook/src/util.lisp: | | The cl-notebook/src/util․lisp file |
|
L | | |
| Lisp File, cl-notebook.asd: | | The cl-notebook․asd file |
| Lisp File, cl-notebook/src/evaluators.lisp: | | The cl-notebook/src/evaluators․lisp file |
| Lisp File, cl-notebook/src/exporters.lisp: | | The cl-notebook/src/exporters․lisp file |
| Lisp File, cl-notebook/src/main.lisp: | | The cl-notebook/src/main․lisp file |
| Lisp File, cl-notebook/src/model.lisp: | | The cl-notebook/src/model․lisp file |
| Lisp File, cl-notebook/src/package.lisp: | | The cl-notebook/src/package․lisp file |
| Lisp File, cl-notebook/src/publish-update.lisp: | | The cl-notebook/src/publish-update․lisp file |
| Lisp File, cl-notebook/src/ui/http-api/cell.lisp: | | The cl-notebook/src/ui/http-api/cell․lisp file |
| Lisp File, cl-notebook/src/ui/http-api/notebook.lisp: | | The cl-notebook/src/ui/http-api/notebook․lisp file |
| Lisp File, cl-notebook/src/ui/http-api/system.lisp: | | The cl-notebook/src/ui/http-api/system․lisp file |
| Lisp File, cl-notebook/src/ui/http-front-end/api.lisp: | | The cl-notebook/src/ui/http-front-end/api․lisp file |
| Lisp File, cl-notebook/src/ui/http-front-end/base.lisp: | | The cl-notebook/src/ui/http-front-end/base․lisp file |
| Lisp File, cl-notebook/src/ui/http-front-end/core.lisp: | | The cl-notebook/src/ui/http-front-end/core․lisp file |
| Lisp File, cl-notebook/src/ui/http-front-end/css.lisp: | | The cl-notebook/src/ui/http-front-end/css․lisp file |
| Lisp File, cl-notebook/src/ui/http-front-end/macros.lisp: | | The cl-notebook/src/ui/http-front-end/macros․lisp file |
| Lisp File, cl-notebook/src/ui/http-front-end/notebook-selector.lisp: | | The cl-notebook/src/ui/http-front-end/notebook-selector․lisp file |
| Lisp File, cl-notebook/src/ui/http-front-end/pareditesque.lisp: | | The cl-notebook/src/ui/http-front-end/pareditesque․lisp file |
| Lisp File, cl-notebook/src/ui/http-front-end/templates.lisp: | | The cl-notebook/src/ui/http-front-end/templates․lisp file |
| Lisp File, cl-notebook/src/util.lisp: | | The cl-notebook/src/util․lisp file |
|
M | | |
| Module, cl-notebook/src: | | The cl-notebook/src module |
| Module, cl-notebook/src/ui: | | The cl-notebook/src/ui module |
| Module, cl-notebook/src/ui/http-api: | | The cl-notebook/src/ui/http-api module |
| Module, cl-notebook/src/ui/http-front-end: | | The cl-notebook/src/ui/http-front-end module |
|
A.2 Functions
| Index Entry | | Section |
|
( | | |
| (setf namespace) : | | Internal generic functions |
| (setf namespace) : | | Internal generic functions |
|
- | | |
| -cell-class : | | Internal functions |
| -cell-comment : | | Internal functions |
| -html-value : | | Internal functions |
|
> | | |
| >>existing-directory : | | Internal functions |
| >>existing-filepath : | | Internal functions |
| >>export-format : | | Internal functions |
| >>nonexistent-file : | | Internal functions |
| >>notebook : | | Internal functions |
| >>package : | | Internal functions |
|
A | | |
| aget : | | Internal functions |
| alist : | | Internal functions |
| arglist : | | Internal generic functions |
| arglist : | | Internal generic functions |
|
C | | |
| capturing-eval : | | Internal generic functions |
| capturing-eval : | | Internal generic functions |
| capturing-eval : | | Internal generic functions |
|
D | | |
| default-package : | | Internal generic functions |
| default-package : | | Internal generic functions |
| define-css : | | Exported functions |
| do-cells : | | Internal functions |
|
E | | |
| empty-expression? : | | Internal generic functions |
| empty-expression? : | | Internal generic functions |
| eval-cell : | | Internal generic functions |
| eval-cell : | | Internal generic functions |
| eval-notebook : | | Internal generic functions |
| eval-notebook : | | Internal generic functions |
| eval-package : | | Internal generic functions |
| eval-package : | | Internal generic functions |
| export-as : | | Internal generic functions |
| export-as : | | Internal generic functions |
| export-as : | | Internal generic functions |
| export-as : | | Internal generic functions |
| export-book-formats : | | Internal functions |
| export-cell : | | Internal generic functions |
| export-cell : | | Internal generic functions |
| export-cell : | | Internal generic functions |
| export-cell : | | Internal generic functions |
| export-cell : | | Internal generic functions |
| export-cell : | | Internal generic functions |
| export-cell : | | Internal generic functions |
| export-cells : | | Internal functions |
|
F | | |
| filename-of : | | Internal generic functions |
| filename-of : | | Internal generic functions |
| filename-of : | | Internal generic functions |
| first-char : | | Internal generic functions |
| first-char : | | Internal generic functions |
| fork-at! : | | Internal functions |
| front-end-error : | | Internal functions |
| front-end-eval : | | Internal generic functions |
| front-end-eval : | | Internal generic functions |
| front-end-eval : | | Internal generic functions |
| front-end-eval : | | Internal generic functions |
| front-end-eval : | | Internal generic functions |
| front-end-eval : | | Internal generic functions |
| front-end-eval : | | Internal generic functions |
| front-end-eval-formats : | | Internal functions |
| Function, -cell-class : | | Internal functions |
| Function, -cell-comment : | | Internal functions |
| Function, -html-value : | | Internal functions |
| Function, >>existing-directory : | | Internal functions |
| Function, >>existing-filepath : | | Internal functions |
| Function, >>export-format : | | Internal functions |
| Function, >>nonexistent-file : | | Internal functions |
| Function, >>notebook : | | Internal functions |
| Function, >>package : | | Internal functions |
| Function, aget : | | Internal functions |
| Function, alist : | | Internal functions |
| Function, define-css : | | Exported functions |
| Function, do-cells : | | Internal functions |
| Function, export-book-formats : | | Internal functions |
| Function, export-cells : | | Internal functions |
| Function, fork-at! : | | Internal functions |
| Function, front-end-error : | | Internal functions |
| Function, front-end-eval-formats : | | Internal functions |
| Function, get-completions : | | Internal functions |
| Function, get-param : | | Internal functions |
| Function, hash : | | Internal functions |
| Function, ignored-error-prop? : | | Internal functions |
| Function, instance->alist : | | Internal functions |
| Function, load-package : | | Internal functions |
| Function, loaded-books! : | | Internal functions |
| Function, main : | | Exported functions |
| Function, main-dev : | | Internal functions |
| Function, make-notebook : | | Internal functions |
| Function, map-cells : | | Internal functions |
| Function, new-notebook! : | | Internal functions |
| Function, notebook-cell : | | Internal functions |
| Function, parse-args! : | | Internal functions |
| Function, printable-readably? : | | Internal functions |
| Function, publish-update-internal! : | | Internal functions |
| Function, read-statics : | | Internal functions |
| Function, reorder-cells! : | | Internal functions |
| Function, slurp : | | Internal functions |
| Function, stringified-error-prop? : | | Internal functions |
| Function, sys-dir : | | Internal functions |
| Function, type-tag : | | Internal functions |
| Function, write-statics : | | Internal functions |
|
G | | |
| Generic Function, (setf namespace) : | | Internal generic functions |
| Generic Function, arglist : | | Internal generic functions |
| Generic Function, capturing-eval : | | Internal generic functions |
| Generic Function, default-package : | | Internal generic functions |
| Generic Function, empty-expression? : | | Internal generic functions |
| Generic Function, eval-cell : | | Internal generic functions |
| Generic Function, eval-notebook : | | Internal generic functions |
| Generic Function, eval-package : | | Internal generic functions |
| Generic Function, export-as : | | Internal generic functions |
| Generic Function, export-cell : | | Internal generic functions |
| Generic Function, filename-of : | | Internal generic functions |
| Generic Function, first-char : | | Internal generic functions |
| Generic Function, front-end-eval : | | Internal generic functions |
| Generic Function, get-notebook! : | | Internal generic functions |
| Generic Function, last-char : | | Internal generic functions |
| Generic Function, load-dependencies! : | | Internal generic functions |
| Generic Function, load-notebook! : | | Internal generic functions |
| Generic Function, make-unique-name-in : | | Internal generic functions |
| Generic Function, mimetype-of : | | Internal generic functions |
| Generic Function, namespace : | | Internal generic functions |
| Generic Function, new-cell! : | | Internal generic functions |
| Generic Function, notebook-cell-order : | | Internal generic functions |
| Generic Function, notebook-id : | | Internal generic functions |
| Generic Function, notebook-name : | | Internal generic functions |
| Generic Function, notebook-package! : | | Internal generic functions |
| Generic Function, notebook-package-spec : | | Internal generic functions |
| Generic Function, notebook-package-spec-string : | | Internal generic functions |
| Generic Function, publish-update! : | | Internal generic functions |
| Generic Function, read-all : | | Internal generic functions |
| Generic Function, register-notebook! : | | Internal generic functions |
| Generic Function, rename-notebook! : | | Internal generic functions |
| Generic Function, repackage-notebook! : | | Internal generic functions |
| Generic Function, stem-path : | | Internal generic functions |
| get-completions : | | Internal functions |
| get-notebook! : | | Internal generic functions |
| get-notebook! : | | Internal generic functions |
| get-param : | | Internal functions |
|
H | | |
| hash : | | Internal functions |
| html-to-str : | | Internal macros |
|
I | | |
| ignored-error-prop? : | | Internal functions |
| instance->alist : | | Internal functions |
|
L | | |
| last-char : | | Internal generic functions |
| last-char : | | Internal generic functions |
| last-char : | | Internal generic functions |
| load-dependencies! : | | Internal generic functions |
| load-dependencies! : | | Internal generic functions |
| load-notebook! : | | Internal generic functions |
| load-notebook! : | | Internal generic functions |
| load-package : | | Internal functions |
| loaded-books! : | | Internal functions |
|
M | | |
| Macro, html-to-str : | | Internal macros |
| main : | | Exported functions |
| main-dev : | | Internal functions |
| make-notebook : | | Internal functions |
| make-unique-name-in : | | Internal generic functions |
| make-unique-name-in : | | Internal generic functions |
| map-cells : | | Internal functions |
| Method, (setf namespace) : | | Internal generic functions |
| Method, arglist : | | Internal generic functions |
| Method, capturing-eval : | | Internal generic functions |
| Method, capturing-eval : | | Internal generic functions |
| Method, default-package : | | Internal generic functions |
| Method, empty-expression? : | | Internal generic functions |
| Method, eval-cell : | | Internal generic functions |
| Method, eval-notebook : | | Internal generic functions |
| Method, eval-package : | | Internal generic functions |
| Method, export-as : | | Internal generic functions |
| Method, export-as : | | Internal generic functions |
| Method, export-as : | | Internal generic functions |
| Method, export-cell : | | Internal generic functions |
| Method, export-cell : | | Internal generic functions |
| Method, export-cell : | | Internal generic functions |
| Method, export-cell : | | Internal generic functions |
| Method, export-cell : | | Internal generic functions |
| Method, export-cell : | | Internal generic functions |
| Method, filename-of : | | Internal generic functions |
| Method, filename-of : | | Internal generic functions |
| Method, first-char : | | Internal generic functions |
| Method, front-end-eval : | | Internal generic functions |
| Method, front-end-eval : | | Internal generic functions |
| Method, front-end-eval : | | Internal generic functions |
| Method, front-end-eval : | | Internal generic functions |
| Method, front-end-eval : | | Internal generic functions |
| Method, front-end-eval : | | Internal generic functions |
| Method, get-notebook! : | | Internal generic functions |
| Method, last-char : | | Internal generic functions |
| Method, last-char : | | Internal generic functions |
| Method, load-dependencies! : | | Internal generic functions |
| Method, load-notebook! : | | Internal generic functions |
| Method, make-unique-name-in : | | Internal generic functions |
| Method, mimetype-of : | | Internal generic functions |
| Method, mimetype-of : | | Internal generic functions |
| Method, mimetype-of : | | Internal generic functions |
| Method, namespace : | | Internal generic functions |
| Method, new-cell! : | | Internal generic functions |
| Method, notebook-cell-order : | | Internal generic functions |
| Method, notebook-id : | | Internal generic functions |
| Method, notebook-name : | | Internal generic functions |
| Method, notebook-package! : | | Internal generic functions |
| Method, notebook-package-spec : | | Internal generic functions |
| Method, notebook-package-spec-string : | | Internal generic functions |
| Method, publish-update! : | | Internal generic functions |
| Method, publish-update! : | | Internal generic functions |
| Method, read-all : | | Internal generic functions |
| Method, read-all : | | Internal generic functions |
| Method, register-notebook! : | | Internal generic functions |
| Method, rename-notebook! : | | Internal generic functions |
| Method, repackage-notebook! : | | Internal generic functions |
| Method, stem-path : | | Internal generic functions |
| mimetype-of : | | Internal generic functions |
| mimetype-of : | | Internal generic functions |
| mimetype-of : | | Internal generic functions |
| mimetype-of : | | Internal generic functions |
|
N | | |
| namespace : | | Internal generic functions |
| namespace : | | Internal generic functions |
| new-cell! : | | Internal generic functions |
| new-cell! : | | Internal generic functions |
| new-notebook! : | | Internal functions |
| notebook-cell : | | Internal functions |
| notebook-cell-order : | | Internal generic functions |
| notebook-cell-order : | | Internal generic functions |
| notebook-id : | | Internal generic functions |
| notebook-id : | | Internal generic functions |
| notebook-name : | | Internal generic functions |
| notebook-name : | | Internal generic functions |
| notebook-package! : | | Internal generic functions |
| notebook-package! : | | Internal generic functions |
| notebook-package-spec : | | Internal generic functions |
| notebook-package-spec : | | Internal generic functions |
| notebook-package-spec-string : | | Internal generic functions |
| notebook-package-spec-string : | | Internal generic functions |
|
P | | |
| parse-args! : | | Internal functions |
| printable-readably? : | | Internal functions |
| publish-update! : | | Internal generic functions |
| publish-update! : | | Internal generic functions |
| publish-update! : | | Internal generic functions |
| publish-update-internal! : | | Internal functions |
|
R | | |
| read-all : | | Internal generic functions |
| read-all : | | Internal generic functions |
| read-all : | | Internal generic functions |
| read-statics : | | Internal functions |
| register-notebook! : | | Internal generic functions |
| register-notebook! : | | Internal generic functions |
| rename-notebook! : | | Internal generic functions |
| rename-notebook! : | | Internal generic functions |
| reorder-cells! : | | Internal functions |
| repackage-notebook! : | | Internal generic functions |
| repackage-notebook! : | | Internal generic functions |
|
S | | |
| slurp : | | Internal functions |
| stem-path : | | Internal generic functions |
| stem-path : | | Internal generic functions |
| stringified-error-prop? : | | Internal functions |
| sys-dir : | | Internal functions |
|
T | | |
| type-tag : | | Internal functions |
|
W | | |
| write-statics : | | Internal functions |
|
A.3 Variables
| Index Entry | | Section |
|
* | | |
| *addon-css-rules* : | | Internal special variables |
| *base-js* : | | Internal special variables |
| *books* : | | Internal special variables |
| *default-indices* : | | Internal special variables |
| *front-end-eval-thread* : | | Internal special variables |
| *notebook-css* : | | Internal special variables |
| *notebooks* : | | Internal special variables |
| *ql* : | | Internal special variables |
| *static* : | | Internal special variables |
| *static-files* : | | Internal special variables |
| *storage* : | | Internal special variables |
|
+ | | |
| +css-input+ : | | Internal special variables |
| +key-codes+ : | | Internal special variables |
| +mod-keys+ : | | Internal special variables |
|
N | | |
| namespace : | | Internal classes |
|
S | | |
| Slot, namespace : | | Internal classes |
| Special Variable, *addon-css-rules* : | | Internal special variables |
| Special Variable, *base-js* : | | Internal special variables |
| Special Variable, *books* : | | Internal special variables |
| Special Variable, *default-indices* : | | Internal special variables |
| Special Variable, *front-end-eval-thread* : | | Internal special variables |
| Special Variable, *notebook-css* : | | Internal special variables |
| Special Variable, *notebooks* : | | Internal special variables |
| Special Variable, *ql* : | | Internal special variables |
| Special Variable, *static* : | | Internal special variables |
| Special Variable, *static-files* : | | Internal special variables |
| Special Variable, *storage* : | | Internal special variables |
| Special Variable, +css-input+ : | | Internal special variables |
| Special Variable, +key-codes+ : | | Internal special variables |
| Special Variable, +mod-keys+ : | | Internal special variables |
|
A.4 Data types