3.2.7 import

Import a table of contents le, generated by FPDoc for another package with the content option (section 3.2.1, page 29). This option can be used to refer to documentation nodes in documentation sets for other packages. The argument consists of two parts: a lename, and a link prex.

The lename is the name of the le that will be imported. The link prex is a prex that will be made to each HTML link; this needs to be done to be able to place the les in dierent directories.

Example:

This will read the le fcl.cnt in the parent directory. For HTML documentation, all links to items in the fcl.cnt le, the link will be prepended with ../fcl.

This allows a setup where all packages have their own subdirectory of a common documentation directory, and all content les reside in the main documentation directory, as e.g. in the following directory tree:

The le fcl.cnt would reside in the docs directory. Similarly, for each package a contents le xxx.cnt could be places in that directory. Inside the subdirectory, commands as the above could be used to provide links to other documentation packages.

Note that for Latex documentation, this option is ignored.