| Setting | Description |
| ("albert"
"use-temporary-files") | Should Albert
use temporary files for intermediate results. This requires you
to compile the accompanying xml2sexp parser. If this value is
NIL, no intermediate files will be used and you
will go directly from source to docbook outpur. Default is
NIL (might change). |
| ("system" "name") | Name of system being
documented. Taken from (asdf:defsystem :name ...) |
| ("system" "author" "name") | Name of system author. Taken from (asdf:defsystem :author ...) |
| ("system" "author" "email") | The system author's
email-address. Default is "". |
| ("system" "date") | Date to be put in e.g
book-headers/front-page. If this value is NIL it
will make a date-string from the day the docs were generated on,
e.g like 12 Jul 2003. Default is NIL |
| ("system" "maintainer" "name") | Name of
system-maintainer, in case it is separate from author. Taken from (asdf:defsystem :maintainer ...) |
| ("system" "licence") | Licence of the system. Taken from (asdf:defsystem :licence ...) |
| ("system" "licencefile") | Filename to the
licencefile that should be inluded verbatim as legal notice in
the API docs. Default is NIL. See also
%generate-legalnotice-link% in
data/albert.dsl on whether to present file verbatim in
docs or on a separate page. |
| ("system" "version" "number") | Version number for
the system, can be a string. Licence of the system. Taken from (asdf:defsystem :version ...) |
| ("system" "description") | Description of the
system. Taken from (asdf:defsystem :description
...) |
| ("system" "directory") | The path where
the system-files can be loaded from and which output should be
relative to. Will be calculated automatically, but a setting in
the asdf-file will override this. Default is "". |
| ("albert" "verbose") | Should Albert be verbose?
(Good for tracking problems) Default is NIL. |
| ("albert" "lisp2csf"
"display-progress") | Should the Albert
Lisp-reader display how it is progressing, good for tracking
which file has problems. Default is NIL. |
| ("albert" "presentation" "formats") | List of output
formats to generate. Default is ("docbook"). |
| ("albert" "presentation" "output-dir") | The
output-directory for any presentations. Default is "Generated-Docs/" |
| ("albert" "presentation" "language") | Language used
in presentation. Default is "english". |
| ("albert" "docbook" "baseurl") | The base URL used
when calculating URLs to other documentation pages. Default is "". |
| ("albert" "docbook" "bgcolor") | Background colour of
docs. Default is "white". |
| ("albert" "docbook" "textcolor") | Colour of
text. Default is "black". |
| ("albert" "docbook" "generate") | What docbook style
to use. Default is "book". |
| ("albert" "docbook" "dtd") | The DTD the output
should be verified against. Default is "/usr/lib/sgml/dtd/docbook-xml/4.1.2/docbookx.dtd" |
| ("albert" "docbook" "output-dir") | The output
directory for the docbook presentation. If not given, or set to
NIL, it uses the ("albert" "presentation"
"output-dir") setting. |
| ("albert" "docbook"
"cvs-viewurl") | URL for a CVS-view
program that can display a file. Default is
"". |
| ("albert" "docbook"
"cvs-tag") | Tag used when accessing
cvsview packages. Default value is "HEAD" and for
CVS, it refers to the latest version. |
| ("hyperspec" "root") | The URL root which should be
used when linking in the hyperspec. Default is "http://www.lispworks.com/reference/HyperSpec/Body/". |
| Setting | Description |
| ("albert" "presentation" "index" "global-index") |
Should a global index of symbols be generated in the index
section? Default is T.
|
| ("albert" "presentation" "index" "class-hierarchy") |
Should a class-index/hierarchy be generated in the index section?
If the value is T, a class-hierarchy will be generated if there
are classes or structs. If the value is an integer, that is the
number of classes needed before a hierarchy is printed. Default is 8.
|
| ("albert" "presentation" "class" "related-methods") |
Should a list of 'related methods' (ie methods that dispatch on that class)
in the class description be included. Still has issues and is fairly slow. Might later become default. Default is NIL.
|
| ("albert" "presentation" "class" "quickindex") |
Default number of entries in a class before a quickindex is
generated for the class. Default is 100.
|
| ("albert" "presentation" "gf" "separatepage")
|
How many methods does a generic function need to get a separate
page? Default is 2.
|
| ("albert" "presentation" "variables" "separatepage")
|
How many variables in a package 'full listing' is needed to make a
separate page in the generated docs for variables. Default is 5.
|
| ("albert" "presentation" "only-exported")
|
Will only exported methods and variables be presented in the API
docs? Default is NIL.
|
| ("albert" "presentation" "funcallable" "calls")
|
Will funcallable objects (functions, methods, ..) present a list
of whom it calls/is calling? Default is T.
|
| ("albert" "presentation" "funcallable" "calls-num")
|
How many objects are needed in the CALLS-list before it uses a
table to display it, instead of a sentence? Default is 12.
|
| ("albert" "presentation" "funcallable" "calledby") |
Will funcallable objects (functions, methods, ..) present a list
(based on other methods' "calls" info) of who calls/is calling it?
Default is NIL.
|
| ("albert" "lisp2csf" "accessors" "class") |
If this is positive, accessors/readers/writers for slots will be included in the info for a
class, which is usually where you would look for it. Default is T.
|
| ("albert" "lisp2csf" "accessors" "package") |
If this is positive, accessors/readers/writers for slots will be
added to the package content list, which might be useful if you
want all methods in one list. This will also help GF grouping
slightly. However, the package content-list is already long and
fairly cluttered so the default is NIL.
|
| ("albert" "presentation" "trace-rules") |
Albert uses presentation rules and sometimes it is interesting to
trace them. If you want tracing, set this setting to T.
Default is NIL.
|
| ("albert" "presentation" "to-current-dir") |
Albert will use paths relative to the ("system"
"directory") path when generating presentations, where you
might not have write-access. Setting this option to
T will ensure that the current directory
CL:*DEFAULT-PATHNAME-DEFAULTS* is used instead.
Default is NIL.
|
| ("albert" "presentation" "default-purpose-string" "class")
|
If no @purpose field is found in class-documentation, what will
the default purpose-string be? Default is "class".
|
| ("albert" "presentation" "default-purpose-string" "struct")
|
If no @purpose field is found in struct-documentation, what will
the default purpose-string be? Default is "struct".
|
| ("albert" "presentation" "default-purpose-string" "generic")
|
If no @purpose field is found in GF-documentation, what will
the default purpose-string be? Default is "generic function".
|
| ("albert" "presentation" "default-purpose-string" "method")
|
If no @purpose field is found in method-documentation, what will
the default purpose-string be? Default is "method".
|
| ("albert" "presentation" "legalnotice" "title")
|
Title for the "Legal Notice" part (if it is included). Default is
"Legal Notice".
|
| ("albert" "lisp2csf" "outfile") | Default outfile for
calls to lisp2csf. Default is "lispy-csf.xml".
|
| ("albert" "csf2csf" "outfile") | Default outfile for
calls to csf2csf (a linker rarely used). Default is
"linked.xml".
|
| ("albert" "csf2sdoc" "outfile") | Default outfile for
the CSF->SDOC tool. Default is
"converted.xml".
|