[fpc-devel] fpdoc + XML description file + indentation whitespace
Michael Van Canneyt
michael at freepascal.org
Fri Aug 6 11:30:44 CEST 2010
On Fri, 6 Aug 2010, Graeme Geldenhuys wrote:
> What is supposed to happen with whitespace in the XML Description files.
> For example. Say you edit an XML file with your favourite text editor, and
> you have a long description. So you add newlines (by pressing ENTER), then
> indent the text to the DESCR node for easier human reading. It seems fpdoc
> inserts that indented (spacing) whitespace as actual space characters (part
> of the help content) in the help content. This is seen all over the place,
> but not always noticed in the final output.
> With INF, TXT (slightly better due to manual line wrapping implementation)
> and MAN the problem is much worse because they teat the content exactly as
> the user entered it. So indentation, to make human readable XML, is not
> recommended. Is there some way fpdoc could help alleviate the problem, or
> is it the job of the output writer to trim such spaces (though this will be
> very hard to catch all cases because you will never know exactly when you
> should or shouldn't trim spaces).
You must catch the spaces in the output engine; there is no other way.
More information about the fpc-devel