[Zope] Q: Embedding documentation in Page Templates?

[Paul Winkler]

On Tue, Apr 12, 2005 at 04:49:26PM -0500, J Cameron Cooper wrote:
> Stephen Nesbitt wrote:
> >All:
> >
> >Does anyone know of a way of embedding documentation directly into a page 
> >template without using <!-- -->? In other words is there some construct 
> >which tells the rendering engine to simply ignore some content.?
> 
> I usually use
> 
>  <tal:comment replace="nothing">
>   comment in here
>  </tal:comment>
> 
> There are other constructs, but I think this is most reasonable.
> 
> The tag can be anything, of course::
> 
>  <span tal:replace="nothing">
>   comment in here
>  </span>
> 
> Come to think of it, that's a few less keystrokes. This is even shorter::
> 
>  <a tal:replace="nothing">
>   comment in here
>  </a>

Of those, I like your first: it explicitly says "comment".
Even somebody unfamiliar with ZPT can probably figure out
what that means.
 
-- 

Paul Winkler
http://www.slinkp.com