[ZDP] BackTalk to Document The Zope Book (2.6 Edition)/Appendix A: DTML Reference

[webmaster at zope.org]

A comment to the paragraph below was recently added via http://www.zope.org/Documentation/Books/ZopeBook/2_6Edition/AppendixA.stx#3-12

---------------

      Commenting out DTML::

        <dtml-comment>
          This DTML is disabled and will not be executed.
          <dtml-call someMethod>
        </dtml-comment>

        % Anonymous User - Apr. 29, 2002 2:00 pm:
         This explanation is misleading and partially incorrect. Zope will not save any comments that are not valid
         DTML. So you cannot not comment: using <dtml-in myExample> to loop ...
         This produces a Zope error.

         This is counter-intuitive and cripples good documentation practices.

         Zope collector Issue 370
         http://collector.zope.org/Zope/370

        % Anonymous User - May 16, 2002 5:53 pm:
         Also, it appears (at least in Zope 2.32-ish) that DTML commands inside comments ARE parsed, since errors in
         syntax or references to objects, methods, etc. that are invalid will cause Zope to complain about the file. Normal
         programming language syntax would dictate that NOTHING after a start-comment token should be parsed until an
         end-comment token is encountered.

        % Anonymous User - July 26, 2002 3:31 pm:
         Agreed with the normal prg lang syntax...

        % Anonymous User - Dec. 31, 2003 10:55 am:
         Perhaps:

         <dtml-comment parser=off>

         ... stuff ...

         </dtml-comment>

        % Anonymous User - Oct. 21, 2005 3:40 pm:
         That works, but typing it is ridiculously awkward.
         Why must it be so absurdly difficult just to make a comment?