DOCUMENTATION-TEMPLATE - Prepare HTML documentation for Common Lisp libraries


 

Abstract

This is a quick hack which helps to build HTML pages that look like this one or like the one you're currently looking at. It hasn't been tested thoroughly, it isn't properly documented, it only works with LispWorks, SBCL, and AllegroCL, and it most likely doesn't do what you expect.

The code comes with a BSD-style license so you can basically do with it whatever you want.

Download shortcut: http://weitz.de/files/documentation-template.tar.gz.


 

Contents

  1. Download
  2. The DOCUMENTATION-TEMPLATE dictionary
    1. create-template
    2. *target*
    3. *maybe-skip-methods-p*
  3. Acknowledgements

 

Download

DOCUMENTATION-TEMPLATE together with this documentation can be downloaded from http://weitz.de/files/documentation-template.tar.gz. The current version is 0.4.3.

If you want to send patches, please read this first.
 

The DOCUMENTATION-TEMPLATE dictionary

The following symbols are exported:


[Function]
create-template package &key target maybe-skip-methods-p subtitle if-exists if-does-not-exist => result


Writes an HTML page with preliminary documentation entries and an index for all exported symbols of the package package to the file target. If maybe-skip-methods-p is true, documentation entries for inidividual methods are skipped if the corresponding generic function has a documentation string


[Special variable]
*target*


Where to output the HTML page. If this value is not NIL, it will be the default target for CREATE-TEMPLATE. CREATE-TEMPLATE will also set this value.


[Special variable]
*maybe-skip-methods-p*


This is the default value for the :MAYBE-SKIP-METHODS-P keyword argument of CREATE-TEMPLATE and its initial value is NIL.

 

Acknowledgements

This documentation was prepared with, you guessed it, DOCUMENTATION-TEMPLATE. Thanks to Michael Weber for the SBCL patches and to Willem Broekema for the AllegroCL patches.

$Header: /usr/local/cvsrep/documentation-template/doc/index.html,v 1.14 2013-01-11 13:45:31 edi Exp $

BACK TO MY HOMEPAGE