The hyperspec Reference Manual

Table of Contents

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

The hyperspec Reference Manual

This is the hyperspec Reference Manual, version 0.1.1, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Fri May 24 09:05:20 2019 GMT+0.


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

1 Introduction

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: ``_.


.. _hyperspec: http://www.lispworks.com/documentation/HyperSpec/Front/index.htm

.. rubric:: Footnotes
.. [#sly-hyperspec] sly's `hyperspec.el `_
.. [#slime-hyperspec] slime's `hyperspec.el `_


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 hyperspec

Author

Matt Novenstern

License

LLGPLv3+

Description

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

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

Source

hyperspec.asd (file)

Component

hyperspec.lisp (file)


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

3 Files

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


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

3.1 Lisp


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

3.1.1 hyperspec.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/hyperspec-20181210-git/hyperspec.asd

Systems

hyperspec (system)


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

3.1.2 hyperspec/hyperspec.lisp

Parent

hyperspec (system)

Location

hyperspec.lisp

Packages

hyperspec

Exported Definitions

lookup (function)

Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 hyperspec

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

Source

hyperspec.lisp (file)

Use List
Exported Definitions

lookup (function)

Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 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 (file)


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

5.2 Internal definitions


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

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 (file)

Special Variable: *symbols*

Maps symbol names to relative urls in the hyperspec.

Package

hyperspec

Source

hyperspec.lisp (file)


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

5.2.2 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 (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   H   L  
Index Entry  Section

F
File, Lisp, hyperspec.asd: The hyperspec<dot>asd file
File, Lisp, hyperspec/hyperspec.lisp: The hyperspec/hyperspec<dot>lisp file

H
hyperspec.asd: The hyperspec<dot>asd file
hyperspec/hyperspec.lisp: The hyperspec/hyperspec<dot>lisp file

L
Lisp File, hyperspec.asd: The hyperspec<dot>asd file
Lisp File, hyperspec/hyperspec.lisp: The hyperspec/hyperspec<dot>lisp file

Jump to:   F   H   L  

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

A.2 Functions

Jump to:   C   F   L  
Index Entry  Section

C
clean-symbol: Internal functions

F
Function, clean-symbol: Internal functions
Function, lookup: Exported functions

L
lookup: Exported functions

Jump to:   C   F   L  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*hyperspec-root*: Internal special variables
*symbols*: Internal special variables

S
Special Variable, *hyperspec-root*: Internal special variables
Special Variable, *symbols*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   H   P   S  
Index Entry  Section

H
hyperspec: The hyperspec system
hyperspec: The hyperspec package

P
Package, hyperspec: The hyperspec package

S
System, hyperspec: The hyperspec system

Jump to:   H   P   S