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

With quicklisp

• 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.

With roswell and qlot

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.

• Install roswell
• Install qlot
• Clone cl-notebook

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

With roswell and qlot

• 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.

With buildapp

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:

• nativesortable
• Code Mirror
• Genericons
• Blob.js and FileSave.js
• A spinner generated from here
• anaphora
• alexandria
• parenscript
• cl-who
• quicklisp
• buildapp

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

• package.lisp (file)
• model.lisp (file)
• util.lisp (file)
• publish-update.lisp (file)
• ui (module)
• evaluators.lisp (file)
• exporters.lisp (file)
• main.lisp (file)

3.2 cl-notebook/src/ui

Parent

src (module)

Location

src/ui/

Components

• http-api (module)
• http-front-end (module)

3.3 cl-notebook/src/ui/http-api

Parent

ui (module)

Location

src/ui/http-api/

Components

• system.lisp (file)
• notebook.lisp (file)
• cell.lisp (file)

3.4 cl-notebook/src/ui/http-front-end

Parent

ui (module)

Location

src/ui/http-front-end/

Components

• 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)

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

• *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)

4.1.3 cl-notebook/src/model.lisp

Parent

src (module)

Location

src/model.lisp

Internal Definitions

• *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 (method)
• (setf namespace) (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)

4.1.4 cl-notebook/src/util.lisp

Parent

src (module)

Location

src/util.lisp

Internal Definitions

• 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)

4.1.5 cl-notebook/src/publish-update.lisp

Parent

src (module)

Location

src/publish-update.lisp

Internal Definitions

• publish-update! (method)
• publish-update! (method)
• publish-update-internal! (function)

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

• +key-codes+ (special variable)
• +mod-keys+ (special variable)

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

• *addon-css-rules* (special variable)
• *notebook-css* (special variable)
• +css-input+ (special variable)

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

• *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)

4.1.18 cl-notebook/src/exporters.lisp

Parent

src (module)

Location

src/exporters.lisp

Internal Definitions

• -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)

4.1.19 cl-notebook/src/main.lisp

Parent

src (module)

Location

src/main.lisp

Exported Definitions

main (function)

Internal Definitions

• main-dev (function)
• read-statics (function)
• write-statics (function)

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

• define-css (function)
• main (function)

Internal Definitions

• *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)
• arglist (method)
• capturing-eval (generic function)
• capturing-eval (method)
• capturing-eval (method)
• default-package (generic function)
• default-package (method)
• do-cells (function)
• empty-expression? (generic function)
• empty-expression? (method)
• eval-cell (generic function)
• eval-cell (method)
• eval-notebook (generic function)
• eval-notebook (method)
• eval-package (generic function)
• eval-package (method)
• export-as (generic function)
• export-as (method)
• export-as (method)
• export-as (method)
• export-book-formats (function)
• export-cell (generic function)
• export-cell (method)
• export-cell (method)
• export-cell (method)
• export-cell (method)
• export-cell (method)
• export-cell (method)
• export-cells (function)
• filename-of (generic function)
• filename-of (method)
• filename-of (method)
• first-char (generic function)
• first-char (method)
• fork-at! (function)
• front-end-error (function)
• front-end-eval (generic function)
• 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)
• get-completions (function)
• get-notebook! (generic function)
• get-notebook! (method)
• get-param (function)
• hash (function)
• html-to-str (macro)
• ignored-error-prop? (function)
• instance->alist (function)
• last-char (generic function)
• last-char (method)
• last-char (method)
• load-dependencies! (generic function)
• load-dependencies! (method)
• load-notebook! (generic function)
• load-notebook! (method)
• load-package (function)
• loaded-books! (function)
• main-dev (function)
• make-notebook (function)
• make-unique-name-in (generic function)
• make-unique-name-in (method)
• map-cells (function)
• mimetype-of (generic function)
• mimetype-of (method)
• mimetype-of (method)
• mimetype-of (method)
• namespace (generic function)
• namespace (method)
• (setf namespace) (method)
• (setf namespace) (generic function)
• new-cell! (generic function)
• new-cell! (method)
• new-notebook! (function)
• notebook (class)
• notebook-cell (function)
• notebook-cell-order (generic function)
• notebook-cell-order (method)
• notebook-id (generic function)
• notebook-id (method)
• notebook-name (generic function)
• notebook-name (method)
• notebook-package! (generic function)
• notebook-package! (method)
• notebook-package-spec (generic function)
• notebook-package-spec (method)
• notebook-package-spec-string (generic function)
• notebook-package-spec-string (method)
• parse-args! (function)
• printable-readably? (function)
• publish-update! (generic function)
• publish-update! (method)
• publish-update! (method)
• publish-update-internal! (function)
• read-all (generic function)
• read-all (method)
• read-all (method)
• read-statics (function)
• register-notebook! (generic function)
• register-notebook! (method)
• rename-notebook! (generic function)
• rename-notebook! (method)
• reorder-cells! (function)
• repackage-notebook! (generic function)
• repackage-notebook! (method)
• slurp (function)
• stem-path (generic function)
• stem-path (method)
• stringified-error-prop? (function)
• sys-dir (function)
• type-tag (function)
• write-statics (function)

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)

Function: -cell-comment CELL

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

• export-as (method)
• export-as (method)
• export-as (method)
• eval-package (method)
• eval-cell (method)
• eval-notebook (method)
• publish-update! (method)
• register-notebook! (method)
• rename-notebook! (method)
• repackage-notebook! (method)
• notebook-package! (method)
• notebook-package-spec (method)
• notebook-package-spec-string (method)
• notebook-cell-order (method)
• notebook-name (method)
• default-package (method)
• notebook-id (method)
• new-cell! (method)
• namespace (method)
• namespace (method)

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

A.2 Functions

A.3 Variables