Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the docbrowser Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:27:23 2022 GMT+0.
Next: Systems, Previous: The docbrowser Reference Manual, Up: The docbrowser Reference Manual [Contents][Index]
Elias Mårtenson
The latest version of Docbrowser can be found at Github:
https://github.com/lokedhs/docbrowser
The application has been tested on SBCL, CCL and CLISP. Please let me know of any issues on other Common Lisp implementations.
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 with an optional :port argument.
To access the docbrowser, point a web browser to http://localhost:8080/
The main page presents a list of all the available packages. You can click on one to see its functions and variables, with their docstrings. You can also go to a function's source.
Next: Modules, Previous: Introduction, Up: The docbrowser Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Web-based Common Lisp documentation browser
Elias Martenson <lokedhs@gmail.com>
BSD
Next: Files, Previous: Systems, Up: The docbrowser Reference Manual [Contents][Index]
Modules are listed depth-first from the system components tree.
Next: docbrowser/src, Previous: Modules, Up: Modules [Contents][Index]
docbrowser (system).
Previous: docbrowser/template, Up: Modules [Contents][Index]
template (module).
docbrowser (system).
Next: Packages, Previous: Modules, Up: The docbrowser Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: docbrowser/template/template-package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
docbrowser (system).
Next: docbrowser/template/util.lisp, Previous: docbrowser/docbrowser.asd, Up: Lisp [Contents][Index]
template (module).
*compile-decl* (special variable).
Next: docbrowser/template/template.lisp, Previous: docbrowser/template/template-package.lisp, Up: Lisp [Contents][Index]
template-package.lisp (file).
template (module).
Next: docbrowser/template/parser.lisp, Previous: docbrowser/template/util.lisp, Up: Lisp [Contents][Index]
util.lisp (file).
template (module).
Next: docbrowser/src/package.lisp, Previous: docbrowser/template/template.lisp, Up: Lisp [Contents][Index]
template.lisp (file).
template (module).
Next: docbrowser/src/misc.lisp, Previous: docbrowser/template/parser.lisp, Up: Lisp [Contents][Index]
src (module).
Next: docbrowser/src/server.lisp, Previous: docbrowser/src/package.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
src (module).
Next: docbrowser/src/docbrowser.lisp, Previous: docbrowser/src/misc.lisp, Up: Lisp [Contents][Index]
misc.lisp (file).
src (module).
Next: docbrowser/src/search.lisp, Previous: docbrowser/src/server.lisp, Up: Lisp [Contents][Index]
server.lisp (file).
src (module).
Next: docbrowser/src/source-function.lisp, Previous: docbrowser/src/docbrowser.lisp, Up: Lisp [Contents][Index]
docbrowser.lisp (file).
src (module).
Previous: docbrowser/src/search.lisp, Up: Lisp [Contents][Index]
search.lisp (file).
src (module).
Next: Definitions, Previous: Files, Up: The docbrowser Reference Manual [Contents][Index]
Packages are listed by definition order.
Next: docbrowser-empty, Previous: Packages, Up: Packages [Contents][Index]
Next: docbrowser-template, Previous: template-parse, Up: Packages [Contents][Index]
Empty package that is used internally by Docbrowser
Next: docbrowser-system, Previous: docbrowser-empty, Up: Packages [Contents][Index]
common-lisp.
Next: docbrowser, Previous: docbrowser-template, Up: Packages [Contents][Index]
private: ASDF system package for Docbrowser.
Previous: docbrowser-system, Up: Packages [Contents][Index]
Runs 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.
Next: Indexes, Previous: Packages, Up: The docbrowser Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
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.
Next: Generic functions, Previous: Special variables, Up: Public Interface [Contents][Index]
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.
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
line.
Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]
hunchentoot.
Previous: Standalone methods, Up: Public Interface [Contents][Index]
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.
Previous: Public Interface, Up: Definitions [Contents][Index]
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
Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]
Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]
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.
Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]
List of fallback dispatchers
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated reader method
name.
automatically generated reader method
Previous: Generic functions, Up: Internals [Contents][Index]
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.
Previous: Definitions, Up: The docbrowser Reference Manual [Contents][Index]
| 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 |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
| 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 |
|---|