Changeset 7819 for main/waeup.kofa/trunk/src/waeup/kofa/app.txt

Timestamp:

8 Mar 2012, 22:28:46 (13 years ago)

Author:

Henrik Bettermann

Message:

KOFA -> Kofa

File:

• main/waeup.kofa/trunk/src/waeup/kofa/app.txt (modified) (7 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/app.txt

@@ -1 @@
-:mod:`waeup.kofa.app` -- central components for KOFA
+:mod:`waeup.kofa.app` -- central components for Kofa
 ****************************************************
 
 .. :doctest:
-.. :layer: waeup.kofa.testing.KOFAUnitTestLayer
+.. :layer: waeup.kofa.testing.KofaUnitTestLayer
 
 .. module:: waeup.kofa.app
@@ -9 +9 @@
 .. class:: University
 
-  The main KOFA application object is given with
+  The main Kofa application object is given with
   :class:`University`. It provides the main containers as faculties,
   hostels, etc.
@@ -76 +76 @@
 first::
 
-  >>> from waeup.kofa.interfaces import IKOFAExporter
-  >>> exporter = IKOFAExporter(myuniversity)
+  >>> from waeup.kofa.interfaces import IKofaExporter
+  >>> exporter = IKofaExporter(myuniversity)
   >>> exporter
   <waeup.kofa.utils.importexport.Exporter object at 0x...>
@@ -90 +90 @@
 memory file::
 
-  >>> from waeup.kofa.interfaces import IKOFAXMLExporter
-  >>> exporter = IKOFAXMLExporter(myuniversity)
+  >>> from waeup.kofa.interfaces import IKofaXMLExporter
+  >>> exporter = IKofaXMLExporter(myuniversity)
   >>> f = exporter.export()
   >>> f
@@ -103 +103 @@
   </pickle>
 
-KOFA plugins
+Kofa plugins
 ============
 
 waeup.kofa provides an API to 'plugin' components. Things that should
-be setup at creation time of a KOFA application can indicate
-that by providing a utility providing IKOFAPlugin.
+be setup at creation time of a Kofa application can indicate
+that by providing a utility providing IKofaPlugin.
 
 The plugins are looked up by an created app, which then will call the
 ``setup()`` method of each plugin.
 
-   >>> from waeup.kofa.interfaces import IKOFAPluggable
+   >>> from waeup.kofa.interfaces import IKofaPluggable
    >>> from zope.component import getAdapters, getUtilitiesFor
-   >>> sorted(list(getUtilitiesFor(IKOFAPluggable)))
+   >>> sorted(list(getUtilitiesFor(IKofaPluggable)))
    [(u'accesscodes', <waeup.kofa.accesscodes...AccessCodePlugin ...)]
 
@@ -122 +122 @@
 
    >>> import grok
-   >>> from waeup.kofa.interfaces import IKOFAPluggable
+   >>> from waeup.kofa.interfaces import IKofaPluggable
    >>> class MyPlugin(grok.GlobalUtility):
-   ...   grok.implements(IKOFAPluggable)
+   ...   grok.implements(IKofaPluggable)
    ...   def setup(self, site, name, logger):
    ...     print "Setup was called for"
@@ -136 +136 @@
    True
 
-and setup a new KOFA instance, we will get a message:
+and setup a new Kofa instance, we will get a message:
 
    >>> from waeup.kofa.app import University