On 2/22/07, Sergei Gorelkin <[EMAIL PROTECTED]> wrote:

One way is that editors do not escape anything, and user
is responsible for manually escaping '&' and '<'. Btw, '>' does not need to be
escaped unless used in ']]>' sequence. This is the easiest way for
developers, but the hardest one for users.

This is maybe not such a bad idea. After all, think what we are
documenting - programming code and not the Lazarus IDE screens. So in
reality it is the developers documenting Lazarus LCL or your project
code. I don't think any of my users would know what the hell a
TtiObject class is! :-)

To help developers (and me) not having to remember all the escaped
text, we can create a 'Insert symbol' screen that will insert &gt;
when you select the '>' symbol.

Another reason I think this idea will work, is because we already mix
markup code in the descriptions. <p> for paragraphs, <table> for
inserting tables, <li> list item, etc...

One problem I see though, is when you type a symbol like & when you
should have escaped it. This might break the xml parser or raise an
error, because it isn't valid xml if it is written to file as is.

BTW:
What happens to that markup like <table> when you generate Latex and
then PDF output from the original .xml documentation?


--
Graeme Geldenhuys

There's no place like S34° 03.168'  E018° 49.342'

_________________________________________________________________
    To unsubscribe: mail [EMAIL PROTECTED] with
               "unsubscribe" as the Subject
  archives at http://www.lazarus.freepascal.org/mailarchives

Reply via email to