Changeset 7811 for main/waeup.kofa/trunk/src/waeup/kofa/accesscodes/accesscode.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/accesscodes/accesscode.txt (modified) (18 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/accesscodes/accesscode.txt

@@ -1 @@
-:mod:`waeup.sirp.accesscodes.accesscode` -- access codes (aka PINs)
+:mod:`waeup.kofa.accesscodes.accesscode` -- access codes (aka PINs)
 *******************************************************************
 
-.. module:: waeup.sirp.accesscodes.accesscode
+.. module:: waeup.kofa.accesscodes.accesscode
 
 Components that represent access codes and related.
 
 .. :NOdoctest:
-.. :NOlayer: waeup.sirp.testing.SIRPUnitTestLayer
+.. :NOlayer: waeup.kofa.testing.KOFAUnitTestLayer
 
 About access-codes
@@ -28 +28 @@
 unique random number of 10 digits.
 
-For the generation of the random number :mod:`waeup.sirp` requires a
+For the generation of the random number :mod:`waeup.kofa` requires a
 'urandom' entropy provider which is available with most standard
 Unix/Linux systems. This makes the generated numbers relatively
@@ -57 +57 @@
 
    The class implements
-   :mod:`waeup.sirp.accesscodes.interfaces.IAccessCode`:
-
-    >>> from waeup.sirp.accesscodes.interfaces import IAccessCode
-    >>> from waeup.sirp.accesscodes.accesscodes import AccessCode
+   :mod:`waeup.kofa.accesscodes.interfaces.IAccessCode`:
+
+    >>> from waeup.kofa.accesscodes.interfaces import IAccessCode
+    >>> from waeup.kofa.accesscodes.accesscodes import AccessCode
     >>> from zope.interface.verify import verifyClass
     >>> verifyClass(IAccessCode, AccessCode)
@@ -150 +150 @@
 
    A persistent :class:`grok.Model`. It implements
-   :class:`waeup.sirp.accesscodes.interfaces.IAccessCodeBatch`.
+   :class:`waeup.kofa.accesscodes.interfaces.IAccessCodeBatch`.
 
    When creating a batch, all entries (access-codes) are generated as
@@ -306 +306 @@
 :class:`AccessCodeBatch` implements :class:`IAccessCodeBatch`:
 
-    >>> from waeup.sirp.accesscodes.interfaces import IAccessCodeBatch
-    >>> from waeup.sirp.accesscodes.accesscodes import AccessCodeBatch
+    >>> from waeup.kofa.accesscodes.interfaces import IAccessCodeBatch
+    >>> from waeup.kofa.accesscodes.accesscodes import AccessCodeBatch
     >>> from zope.interface.verify import verifyClass
     >>> verifyClass(IAccessCodeBatch, AccessCodeBatch)
@@ -317 +317 @@
 
     >>> import datetime
-    >>> from waeup.sirp.accesscodes.accesscodes import AccessCodeBatch
+    >>> from waeup.kofa.accesscodes.accesscodes import AccessCodeBatch
     >>> batch = AccessCodeBatch(
     ...   datetime.datetime(2009, 12, 23), 'Fred','APP', 12.12, 3, num=10)
@@ -331 +331 @@
 
     >>> [x for x in batch.entries()]
-    [<waeup.sirp...AccessCode object at 0x...>, ...]
+    [<waeup.kofa...AccessCode object at 0x...>, ...]
 
 Getting a single entry from the batch:
@@ -338 +338 @@
     >>> ac = batch.getAccessCode(ac_id)
     >>> ac
-    <waeup.sirp...AccessCode object at 0x...>
+    <waeup.kofa...AccessCode object at 0x...>
 
     >>> ac is list(batch.entries())[0]
@@ -374 +374 @@
 #
 #    >>> batch.getAccessCodeForStudentId('some_user_id')
-#    <waeup.sirp...AccessCode object at 0x...>
+#    <waeup.kofa...AccessCode object at 0x...>
 #
 #Non-existent values will cause a :exc:`KeyError`:
@@ -440 +440 @@
     >>> result = batch.search(0, 'serial')
     >>> result
-    [<waeup.sirp...AccessCode object at 0x...>]
+    [<waeup.kofa...AccessCode object at 0x...>]
 
     >>> result[0].batch_serial
@@ -545 +545 @@
 Creating a batch container:
 
-    >>> from waeup.sirp.accesscodes.accesscodes import (
+    >>> from waeup.kofa.accesscodes.accesscodes import (
     ...   AccessCodeBatchContainer)
     >>> container = AccessCodeBatchContainer()
@@ -561 +561 @@
 
     >>> container.search(1, 'serial')
-    [<waeup.sirp...AccessCode object at 0x...>,
-     <waeup.sirp...AccessCode object at 0x...>]
+    [<waeup.kofa...AccessCode object at 0x...>,
+     <waeup.kofa...AccessCode object at 0x...>]
 
     >>> container.search('not-a-number', 'serial')
@@ -569 +569 @@
     >>> result = container.search('1', 'serial')
     >>> result
-    [<waeup.sirp...AccessCode object at 0x...>,
-     <waeup.sirp...AccessCode object at 0x...>]
+    [<waeup.kofa...AccessCode object at 0x...>,
+     <waeup.kofa...AccessCode object at 0x...>]
 
 Searching for ACs:
@@ -576 +576 @@
     >>> ac = result[0]
     >>> container.search(ac.representation, 'pin')
-    [<waeup.sirp...AccessCode object at 0x...>]
+    [<waeup.kofa...AccessCode object at 0x...>]
 
 Searching for student IDs:
@@ -583 +583 @@
 #    ...   ac.representation, 'some_user')
 #    >>> container.search('some_user', 'stud_id')
-#    [<waeup.sirp...AccessCode object at 0x...>]
+#    [<waeup.kofa...AccessCode object at 0x...>]
 
 
@@ -591 +591 @@
 .. class:: AccessCodePlugin
 
-  A `waeup.sirp` plugin that updates existing SIRP university
+  A `waeup.kofa` plugin that updates existing KOFA university
   instances so that they provide support for access-codes.
 
-  .. attribute:: grok.implements(ISIRPPluggable)
+  .. attribute:: grok.implements(IKOFAPluggable)
   .. attribute:: grok.name('accesscodes')
 
@@ -608 +608 @@
 
   The AccessCodePlugin is available as a global named utility for the
-  ISIRPPluggable interface named ``accesscodes``.
+  IKOFAPluggable interface named ``accesscodes``.
 
   It is looked up by a university instance when created, so that this
@@ -615 +615 @@
 
     >>> from zope.component import getUtility
-    >>> from waeup.sirp.interfaces import ISIRPPluggable
-    >>> plugin = getUtility(ISIRPPluggable, name='accesscodes')
+    >>> from waeup.kofa.interfaces import IKOFAPluggable
+    >>> plugin = getUtility(IKOFAPluggable, name='accesscodes')
     >>> plugin
-    <waeup.sirp.accesscodes.accesscodes.AccessCodePlugin object at 0x...>
+    <waeup.kofa.accesscodes.accesscodes.AccessCodePlugin object at 0x...>
 
   It provides a `setup()` and an `update()` method. Both have to be