Changeset 13098

Timestamp:

23 Jun 2015, 09:27:05 (10 years ago)

Author:

Henrik Bettermann

Message:

More docs.

Location:

main/waeup.kofa/trunk

Files:

• docs/source/userdocs/applicants/workflow.rst (modified) (4 diffs)
• docs/source/userdocs/browsing.rst (modified) (2 diffs)
• docs/source/userdocs/multicolumn.png (added)
• docs/source/userdocs/navbox.png (deleted)
• docs/source/userdocs/students/workflow.rst (modified) (1 diff)
• src/waeup/kofa/applicants/permissions.py (modified) (1 diff)

main/waeup.kofa/trunk/docs/source/userdocs/applicants/workflow.rst

@@ -7 +7 @@
 mentioned application workflow is shown here::
 
-           initialized
+            initialized
              |
              |a
@@ -27 +27 @@
              |f
              |
-           created
+            created
 
 
@@ -58 +58 @@
 
 
-
-
-.. _application_workflow_batch_processing:
-
-Workflow Batch Processing
-=========================
-
-
 .. _application_history:
 
@@ -71 +63 @@
 ===================
 
+All transitions are automatically logged in applicants.log and the applicant's history. And also the import of workflow states is recorded in the logfile and the history, see :ref:`student_history` for further information. This is a sample history of an applicant which passes through the application process without any complications::
+
+  2015-06-23 08:56:23 UTC - Application initialized by Anonymous
+  2015-06-23 08:57:42 UTC - Application started by Demo Applicant
+  2015-06-23 08:59:41 UTC - Payment approved by Benny Goodman
+  2015-06-23 09:00:50 UTC - Application submitted by Demo Applicant
+  2015-06-23 09:01:13 UTC - Applicant admitted by Benny Goodman
+  2015-06-23 09:02:36 UTC - Student record created (K1000003) by Benny Goodman
+
+Benny Goodman is the name of an applications manager. If the workflow state is set by import, the following message would
+have been added instead::
+
+  2015-06-23 09:01:13 UTC - State 'admitted' set by Benny Goodman
+
+Applicant histories are exportable but cannot be imported.

main/waeup.kofa/trunk/docs/source/userdocs/browsing.rst

@@ -30 +30 @@
 Data' tab in the navigation bar.
 
+.. _navigation_bar:
+
+The navigation bar for an anonymous user:
+
+.. image:: navbar_anon.png
+
+The navigation bar for a student with drop-down menue:
+
+.. image:: navbar_student.png
+
+The navigation bar for an officer with lots of permissions:
+
+.. image:: navbar_officer.png
+
 Officers see a double-column theme after logging in. The left column
 contains a box which contains links to the user's preferences (My
@@ -40 +54 @@
 pages of an applicant or student record respectively.
 
-.. image:: navbox.png
-   :scale: 50 %
-
-
-.. _navigation_bar:
-
-Navigation Bar
-==============
-
-The navigation bar of an anonymous user:
-
-.. image:: navbar_anon.png
-
-The navigation bar of an officer with lots of permissions:
-
-.. image:: navbar_officer.png
-
-The navigation bar of a student with drop-down menue:
-
-.. image:: navbar_student.png
+.. image:: multicolumn.png
 
 

main/waeup.kofa/trunk/docs/source/userdocs/students/workflow.rst

@@ -156 +156 @@
 However, these logfiles can only be accessed by some officers and
 are hidden from students. Since Kofa takes up the cause of
-transparancy, we were of the opinion, that also students must know,
+transparancy, we are of the opinion, that also students must know,
 when and by whom the state of their record was changed. Therefore we
 store all workflow-relevant changes additionally in the student

main/waeup.kofa/trunk/src/waeup/kofa/applicants/permissions.py

@@ -88 +88 @@
 
 class ApplicationsManager(grok.Role):
-    """The Applications Officer is allowed to edit all application records.
-    The role allows also to add payment tickets.
+    """The Applications Manager is allowed to edit all application records.
+    The role also allows to add payment tickets.
     """
     grok.name('waeup.ApplicationsManager')