mirror of
git://git.code.sf.net/p/sbcl/sbcl
synced 2026-09-10 07:26:40 -04:00
4271a2f375
Summary
-------
Implement of a subset of PAX so that we can write PAX:DEFSECTIONlike
forms that supports the same restricted Markdown that we use for
docstrings and generate doc/manual/*.texinfo files from them.
Without PAX
-----------
There is no hard dependency on PAX. When the new SB-MANUAL contrib is
loaded, one can M-. around in documentation (sections are variables),
and function docstrings can now link to sections.
The generated Texinfo files are quite close to the originals, with
some loss of "semantic" markup: e.g. Markdown has `FOO` but no
@var{FOO} and @code{FOO}. We didn't derive much practical benefit from
that distinction.
With PAX
--------
(SB-MANUAL::SWITCH-TO-PAX) ensures that PAX is loaded and patches things
up, as if everything had been defined with PAX to begin with. Now, we
get PAX::@BROWSING-LIVE-DOCUMENTATION for low-latency, interactive
documentation work and PAX::@GENERATING-DOCUMENTATION for auto-linked
documentation.
Notable features:
- auto-generated links within the manual: if SB-EXT:EXIT is mentioned,
then it's linked to its documentation.
- auto-generated links to the CLHS (these links are red in PDF)
- locatives (e.g. the "[function]" in "- [function] SB-EXT:EXIT" are
also links and they go to the sources on GitHub (in live browsing,
they tell Slime to open the definition)
Details
-------
- Factor out the Markdown-to-Texinfo code into a new SB-MANUAL
contrib.
- Convert doc/manual/*.texinfo files to PAXlike DEFSECTION format and
add each chapter as a contrib/sb-manual/doc/<chapter>.lisp file.
- Fix a *lot* of small issues during the conversion.
- Make doc/make-doc.sh regenerate the all .texinfo files except
sbcl.texinfo and backmatter.texinfo.
- Fix docstrings of Lisp definitions used in the manual to conform to
the supported Markdown syntax.
- Retain the Texinfo function, variable and type indicies but drop the
concept index. There is no obvious way to support that in Markdown,
and it was used rather sporadically rather incomplete.
- Even with the new features, the amount of Lisp code didn't change
significantly.
- See contrib/sb-manual/README for the Todo list
32 lines
1.5 KiB
Plaintext
32 lines
1.5 KiB
Plaintext
This directory is for extensions to SBCL. They aren't necessary for
|
|
core SBCL functionality, or else they'd be built into the main SBCL
|
|
binary automatically. And they're not portable Common Lisp, or they'd
|
|
be put elsewhere (see http://sbcl.sf.net/libs.php for pointers)
|
|
|
|
There are two kinds of contrib modules in this directory:
|
|
|
|
* Newer contrib modules conform to the contrib standard (see
|
|
STANDARDS) and are automatically built and installed along with
|
|
SBCL itself. Each of these is in its own subdirectory with a
|
|
Makefile, and can be loaded with REQUIRE.
|
|
|
|
* Older standalone files in the contrib directory itself are
|
|
effectively unpackaged and may or may not work with the current
|
|
SBCL version.
|
|
|
|
Some good candidates for future extensions here are:
|
|
* bindings to existing foreign libraries (e.g. to a regexp library
|
|
like PCRE, or to a compression library like zlib, or to a graphics
|
|
library like Tk)
|
|
* new libraries (e.g. a CORBA interface)
|
|
* low-level hooks into SBCL needed to interface it to some wrapper
|
|
system (e.g. to interface to a graphical debugger of some sort)
|
|
* a too-alpha-to-be-supported-yet tree shaker
|
|
|
|
SBCL extensions of less general interest, e.g. a binding to the C
|
|
interface of the Oracle RDBMS, or particularly large extensions, e.g.
|
|
big graphics frameworks, can also be associated with the SBCL project,
|
|
but instead of being included in this directory as part of the
|
|
distribution, they will be made available or linked to on the SBCL
|
|
project web site.
|