Thursday, February 22, 2007, 11:07:19 AM, Graeme wrote:
GG> Hi,
GG> I thought I would try using the LazDoc editor which is built into the
GG> IDE (not standalone lazde). Off the bat it seems to work really well,
GG> but then I built my documentation to html.
GG> All my "see also" links, the <link> tag and the <printshort> tags
GG> used inside the descriptions get escaped and appear exactly as I typed
GG> them in the html generated documentation, instead of creating links.
GG> Seems we have a chicken and egg situation here. The built-in LazDoc
GG> editor escapes everything to generate valid html and the standalone
GG> 'lazde' doesn't escape enough. :-) How do we let the different
GG> editors know when to escape text and when not to. Example the & sign
GG> must be escaped, the < and > signs as well, except when they get used
GG> as link tags.
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.
The opposite way is to have the editor deal with 'rich text' instead
of plaintext. Then all tags will be effectively hidden from user, and all user
input can be safely escaped. But it is the hardest way for developers.
I wonder if there is any cross-platform editor component for rich text?
GG> I gather the parser needs to be improved to handle this correctly?
The parser is compliant to W3 specs... The problem is that each time
you want to edit documentation, you end up editing XML - and that is
NOT what you wanted to edit initially.
GG> These special rules could get quite complex, quickly. Is there not
GG> maybe a different way we can handle this. Using different tags that
GG> don't conflict with XML tags. Maybe something like the PasDoc or
GG> Javadoc syntax using the @ sign infront of keywords.
GG> example:
GG> @link(text goes here) vs <link>text goes here</link>
... or maybe go a step further and replace all XML markup with, say, Wiki
markup? ;-)
--
Best regards,
Sergei
_________________________________________________________________
To unsubscribe: mail [EMAIL PROTECTED] with
"unsubscribe" as the Subject
archives at http://www.lazarus.freepascal.org/mailarchives
