Re: [Dtddoc-develop] V. 1.x: HTML in source comments partially broken

[Stefan C. <sch...@sk...>]

Hey nice to see some activity around here again !

I've now settled in my new house. I'll have some spare time (equivalent of=
=20
gold when you're a dad :-))

stF
=20
> Hi Yves,
>=20
> Le lundi 29 octobre 2007, Yves Forkl (SRZ) a =E9crit :
> > Hi,
> >
> > after having looked into a number of OSS DTD documenting systems, I
> > decided to use (your) DTDDoc because it revealed as one of the most
> > advanced tools for this task. I have been using its V. 0.11 intensively
> > now for several years and am still fond of it - thank you for this
> > wonderful tool!
> thank you, it's nice to know that the tool is still used and appreciated =
:)
>=20
> >
> > Feeding DTDDoc with some DTDs containing rather complex documentation
> > which are generated using XSLT, I am depending heavily on the ability to
> > "pass through" all kinds of HTML constructs inside the DTD comments.
> >
> > While this worked quite well in V. 0.11, the "automatic '<' escaping in
> > case of non-html tags" added in V. 1.0 means that some HTML elements
> > sadly will not make it anymore through DTDDoc. I observed, for instance,
> > that <name>My name</name> is not accepted as HTML but rather escaped,
> > and <hr /> only produces a horizontal line when written with a space
> > inside the tag.
> >
> > This raises a couple of questions:
> >
> > 1 - How do you determine which elements belong to HTML and which do not?
> >   (Ideally, this list should be configurable, but I fear that it's
> > hard-coded somewhere.)
> just take a look at DTDDoc.Tools class, which contains HTML_TAGS constant=
=20
and=20
> startsWithHtmlTag() method
>=20
> >
> > 2 - Which version of (X)HTML do you consider by default? HTML 4 or XHTML
> > 1? Transitional or strict or...? Any version of XHTML would allow
> > "<hr/>", while none of the HTML versions would.
> I don't really remember where I got the list, but I'm interested in any=20
> improvement. I just added the "name" tag you requested, and fixed=20
the "<hr/>"=20
> bug: I didn't think at this case in my algorithm...
>=20
> >
> > 3 - Where in DTDDoc's source code could I modify the HTML escaping
> > behavior, for my own purposes or as a contribution to the project?
> It's already available in CVS as it was easy to fix: you'll just have to=
=20
> recompile.
>=20
> >
> > Another problem in the interpretation of comment contents in V. 1.x
> > results from the fact that blank lines will now always be substituted by
> > </p><p>. Hence, if a comment contains
> >
> > <ul>
> >
> >    <li>foo</li>
> >
> >    <li>bar</li>
> >
> > </ul>
> >
> > the list structure is now destroyed by replacing the empty lines with
> > </p><p>, while previously in V. 0.11 the empty lines were left as is. It
> > would be helpful if I could revert DTDDoc to its former behavior by
> > adapting the source code. (Optimally, this should be configurable, e.g.
> > via a command line option.) At which place should I look for this?
> this one will be more tricky to choose what's the best to do.
> Take a look at DTDDoc.DTDCommenter#forcePrintParagraph() method. I think =
it=20
> should be quite easy to make it work like you want in your particular cas=
e,=20
> but doing it work in any case is more problematic IMHO with=20
> the "auto-linefeed" feature... If you find a nice way of treating this=20
> feature, please share: I'll be happy to integrate the change.
>=20
> >
> > I would love to be able to upgrade to V. 1.1 after having fixed all of
> > this...
> then it will be 1.2-SNAPSHOT, 1.1 is definitely bugged :)
>=20
> >
> > Finally, let me say that I am grateful to you for having removed the
> > special meaning from the question mark.
> stupid bug with encodings...
>=20
> > As to the percent sign, I am=20
> > still not so much convinced that it needs to have special meaning when
> > there is the "pre" element, but I can live with that.
> it's an historic feature, then if nobody cries loud, it won't be changed:=
=20
> perhaps somebody relies on it
>=20
> >
> > Yours,
> >
> >    Yves
> Regards
>=20
> Herv=E9
>=20
> >
> >
> > -----------------------------------------------------------------------=
=2D-
> > This SF.net email is sponsored by: Splunk Inc.
> > Still grepping through log files to find problems?  Stop.
> > Now Search log events and configuration files using AJAX and a browser.
> > Download your FREE copy of Splunk now >> http://get.splunk.com/
> > _______________________________________________
> > Dtddoc-develop mailing list
> > Dtd...@li...
> > https://lists.sourceforge.net/lists/listinfo/dtddoc-develop
>=20
>=20
>=20
> -------------------------------------------------------------------------
> This SF.net email is sponsored by: Splunk Inc.
> Still grepping through log files to find problems?  Stop.
> Now Search log events and configuration files using AJAX and a browser.
> Download your FREE copy of Splunk now >> http://get.splunk.com/
> _______________________________________________
> Dtddoc-develop mailing list
> Dtd...@li...
> https://lists.sourceforge.net/lists/listinfo/dtddoc-develop
>=20

=2D-=20
=46ree software, free society