Changeset 7811 for main/waeup.kofa/trunk/src/waeup/kofa/image/README.txt

Timestamp:

8 Mar 2012, 19:00:51 (13 years ago)

Author:

uli

Message:

Rename all non-locales stuff from sirp to kofa.

File:

• main/waeup.kofa/trunk/src/waeup/kofa/image/README.txt (modified) (12 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/image/README.txt

@@ -1 @@
-waeup.sirp.image -- handling image files
+waeup.kofa.image -- handling image files
 ========================================
 
-The image file widget is built on top of the :class:`SIRPImageFile` object::
-
-  >>> from waeup.sirp.image import SIRPImageFile
-  >>> file = SIRPImageFile('foo.jpg', 'mydata')
+The image file widget is built on top of the :class:`KOFAImageFile` object::
+
+  >>> from waeup.kofa.image import KOFAImageFile
+  >>> file = KOFAImageFile('foo.jpg', 'mydata')
   >>> file.filename
   'foo.jpg'
@@ -16 +16 @@
   'mydata'
 
-We can also create SIRPImageFile objects from file-like objects::
+We can also create KOFAImageFile objects from file-like objects::
 
   >>> from StringIO import StringIO
@@ -36 +36 @@
 ----------------
 
-The SIRPImageFile object normally stores the file data using ZODB
+The KOFAImageFile object normally stores the file data using ZODB
 persistence. Files can however also be stored by tramline.  If
 tramline is installed in Apache, the Tramline takes care of generating
@@ -73 +73 @@
 just '1') will now be created::
 
-  >>> file = SIRPImageFile('foo.jpg', '1')
+  >>> file = KOFAImageFile('foo.jpg', '1')
 
 The data is now '1', referring to the real file::
@@ -102 +102 @@
 We expect the same behavior as when tramline is not installed::
 
-  >>> file = SIRPImageFile('foo.jpg', 'data')
+  >>> file = KOFAImageFile('foo.jpg', 'data')
   >>> f = file.file
   >>> f.read()
@@ -114 +114 @@
   >>> shutil.rmtree(dirpath)
 
-Support for :mod:`waeup.sirp.imagestorage`
+Support for :mod:`waeup.kofa.imagestorage`
 ------------------------------------------
 
 The behaviour shown above can be used for any Zope3 application. With
-:mod:`waeup.sirp` we use a special file retrieval utility defined in
-:mod:`waeup.sirp.imagestorage`. As this utility is based on
-:mod:`waeup.sirp` internal stuff we do not show it here but in the
+:mod:`waeup.kofa` we use a special file retrieval utility defined in
+:mod:`waeup.kofa.imagestorage`. As this utility is based on
+:mod:`waeup.kofa` internal stuff we do not show it here but in the
 tests that come with that storage type.
 
@@ -135 +135 @@
 The `ImageFile` field accepts only certain content types:
 
-  >>> from waeup.sirp.image.schema import ImageFile
+  >>> from waeup.kofa.image.schema import ImageFile
   >>> from zope.publisher.browser import TestRequest
   >>> field = ImageFile(__name__='foo', title=u'Foo')
@@ -141 +141 @@
   Traceback (most recent call last):
   ...
-  WrongType: ('asd', <class 'waeup.sirp.image.image.SIRPImageFile'>, 'foo')
+  WrongType: ('asd', <class 'waeup.kofa.image.image.KOFAImageFile'>, 'foo')
 
 which means: `ImageFile` fields should better contain
-:class:`SIRPImageFile` instances.
-
-We can store normal :class:`SIRPImageFile` instances:
-
-  >>> field.validate(SIRPImageFile('bar.jpg', 'data')) is None
+:class:`KOFAImageFile` instances.
+
+We can store normal :class:`KOFAImageFile` instances:
+
+  >>> field.validate(KOFAImageFile('bar.jpg', 'data')) is None
   True
 
@@ -173 +173 @@
 
   >>> field.validate(
-  ...     SIRPImageFile('bar.jpg', '123456789012')) is None
-  True
-
-  >>> field.validate(
-  ...     SIRPImageFile('bar.jpg', '12345')) is None
+  ...     KOFAImageFile('bar.jpg', '123456789012')) is None
+  True
+
+  >>> field.validate(
+  ...     KOFAImageFile('bar.jpg', '12345')) is None
   True
 
@@ -183 +183 @@
 
   >>> field.validate(
-  ...     SIRPImageFile('bar.jpg', '1234567890123'))
+  ...     KOFAImageFile('bar.jpg', '1234567890123'))
   Traceback (most recent call last):
   ...
@@ -189 +189 @@
 
   >>> field.validate(
-  ...     SIRPImageFile('bar.jpg', '1234'))
+  ...     KOFAImageFile('bar.jpg', '1234'))
   Traceback (most recent call last):
   ...
@@ -198 +198 @@
 ----------------------------
 
-SIRPImageFile does not reproduce the broken unequal comparison from
+KOFAImageFile does not reproduce the broken unequal comparison from
 its base:
 
-  >>> f1 = SIRPImageFile('bar.jpg', '123456789')
-  >>> f2 = SIRPImageFile('bar.jpg', '123456789')
-  >>> f3 = SIRPImageFile('baz.jpg', '1234')
+  >>> f1 = KOFAImageFile('bar.jpg', '123456789')
+  >>> f2 = KOFAImageFile('bar.jpg', '123456789')
+  >>> f3 = KOFAImageFile('baz.jpg', '1234')
   >>> f1 == f2
   True