[Erp5-report] r12156 - /erp5/trunk/products/ERP5/Document/Document.py

[nobody at svn.erp5.org]

Author: jp
Date: Fri Jan 19 15:04:03 2007
New Revision: 12156

URL: http://svn.erp5.org?rev=12156&view=rev
Log:
More documentation.

Modified:
    erp5/trunk/products/ERP5/Document/Document.py

Modified: erp5/trunk/products/ERP5/Document/Document.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/Document/Document.py?rev=12156&r1=12155&r2=12156&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/Document/Document.py (original)
+++ erp5/trunk/products/ERP5/Document/Document.py Fri Jan 19 15:04:03 2007
@@ -320,13 +320,22 @@
   def index_html(self, REQUEST, RESPONSE, format=None, **kw):
     """
       We follow here the standard Zope API for files and images
-      and extend it to support format conversion.
-
-      format - the format specied in the form of an extension
+      and extend it to support format conversion. The idea
+      is that an image which ID is "something.jpg" should
+      ne directly accessible through the URL
+      /a/b/something.jpg. The same is true for a file and
+      for any document type which primary purpose is to
+      be used by a helper application rather than displayed
+      as HTML in a web browser. Exceptions to this approach
+      include Web Pages which are intended to be primarily rendered
+      withing the layout of a Web Site or withing a standard ERP5 page.
+      Please refer to the index_html of TextDocument.
+
+      format - the format specified in the form of an extension
       string (ex. jpeg, html, text, txt, etc.)
     """
     pass
-  
+
   security.declareProtected(Permissions.View, 'getSearchableText')
   def getSearchableText(self, md=None):
     """