[next] [prev] [prev-tail] [tail] [up]

#### import

Import a table of contents file, generated by FPDO C for another package with the content option (section 3.2, 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 filename, and a link prefix.

The filename is the name of the file that will be imported. The link prefix is a prefix that will be made to each HTML link; this needs to be done to be able to place the files in different directories.

Example:

     --import=../fcl.cnt,../fcl

This will read the file fcl.cnt in the parent directory. For HTML documentation, all links to items in the fcl.cnt file, 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 files reside in the main documentation directory, as e.g. in the following directory tree:

     /docs/fcl
          /fpdoc
          /fpgui
          /fpgfx
          /fpimg

The file fcl.cnt would reside in the docs directory. Similarly, for each package a contents file 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.

[next] [prev] [prev-tail] [front] [up]