The hyperspec Reference Manual

This is the hyperspec Reference Manual, version 0.1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 05:31:21 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 hyperspec

A simple library for looking up common-lisp symbols in the hyperspec.

Author

Matt Novenstern

License

LLGPLv3+

Long Description

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>‘_

Version

0.1.1

Dependency

alexandria (system).

Source

hyperspec.asd.

Child Component

hyperspec.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 hyperspec/hyperspec.asd

Source

hyperspec.asd.

Parent Component

hyperspec (system).

ASDF Systems

hyperspec.


3.1.2 hyperspec/hyperspec.lisp

Source

hyperspec.asd.

Parent Component

hyperspec (system).

Packages

hyperspec.

Public Interface

lookup (function).

Internals

4 Packages

Packages are listed by definition order.


4.1 hyperspec

Package for looking up hyperspec urls by symbol. The only exposed function is :function:‘hyperspec:lookup‘.

Source

hyperspec.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface

lookup (function).

Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: lookup (symbol)

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.

Package

hyperspec.

Source

hyperspec.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *hyperspec-root*

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/“.

Package

hyperspec.

Source

hyperspec.lisp.

Special Variable: *symbols*

Maps symbol names to relative urls in the hyperspec.

Package

hyperspec.

Source

hyperspec.lisp.


5.2.2 Ordinary functions

Function: clean-symbol (symbol)

Takes a symbol or string and returns a downcased string of the symbol if it’s in the common-lisp package.

Package

hyperspec.

Source

hyperspec.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions