The qbook Reference Manual

Table of Contents

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

The qbook Reference Manual

This is the qbook Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:26:53 2018 GMT+0.


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

1 Introduction

-*- outline -*-


* The qbook lisp documentation system

qbook generates HTML (or LaTeX) formatted code listings of Common
Lisp source files. Comments in the source code are rendered as HTML
paragraphs, text is rendered in 
 blocks. Headings are
created by preceding the text of the comment with one or more #\*
chars.

This is inspired by Luke Gorrie's pbook.el.


* How to use it

qbook can be started directly from ASDF.

Be sure to have loaded the qbook system:

    (asdf:oos 'asdf:load-op 'qbook)

Assuming that your ASDF package is calle pkg, use the following
commands to create the documentation in

1) HTML format:

    (asdf:oos 'qbook:publish-op :pkg :generator
              (make-instance 'qbook:html-generator
                             :output-directory "/path/to/folder/"
                             :title "Documentation for pkg"))

2) LaTeX format:

    (asdf:oos 'qbook:publish-op :pkg :generator
              (make-instance 'qbook:latex-generator
                             :output-file "/path/to/file"
                             :title "Documentation for pkg"))



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 qbook

Dependencies
  • arnesi
  • iterate
  • cl-ppcre
  • yaclml
Source

qbook.asd (file)

Components

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

3 Modules

Modules are listed depth-first from the system components tree.


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

3.1 qbook/src

Parent

qbook (system)

Location

src/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 qbook.asd

Location

qbook.asd

Systems

qbook (system)

Packages

it.bese.qbook.system


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

4.1.2 qbook/src/code-analysis.lisp

Dependencies
Parent

src (module)

Location

src/code-analysis.lisp

Internal Definitions

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

4.1.3 qbook/src/html.lisp

Dependencies
Parent

src (module)

Location

src/html.lisp

Exported Definitions

html-generator (class)

Internal Definitions

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

4.1.4 qbook/src/stylesheets.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/stylesheets.lisp

Internal Definitions

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

4.1.5 qbook/src/latex.lisp

Dependencies
Parent

src (module)

Location

src/latex.lisp

Exported Definitions

latex-generator (class)

Internal Definitions

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

4.1.6 qbook/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

it.bese.qbook


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

4.1.7 qbook/src/publish-op.lisp

Dependencies
Parent

src (module)

Location

src/publish-op.lisp

Exported Definitions

publish-op (class)

Internal Definitions

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

4.1.8 qbook/src/qbook.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/qbook.lisp

Exported Definitions

publish-qbook (function)

Internal Definitions

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

4.2 Other


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

4.2.1 qbook/qbook.asd

Parent

qbook (system)

Location

qbook.asd


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

5 Packages

Packages are listed by definition order.


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

5.1 it.bese.qbook.system

ASDF System package for qbook.

Source

qbook.asd

Use List
  • asdf/interface
  • common-lisp

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

5.2 it.bese.qbook

Source

packages.lisp (file)

Nickname

qbook

Use List
  • it.bese.yaclml
  • cl-ppcre
  • iterate
  • it.bese.arnesi
  • common-lisp
Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Functions

Function: publish-qbook FILE-NAME GENERATOR

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

Package

it.bese.qbook

Source

qbook.lisp (file)


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

6.1.2 Classes

Class: html-generator ()
Package

it.bese.qbook

Source

html.lisp (file)

Direct superclasses

generator (class)

Direct methods
Direct slots
Slot: output-directory
Initargs

:output-directory

Readers

output-directory (generic function)

Writers

(setf output-directory) (generic function)

Class: latex-generator ()
Package

it.bese.qbook

Source

latex.lisp (file)

Direct superclasses

generator (class)

Direct methods
Direct slots
Slot: output-file
Initargs

:output-file

Readers

output-file (generic function)

Writers

(setf output-file) (generic function)

Slot: listings

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

Initargs

:listings

Readers

listings (generic function)

Writers

(setf listings) (generic function)

Class: publish-op ()
Package

it.bese.qbook

Source

publish-op.lisp (file)

Direct superclasses

operation (class)

Direct methods
  • operation-done-p (method)
  • perform (method)
  • perform (method)
  • input-files (method)
  • input-file (method)
  • input-file (method)
  • generator (method)
  • generator (method)
Direct slots
Slot: generator
Initargs

:generator

Readers

generator (generic function)

Writers

(setf generator) (generic function)

Slot: input-file
Initargs

:input-file

Readers

input-file (generic function)

Writers

(setf input-file) (generic function)


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

6.2 Internal definitions


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

6.2.1 Special variables

Special Variable: *book*
Package

it.bese.qbook

Source

html.lisp (file)

Special Variable: *code-info-collectors*
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Special Variable: *generator*
Package

it.bese.qbook

Source

html.lisp (file)

Special Variable: *known-elements*
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Special Variable: *latex-stream*
Package

it.bese.qbook

Source

latex.lisp (file)

Special Variable: *print.css*

The alternative (destined for hard copy) HTML stylesheet.

Package

it.bese.qbook

Source

stylesheets.lisp (file)

Special Variable: *style.css*

The default stylesheet for qbook generated html documentation.

Package

it.bese.qbook

Source

stylesheets.lisp (file)


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

6.2.2 Macros

Macro: <qbook-page &rest G0
Package

it.bese.qbook

Source

html.lisp (file)

Macro: defcode-info-collector OPERATOR ARGS &body BODY
Package

it.bese.qbook

Source

code-analysis.lisp (file)


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

6.2.3 Functions

Function: \command NAME &rest ARGS
Package

it.bese.qbook

Source

latex.lisp (file)

Function: analyse-code-part CODE-PART
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Function: bulid-indexes BOOK
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: collect-code-info PARTS
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: compare-descriptor-names A B
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: convert-to-sections FILE-NAME PARTS
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: defclass-descriptor FORM-0
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Function: defconstant-descriptor FORM-0
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Function: defgeneric-descriptor FORM-0
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Function: defmacro-descriptor FORM-0
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Function: defmethod-descriptor FORM-0
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Function: defparameter-descriptor FORM-0
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Function: defun-descriptor FORM-0
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Function: defvar-descriptor FORM-0
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Function: effective-name FUNCTION-NAME
Package

it.bese.qbook

Source

html.lisp (file)

Function: find-descriptor LABEL NAME
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Function: generate-index GENERATOR BOOK INDEX-CLASS
Package

it.bese.qbook

Source

html.lisp (file)

Function: generate-permuted-index GENERATOR BOOK
Package

it.bese.qbook

Source

html.lisp (file)

Function: generate-section SECTION GENERATOR
Package

it.bese.qbook

Source

html.lisp (file)

Function: generate-table-of-contents SECTIONS GENERATOR
Package

it.bese.qbook

Source

html.lisp (file)

Function: heading-text-p TEXT
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: make-part-reader FUNCTION TYPE
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: make-qbook-readtable ()
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: make-slot-descriptor SLOT-SPEC
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Function: num-lines TEXT
Package

it.bese.qbook

Source

html.lisp (file)

Function: post-process PARTS
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: post-process-navigation PARTS
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: process-directives PARTS
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: publish PARTS
Package

it.bese.qbook

Source

html.lisp (file)

Function: qbook-semicolon-reader STREAM CHAR
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: read-source-file FILE-NAME
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: read-whitespace STREAM
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: real-comment-p TEXT
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: register-descriptor DESCRIPTOR
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Function: sort-descriptors DESCRIPTORS
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: sort-parts-with-descriptors PARTS
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: subseq-first-sentence STRING LIMIT
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Function: whitespacep CHAR
Package

it.bese.qbook

Source

qbook.lisp (file)

Function: write-code PART STATE
Package

it.bese.qbook

Source

html.lisp (file)

Function: write-comment PART STATE
Package

it.bese.qbook

Source

html.lisp (file)

Function: write-latex-escaped STRING STREAM
Package

it.bese.qbook

Source

latex.lisp (file)


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

6.2.4 Generic functions

Generic Function: all-code-parts BOOK
Package

it.bese.qbook

Methods
Method: all-code-parts (BOOK book)
Source

qbook.lisp (file)

Generic Function: book-indexes-sorted BOOK
Package

it.bese.qbook

Methods
Method: book-indexes-sorted (BOOK book)
Source

qbook.lisp (file)

Generic Function: code-part-p OBJECT
Package

it.bese.qbook

Source

qbook.lisp (file)

Methods
Method: code-part-p OBJECT
Method: code-part-p (OBJECT code-part)
Generic Function: comment-part-p OBJ
Package

it.bese.qbook

Source

qbook.lisp (file)

Methods
Method: comment-part-p OBJ
Method: comment-part-p (OBJ comment-part)
Generic Function: contents OBJECT
Generic Function: (setf contents) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: contents (BOOK book)

automatically generated reader method

Source

qbook.lisp (file)

Method: (setf contents) NEW-VALUE (BOOK book)

automatically generated writer method

Source

qbook.lisp (file)

Generic Function: depth OBJECT
Generic Function: (setf depth) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: depth (HEADING-PART heading-part)

automatically generated reader method

Source

qbook.lisp (file)

Method: (setf depth) NEW-VALUE (HEADING-PART heading-part)

automatically generated writer method

Source

qbook.lisp (file)

Generic Function: descriptor OBJECT
Generic Function: (setf descriptor) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: descriptor (CODE-PART code-part)

automatically generated reader method

Source

qbook.lisp (file)

Method: (setf descriptor) NEW-VALUE (CODE-PART code-part)

automatically generated writer method

Source

qbook.lisp (file)

Generic Function: docstring OBJECT
Generic Function: (setf docstring) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: docstring (DESCRIPTOR descriptor)

automatically generated reader method

Source

code-analysis.lisp (file)

Method: (setf docstring) NEW-VALUE (DESCRIPTOR descriptor)

automatically generated writer method

Source

code-analysis.lisp (file)

Generic Function: 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.

Package

it.bese.qbook

Source

code-analysis.lisp (file)

Methods
Method: docstring-first-sentence (DESCRIPTOR descriptor) &optional LIMIT
Generic Function: end-position OBJECT
Generic Function: (setf end-position) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: end-position (SOURCE-FILE-PART source-file-part)

automatically generated reader method

Source

qbook.lisp (file)

Method: (setf end-position) NEW-VALUE (SOURCE-FILE-PART source-file-part)

automatically generated writer method

Source

qbook.lisp (file)

Generic Function: generate-part PART GENERATOR
Package

it.bese.qbook

Source

latex.lisp (file)

Methods
Method: generate-part (PART comment-part) (GENERATOR latex-generator)
Method: generate-part (PART heading-part) (GENERATOR latex-generator)
Method: generate-part (PART whitespace-part) (GENERATOR latex-generator)
Method: generate-part (PART code-part) (GENERATOR latex-generator)
Generic Function: generator OBJECT
Generic Function: (setf generator) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: generator (PUBLISH-OP publish-op)

automatically generated reader method

Source

publish-op.lisp (file)

Method: (setf generator) NEW-VALUE (PUBLISH-OP publish-op)

automatically generated writer method

Source

publish-op.lisp (file)

Generic Function: heading-part-p OBJ
Package

it.bese.qbook

Source

qbook.lisp (file)

Methods
Method: heading-part-p OBJ
Method: heading-part-p (OBJ heading-part)
Generic Function: html-name DESCRIPTOR
Package

it.bese.qbook

Methods
Method: html-name (DESCRIPTOR defmethod-descriptor)
Source

html.lisp (file)

Method: html-name (DESCRIPTOR descriptor)
Source

html.lisp (file)

Generic Function: indexes OBJECT
Generic Function: (setf indexes) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: indexes (BOOK book)

automatically generated reader method

Source

qbook.lisp (file)

Method: (setf indexes) NEW-VALUE (BOOK book)

automatically generated writer method

Source

qbook.lisp (file)

Generic Function: input-file OBJECT
Generic Function: (setf input-file) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: input-file (PUBLISH-OP publish-op)

automatically generated reader method

Source

publish-op.lisp (file)

Method: (setf input-file) NEW-VALUE (PUBLISH-OP publish-op)

automatically generated writer method

Source

publish-op.lisp (file)

Generic Function: input-files OP SYSTEM
Package

it.bese.qbook

Methods
Method: input-files (OP publish-op) (SYSTEM system)
Source

publish-op.lisp (file)

Generic Function: label-prefix OBJECT
Generic Function: (setf label-prefix) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: label-prefix (DESCRIPTOR descriptor)

automatically generated reader method

Source

code-analysis.lisp (file)

Method: (setf label-prefix) NEW-VALUE (DESCRIPTOR descriptor)

automatically generated writer method

Source

code-analysis.lisp (file)

Generic Function: lambda-list OBJECT
Generic Function: (setf lambda-list) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: lambda-list (DEFUN-DESCRIPTOR defun-descriptor)

automatically generated reader method

Source

code-analysis.lisp (file)

Method: (setf lambda-list) NEW-VALUE (DEFUN-DESCRIPTOR defun-descriptor)

automatically generated writer method

Source

code-analysis.lisp (file)

Generic Function: listings OBJECT
Generic Function: (setf listings) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: listings (LATEX-GENERATOR latex-generator)
Method: (setf listings) NEW-VALUE (LATEX-GENERATOR latex-generator)

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

Source

latex.lisp (file)

Generic Function: make-anchor-link H
Package

it.bese.qbook

Methods
Method: make-anchor-link (D descriptor)
Source

html.lisp (file)

Method: make-anchor-link (H heading-part)
Source

html.lisp (file)

Generic Function: make-anchor-name TEXT
Package

it.bese.qbook

Methods
Method: make-anchor-name (METHOD-DESCRIPTOR defmethod-descriptor)
Source

html.lisp (file)

Method: make-anchor-name (DESCRIPTOR descriptor)
Source

html.lisp (file)

Method: make-anchor-name (TEXT string)
Source

html.lisp (file)

Generic Function: next-part OBJECT
Generic Function: (setf next-part) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: next-part (HEADING-PART heading-part)

automatically generated reader method

Source

qbook.lisp (file)

Method: (setf next-part) NEW-VALUE (HEADING-PART heading-part)

automatically generated writer method

Source

qbook.lisp (file)

Generic Function: origin-file OBJECT
Generic Function: (setf origin-file) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: origin-file (SOURCE-FILE-PART source-file-part)

automatically generated reader method

Source

qbook.lisp (file)

Method: (setf origin-file) NEW-VALUE (SOURCE-FILE-PART source-file-part)

automatically generated writer method

Source

qbook.lisp (file)

Generic Function: output-directory OBJECT
Generic Function: (setf output-directory) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: output-directory (HTML-GENERATOR html-generator)

automatically generated reader method

Source

html.lisp (file)

Method: (setf output-directory) NEW-VALUE (HTML-GENERATOR html-generator)

automatically generated writer method

Source

html.lisp (file)

Generic Function: output-file OBJECT
Generic Function: (setf output-file) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: output-file (LATEX-GENERATOR latex-generator)

automatically generated reader method

Source

latex.lisp (file)

Method: (setf output-file) NEW-VALUE (LATEX-GENERATOR latex-generator)

automatically generated writer method

Source

latex.lisp (file)

Method: output-file (SOURCE-FILE-PART source-file-part)

automatically generated reader method

Source

qbook.lisp (file)

Method: (setf output-file) NEW-VALUE (SOURCE-FILE-PART source-file-part)

automatically generated writer method

Source

qbook.lisp (file)

Generic Function: permutated-global-index BOOK
Package

it.bese.qbook

Methods
Method: permutated-global-index (BOOK book)
Source

qbook.lisp (file)

Generic Function: pretty-label-prefix OBJECT
Generic Function: (setf pretty-label-prefix) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: pretty-label-prefix (DESCRIPTOR descriptor)

automatically generated reader method

Source

code-analysis.lisp (file)

Method: (setf pretty-label-prefix) NEW-VALUE (DESCRIPTOR descriptor)

automatically generated writer method

Source

code-analysis.lisp (file)

Generic Function: prev-part OBJECT
Generic Function: (setf prev-part) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: prev-part (HEADING-PART heading-part)

automatically generated reader method

Source

qbook.lisp (file)

Method: (setf prev-part) NEW-VALUE (HEADING-PART heading-part)

automatically generated writer method

Source

qbook.lisp (file)

Generic Function: process-directive PART
Package

it.bese.qbook

Source

qbook.lisp (file)

Methods
Method: process-directive (PART comment-part)
Method: process-directive (PART source-file-part)
Generic Function: qualifier OBJECT
Generic Function: (setf qualifier) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: qualifier (DEFMETHOD-DESCRIPTOR defmethod-descriptor)

automatically generated reader method

Source

code-analysis.lisp (file)

Method: (setf qualifier) NEW-VALUE (DEFMETHOD-DESCRIPTOR defmethod-descriptor)

automatically generated writer method

Source

code-analysis.lisp (file)

Generic Function: slots OBJECT
Generic Function: (setf slots) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: slots (DEFCLASS-DESCRIPTOR defclass-descriptor)

automatically generated reader method

Source

code-analysis.lisp (file)

Method: (setf slots) NEW-VALUE (DEFCLASS-DESCRIPTOR defclass-descriptor)

automatically generated writer method

Source

code-analysis.lisp (file)

Generic Function: start-position OBJECT
Generic Function: (setf start-position) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: start-position (SOURCE-FILE-PART source-file-part)

automatically generated reader method

Source

qbook.lisp (file)

Method: (setf start-position) NEW-VALUE (SOURCE-FILE-PART source-file-part)

automatically generated writer method

Source

qbook.lisp (file)

Generic Function: supers OBJECT
Generic Function: (setf supers) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: supers (DEFCLASS-DESCRIPTOR defclass-descriptor)

automatically generated reader method

Source

code-analysis.lisp (file)

Method: (setf supers) NEW-VALUE (DEFCLASS-DESCRIPTOR defclass-descriptor)

automatically generated writer method

Source

code-analysis.lisp (file)

Generic Function: text OBJECT
Generic Function: (setf text) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: text (SOURCE-FILE-PART source-file-part)

automatically generated reader method

Source

qbook.lisp (file)

Method: (setf text) NEW-VALUE (SOURCE-FILE-PART source-file-part)

automatically generated writer method

Source

qbook.lisp (file)

Generic Function: title OBJECT
Generic Function: (setf title) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: title (BOOK book)
Method: (setf title) NEW-VALUE (BOOK book)

The title of the book.

Source

qbook.lisp (file)

Method: title (GENERATOR generator)

automatically generated reader method

Source

qbook.lisp (file)

Method: (setf title) NEW-VALUE (GENERATOR generator)

automatically generated writer method

Source

qbook.lisp (file)

Generic Function: up-part OBJECT
Generic Function: (setf up-part) NEW-VALUE OBJECT
Package

it.bese.qbook

Methods
Method: up-part (HEADING-PART heading-part)

automatically generated reader method

Source

qbook.lisp (file)

Method: (setf up-part) NEW-VALUE (HEADING-PART heading-part)

automatically generated writer method

Source

qbook.lisp (file)

Generic Function: write-code-descriptor DESCRIPTOR PART
Package

it.bese.qbook

Source

html.lisp (file)

Methods
Method: write-code-descriptor (DESCRIPTOR defclass-descriptor) PART
Method: write-code-descriptor (DESCRIPTOR descriptor) PART
Method: write-code-descriptor (DESCRIPTOR descriptor) PART around
Method: write-code-descriptor DESCRIPTOR PART

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

6.2.5 Classes

Class: book ()
Package

it.bese.qbook

Source

qbook.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: title

The title of the book.

Initargs

:title

Readers

title (generic function)

Writers

(setf title) (generic function)

Slot: contents
Initargs

:contents

Readers

contents (generic function)

Writers

(setf contents) (generic function)

Slot: indexes
Initargs

:indexes

Initform

(make-hash-table :test (quote eq))

Readers

indexes (generic function)

Writers

(setf indexes) (generic function)

Class: class-slot-descriptor ()
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Direct superclasses

descriptor (class)

Class: code-part ()
Package

it.bese.qbook

Source

qbook.lisp (file)

Direct superclasses

source-file-part (class)

Direct methods
Direct slots
Slot: form
Initargs

:form

Readers

form (generic function)

Writers

(setf form) (generic function)

Slot: descriptor
Initargs

:descriptor

Readers

descriptor (generic function)

Writers

(setf descriptor) (generic function)

Class: comment-part ()
Package

it.bese.qbook

Source

qbook.lisp (file)

Direct superclasses

source-file-part (class)

Direct subclasses

heading-part (class)

Direct methods
Class: defclass-descriptor ()
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Direct superclasses

descriptor (class)

Direct methods
Direct slots
Slot: slots
Initargs

:slots

Initform

(quote nil)

Readers

slots (generic function)

Writers

(setf slots) (generic function)

Slot: supers
Initargs

:supers

Initform

(quote nil)

Readers

supers (generic function)

Writers

(setf supers) (generic function)

Direct Default Initargs
InitargValue
:label-prefix"class"
:pretty-label-prefix"class"
Class: defconstant-descriptor ()
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Direct superclasses

global-variable-descriptor (class)

Direct Default Initargs
InitargValue
:label-prefix"constant"
:pretty-label-prefix"constant"
Class: defgeneric-descriptor ()
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Direct superclasses

defun-descriptor (class)

Direct Default Initargs
InitargValue
:label-prefix"generic function"
:pretty-label-prefix"generic function"
Class: defmacro-descriptor ()
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Direct superclasses

defun-descriptor (class)

Direct Default Initargs
InitargValue
:label-prefix"macro"
:pretty-label-prefix"macro"
Class: defmethod-descriptor ()
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Direct superclasses

defun-descriptor (class)

Direct methods
Direct slots
Slot: qualifier
Initargs

:qualifier

Readers

qualifier (generic function)

Writers

(setf qualifier) (generic function)

Direct Default Initargs
InitargValue
:label-prefix"method"
:pretty-label-prefix"method"
Class: defun-descriptor ()
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Direct superclasses

descriptor (class)

Direct subclasses
Direct methods
  • body (method)
  • body (method)
  • lambda-list (method)
  • lambda-list (method)
Direct slots
Slot: lambda-list
Initargs

:lambda-list

Readers

lambda-list (generic function)

Writers

(setf lambda-list) (generic function)

Slot: body
Initargs

:body

Readers

body (generic function)

Writers

(setf body) (generic function)

Direct Default Initargs
InitargValue
:label-prefix"function"
:pretty-label-prefix"function"
Class: descriptor ()
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: docstring
Initargs

:docstring

Readers

docstring (generic function)

Writers

(setf docstring) (generic function)

Slot: label-prefix
Initargs

:label-prefix

Readers

label-prefix (generic function)

Writers

(setf label-prefix) (generic function)

Slot: pretty-label-prefix
Initargs

:pretty-label-prefix

Readers

pretty-label-prefix (generic function)

Writers

(setf pretty-label-prefix) (generic function)

Class: generator ()
Package

it.bese.qbook

Source

qbook.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
  • title (method)
  • title (method)
Direct slots
Slot: title
Initargs

:title

Readers

title (generic function)

Writers

(setf title) (generic function)

Class: global-variable-descriptor ()
Package

it.bese.qbook

Source

code-analysis.lisp (file)

Direct superclasses

descriptor (class)

Direct subclasses

defconstant-descriptor (class)

Direct Default Initargs
InitargValue
:label-prefix"variable"
:pretty-label-prefix"variable"
Class: heading-part ()
Package

it.bese.qbook

Source

qbook.lisp (file)

Direct superclasses

comment-part (class)

Direct methods
Direct slots
Slot: depth
Initargs

:depth

Readers

depth (generic function)

Writers

(setf depth) (generic function)

Slot: next-part
Readers

next-part (generic function)

Writers

(setf next-part) (generic function)

Slot: prev-part
Readers

prev-part (generic function)

Writers

(setf prev-part) (generic function)

Slot: up-part
Readers

up-part (generic function)

Writers

(setf up-part) (generic function)

Class: source-file-part ()
Package

it.bese.qbook

Source

qbook.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: start-position
Initargs

:start-position

Readers

start-position (generic function)

Writers

(setf start-position) (generic function)

Slot: end-position
Initargs

:end-position

Readers

end-position (generic function)

Writers

(setf end-position) (generic function)

Slot: text
Initargs

:text

Readers

text (generic function)

Writers

(setf text) (generic function)

Slot: origin-file
Initargs

:origin-file

Readers

origin-file (generic function)

Writers

(setf origin-file) (generic function)

Slot: output-file
Readers

output-file (generic function)

Writers

(setf output-file) (generic function)

Class: whitespace-part ()
Package

it.bese.qbook

Source

qbook.lisp (file)

Direct superclasses

source-file-part (class)

Direct methods

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   O   Q  
Index Entry  Section

F
File, Lisp, qbook.asd: The qbook<dot>asd file
File, Lisp, qbook/src/code-analysis.lisp: The qbook/src/code-analysis<dot>lisp file
File, Lisp, qbook/src/html.lisp: The qbook/src/html<dot>lisp file
File, Lisp, qbook/src/latex.lisp: The qbook/src/latex<dot>lisp file
File, Lisp, qbook/src/packages.lisp: The qbook/src/packages<dot>lisp file
File, Lisp, qbook/src/publish-op.lisp: The qbook/src/publish-op<dot>lisp file
File, Lisp, qbook/src/qbook.lisp: The qbook/src/qbook<dot>lisp file
File, Lisp, qbook/src/stylesheets.lisp: The qbook/src/stylesheets<dot>lisp file
File, other, qbook/qbook.asd: The qbook/qbook<dot>asd file

L
Lisp File, qbook.asd: The qbook<dot>asd file
Lisp File, qbook/src/code-analysis.lisp: The qbook/src/code-analysis<dot>lisp file
Lisp File, qbook/src/html.lisp: The qbook/src/html<dot>lisp file
Lisp File, qbook/src/latex.lisp: The qbook/src/latex<dot>lisp file
Lisp File, qbook/src/packages.lisp: The qbook/src/packages<dot>lisp file
Lisp File, qbook/src/publish-op.lisp: The qbook/src/publish-op<dot>lisp file
Lisp File, qbook/src/qbook.lisp: The qbook/src/qbook<dot>lisp file
Lisp File, qbook/src/stylesheets.lisp: The qbook/src/stylesheets<dot>lisp file

M
Module, qbook/src: The qbook/src module

O
Other File, qbook/qbook.asd: The qbook/qbook<dot>asd file

Q
qbook.asd: The qbook<dot>asd file
qbook/qbook.asd: The qbook/qbook<dot>asd file
qbook/src: The qbook/src module
qbook/src/code-analysis.lisp: The qbook/src/code-analysis<dot>lisp file
qbook/src/html.lisp: The qbook/src/html<dot>lisp file
qbook/src/latex.lisp: The qbook/src/latex<dot>lisp file
qbook/src/packages.lisp: The qbook/src/packages<dot>lisp file
qbook/src/publish-op.lisp: The qbook/src/publish-op<dot>lisp file
qbook/src/qbook.lisp: The qbook/src/qbook<dot>lisp file
qbook/src/stylesheets.lisp: The qbook/src/stylesheets<dot>lisp file

Jump to:   F   L   M   O   Q  

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

A.2 Functions

Jump to:   (   <   \  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   Q   R   S   T   U   W  
Index Entry  Section

(
(setf contents): Internal generic functions
(setf contents): Internal generic functions
(setf depth): Internal generic functions
(setf depth): Internal generic functions
(setf descriptor): Internal generic functions
(setf descriptor): Internal generic functions
(setf docstring): Internal generic functions
(setf docstring): Internal generic functions
(setf end-position): Internal generic functions
(setf end-position): Internal generic functions
(setf generator): Internal generic functions
(setf generator): Internal generic functions
(setf indexes): Internal generic functions
(setf indexes): Internal generic functions
(setf input-file): Internal generic functions
(setf input-file): Internal generic functions
(setf label-prefix): Internal generic functions
(setf label-prefix): Internal generic functions
(setf lambda-list): Internal generic functions
(setf lambda-list): Internal generic functions
(setf listings): Internal generic functions
(setf listings): Internal generic functions
(setf next-part): Internal generic functions
(setf next-part): Internal generic functions
(setf origin-file): Internal generic functions
(setf origin-file): Internal generic functions
(setf output-directory): Internal generic functions
(setf output-directory): Internal generic functions
(setf output-file): Internal generic functions
(setf output-file): Internal generic functions
(setf output-file): Internal generic functions
(setf pretty-label-prefix): Internal generic functions
(setf pretty-label-prefix): Internal generic functions
(setf prev-part): Internal generic functions
(setf prev-part): Internal generic functions
(setf qualifier): Internal generic functions
(setf qualifier): Internal generic functions
(setf slots): Internal generic functions
(setf slots): Internal generic functions
(setf start-position): Internal generic functions
(setf start-position): Internal generic functions
(setf supers): Internal generic functions
(setf supers): Internal generic functions
(setf text): Internal generic functions
(setf text): Internal generic functions
(setf title): Internal generic functions
(setf title): Internal generic functions
(setf title): Internal generic functions
(setf up-part): Internal generic functions
(setf up-part): Internal generic functions

<
<qbook-page: Internal macros

\
\command: Internal functions

A
all-code-parts: Internal generic functions
all-code-parts: Internal generic functions
analyse-code-part: Internal functions

B
book-indexes-sorted: Internal generic functions
book-indexes-sorted: Internal generic functions
bulid-indexes: Internal functions

C
code-part-p: Internal generic functions
code-part-p: Internal generic functions
code-part-p: Internal generic functions
collect-code-info: Internal functions
comment-part-p: Internal generic functions
comment-part-p: Internal generic functions
comment-part-p: Internal generic functions
compare-descriptor-names: Internal functions
contents: Internal generic functions
contents: Internal generic functions
convert-to-sections: Internal functions

D
defclass-descriptor: Internal functions
defcode-info-collector: Internal macros
defconstant-descriptor: Internal functions
defgeneric-descriptor: Internal functions
defmacro-descriptor: Internal functions
defmethod-descriptor: Internal functions
defparameter-descriptor: Internal functions
defun-descriptor: Internal functions
defvar-descriptor: Internal functions
depth: Internal generic functions
depth: Internal generic functions
descriptor: Internal generic functions
descriptor: Internal generic functions
docstring: Internal generic functions
docstring: Internal generic functions
docstring-first-sentence: Internal generic functions
docstring-first-sentence: Internal generic functions

E
effective-name: Internal functions
end-position: Internal generic functions
end-position: Internal generic functions

F
find-descriptor: Internal functions
Function, analyse-code-part: Internal functions
Function, bulid-indexes: Internal functions
Function, collect-code-info: Internal functions
Function, compare-descriptor-names: Internal functions
Function, convert-to-sections: Internal functions
Function, defclass-descriptor: Internal functions
Function, defconstant-descriptor: Internal functions
Function, defgeneric-descriptor: Internal functions
Function, defmacro-descriptor: Internal functions
Function, defmethod-descriptor: Internal functions
Function, defparameter-descriptor: Internal functions
Function, defun-descriptor: Internal functions
Function, defvar-descriptor: Internal functions
Function, effective-name: Internal functions
Function, find-descriptor: Internal functions
Function, generate-index: Internal functions
Function, generate-permuted-index: Internal functions
Function, generate-section: Internal functions
Function, generate-table-of-contents: Internal functions
Function, heading-text-p: Internal functions
Function, make-part-reader: Internal functions
Function, make-qbook-readtable: Internal functions
Function, make-slot-descriptor: Internal functions
Function, num-lines: Internal functions
Function, post-process: Internal functions
Function, post-process-navigation: Internal functions
Function, process-directives: Internal functions
Function, publish: Internal functions
Function, publish-qbook: Exported functions
Function, qbook-semicolon-reader: Internal functions
Function, read-source-file: Internal functions
Function, read-whitespace: Internal functions
Function, real-comment-p: Internal functions
Function, register-descriptor: Internal functions
Function, sort-descriptors: Internal functions
Function, sort-parts-with-descriptors: Internal functions
Function, subseq-first-sentence: Internal functions
Function, whitespacep: Internal functions
Function, write-code: Internal functions
Function, write-comment: Internal functions
Function, write-latex-escaped: Internal functions
Function, \command: Internal functions

G
generate-index: Internal functions
generate-part: Internal generic functions
generate-part: Internal generic functions
generate-part: Internal generic functions
generate-part: Internal generic functions
generate-part: Internal generic functions
generate-permuted-index: Internal functions
generate-section: Internal functions
generate-table-of-contents: Internal functions
generator: Internal generic functions
generator: Internal generic functions
Generic Function, (setf contents): Internal generic functions
Generic Function, (setf depth): Internal generic functions
Generic Function, (setf descriptor): Internal generic functions
Generic Function, (setf docstring): Internal generic functions
Generic Function, (setf end-position): Internal generic functions
Generic Function, (setf generator): Internal generic functions
Generic Function, (setf indexes): Internal generic functions
Generic Function, (setf input-file): Internal generic functions
Generic Function, (setf label-prefix): Internal generic functions
Generic Function, (setf lambda-list): Internal generic functions
Generic Function, (setf listings): Internal generic functions
Generic Function, (setf next-part): Internal generic functions
Generic Function, (setf origin-file): Internal generic functions
Generic Function, (setf output-directory): Internal generic functions
Generic Function, (setf output-file): Internal generic functions
Generic Function, (setf pretty-label-prefix): Internal generic functions
Generic Function, (setf prev-part): Internal generic functions
Generic Function, (setf qualifier): Internal generic functions
Generic Function, (setf slots): Internal generic functions
Generic Function, (setf start-position): Internal generic functions
Generic Function, (setf supers): Internal generic functions
Generic Function, (setf text): Internal generic functions
Generic Function, (setf title): Internal generic functions
Generic Function, (setf up-part): Internal generic functions
Generic Function, all-code-parts: Internal generic functions
Generic Function, book-indexes-sorted: Internal generic functions
Generic Function, code-part-p: Internal generic functions
Generic Function, comment-part-p: Internal generic functions
Generic Function, contents: Internal generic functions
Generic Function, depth: Internal generic functions
Generic Function, descriptor: Internal generic functions
Generic Function, docstring: Internal generic functions
Generic Function, docstring-first-sentence: Internal generic functions
Generic Function, end-position: Internal generic functions
Generic Function, generate-part: Internal generic functions
Generic Function, generator: Internal generic functions
Generic Function, heading-part-p: Internal generic functions
Generic Function, html-name: Internal generic functions
Generic Function, indexes: Internal generic functions
Generic Function, input-file: Internal generic functions
Generic Function, input-files: Internal generic functions
Generic Function, label-prefix: Internal generic functions
Generic Function, lambda-list: Internal generic functions
Generic Function, listings: Internal generic functions
Generic Function, make-anchor-link: Internal generic functions
Generic Function, make-anchor-name: Internal generic functions
Generic Function, next-part: Internal generic functions
Generic Function, origin-file: Internal generic functions
Generic Function, output-directory: Internal generic functions
Generic Function, output-file: Internal generic functions
Generic Function, permutated-global-index: Internal generic functions
Generic Function, pretty-label-prefix: Internal generic functions
Generic Function, prev-part: Internal generic functions
Generic Function, process-directive: Internal generic functions
Generic Function, qualifier: Internal generic functions
Generic Function, slots: Internal generic functions
Generic Function, start-position: Internal generic functions
Generic Function, supers: Internal generic functions
Generic Function, text: Internal generic functions
Generic Function, title: Internal generic functions
Generic Function, up-part: Internal generic functions
Generic Function, write-code-descriptor: Internal generic functions

H
heading-part-p: Internal generic functions
heading-part-p: Internal generic functions
heading-part-p: Internal generic functions
heading-text-p: Internal functions
html-name: Internal generic functions
html-name: Internal generic functions
html-name: Internal generic functions

I
indexes: Internal generic functions
indexes: Internal generic functions
input-file: Internal generic functions
input-file: Internal generic functions
input-files: Internal generic functions
input-files: Internal generic functions

L
label-prefix: Internal generic functions
label-prefix: Internal generic functions
lambda-list: Internal generic functions
lambda-list: Internal generic functions
listings: Internal generic functions
listings: Internal generic functions

M
Macro, <qbook-page: Internal macros
Macro, defcode-info-collector: Internal macros
make-anchor-link: Internal generic functions
make-anchor-link: Internal generic functions
make-anchor-link: Internal generic functions
make-anchor-name: Internal generic functions
make-anchor-name: Internal generic functions
make-anchor-name: Internal generic functions
make-anchor-name: Internal generic functions
make-part-reader: Internal functions
make-qbook-readtable: Internal functions
make-slot-descriptor: Internal functions
Method, (setf contents): Internal generic functions
Method, (setf depth): Internal generic functions
Method, (setf descriptor): Internal generic functions
Method, (setf docstring): Internal generic functions
Method, (setf end-position): Internal generic functions
Method, (setf generator): Internal generic functions
Method, (setf indexes): Internal generic functions
Method, (setf input-file): Internal generic functions
Method, (setf label-prefix): Internal generic functions
Method, (setf lambda-list): Internal generic functions
Method, (setf listings): Internal generic functions
Method, (setf next-part): Internal generic functions
Method, (setf origin-file): Internal generic functions
Method, (setf output-directory): Internal generic functions
Method, (setf output-file): Internal generic functions
Method, (setf output-file): Internal generic functions
Method, (setf pretty-label-prefix): Internal generic functions
Method, (setf prev-part): Internal generic functions
Method, (setf qualifier): Internal generic functions
Method, (setf slots): Internal generic functions
Method, (setf start-position): Internal generic functions
Method, (setf supers): Internal generic functions
Method, (setf text): Internal generic functions
Method, (setf title): Internal generic functions
Method, (setf title): Internal generic functions
Method, (setf up-part): Internal generic functions
Method, all-code-parts: Internal generic functions
Method, book-indexes-sorted: Internal generic functions
Method, code-part-p: Internal generic functions
Method, code-part-p: Internal generic functions
Method, comment-part-p: Internal generic functions
Method, comment-part-p: Internal generic functions
Method, contents: Internal generic functions
Method, depth: Internal generic functions
Method, descriptor: Internal generic functions
Method, docstring: Internal generic functions
Method, docstring-first-sentence: Internal generic functions
Method, end-position: Internal generic functions
Method, generate-part: Internal generic functions
Method, generate-part: Internal generic functions
Method, generate-part: Internal generic functions
Method, generate-part: Internal generic functions
Method, generator: Internal generic functions
Method, heading-part-p: Internal generic functions
Method, heading-part-p: Internal generic functions
Method, html-name: Internal generic functions
Method, html-name: Internal generic functions
Method, indexes: Internal generic functions
Method, input-file: Internal generic functions
Method, input-files: Internal generic functions
Method, label-prefix: Internal generic functions
Method, lambda-list: Internal generic functions
Method, listings: Internal generic functions
Method, make-anchor-link: Internal generic functions
Method, make-anchor-link: Internal generic functions
Method, make-anchor-name: Internal generic functions
Method, make-anchor-name: Internal generic functions
Method, make-anchor-name: Internal generic functions
Method, next-part: Internal generic functions
Method, origin-file: Internal generic functions
Method, output-directory: Internal generic functions
Method, output-file: Internal generic functions
Method, output-file: Internal generic functions
Method, permutated-global-index: Internal generic functions
Method, pretty-label-prefix: Internal generic functions
Method, prev-part: Internal generic functions
Method, process-directive: Internal generic functions
Method, process-directive: Internal generic functions
Method, qualifier: Internal generic functions
Method, slots: Internal generic functions
Method, start-position: Internal generic functions
Method, supers: Internal generic functions
Method, text: Internal generic functions
Method, title: Internal generic functions
Method, title: Internal generic functions
Method, up-part: Internal generic functions
Method, write-code-descriptor: Internal generic functions
Method, write-code-descriptor: Internal generic functions
Method, write-code-descriptor: Internal generic functions
Method, write-code-descriptor: Internal generic functions

N
next-part: Internal generic functions
next-part: Internal generic functions
num-lines: Internal functions

O
origin-file: Internal generic functions
origin-file: Internal generic functions
output-directory: Internal generic functions
output-directory: Internal generic functions
output-file: Internal generic functions
output-file: Internal generic functions
output-file: Internal generic functions

P
permutated-global-index: Internal generic functions
permutated-global-index: Internal generic functions
post-process: Internal functions
post-process-navigation: Internal functions
pretty-label-prefix: Internal generic functions
pretty-label-prefix: Internal generic functions
prev-part: Internal generic functions
prev-part: Internal generic functions
process-directive: Internal generic functions
process-directive: Internal generic functions
process-directive: Internal generic functions
process-directives: Internal functions
publish: Internal functions
publish-qbook: Exported functions

Q
qbook-semicolon-reader: Internal functions
qualifier: Internal generic functions
qualifier: Internal generic functions

R
read-source-file: Internal functions
read-whitespace: Internal functions
real-comment-p: Internal functions
register-descriptor: Internal functions

S
slots: Internal generic functions
slots: Internal generic functions
sort-descriptors: Internal functions
sort-parts-with-descriptors: Internal functions
start-position: Internal generic functions
start-position: Internal generic functions
subseq-first-sentence: Internal functions
supers: Internal generic functions
supers: Internal generic functions

T
text: Internal generic functions
text: Internal generic functions
title: Internal generic functions
title: Internal generic functions
title: Internal generic functions

U
up-part: Internal generic functions
up-part: Internal generic functions

W
whitespacep: Internal functions
write-code: Internal functions
write-code-descriptor: Internal generic functions
write-code-descriptor: Internal generic functions
write-code-descriptor: Internal generic functions
write-code-descriptor: Internal generic functions
write-code-descriptor: Internal generic functions
write-comment: Internal functions
write-latex-escaped: Internal functions

Jump to:   (   <   \  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   Q   R   S   T   U   W  

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

A.3 Variables

Jump to:   *  
B   C   D   E   F   G   I   L   N   O   P   Q   S   T   U  
Index Entry  Section

*
*book*: Internal special variables
*code-info-collectors*: Internal special variables
*generator*: Internal special variables
*known-elements*: Internal special variables
*latex-stream*: Internal special variables
*print.css*: Internal special variables
*style.css*: Internal special variables

B
body: Internal classes

C
contents: Internal classes

D
depth: Internal classes
descriptor: Internal classes
docstring: Internal classes

E
end-position: Internal classes

F
form: Internal classes

G
generator: Exported classes

I
indexes: Internal classes
input-file: Exported classes

L
label-prefix: Internal classes
lambda-list: Internal classes
listings: Exported classes

N
name: Internal classes
next-part: Internal classes

O
origin-file: Internal classes
output-directory: Exported classes
output-file: Exported classes
output-file: Internal classes

P
pretty-label-prefix: Internal classes
prev-part: Internal classes

Q
qualifier: Internal classes

S
Slot, body: Internal classes
Slot, contents: Internal classes
Slot, depth: Internal classes
Slot, descriptor: Internal classes
Slot, docstring: Internal classes
Slot, end-position: Internal classes
Slot, form: Internal classes
Slot, generator: Exported classes
Slot, indexes: Internal classes
Slot, input-file: Exported classes
Slot, label-prefix: Internal classes
Slot, lambda-list: Internal classes
Slot, listings: Exported classes
Slot, name: Internal classes
Slot, next-part: Internal classes
Slot, origin-file: Internal classes
Slot, output-directory: Exported classes
Slot, output-file: Exported classes
Slot, output-file: Internal classes
Slot, pretty-label-prefix: Internal classes
Slot, prev-part: Internal classes
Slot, qualifier: Internal classes
Slot, slots: Internal classes
Slot, start-position: Internal classes
Slot, supers: Internal classes
Slot, text: Internal classes
Slot, title: Internal classes
Slot, title: Internal classes
Slot, up-part: Internal classes
slots: Internal classes
Special Variable, *book*: Internal special variables
Special Variable, *code-info-collectors*: Internal special variables
Special Variable, *generator*: Internal special variables
Special Variable, *known-elements*: Internal special variables
Special Variable, *latex-stream*: Internal special variables
Special Variable, *print.css*: Internal special variables
Special Variable, *style.css*: Internal special variables
start-position: Internal classes
supers: Internal classes

T
text: Internal classes
title: Internal classes
title: Internal classes

U
up-part: Internal classes

Jump to:   *  
B   C   D   E   F   G   I   L   N   O   P   Q   S   T   U  

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

A.4 Data types

Jump to:   B   C   D   G   H   I   L   P   Q   S   W  
Index Entry  Section

B
book: Internal classes

C
Class, book: Internal classes
Class, class-slot-descriptor: Internal classes
Class, code-part: Internal classes
Class, comment-part: Internal classes
Class, defclass-descriptor: Internal classes
Class, defconstant-descriptor: Internal classes
Class, defgeneric-descriptor: Internal classes
Class, defmacro-descriptor: Internal classes
Class, defmethod-descriptor: Internal classes
Class, defun-descriptor: Internal classes
Class, descriptor: Internal classes
Class, generator: Internal classes
Class, global-variable-descriptor: Internal classes
Class, heading-part: Internal classes
Class, html-generator: Exported classes
Class, latex-generator: Exported classes
Class, publish-op: Exported classes
Class, source-file-part: Internal classes
Class, whitespace-part: Internal classes
class-slot-descriptor: Internal classes
code-part: Internal classes
comment-part: Internal classes

D
defclass-descriptor: Internal classes
defconstant-descriptor: Internal classes
defgeneric-descriptor: Internal classes
defmacro-descriptor: Internal classes
defmethod-descriptor: Internal classes
defun-descriptor: Internal classes
descriptor: Internal classes

G
generator: Internal classes
global-variable-descriptor: Internal classes

H
heading-part: Internal classes
html-generator: Exported classes

I
it.bese.qbook: The it<dot>bese<dot>qbook package
it.bese.qbook.system: The it<dot>bese<dot>qbook<dot>system package

L
latex-generator: Exported classes

P
Package, it.bese.qbook: The it<dot>bese<dot>qbook package
Package, it.bese.qbook.system: The it<dot>bese<dot>qbook<dot>system package
publish-op: Exported classes

Q
qbook: The qbook system

S
source-file-part: Internal classes
System, qbook: The qbook system

W
whitespace-part: Internal classes

Jump to:   B   C   D   G   H   I   L   P   Q   S   W