Commit 54b47589 authored by Francois-Rene Rideau's avatar Francois-Rene Rideau

Update UIOP README

Quickref now includes a good UIOP reference manual, as extracted by Declt.
parent cd6a4cf4
......@@ -113,23 +113,24 @@ Other automated tools may hopefully extract all that information and
make a webpage from it, at which point it would be nice to insert a link here.
But many tools fail to extract useful data.
One tool with which you can extract all the documentation is HEΛP.
At this time, the interface is not great: it isn't obvious at all that you can indeed
use a scrollbar on the right of the top left side panel to navigate the many packages;
once you click on the package you're interested in, you can see its defined symbols:
<http://bimib.disco.unimib.it/people/Marco.Antoniotti/Projects/CL/HELAMBDAP/tests/asdf-uiop/docs/html/dictionary/dictionary.html>
The next version of [Declt](https://www.lrde.epita.fr/~didier/software/lisp/misc.php#declt)
and through it of QuickRef will support extracting the documentation from UIOP:
<https://quickref.common-lisp.net/>
Tools with which you can extract all the documentation include
[Declt](https://www.lrde.epita.fr/~didier/software/lisp/misc.php#declt)
and [HEΛP](http://helambdap.sourceforge.net/).
See the Quickref UIOP reference manual <https://quickref.common-lisp.net/uiop.html>
as extracted by Declt.
There is also a pre-extracted HEΛP documentation page
<http://bimib.disco.unimib.it/people/Marco.Antoniotti/Projects/CL/HELAMBDAP/tests/asdf-uiop/docs/html/dictionary/dictionary.html>.
Note however that the HEΛP interface is not very usable at this time:
it isn't obvious at all that you can indeed use a scrollbar
on the right of the top left side panel to navigate the many packages;
once you click on the package you're interested in, you can see its defined symbols.
Another automated documentation tool is quickdocs, but unhappily, at the time of this writing,
it only extracts information from the first package
(see [bug #24](https://github.com/fukamachi/quickdocs/issues/24)):
<http://quickdocs.org/uiop/api>
Help wanted extracting working documentation from UIOP's docstrings.
Using UIOP
----------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment