[fpc-devel] FPC documentation xml files

[Vincent Snijders]

Graeme Geldenhuys schreef:
> Thanks...
> 
> Okay, I found a bit of a problem.  I first thought it was just my Web
> Browser fonts, then thought it must be in the documentation.  After
> looking at the *.xml files, I now think it is in the conversion from
> *.xml to *.html that the problem gets introduced.
> 
> The problem is the spaces between words.  Look at the example below
> taken from the following docs:
>  http://lazarus-ccr.sourceforge.net/docs/fcl/contnrs/tobjectlist.html
> 
> In the first line, there are a few mistakes.  No space between
> "TObjectList" and "is". No space between "TList" and "descendent".
> etc...
> 
> This occurs all over in the FPC documentation.  Note though, that it
> doesn't occur in the Lazarus documentation, which also used the fpdoc
> *.xml files.  Something different in the FPC docs?
> 
> ------------------------------------
> Description
> 
> TObjectListis a TListdescendent which has as the default array
> property TObjectsinstead of pointers. By default it also manages the
> objects: when an object is deleted or removed from the list, it is
> automatically freed. This behaviour can be disabled when the list is
> created.
> 
> In difference with TFPObjectList, TObjectListoffers a notification
> mechanism of list change operations: insert, delete. This slows down
> bulk operations, so if the notifications are not needed,
> TObjectListmay be more appropriate.
> ------------------------------------
> 
> Regards,
>  Graeme.

I think it caused by the way text element after a element with a tag are parsed by 
the xml reader.

If you have the following xml fragment:
<p>This is <b>bold</b> text.</p>

This should be parsed by the xmlread unit into a p-element with 3 child nodes: a 
text node, b-element node, and another text node.

function TXMLReader.ParseElementContent parses 'This is <b>bold</b> text.'.
Before it starts reading the next node, if first reads all the white space, which 
should not be done for text nodes, I think.

The reason that you did not see this in the LCL documentation, is because we don't 
use very much markup and links in the descriptions.

Vincent