applied-names-multiple-sources | (applied-names-multiple-sources source-list-list) | Index support: cross references involving both applied and defining name occurences
|
begin-documentation | (begin-documentation) | Begin the documentation part |
browser-pixel-width | browser-pixel-width | The width (in pixels) of the browser
|
control-frame-pixel-height | control-frame-pixel-height | The height of the top control frame in pixels
|
defined-names | (defined-names source-list) | Return the list of top-level defined names in the source list
Source list may be as returned by read-source |
documentation-entry | (documentation-entry . elements) | Define a documentation entry |
documentation-intro | (documentation-intro title author affiliation-list abstract) | Define the title, affiliation, author, affiliation-list, and the abstract
|
documentation-section | (documentation-section . elements) | Define a documentation-section |
elucidate-program-source | (elucidate-program-source source-path destination-path source-list defined-names documented-names size source-key) | Decorate the Scheme source-file with anchors and links |
elucidator-verbose-mode | elucidator-verbose-mode | If #t a number of messages are written on the output when processing is done |
end-documentation | (end-documentation) | End of documentation part |
end-file-empty-lines | end-file-empty-lines | The number of empty lines in the bottom of an html file,
in order to allow navigation to bottom stuf
|
html-directory | (html-directory) | The directory in which the generated html files are located |
linking-from | (linking-from word doc-id) | This function is called during the traversal of a documentation body |
make-all-indexes | (make-all-indexes) | Make both duplicate, cross-reference and defining-name indexes
|
make-no-indexes | (make-no-indexes) | Make neither duplicate, cross-reference or defining-name indexes
|
maximum-processing | (maximum-processing) | Set variables such that maximum processing is called for
|
minimum-processing | (minimum-processing) | Set variables such that minimum processing is called for
|
present-defined-name-index | (present-defined-name-index) | Index support: total index of all defining name occurences |
process-only | (process-only . source-keys) | Only process the sources whose keys are given in the parameter |
program-source | (program-source . elements) | Define a documentation source in terms of a number of elements |
read-source | (read-source file) | Read the file (a lisp source file) and return a list of the lisp expressions at the source file
|
scheme-library | scheme-library | The scheme library relative to software-base-library
|
set-documentation-name | (set-documentation-name name) | Define the name of the documentation |
set-source-directory | (set-source-directory dir) | Defines the source directory to be dir |
software-base-directory | software-base-directory | The directory in which all Scheme programs and libraries are located
|
software-directory | software-directory | The directory in which the elucidator is located
|
source-directory | source-directory | The directory in which the documentation source is locacted |
the-library | the-library | The directory in which the libraries are located
|