[fpc-devel] FPDoc projects future

Hans-Peter Diettrich DrDiettrich1 at aol.com
Wed Nov 30 13:19:36 CET 2011


michael.vancanneyt at wisa.be schrieb:

>> (so  rtl/xxx/yy.html referencing fcl/zzz/ooo.html is done by generating a
>> link to ../../fcl/zzz/ooo.html )
>>
>> But this is an html format problem, not a fpdoc problem.
> 
> I thought the cross-references are done based on the location of the cxt
> file, and all links are make relative to this location ?

This doesn't work for CHM output, so that --import expects both a 
reference to the content file and a link prefix, where the link prefix 
differs between HTML and CHM output (see help on --import).

Now it IMO is an fpdoc (project) problem, when the required packages are 
*not* listed in the project. Once the required imports are part of the 
project, fpdoc can check for the related information, and issue an error 
message when something's missing in the command line or in the target 
directories. An fpdoc project could include entries like
   <import package=rtl content="../rtl.ctx" htmlprefix="../rtl" 
chmprefix="..."/>
which will typically reduce to
   <import package=rtl/>
because everything else can be derived from the context file reference, 
which *must* be present in the --import command line option.

A user then can write its own batch file, like
   fpdoc -p=mydoc.xml --import=<myrtl.ctx> --import=<myfcl.ctx> 
--output=<whatever>

DoDi




More information about the fpc-devel mailing list