This is the hyperspec Reference Manual, version 0.1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 06:27:04 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
hyperspecA simple library for looking up common-lisp symbols in the hyperspec.
Matt Novenstern
LLGPLv3+
A simple library for looking up common-lisp symbols in the ‘hyperspec‘_.
The only exported symbol is :function:‘hyperspec:lookup‘. It takes a symbol or string and returns a url or nil if none is found.
The library is based on the implementations of this functionality in sly [#sly-hyperspec]_ and slime [#slime-hyperspec]_ .
Documentation: ‘<https://fisxoj.github.io/hyperspec>‘_.
.. _hyperspec: http://www.lispworks.com/documentation/HyperSpec/Front/index.htm
.. rubric:: Footnotes
.. [#sly-hyperspec] sly’s ‘hyperspec.el <https://github.com/joaotavora/sly/blob/master/lib/hyperspec.el>‘_
.. [#slime-hyperspec] slime’s ‘hyperspec.el <https://github.com/slime/slime/blob/master/lib/hyperspec.el>‘_
0.1.1
alexandria (system).
hyperspec.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
hyperspec/hyperspec.lisphyperspec (system).
lookup (function).
*hyperspec-root* (special variable).
*symbols* (special variable).
clean-symbol (function).
Packages are listed by definition order.
hyperspecPackage for looking up hyperspec urls by symbol. The only exposed function is :function:‘hyperspec:lookup‘.
alexandria.
common-lisp.
lookup (function).
*hyperspec-root* (special variable).
*symbols* (special variable).
clean-symbol (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Look up a symbol in the COMMON-LISP package and return a url to the appropriate hyperspec page. Returns “nil“ if the symbol isn’t found.
The root of the Common Lisp HyperSpec URL.
If you copy the HyperSpec to your local system, set this variable to
something like “file://usr/local/doc/HyperSpec/“.
Maps symbol names to relative urls in the hyperspec.
Takes a symbol or string and returns a downcased string of the symbol if it’s in the common-lisp package.
| Jump to: | C F L |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| C | |||
clean-symbol: | Private ordinary functions | ||
| | |||
| F | |||
Function, clean-symbol: | Private ordinary functions | ||
Function, lookup: | Public ordinary functions | ||
| | |||
| L | |||
lookup: | Public ordinary functions | ||
| | |||
| Jump to: | C F L |
|---|
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
| Jump to: | F H P S |
|---|
| Jump to: | F H P S |
|---|