Common Lisp Package: IT.BESE.QBOOK

README:

FUNCTION

Public

PUBLISH-QBOOK (FILE-NAME GENERATOR)

Convert FILE-NAME into a qbook html file named OUTPUT-FILE with title TITLE.

Private

Undocumented

\COMMAND (NAME &REST ARGS)

ANALYSE-CODE-PART (CODE-PART)

BULID-INDEXES (BOOK)

COLLECT-CODE-INFO (PARTS)

COMPARE-DESCRIPTOR-NAMES (A B)

CONVERT-TO-SECTIONS (FILE-NAME PARTS)

DEFCLASS-DESCRIPTOR (FORM-144)

DEFCONSTANT-DESCRIPTOR (FORM-276)

DEFGENERIC-DESCRIPTOR (FORM-217)

DEFMACRO-DESCRIPTOR (FORM-122)

DEFMETHOD-DESCRIPTOR (FORM-250)

DEFPARAMETER-DESCRIPTOR (FORM-202)

DEFUN-DESCRIPTOR (FORM-100)

DEFVAR-DESCRIPTOR (FORM-191)

EFFECTIVE-NAME (FUNCTION-NAME)

FIND-DESCRIPTOR (LABEL NAME)

GENERATE-INDEX (GENERATOR BOOK INDEX-CLASS)

GENERATE-PERMUTED-INDEX (GENERATOR BOOK)

GENERATE-SECTION (SECTION GENERATOR)

GENERATE-TABLE-OF-CONTENTS (SECTIONS GENERATOR)

HEADING-TEXT-P (TEXT)

MAKE-PART-READER (FUNCTION TYPE)

MAKE-QBOOK-READTABLE

MAKE-SLOT-DESCRIPTOR (SLOT-SPEC)

NUM-LINES (TEXT)

POST-PROCESS (PARTS)

POST-PROCESS-NAVIGATION (PARTS)

PROCESS-DIRECTIVES (PARTS)

PUBLISH (PARTS)

QBOOK-SEMICOLON-READER (STREAM CHAR)

READ-SOURCE-FILE (FILE-NAME)

READ-WHITESPACE (STREAM)

REAL-COMMENT-P (TEXT)

REGISTER-DESCRIPTOR (DESCRIPTOR)

SORT-DESCRIPTORS (DESCRIPTORS)

SORT-PARTS-WITH-DESCRIPTORS (PARTS)

SUBSEQ-FIRST-SENTENCE (STRING LIMIT)

WHITESPACEP (CHAR)

WRITE-CODE (PART STATE)

WRITE-COMMENT (PART STATE)

WRITE-LATEX-ESCAPED (STRING STREAM)

MACRO

Private

Undocumented

<QBOOK-PAGE (&REST G17)

DEFCODE-INFO-COLLECTOR (OPERATOR ARGS &BODY BODY)

GENERIC-FUNCTION

Private

DOCSTRING-FIRST-SENTENCE (DESCRIPTOR &OPTIONAL LIMIT)

Returns the first sentence of DESCRIPTOR's docstring. Returns at most LIMIT characters (if the first sentence is longer than LIMIT characters it will be simply truncated. If DESCRIPTOR's docstring is NIL this function returns nil.

Undocumented

ALL-CODE-PARTS (BOOK)

BOOK-INDEXES-SORTED (BOOK)

CODE-PART-P (OBJECT)

COMMENT-PART-P (OBJ)

GENERATE-PART (PART GENERATOR)

HEADING-PART-P (OBJ)

HTML-NAME (DESCRIPTOR)

INPUT-FILES (OP SYSTEM)

MAKE-ANCHOR-NAME (TEXT)

PERMUTATED-GLOBAL-INDEX (BOOK)

PROCESS-DIRECTIVE (PART)

WRITE-CODE-DESCRIPTOR (DESCRIPTOR PART)

SLOT-ACCESSOR

Private

LISTINGS (OBJECT)

When non-NIL, generate listings with LaTeX listings package. When string, push \ltset{this string} in the preamble.

SETFLISTINGS (NEW-VALUE OBJECT)

When non-NIL, generate listings with LaTeX listings package. When string, push \ltset{this string} in the preamble.

TITLE (OBJECT)

The title of the book.

SETFTITLE (NEW-VALUE OBJECT)

The title of the book.

Undocumented

CONTENTS (OBJECT)

SETFCONTENTS (NEW-VALUE OBJECT)

DEPTH (OBJECT)

SETFDEPTH (NEW-VALUE OBJECT)

DESCRIPTOR (OBJECT)

SETFDESCRIPTOR (NEW-VALUE OBJECT)

DOCSTRING (OBJECT)

SETFDOCSTRING (NEW-VALUE OBJECT)

END-POSITION (OBJECT)

SETFEND-POSITION (NEW-VALUE OBJECT)

GENERATOR (OBJECT)

SETFGENERATOR (NEW-VALUE OBJECT)

INDEXES (OBJECT)

SETFINDEXES (NEW-VALUE OBJECT)

INPUT-FILE (OBJECT)

SETFINPUT-FILE (NEW-VALUE OBJECT)

LABEL-PREFIX (OBJECT)

SETFLABEL-PREFIX (NEW-VALUE OBJECT)

LAMBDA-LIST (OBJECT)

SETFLAMBDA-LIST (NEW-VALUE OBJECT)

NEXT-PART (OBJECT)

SETFNEXT-PART (NEW-VALUE OBJECT)

ORIGIN-FILE (OBJECT)

SETFORIGIN-FILE (NEW-VALUE OBJECT)

OUTPUT-DIRECTORY (OBJECT)

SETFOUTPUT-DIRECTORY (NEW-VALUE OBJECT)

OUTPUT-FILE (OBJECT)

SETFOUTPUT-FILE (NEW-VALUE OBJECT)

PRETTY-LABEL-PREFIX (OBJECT)

SETFPRETTY-LABEL-PREFIX (NEW-VALUE OBJECT)

PREV-PART (OBJECT)

SETFPREV-PART (NEW-VALUE OBJECT)

QUALIFIER (OBJECT)

SETFQUALIFIER (NEW-VALUE OBJECT)

SLOTS (OBJECT)

SETFSLOTS (NEW-VALUE OBJECT)

START-POSITION (OBJECT)

SETFSTART-POSITION (NEW-VALUE OBJECT)

SUPERS (OBJECT)

SETFSUPERS (NEW-VALUE OBJECT)

TEXT (OBJECT)

SETFTEXT (NEW-VALUE OBJECT)

UP-PART (OBJECT)

SETFUP-PART (NEW-VALUE OBJECT)

VARIABLE

Private

*PRINT.CSS*

The alternative (destined for hard copy) HTML stylesheet.

*STYLE.CSS*

The default stylesheet for qbook generated html documentation.

Undocumented

*CODE-INFO-COLLECTORS*

*KNOWN-ELEMENTS*

CLASS

Public

Undocumented

HTML-GENERATOR

LATEX-GENERATOR

PUBLISH-OP

Private

Undocumented

BOOK

CLASS-SLOT-DESCRIPTOR

CODE-PART

COMMENT-PART

DEFCLASS-DESCRIPTOR (FORM-144)

DEFCONSTANT-DESCRIPTOR (FORM-276)

DEFGENERIC-DESCRIPTOR (FORM-217)

DEFMACRO-DESCRIPTOR (FORM-122)

DEFMETHOD-DESCRIPTOR (FORM-250)

DEFUN-DESCRIPTOR (FORM-100)

DESCRIPTOR (OBJECT)

GENERATOR (OBJECT)

GLOBAL-VARIABLE-DESCRIPTOR

HEADING-PART

SOURCE-FILE-PART

WHITESPACE-PART