On Tue, 14 Aug 2012, Tomas Hajny wrote:
$PREFIX/share/doc/fpc-$fpcversion/
Seems like the reasonable thing, yes.
Actually, the file is more a configuration file for fpdoc than its
documentation, isn't it? From this point of view, shouldn't
SysUtils.GetAppConfigDir serve as the most reasonable location?
It is definitely not a config file. It is a file that must be copied to
every project you want to document with fpdoc.
If I understand it correctly, this is only the case for plain HTML whereas
CHM includes it internally (and from this point of view it is much more a
configuration file influencing the output than part of fpdoc documentation
- see also the comment from Marco).
As far as I know, CHM does not include it internally. It expects it to be
there, just as the other HTML files should be there.
From certain point of view it is unfortunate that the same file (equally
named and potentially even equally placed) is used as the default template
for generation of new documents with fpdoc and also for viewing of the
(distributed) FPC documentation because fpdoc users may want to change the
style of their generated documents but they may not be interested in
changing the design of our FPC documentation.
The file in the docs dir is there so they can copy it.
It will never be used directly.
Anyway, it's all moot now, I will let fpdoc generate the file.
Michael.
_______________________________________________
fpc-pascal maillist - fpc-pascal@lists.freepascal.org
http://lists.freepascal.org/mailman/listinfo/fpc-pascal
