Common Lisp Package: CL-PDF-DOC

README:

FUNCTION

Private

GENERATE-HEADER

Page Header Code

GET-HEADER-FONT (SIZE)

Given a default size return the documents font size

Undocumented

APPENDIX-A

CHAPTER-1

CHAPTER-1-INSTALLATION

CHAPTER-2

CHAPTER-3

DEFINITION-TABLE (DEFINITION-LISTS)

DISPLAY-PARAMETERS

GENERATE-CL-PDF-DOCUMENTATION (&KEY (FILE /tmp/cl-pdf-doc.pdf))

TITLE-PAGE

MACRO

Private

BODY-TEXT (&BODY BODY)

Normal Body Text

CHAPTER ((TITLE &KEY (OUTLINE-NAME TITLE)) &BODY BODY)

Sets up a block of code that will represent a chapter in the documentation. Title - Is the title of the chapter Outline-name - is the pdf bookmark name Body - Chapter Contents

CODE-TEXT ((&OPTIONAL (TITLE Code Example)) &BODY BODY)

Verbatim Lisp code text

EMPHASIZE (&BODY BODY)

Place body test inline in italics

FUNCTION-DESCRIPTION ((NAME &KEY (TYPE function) (SPEC ()) (RETURN-VALUE nil) (ARGS NIL)) &BODY DESCRIPTION)

Macro to set up a macro or function description

HIGHLIGHT (&BODY BODY)

Place body text inline in bold

OUTLINE-HEADER ((HEADER-STRING &KEY (HEADER-SIZE 1) (OUTLINE-NAME HEADER-STRING)) &BODY BODY)

Header for the text that will be registered in the pdf bookmarks outline section

QUOTE-BLOCK (&BODY BODY)

Block of text which is set apart by font type and extra indentation

VARIABLE

Private

*DOC-MARGINS*

Margins used throughout document 72 = 1 inch or 0.5 in left and right, 1 in top and bottom

*DOC-PAPER-SIZE*

Options can be found in typesetting->top-level.lisp, and are currently :A3, :A4, :A5, :Letter :Legal