The docbrowser Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The docbrowser Reference Manual

This is the docbrowser Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:42:24 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Docbrowser - Web-based Common Lisp documentation browser

Author information

Elias MÃ¥rtenson

Source code repository location

The latest version of Docbrowser can be found at Github:

https://github.com/lokedhs/docbrowser

Compatibility

The application has been tested on SBCL, CCL and CLISP. Please let me know of any issues on other Common Lisp implementations.

Starting the server

After loading the package, run the following command from the REPL:

(docbrowser:start-docserver)

This will start the docserver on port 8080. A different port number can also be given as an optional argument.

To access the docbrowser, point a web browser to http://localhost:8080/


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 docbrowser

Author

Elias Martenson <lokedhs@gmail.com>

License

BSD

Description

Web-based Common Lisp documentation browser

Dependencies
Source

docbrowser.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 docbrowser/template

Parent

docbrowser (system)

Location

template/

Components

Previous: , Up: Modules   [Contents][Index]

3.2 docbrowser/src

Dependency

template (module)

Parent

docbrowser (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 docbrowser.asd

Location

docbrowser.asd

Systems

docbrowser (system)

Packages

docbrowser-system


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 docbrowser/template/template-package.lisp

Parent

template (module)

Location

template/template-package.lisp

Packages

docbrowser-template

Internal Definitions

*compile-decl* (special variable)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 docbrowser/template/util.lisp

Dependency

template-package.lisp (file)

Parent

template (module)

Location

template/util.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 docbrowser/template/template.lisp

Dependency

util.lisp (file)

Parent

template (module)

Location

template/template.lisp

Exported Definitions

exec-template-file (function)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 docbrowser/template/parser.lisp

Dependency

template.lisp (file)

Parent

template (module)

Location

template/parser.lisp

Packages

template-parse

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.6 docbrowser/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

docbrowser


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.7 docbrowser/src/misc.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/misc.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.8 docbrowser/src/server.lisp

Dependency

misc.lisp (file)

Parent

src (module)

Location

src/server.lisp

Exported Definitions

start-docserver (function)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.9 docbrowser/src/docbrowser.lisp

Dependency

server.lisp (file)

Parent

src (module)

Location

src/docbrowser.lisp

Packages

docbrowser-empty

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.10 docbrowser/src/search.lisp

Dependency

docbrowser.lisp (file)

Parent

src (module)

Location

src/search.lisp

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

4.1.11 docbrowser/src/source-function.lisp

Dependency

search.lisp (file)

Parent

src (module)

Location

src/source-function.lisp

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 docbrowser-system

private: ASDF system package for Docbrowser.

Source

docbrowser.asd

Use List

Next: , Previous: , Up: Packages   [Contents][Index]

5.2 docbrowser-template

Source

template-package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.3 template-parse

Source

parser.lisp (file)


Next: , Previous: , Up: Packages   [Contents][Index]

5.4 docbrowser

Runs a webserver that allows the user to browse and search information about the packages in the Lisp runtime, including functions, classes and variables.

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

start-docserver (function)

Internal Definitions

Previous: , Up: Packages   [Contents][Index]

5.5 docbrowser-empty

Empty package that is used internally by Docbrowser

Source

docbrowser.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *begin-code*

The string that opens a script segment. The end of a script segment is specified by *END-CODE*.

Package

docbrowser-template

Source

parser.lisp (file)

Special Variable: *current-content*
Package

docbrowser-template

Source

parser.lisp (file)

Special Variable: *end-code*

The string that ends a script segment.

Package

docbrowser-template

Source

parser.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Functions

Function: escape-string-all STRING S

Escapes all characters in STRING which aren’t in the 7-bit ASCII character set.

Package

docbrowser-template

Source

util.lisp (file)

Function: escape-string-minimal STRING S

Escape only #<, #>, and #& in STRING.

Package

docbrowser-template

Source

util.lisp (file)

Function: escape-string-minimal-plus-quotes STRING S

Like ESCAPE-STRING-MINIMAL but also escapes quotes.

Package

docbrowser-template

Source

util.lisp (file)

Function: exec-template-file FILE DATA STREAM &key BINARY ENCODING

Load and compile FILE and put it into the template cache if it was not already in the cache. Then run the template using DATA and write the output to STREAM.

Package

docbrowser-template

Source

template.lisp (file)

Function: parse-template STREAM &key BINARY ENCODING INCLUDE-ROOT-DIR

Parses and compiles the template defition given as STREAM. If BINARY
is NIL, the generated template will output its data as strings (using PRINC), otherwise the output will be converted to binary using the encoding specified by ENCODING. The binary output is the preferred
method as that will allow constant strings in the template to be
encoded during parsing instead of at runtime.

INCLUDE-ROOT-DIR is used to specify a base directory from where the "include" command will search for files.

The return value is a function that takes two arguments, DATA and OUTPUT. DATA is the data that will be used by the template, and OUTPUT is the output stream to which the result should be written.

Package

docbrowser-template

Source

parser.lisp (file)

Function: start-docserver &optional PORT

Start the documentation server with a HTTP listener on port PORT.

Package

docbrowser

Source

server.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Generic functions

Generic Function: template-error-column CONDITION
Package

docbrowser-template

Methods
Method: template-error-column (CONDITION template-error)
Source

parser.lisp (file)

Generic Function: template-error-content CONDITION
Package

docbrowser-template

Methods
Method: template-error-content (CONDITION template-error)
Source

parser.lisp (file)

Generic Function: template-error-content-index CONDITION
Package

docbrowser-template

Methods
Method: template-error-content-index (CONDITION template-error)
Source

parser.lisp (file)

Generic Function: template-error-line CONDITION
Package

docbrowser-template

Methods
Method: template-error-line (CONDITION template-error)
Source

parser.lisp (file)

Generic Function: template-error-message CONDITION
Package

docbrowser-template

Methods
Method: template-error-message (CONDITION template-error)
Source

parser.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.4 Conditions

Condition: template-error ()

Error that is raised if there is an error parsing a template

Package

docbrowser-template

Source

parser.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: line

The line number where the error occurred.

Initargs

:line

Initform

(quote (error "~s required when creating ~s" :line (quote docbrowser-template:template-error)))

Readers

template-error-line (generic function)

Slot: column

The column index of the line where the error occurred, if available. Otherwise NIL.

Initargs

:column

Initform

(quote nil)

Readers

template-error-column (generic function)

Slot: message

The error message

Initargs

:message

Initform

(quote (error "~s required when creating ~s" :message (quote docbrowser-template:template-error)))

Readers

template-error-message (generic function)

Slot: content

The actual template content where the error occurred. Either the entire line, or part of it.

Initargs

:content

Initform

(quote nil)

Readers

template-error-content (generic function)

Slot: content-index

The position in content closest to the actual error, or NIL if the information is not available.

Initargs

:content-index

Initform

(quote nil)

Readers

template-error-content-index (generic function)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *actions*
Package

docbrowser-template

Source

parser.lisp (file)

Special Variable: *cached-templates*
Package

docbrowser-template

Source

template.lisp (file)

Special Variable: *cached-templates-lock*
Package

docbrowser-template

Source

template.lisp (file)

Special Variable: *compile-decl*
Package

docbrowser-template

Source

template-package.lisp (file)

Special Variable: *current-line-num*

Dynamic variable used to track the current line number during parsing

Package

docbrowser-template

Source

parser.lisp (file)

Special Variable: *current-stream*

The stream that the template output is written to.

Package

docbrowser-template

Source

parser.lisp (file)

Special Variable: *escape-char-p*
Package

docbrowser-template

Source

util.lisp (file)

Special Variable: *files-base-dir*
Package

docbrowser

Source

server.lisp (file)

Special Variable: *global-acceptor*

The acceptor for the currently running server.

Package

docbrowser

Source

server.lisp (file)

Special Variable: *include-root-dir*
Package

docbrowser-template

Source

parser.lisp (file)

Special Variable: *maximum-search-results*

The maximum number of search results returned.

Package

docbrowser

Source

search.lisp (file)

Special Variable: *output-binary*
Package

docbrowser-template

Source

parser.lisp (file)

Special Variable: *output-encoding*
Package

docbrowser-template

Source

parser.lisp (file)

Special Variable: *subtemplate-list*
Package

docbrowser-template

Source

parser.lisp (file)

Special Variable: *template-parser*
Package

docbrowser-template

Source

parser.lisp (file)

Special Variable: *url-handlers*

A hash table keyed on the base URL that maps to the underlying handler function

Package

docbrowser

Source

server.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Macros

Macro: define-handler-fn NAME URL &body BODY
Package

docbrowser

Source

server.lisp (file)

Macro: define-json-handler-fn NAME URL DATA-SYMBOL &body BODY
Package

docbrowser

Source

search.lisp (file)

Macro: make-lexer-actions &rest DEFINITIONS
Package

docbrowser-template

Source

parser.lisp (file)

Macro: short-define-parser NAME INITIALS &body DEFINITIONS
Package

docbrowser-template

Source

parser.lisp (file)

Macro: with-hunchentoot-stream (OUT &optional CONTENT-TYPE APPEND-CHARSET) &body BODY
Package

docbrowser

Source

server.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Functions

Function: %annotate-function-info FN-INFO CLASSES

Append :ACCESSORP tag if the function is present as an accessor function.

Package

docbrowser

Source

docbrowser.lisp (file)

Function: %ensure-external SYMBOL
Package

docbrowser

Source

docbrowser.lisp (file)

Function: %make-define-handler-fn-form DOCSTRING NAME BODY
Package

docbrowser

Source

server.lisp (file)

Function: %show-package-screen-show OUT PACKAGE
Package

docbrowser

Source

docbrowser.lisp (file)

Function: assoc-cdr KEY DATA &key ERROR-P

Return (CDR (ASSOC KEY DATA)). If ERROR-P is non-NIL, signal an error if KEY is not available is DATA.

Package

docbrowser

Source

misc.lisp (file)

Function: assoc-name V
Package

docbrowser

Source

docbrowser.lisp (file)

Function: debug-lexer STRING
Package

docbrowser-template

Source

parser.lisp (file)

Function: debug-parser S &optional BINARY
Package

docbrowser-template

Source

parser.lisp (file)

Function: escape-char CH
Package

docbrowser

Source

source-function.lisp (file)

Function: escape-string STRING S &key TEST
Package

docbrowser-template

Source

util.lisp (file)

Function: escape-string-slashes STRING
Package

docbrowser-template

Source

parser.lisp (file)

Function: exec-template-to-string FILE DATA
Package

docbrowser-template

Source

template.lisp (file)

Function: find-matching-symbols STRING
Package

docbrowser

Source

search.lisp (file)

Function: find-superclasses CLASS
Package

docbrowser

Source

docbrowser.lisp (file)

Function: format-argument-to-string ARG
Package

docbrowser

Source

docbrowser.lisp (file)

Function: format-source SOURCE-DESCRIPTOR
Package

docbrowser

Source

source-function.lisp (file)

Function: hunchentoot-stream-as-text &key CONTENT-TYPE APPEND-CHARSET

Sends the appropriate headers to ensure that all data is sent back using the correct encoding and returns a text stream that the result can be written to.

Package

docbrowser

Source

server.lisp (file)

Function: inner-parse-stream-to-form STREAM
Package

docbrowser-template

Source

parser.lisp (file)

Function: load-accessor-info CLASS SLOT
Package

docbrowser

Source

docbrowser.lisp (file)

Function: load-class-info CLASS-NAME
Package

docbrowser

Source

docbrowser.lisp (file)

Function: load-function-info SYMBOL
Package

docbrowser

Source

docbrowser.lisp (file)

Function: load-slots CLASS
Package

docbrowser

Source

docbrowser.lisp (file)

Function: load-specialisation-info CLASS-NAME
Package

docbrowser

Source

docbrowser.lisp (file)

Function: load-variable-info SYMBOL
Package

docbrowser

Source

docbrowser.lisp (file)

Function: main-screen ()
Package

docbrowser

Source

docbrowser.lisp (file)

Function: make-lexer-actions-list DEFINITIONS
Package

docbrowser-template

Source

parser.lisp (file)

Function: make-stream-template-lexer INPUT-STREAM
Package

docbrowser-template

Source

parser.lisp (file)

Function: nice-princ-to-string OBJ
Package

docbrowser

Source

misc.lisp (file)

Function: package-list-screen ()
Package

docbrowser

Source

docbrowser.lisp (file)

Function: parse-stream-to-form STREAM BINARY ENCODING INCLUDE-ROOT-DIR
Package

docbrowser-template

Source

parser.lisp (file)

Function: parse-template-file PATHNAME &key BINARY ENCODING
Package

docbrowser-template

Source

template.lisp (file)

Function: prin1-to-string-with-package OBJ PACKAGE
Package

docbrowser

Source

misc.lisp (file)

Function: process-json FN
Package

docbrowser

Source

search.lisp (file)

Function: process-search-result SYMBOLS
Package

docbrowser

Source

search.lisp (file)

Function: read-file-content FILE
Package

docbrowser

Source

source-function.lisp (file)

Function: safe-class-for-symbol SYMBOL
Package

docbrowser

Source

docbrowser.lisp (file)

Function: search-command-screen ()

Handler for AJAX-calls to perform a search operation

Package

docbrowser

Source

search.lisp (file)

Function: search-screen ()
Package

docbrowser

Source

search.lisp (file)

Function: show-package-screen ()
Package

docbrowser

Source

docbrowser.lisp (file)

Function: show-template OUT FILE DATA
Package

docbrowser

Source

server.lisp (file)

Function: signal-template-error MESSAGE &optional COLUMN CONTENT CONTENT-INDEX
Package

docbrowser-template

Source

parser.lisp (file)

Function: source-function-screen ()
Package

docbrowser

Source

source-function.lisp (file)

Function: specialise->symbol SPEC
Package

docbrowser

Source

docbrowser.lisp (file)

Function: string->symbol SYMBOL-NAME &optional PACKAGE
Package

docbrowser-template

Source

parser.lisp (file)

Function: style-from-type TYPE
Package

docbrowser

Source

source-function.lisp (file)

Function: symbol-external-p SYMBOL &optional PACKAGE

Return non-NIL if SYMBOL is external in PACKAGE. SYMBOL may be either a symbol, or a SETF form, in which case the check will be performed on the CADR of the list.

Package

docbrowser

Source

misc.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Generic functions

Generic Function: docbrowser-acceptor-files-dispatcher OBJECT
Package

docbrowser

Methods
Method: docbrowser-acceptor-files-dispatcher (DOCBROWSER-ACCEPTOR docbrowser-acceptor)

List of fallback dispatchers

Source

server.lisp (file)

Generic Function: parsed-file-last-time-check OBJECT
Generic Function: (setf parsed-file-last-time-check) NEW-VALUE OBJECT
Package

docbrowser-template

Methods
Method: parsed-file-last-time-check (PARSED-FILE parsed-file)

automatically generated reader method

Source

template.lisp (file)

Method: (setf parsed-file-last-time-check) NEW-VALUE (PARSED-FILE parsed-file)

automatically generated writer method

Source

template.lisp (file)

Generic Function: parsed-file-modified-date OBJECT
Package

docbrowser-template

Methods
Method: parsed-file-modified-date (PARSED-FILE parsed-file)

automatically generated reader method

Source

template.lisp (file)

Generic Function: parsed-file-pathspec OBJECT
Package

docbrowser-template

Methods
Method: parsed-file-pathspec (PARSED-FILE parsed-file)

automatically generated reader method

Source

template.lisp (file)

Generic Function: parsed-file-template OBJECT
Package

docbrowser-template

Methods
Method: parsed-file-template (PARSED-FILE parsed-file)

automatically generated reader method

Source

template.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.5 Classes

Class: docbrowser-acceptor ()

Acceptor for the documentation browser

Package

docbrowser

Source

server.lisp (file)

Direct superclasses

acceptor (class)

Direct methods
Direct slots
Slot: files-dispatcher

List of fallback dispatchers

Readers

docbrowser-acceptor-files-dispatcher (generic function)

Class: parsed-file ()

Cached parse result

Package

docbrowser-template

Source

template.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: name
Type

pathname

Initargs

:name

Initform

(error "name is a required parameter")

Readers

parsed-file-pathspec (generic function)

Slot: modified-date
Type

integer

Readers

parsed-file-modified-date (generic function)

Slot: last-time-check
Type

integer

Readers

parsed-file-last-time-check (generic function)

Writers

(setf parsed-file-last-time-check) (generic function)

Slot: template
Type

function

Initargs

:template

Initform

(error "template is unset")

Readers

parsed-file-template (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   D   F   L   M  
Index Entry  Section

D
docbrowser.asd: The docbrowser<dot>asd file
docbrowser/src: The docbrowser/src module
docbrowser/src/docbrowser.lisp: The docbrowser/src/docbrowser<dot>lisp file
docbrowser/src/misc.lisp: The docbrowser/src/misc<dot>lisp file
docbrowser/src/package.lisp: The docbrowser/src/package<dot>lisp file
docbrowser/src/search.lisp: The docbrowser/src/search<dot>lisp file
docbrowser/src/server.lisp: The docbrowser/src/server<dot>lisp file
docbrowser/src/source-function.lisp: The docbrowser/src/source-function<dot>lisp file
docbrowser/template: The docbrowser/template module
docbrowser/template/parser.lisp: The docbrowser/template/parser<dot>lisp file
docbrowser/template/template-package.lisp: The docbrowser/template/template-package<dot>lisp file
docbrowser/template/template.lisp: The docbrowser/template/template<dot>lisp file
docbrowser/template/util.lisp: The docbrowser/template/util<dot>lisp file

F
File, Lisp, docbrowser.asd: The docbrowser<dot>asd file
File, Lisp, docbrowser/src/docbrowser.lisp: The docbrowser/src/docbrowser<dot>lisp file
File, Lisp, docbrowser/src/misc.lisp: The docbrowser/src/misc<dot>lisp file
File, Lisp, docbrowser/src/package.lisp: The docbrowser/src/package<dot>lisp file
File, Lisp, docbrowser/src/search.lisp: The docbrowser/src/search<dot>lisp file
File, Lisp, docbrowser/src/server.lisp: The docbrowser/src/server<dot>lisp file
File, Lisp, docbrowser/src/source-function.lisp: The docbrowser/src/source-function<dot>lisp file
File, Lisp, docbrowser/template/parser.lisp: The docbrowser/template/parser<dot>lisp file
File, Lisp, docbrowser/template/template-package.lisp: The docbrowser/template/template-package<dot>lisp file
File, Lisp, docbrowser/template/template.lisp: The docbrowser/template/template<dot>lisp file
File, Lisp, docbrowser/template/util.lisp: The docbrowser/template/util<dot>lisp file

L
Lisp File, docbrowser.asd: The docbrowser<dot>asd file
Lisp File, docbrowser/src/docbrowser.lisp: The docbrowser/src/docbrowser<dot>lisp file
Lisp File, docbrowser/src/misc.lisp: The docbrowser/src/misc<dot>lisp file
Lisp File, docbrowser/src/package.lisp: The docbrowser/src/package<dot>lisp file
Lisp File, docbrowser/src/search.lisp: The docbrowser/src/search<dot>lisp file
Lisp File, docbrowser/src/server.lisp: The docbrowser/src/server<dot>lisp file
Lisp File, docbrowser/src/source-function.lisp: The docbrowser/src/source-function<dot>lisp file
Lisp File, docbrowser/template/parser.lisp: The docbrowser/template/parser<dot>lisp file
Lisp File, docbrowser/template/template-package.lisp: The docbrowser/template/template-package<dot>lisp file
Lisp File, docbrowser/template/template.lisp: The docbrowser/template/template<dot>lisp file
Lisp File, docbrowser/template/util.lisp: The docbrowser/template/util<dot>lisp file

M
Module, docbrowser/src: The docbrowser/src module
Module, docbrowser/template: The docbrowser/template module

Jump to:   D   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
A   D   E   F   G   H   I   L   M   N   P   R   S   T   W  
Index Entry  Section

%
%annotate-function-info: Internal functions
%ensure-external: Internal functions
%make-define-handler-fn-form: Internal functions
%show-package-screen-show: Internal functions

(
(setf parsed-file-last-time-check): Internal generic functions
(setf parsed-file-last-time-check): Internal generic functions

A
assoc-cdr: Internal functions
assoc-name: Internal functions

D
debug-lexer: Internal functions
debug-parser: Internal functions
define-handler-fn: Internal macros
define-json-handler-fn: Internal macros
docbrowser-acceptor-files-dispatcher: Internal generic functions
docbrowser-acceptor-files-dispatcher: Internal generic functions

E
escape-char: Internal functions
escape-string: Internal functions
escape-string-all: Exported functions
escape-string-minimal: Exported functions
escape-string-minimal-plus-quotes: Exported functions
escape-string-slashes: Internal functions
exec-template-file: Exported functions
exec-template-to-string: Internal functions

F
find-matching-symbols: Internal functions
find-superclasses: Internal functions
format-argument-to-string: Internal functions
format-source: Internal functions
Function, %annotate-function-info: Internal functions
Function, %ensure-external: Internal functions
Function, %make-define-handler-fn-form: Internal functions
Function, %show-package-screen-show: Internal functions
Function, assoc-cdr: Internal functions
Function, assoc-name: Internal functions
Function, debug-lexer: Internal functions
Function, debug-parser: Internal functions
Function, escape-char: Internal functions
Function, escape-string: Internal functions
Function, escape-string-all: Exported functions
Function, escape-string-minimal: Exported functions
Function, escape-string-minimal-plus-quotes: Exported functions
Function, escape-string-slashes: Internal functions
Function, exec-template-file: Exported functions
Function, exec-template-to-string: Internal functions
Function, find-matching-symbols: Internal functions
Function, find-superclasses: Internal functions
Function, format-argument-to-string: Internal functions
Function, format-source: Internal functions
Function, hunchentoot-stream-as-text: Internal functions
Function, inner-parse-stream-to-form: Internal functions
Function, load-accessor-info: Internal functions
Function, load-class-info: Internal functions
Function, load-function-info: Internal functions
Function, load-slots: Internal functions
Function, load-specialisation-info: Internal functions
Function, load-variable-info: Internal functions
Function, main-screen: Internal functions
Function, make-lexer-actions-list: Internal functions
Function, make-stream-template-lexer: Internal functions
Function, nice-princ-to-string: Internal functions
Function, package-list-screen: Internal functions
Function, parse-stream-to-form: Internal functions
Function, parse-template: Exported functions
Function, parse-template-file: Internal functions
Function, prin1-to-string-with-package: Internal functions
Function, process-json: Internal functions
Function, process-search-result: Internal functions
Function, read-file-content: Internal functions
Function, safe-class-for-symbol: Internal functions
Function, search-command-screen: Internal functions
Function, search-screen: Internal functions
Function, show-package-screen: Internal functions
Function, show-template: Internal functions
Function, signal-template-error: Internal functions
Function, source-function-screen: Internal functions
Function, specialise->symbol: Internal functions
Function, start-docserver: Exported functions
Function, string->symbol: Internal functions
Function, style-from-type: Internal functions
Function, symbol-external-p: Internal functions

G
Generic Function, (setf parsed-file-last-time-check): Internal generic functions
Generic Function, docbrowser-acceptor-files-dispatcher: Internal generic functions
Generic Function, parsed-file-last-time-check: Internal generic functions
Generic Function, parsed-file-modified-date: Internal generic functions
Generic Function, parsed-file-pathspec: Internal generic functions
Generic Function, parsed-file-template: Internal generic functions
Generic Function, template-error-column: Exported generic functions
Generic Function, template-error-content: Exported generic functions
Generic Function, template-error-content-index: Exported generic functions
Generic Function, template-error-line: Exported generic functions
Generic Function, template-error-message: Exported generic functions

H
hunchentoot-stream-as-text: Internal functions

I
inner-parse-stream-to-form: Internal functions

L
load-accessor-info: Internal functions
load-class-info: Internal functions
load-function-info: Internal functions
load-slots: Internal functions
load-specialisation-info: Internal functions
load-variable-info: Internal functions

M
Macro, define-handler-fn: Internal macros
Macro, define-json-handler-fn: Internal macros
Macro, make-lexer-actions: Internal macros
Macro, short-define-parser: Internal macros
Macro, with-hunchentoot-stream: Internal macros
main-screen: Internal functions
make-lexer-actions: Internal macros
make-lexer-actions-list: Internal functions
make-stream-template-lexer: Internal functions
Method, (setf parsed-file-last-time-check): Internal generic functions
Method, docbrowser-acceptor-files-dispatcher: Internal generic functions
Method, parsed-file-last-time-check: Internal generic functions
Method, parsed-file-modified-date: Internal generic functions
Method, parsed-file-pathspec: Internal generic functions
Method, parsed-file-template: Internal generic functions
Method, template-error-column: Exported generic functions
Method, template-error-content: Exported generic functions
Method, template-error-content-index: Exported generic functions
Method, template-error-line: Exported generic functions
Method, template-error-message: Exported generic functions

N
nice-princ-to-string: Internal functions

P
package-list-screen: Internal functions
parse-stream-to-form: Internal functions
parse-template: Exported functions
parse-template-file: Internal functions
parsed-file-last-time-check: Internal generic functions
parsed-file-last-time-check: Internal generic functions
parsed-file-modified-date: Internal generic functions
parsed-file-modified-date: Internal generic functions
parsed-file-pathspec: Internal generic functions
parsed-file-pathspec: Internal generic functions
parsed-file-template: Internal generic functions
parsed-file-template: Internal generic functions
prin1-to-string-with-package: Internal functions
process-json: Internal functions
process-search-result: Internal functions

R
read-file-content: Internal functions

S
safe-class-for-symbol: Internal functions
search-command-screen: Internal functions
search-screen: Internal functions
short-define-parser: Internal macros
show-package-screen: Internal functions
show-template: Internal functions
signal-template-error: Internal functions
source-function-screen: Internal functions
specialise->symbol: Internal functions
start-docserver: Exported functions
string->symbol: Internal functions
style-from-type: Internal functions
symbol-external-p: Internal functions

T
template-error-column: Exported generic functions
template-error-column: Exported generic functions
template-error-content: Exported generic functions
template-error-content: Exported generic functions
template-error-content-index: Exported generic functions
template-error-content-index: Exported generic functions
template-error-line: Exported generic functions
template-error-line: Exported generic functions
template-error-message: Exported generic functions
template-error-message: Exported generic functions

W
with-hunchentoot-stream: Internal macros

Jump to:   %   (  
A   D   E   F   G   H   I   L   M   N   P   R   S   T   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
C   F   L   M   N   S   T  
Index Entry  Section

*
*actions*: Internal special variables
*begin-code*: Exported special variables
*cached-templates*: Internal special variables
*cached-templates-lock*: Internal special variables
*compile-decl*: Internal special variables
*current-content*: Exported special variables
*current-line-num*: Internal special variables
*current-stream*: Internal special variables
*end-code*: Exported special variables
*escape-char-p*: Internal special variables
*files-base-dir*: Internal special variables
*global-acceptor*: Internal special variables
*include-root-dir*: Internal special variables
*maximum-search-results*: Internal special variables
*output-binary*: Internal special variables
*output-encoding*: Internal special variables
*subtemplate-list*: Internal special variables
*template-parser*: Internal special variables
*url-handlers*: Internal special variables

C
column: Exported conditions
content: Exported conditions
content-index: Exported conditions

F
files-dispatcher: Internal classes

L
last-time-check: Internal classes
line: Exported conditions

M
message: Exported conditions
modified-date: Internal classes

N
name: Internal classes

S
Slot, column: Exported conditions
Slot, content: Exported conditions
Slot, content-index: Exported conditions
Slot, files-dispatcher: Internal classes
Slot, last-time-check: Internal classes
Slot, line: Exported conditions
Slot, message: Exported conditions
Slot, modified-date: Internal classes
Slot, name: Internal classes
Slot, template: Internal classes
Special Variable, *actions*: Internal special variables
Special Variable, *begin-code*: Exported special variables
Special Variable, *cached-templates*: Internal special variables
Special Variable, *cached-templates-lock*: Internal special variables
Special Variable, *compile-decl*: Internal special variables
Special Variable, *current-content*: Exported special variables
Special Variable, *current-line-num*: Internal special variables
Special Variable, *current-stream*: Internal special variables
Special Variable, *end-code*: Exported special variables
Special Variable, *escape-char-p*: Internal special variables
Special Variable, *files-base-dir*: Internal special variables
Special Variable, *global-acceptor*: Internal special variables
Special Variable, *include-root-dir*: Internal special variables
Special Variable, *maximum-search-results*: Internal special variables
Special Variable, *output-binary*: Internal special variables
Special Variable, *output-encoding*: Internal special variables
Special Variable, *subtemplate-list*: Internal special variables
Special Variable, *template-parser*: Internal special variables
Special Variable, *url-handlers*: Internal special variables

T
template: Internal classes

Jump to:   *  
C   F   L   M   N   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   D   P   S   T  
Index Entry  Section

C
Class, docbrowser-acceptor: Internal classes
Class, parsed-file: Internal classes
Condition, template-error: Exported conditions

D
docbrowser: The docbrowser system
docbrowser: The docbrowser package
docbrowser-acceptor: Internal classes
docbrowser-empty: The docbrowser-empty package
docbrowser-system: The docbrowser-system package
docbrowser-template: The docbrowser-template package

P
Package, docbrowser: The docbrowser package
Package, docbrowser-empty: The docbrowser-empty package
Package, docbrowser-system: The docbrowser-system package
Package, docbrowser-template: The docbrowser-template package
Package, template-parse: The template-parse package
parsed-file: Internal classes

S
System, docbrowser: The docbrowser system

T
template-error: Exported conditions
template-parse: The template-parse package

Jump to:   C   D   P   S   T