SPRES package

Name

SPRES package -- Exports/uses/nicknames/etc

Description

the presentation api for outsiders

Exports

PRESENT-SDOC, PRESENT-SDOC-FILE and RESET-PRESENTATION-SYSTEM

Uses

SDS-GLOBAL, APISPEC-BASE and COMMON-LISP

Package Content

Methods

PRESENT-SDOC
 (PRESENT-SDOC SDOC-TREE &KEY (FORMAT-SPEC :ALL) (LANGUAGE-SPEC :EN)) [function]
Description 

The real entry point to the SDOC madness. Initialises most appropriate variables and may seem complex. It is. SDOC-TREE should be of type SDOC-TOPLEVEL FORMAT-SPEC should be :all or a named format LANGUAGE-SPEC should be :en for english PREFS-FILE should name a preference file PREFS-TOP if you already have a preference-tree, pass the toplevel object here and PREFS-FILE won't be used.

Called By 

DOCUMENT-FILES and PRESENT-SDOC-FILE

Calls 
Location 

spres/interface.lisp

PRESENT-SDOC-FILE
 (PRESENT-SDOC-FILE SDOC-FILE &KEY (FORMAT-SPEC :ALL) (LANGUAGE-SPEC :EN)) [function]
Description 

Presents a named sdoc-file, se PRESENT-SDOC for more docs.

Calls 

PRESENT-SDOC, SDS-API-SDOC:PARSE-SDOC-FILE and WARN

Location 

spres/interface.lisp

PRINT-INFO-SPRES
 (PRINT-INFO-SPRES STREAM) [function]
Description 

Prints info about the presentation to the given stream.

Calls 

FORMAT and MAPHASH

Location 

spres/interface.lisp

This documentation was generated 27 Oct 2003 from the original sources by Albert v.0.4.9.