Integration of external pages

To facilitate the integration of manually written pages (either in html or with cgi library) the engine will search for files with extensions '.predoc', '.doc' and execute them as tcl code, in a special environment.

This interface was changed in the transition from version 1.0 to 2.0. Please read the change report too.

.predoc

They are searched for immediately after the scanning for packages took place and executed at once, if found. This is done in a separate interpreter. A restricted set of the methods provided by the global distribution object is made available. These are

depDef	See distribution:depDef
docfile	See distribution:docfile
imgConverter	See distribution:imgConverter
imgDef	See distribution:imgDef
xrefDef	See distribution:xrefDef

They allow the user to define external links, specify additional information about required packages and to mark other files as part of the documentation. The latter might be images used in other pages or native html files as well. See refs.predoc for an example.

.doc

They are searched at the same time as the '.predoc'-files, but executed after all documentation pages were generated, with the exception of the distribution home page. The execution takes place in a separate interpreter. A restricted set of the methods provided by the global distribution object is made available, together with the full interface to the formatting object.
The code is able to generate pages, create external references, mark other files as being part of the documentation, resolve cross references to packages, files, ..., define and use information about external packages. Here is a complete table:

add2Sidebar	See distribution:add2Sidebar
classRef	See distribution:classRef
depDef	See distribution:depDef
docfile	See distribution:docfile
fileRef	See distribution:fileRef
imgConverter	See distribution:imgConverter
imgDef	See distribution:imgDef
imgRef	See distribution:imgRef
methodRef	See distribution:methodRef
newPage	See distribution:NewPage
optionRef	See distribution:optionRef
pkgRef	See distribution:pkgRef
procRef	See distribution:procRef
xrefDef	See distribution:xrefDef
xRef	See distribution:xRef
All formatting methods of genericFormatter, with the exception of genericFormatter:newPage.

Examples are doc/to.doc and doc/if.doc.

Top (Introduction)

Generated by AutoDoc 2.4 at 09/28/2001, invoked by Andreas Kupries,,,