This is the docbrowser Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 05:23:24 2025 GMT+0.
docbrowser/docbrowser.asddocbrowser/template/template-package.lispdocbrowser/template/util.lispdocbrowser/template/template.lispdocbrowser/template/parser.lispdocbrowser/src/package.lispdocbrowser/src/misc.lispdocbrowser/src/server.lispdocbrowser/src/docbrowser.lispdocbrowser/src/search.lispdocbrowser/src/source-function.lispThe main system appears first, followed by any subsystem dependency.
docbrowserWeb-based Common Lisp documentation browser
Elias Martenson <lokedhs@gmail.com>
BSD
hunchentoot (system).
bordeaux-threads (system).
yacc (system).
parse-number (system).
babel (system).
closer-mop (system).
swank (system).
cl-json (system).
flexi-streams (system).
colorize (system).
split-sequence (system).
string-case (system).
alexandria (system).
Modules are listed depth-first from the system components tree.
docbrowser/templatedocbrowser (system).
template-package.lisp (file).
util.lisp (file).
template.lisp (file).
parser.lisp (file).
docbrowser/srctemplate (module).
docbrowser (system).
package.lisp (file).
misc.lisp (file).
server.lisp (file).
docbrowser.lisp (file).
search.lisp (file).
source-function.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
docbrowser/docbrowser.asddocbrowser/template/template-package.lispdocbrowser/template/util.lispdocbrowser/template/template.lispdocbrowser/template/parser.lispdocbrowser/src/package.lispdocbrowser/src/misc.lispdocbrowser/src/server.lispdocbrowser/src/docbrowser.lispdocbrowser/src/search.lispdocbrowser/src/source-function.lispdocbrowser/template/template-package.lisptemplate (module).
*compile-decl* (special variable).
docbrowser/template/util.lisptemplate-package.lisp (file).
template (module).
escape-string-all (function).
escape-string-minimal (function).
escape-string-minimal-plus-quotes (function).
*escape-char-p* (special variable).
escape-string (function).
docbrowser/template/template.lisputil.lisp (file).
template (module).
exec-template-file (function).
initialize-instance (method).
*cached-templates* (special variable).
*cached-templates-lock* (special variable).
exec-template-to-string (function).
parse-template-file (function).
parsed-file (class).
parsed-file-last-time-check (reader method).
(setf parsed-file-last-time-check) (writer method).
parsed-file-modified-date (reader method).
parsed-file-pathspec (reader method).
parsed-file-template (reader method).
docbrowser/template/parser.lisptemplate.lisp (file).
template (module).
*begin-code* (special variable).
*current-content* (special variable).
*end-code* (special variable).
parse-template (function).
template-error (condition).
template-error-column (reader method).
template-error-content (reader method).
template-error-content-index (reader method).
template-error-line (reader method).
template-error-message (reader method).
*actions* (special variable).
*current-line-num* (special variable).
*current-stream* (special variable).
*include-root-dir* (special variable).
*output-binary* (special variable).
*output-encoding* (special variable).
*subtemplate-list* (special variable).
*template-parser* (special variable).
debug-lexer (function).
debug-parser (function).
escape-string-slashes (function).
inner-parse-stream-to-form (function).
make-lexer-actions (macro).
make-lexer-actions-list (function).
make-stream-template-lexer (function).
parse-stream-to-form (function).
short-define-parser (macro).
signal-template-error (function).
string->symbol (function).
docbrowser/src/misc.lisppackage.lisp (file).
src (module).
assoc-cdr (function).
nice-princ-to-string (function).
prin1-to-string-with-package (function).
symbol-external-p (function).
docbrowser/src/server.lispmisc.lisp (file).
src (module).
acceptor-dispatch-request (method).
initialize-instance (method).
start-docserver (function).
stop-docserver (function).
%make-define-handler-fn-form (function).
*files-base-dir* (special variable).
*global-acceptor* (special variable).
*url-handlers* (special variable).
define-handler-fn (macro).
docbrowser-acceptor (class).
docbrowser-acceptor-files-dispatcher (reader method).
hunchentoot-stream-as-text (function).
show-template (function).
with-hunchentoot-stream (macro).
docbrowser/src/docbrowser.lispserver.lisp (file).
src (module).
%annotate-function-info (function).
%ensure-external (function).
%show-package-screen-show (function).
assoc-name (function).
find-superclasses (function).
format-argument-to-string (function).
load-accessor-info (function).
load-class-info (function).
load-function-info (function).
load-slots (function).
load-specialisation-info (function).
load-variable-info (function).
main-screen (function).
package-list-screen (function).
safe-class-for-symbol (function).
show-package-screen (function).
specialise->symbol (function).
docbrowser/src/search.lispdocbrowser.lisp (file).
src (module).
*maximum-search-results* (special variable).
define-json-handler-fn (macro).
find-matching-symbols (function).
process-json (function).
process-search-result (function).
search-command-screen (function).
search-screen (function).
docbrowser/src/source-function.lispsearch.lisp (file).
src (module).
escape-char (function).
format-source (function).
read-file-content (function).
source-function-screen (function).
style-from-type (function).
Packages are listed by definition order.
docbrowser-systemprivate: ASDF system package for Docbrowser.
asdf/interface.
common-lisp.
docbrowser-templatecommon-lisp.
*begin-code* (special variable).
*current-content* (special variable).
*end-code* (special variable).
escape-string-all (function).
escape-string-minimal (function).
escape-string-minimal-plus-quotes (function).
exec-template-file (function).
parse-template (function).
template-error (condition).
template-error-column (generic reader).
template-error-content (generic reader).
template-error-content-index (generic reader).
template-error-line (generic reader).
template-error-message (generic reader).
*actions* (special variable).
*cached-templates* (special variable).
*cached-templates-lock* (special variable).
*compile-decl* (special variable).
*current-line-num* (special variable).
*current-stream* (special variable).
*escape-char-p* (special variable).
*include-root-dir* (special variable).
*output-binary* (special variable).
*output-encoding* (special variable).
*subtemplate-list* (special variable).
*template-parser* (special variable).
debug-lexer (function).
debug-parser (function).
escape-string (function).
escape-string-slashes (function).
exec-template-to-string (function).
inner-parse-stream-to-form (function).
make-lexer-actions (macro).
make-lexer-actions-list (function).
make-stream-template-lexer (function).
parse-stream-to-form (function).
parse-template-file (function).
parsed-file (class).
parsed-file-last-time-check (generic reader).
(setf parsed-file-last-time-check) (generic writer).
parsed-file-modified-date (generic reader).
parsed-file-pathspec (generic reader).
parsed-file-template (generic reader).
short-define-parser (macro).
signal-template-error (function).
string->symbol (function).
docbrowserRuns a webserver that allows the user to browse and search information about the packages in the Lisp runtime, including functions, classes and variables.
common-lisp.
start-docserver (function).
stop-docserver (function).
%annotate-function-info (function).
%ensure-external (function).
%make-define-handler-fn-form (function).
%show-package-screen-show (function).
*files-base-dir* (special variable).
*global-acceptor* (special variable).
*maximum-search-results* (special variable).
*url-handlers* (special variable).
assoc-cdr (function).
assoc-name (function).
define-handler-fn (macro).
define-json-handler-fn (macro).
docbrowser-acceptor (class).
docbrowser-acceptor-files-dispatcher (generic reader).
escape-char (function).
find-matching-symbols (function).
find-superclasses (function).
format-argument-to-string (function).
format-source (function).
hunchentoot-stream-as-text (function).
load-accessor-info (function).
load-class-info (function).
load-function-info (function).
load-slots (function).
load-specialisation-info (function).
load-variable-info (function).
main-screen (function).
nice-princ-to-string (function).
package-list-screen (function).
prin1-to-string-with-package (function).
process-json (function).
process-search-result (function).
read-file-content (function).
safe-class-for-symbol (function).
search-command-screen (function).
search-screen (function).
show-package-screen (function).
show-template (function).
source-function-screen (function).
specialise->symbol (function).
style-from-type (function).
symbol-external-p (function).
with-hunchentoot-stream (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The string that opens a script segment. The end of a script segment is specified by *END-CODE*.
The string that ends a script segment.
Escapes all characters in STRING which aren’t in the 7-bit ASCII character set.
Escape only #<, #>, and #& in STRING.
Like ESCAPE-STRING-MINIMAL but also escapes quotes.
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.
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.
Start the documentation server with a HTTP listener on port PORT.
Stop the documentation server.
template-error)) ¶template-error)) ¶template-error)) ¶template-error)) ¶line.
template-error)) ¶docbrowser-acceptor) request) ¶hunchentoot.
parsed-file) &key &allow-other-keys) ¶docbrowser-acceptor) &key &allow-other-keys) ¶Error that is raised if there is an error parsing a template
error.
The line number where the error occurred.
(quote (error "~s required when creating ~s" :line (quote docbrowser-template:template-error)))
:line
This slot is read-only.
The column index of the line where the error occurred, if available. Otherwise NIL.
(quote nil)
:column
This slot is read-only.
The error message
(quote (error "~s required when creating ~s" :message (quote docbrowser-template:template-error)))
:message
This slot is read-only.
The actual template content where the error occurred. Either the entire line, or part of it.
(quote nil)
:content
This slot is read-only.
The position in content closest to the actual error, or NIL if the information is not available.
(quote nil)
:content-index
This slot is read-only.
Dynamic variable used to track the current line number during parsing
The stream that the template output is written to.
The acceptor for the currently running server.
The maximum number of search results returned.
A hash table keyed on the base URL that maps to the underlying handler function
Append :ACCESSORP tag if the function is present as an accessor function.
Return (CDR (ASSOC KEY DATA)). If ERROR-P is non-NIL, signal an error if KEY is not available is DATA.
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.
Handler for AJAX-calls to perform a search operation
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.
docbrowser-acceptor)) ¶List of fallback dispatchers
parsed-file)) ¶automatically generated reader method
parsed-file)) ¶automatically generated writer method
parsed-file)) ¶automatically generated reader method
parsed-file)) ¶automatically generated reader method
name.
parsed-file)) ¶automatically generated reader method
Acceptor for the documentation browser
acceptor.
List of fallback dispatchers
This slot is read-only.
Cached parse result
pathname
(error "name is a required parameter")
:name
This slot is read-only.
integer
This slot is read-only.
integer
function
(error "template is unset")
:template
This slot is read-only.
| Jump to: | %
(
A D E F G H I L M N P R S T W |
|---|
| Jump to: | %
(
A D E F G H I L M N P R S T W |
|---|
| Jump to: | *
C F L M N S T |
|---|
| Jump to: | *
C F L M N S T |
|---|
| Jump to: | C D F M P S T U |
|---|
| Jump to: | C D F M P S T U |
|---|