[Zope3-dev] FWIW: I endorse reStructuredText

Steve Alexander steve@cat-box.net
Thu, 06 Feb 2003 12:16:32 +0200


I suggest '.rst' be used in Zope for files on the filesystem (for 
example, documentation checked into CVS).

This indicates to me that the author of the document intends it to be 
viewed as reST and also maintained as reST. If I read it, and find 
something in it that doesn't make sense according to reST, I know that I 
can fix the error, because it obvious that it is supposed to be reST.


I suggest '.rst' be used in Zope for reST resources that we might want 
to provide in packages, configure with zcml, and serve up from Zope. For 
example, the help system.  There could legitimately be normal .txt files 
in the help system. I want to render the reST files as HTML, but leave 
the .txt files as they are.


Zope already uses .pt for page template files, rather than .html.
It is important to know that the author intends it to be a dynamic page 
template, not static html.

Zope already uses .zcml files for ZCML files, rather than .xml.


So, I think I'm +1 with Tres on '.rst'.

--
Steve Alexander