Changeset 13076 for main

Timestamp:

19 Jun 2015, 05:49:57 (10 years ago)

Author:

Henrik Bettermann

Message:

After careful consideration: plural is more appropriate than singular.

A student section has another meaning: ​https://en.wikipedia.org/wiki/Student_section

Location:

main/waeup.kofa/trunk

Files:

• docs/source/developerdocs/api/api_students.rst (modified) (1 diff)
• docs/source/userdocs/applicants.rst (modified) (2 diffs)
• docs/source/userdocs/security.rst (modified) (5 diffs)
• docs/source/userdocs/students.rst (modified) (2 diffs)
• docs/source/userdocs/students/browser.rst (modified) (2 diffs)
• docs/source/userdocs/students/interfaces.rst (modified) (1 diff)
• src/waeup/kofa/applicants/browser.py (modified) (2 diffs)
• src/waeup/kofa/applicants/interfaces.py (modified) (1 diff)
• src/waeup/kofa/applicants/tests/test_browser.py (modified) (4 diffs)
• src/waeup/kofa/applicants/utils.py (modified) (1 diff)
• src/waeup/kofa/applicants/viewlets.py (modified) (1 diff)
• src/waeup/kofa/students/browser.py (modified) (1 diff)
• src/waeup/kofa/students/interfaces.py (modified) (1 diff)
• src/waeup/kofa/students/permissions.py (modified) (1 diff)
• src/waeup/kofa/students/tests/test_browser.py (modified) (1 diff)
• src/waeup/kofa/students/utils.py (modified) (1 diff)
• src/waeup/kofa/students/viewlets.py (modified) (1 diff)
• src/waeup/kofa/students/vocabularies.py (modified) (1 diff)
• src/waeup/kofa/university/catalog.py (modified) (1 diff)

main/waeup.kofa/trunk/docs/source/developerdocs/api/api_students.rst

@@ -1 @@
-`students` -- Student Section Components Package
-************************************************
+`students` -- Students Section Components Package
+*************************************************
 
 (see also: :ref:`api-students-modules`)

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

@@ -1 @@
-.. _applicant_section:
+.. _applicants_section:
 
-Applicant Section :sup:`in progress`
-************************************
+Applicants Section :sup:`in progress`
+*************************************
 
-Applicants and Students are different entities. Moreover, the student section is completely independent from the applicant section. Kofa can be configured without its `applicants` module but not without its `students` module.
+Applicants and Students are different entities and stored in different places. Moreover, the students section is completely independent from the applicants section. Kofa can be configured without its `applicants` module but not without its `students` module.
 
 Anonymous users can self-register and automatically become applicants (users) of the portal. The number of applicants is not limited and, theoretically, Kofa can host hundredthousands of applicants in various applicants containers. Usually, only a few of them are beeing accepted for studying at the university. Once the application process has ended, admitted applicants are transformed into student records.  New student records are created and the data are copied from the applicant records. When this 'student creation' process is finished, the applicant records are dispensable. Aim was to provide an easy way to get rid of the huge batches of applicant records by only one click, in order to keep the database clean and tidy. The process is described further below.
@@ -10 +10 @@
 .. note::
 
-  The term 'application' has a double meaning in English. An 'application' in computer sciences is understood as a software or web application. Software developers may get confused by using the term in a different context. To take this into account, we prefer to speak of an 'applicant' in this documentation, instead of an 'application' although, in the linguistic context, it sometimes makes more sense to speak of the latter. However, in the user interface (UI) and also in Python docstrings the term 'application' predominates.
+  The term 'application' has a double meaning in English. An 'application' in computer sciences stands for a software or web application. Software developers may get confused by using the term in a different context. To take this into account, we prefer to speak of 'applicant' in this documentation, instead of 'application' although, in the linguistic context, it sometimes makes more sense to speak of the latter. However, in the user interface (UI) and also in Python docstrings the term 'application' predominates.
+
+In contrast to student containers, applicant containers do not contain subcontainers. The only objects they contain are applicant payment tickets (i.e. instances `ApplicantOnlinePayment`). Thus it does not make sense to speak of a  treelike structure. In contrast to the students section

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

@@ -89 +89 @@
    :noindex:
 
-Applicant Section Permissions
------------------------------
+Applicants Section Permissions
+------------------------------
 
 .. autoclass:: waeup.kofa.applicants.permissions.ViewApplication()
@@ -107 +107 @@
    :noindex:
 
-Student Section Permissions
----------------------------
+Students Section Permissions
+----------------------------
 
 .. autoclass:: waeup.kofa.students.permissions.ViewStudent()
@@ -199 +199 @@
    :noindex:
 
-Global Applicant Section Roles
-------------------------------
-
-Global Applicant Section Roles are assigned portal-wide (globally)
-but do actually only allocate permissions in the applicant section.
+Global Applicants Section Roles
+-------------------------------
+
+Global Applicants Section Roles are assigned portal-wide (globally)
+but do actually only allocate permissions in the applicants section.
 
 .. autoclass:: waeup.kofa.applicants.permissions.ApplicantRole()
@@ -214 +214 @@
    :noindex:
 
-Global Student Section Roles
-----------------------------
-
-Global Student Section Roles are assigned portal-wide (globally) but
-do actually only allocate permissions in the student section.
+Global Students Section Roles
+-----------------------------
+
+Global Students Section Roles are assigned portal-wide (globally) but
+do actually only allocate permissions in the students section.
 
 .. autoclass:: waeup.kofa.students.permissions.StudentRole()
@@ -249 +249 @@
 strange that some of these 'odd' roles do not give more permissions
 than the user already has due to other roles. Their real purpose is to
-delegate permissions to the students or applicant section. If a user
+delegate permissions to the students or applicants section. If a user
 has for example the LocalStudentsManager role described below at
 department level, s/he automatically gets the StudentsManager role for

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

@@ -1 +1 @@
 .. _student_section:
 
-Student Section
-***************
+Students Section
+****************
 
 'Student' is a multi-purpose term in Kofa which may lead to some
@@ -13 +13 @@
 
 The :ref:`treelike storage of objects <object_database>` in the
-student section can be figured as follows::
+students section can be figured as follows::
 
 
-  Student Section (StudentsContainer)
+  Students Section (StudentsContainer)
   |
   +---> Student

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

@@ -1 +1 @@
 .. _students_browser:
 
-Browsing the Student Section
-============================
+Browsing the Students Section
+=============================
 
 The reader may ask: How do officers and students browse the portal?
@@ -376 +376 @@
 
 Lecturers cannot access student records directly. They don't have
-access to the student section. Instead, lecturers go to their course
+access to the students section. Instead, lecturers go to their course
 in the academic section and view or export lists of students who
 attended the course, either in a previous or in the current session.

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

@@ -308 +308 @@
 -----------------------
 
+`IStudentOnlinePayment` instances are called student payment tickets
+or sometimes only payments. They contain the data which confirm that
+the student has paid a specific fee.
 `waeup.kofa.students.interfaces.IStudentOnlinePayment` inherits from
 `waeup.kofa.payments.interfaces.IOnlinePayment` and has only two

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

@@ -72 +72 @@
     grok.require('waeup.Public')
     form_fields = grok.AutoFields(IApplicantsRoot)
-    label = _('Applicant Section')
+    label = _('Applicants Section')
     pnav = 3
 
@@ -127 +127 @@
     grok.template('applicantsrootmanagepage')
     form_fields = grok.AutoFields(IApplicantsRoot)
-    label = _('Manage applicant section')
+    label = _('Manage applicants section')
     pnav = 3
     grok.require('waeup.manageApplication')

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

@@ -476 +476 @@
 
     This reduced interface is for former students or students who are not
-    users of the portal but have to pay supplementary fees.
+    student users of the portal but have to pay supplementary fees.
 
     This interface is used in browser components only. Thus we can't add

main/waeup.kofa/trunk/src/waeup/kofa/applicants/tests/test_browser.py

@@ -204 +204 @@
         self.assertRaises(
             LinkNotFoundError,
-            self.browser.getLink, 'Manage applicant section')
+            self.browser.getLink, 'Manage applicants section')
         self.assertRaises(
             Unauthorized, self.browser.open, self.manage_root_path)
@@ -216 +216 @@
         self.browser.addHeader('Authorization', 'Basic mgr:mgrpw')
         self.browser.open(self.root_path)
-        self.assertTrue('Manage applicant section' in self.browser.contents)
+        self.assertTrue('Manage applicants section' in self.browser.contents)
         # There is a manage link
-        link = self.browser.getLink('Manage applicant section')
+        link = self.browser.getLink('Manage applicants section')
         link.click()
         self.assertEqual(self.browser.headers['Status'], '200 Ok')
@@ -252 +252 @@
         self.browser.getControl("Save").click()
         self.browser.open(self.root_path)
-        self.assertTrue('Manage applicant section' in self.browser.contents)
+        self.assertTrue('Manage applicants section' in self.browser.contents)
         # There is a search link
         link = self.browser.getLink('Find applicants')
@@ -562 +562 @@
         self.assertEqual(self.browser.headers['Status'], '200 Ok')
         self.assertFalse('Search' in self.browser.contents)
-        self.assertFalse('Manage applicant section' in self.browser.contents)
+        self.assertFalse('Manage applicants section' in self.browser.contents)
         # ... and can't access the manage page
         self.assertRaises(

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

@@ -16 +16 @@
 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 ##
-"""General helper functions and utilities for the applicant section.
+"""General helper functions and utilities for the applicants section.
 """
 

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

@@ -97 +97 @@
     grok.view(ApplicantsRootPage)
     grok.require('waeup.manageApplication')
-    text = _('Manage applicant section')
+    text = _('Manage applicants section')
 
 class ApplicantRegisterActionButton(ManageActionButton):

main/waeup.kofa/trunk/src/waeup/kofa/students/browser.py

@@ -288 +288 @@
     grok.template('containermanagepage')
     pnav = 4
-    label = _('Manage student section')
+    label = _('Manage students section')
     search_button = _('Find student(s)')
     remove_button = _('Remove selected')

main/waeup.kofa/trunk/src/waeup/kofa/students/interfaces.py

@@ -179 +179 @@
 class IStudentNavigation(IStudentNavigationBase):
     """Interface needed for navigation and logging. This interface is
-    implemented by all content classes in the student section.
+    implemented by all content classes in the students section.
     """
     student = Attribute('Student object of context')

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

@@ -17 +17 @@
 ##
 """
-Permissions for the student section.
+Permissions for the students section.
 """
 import grok
 
-# Student section permissions
+# Students section permissions
 
 class HandleStudent(grok.Permission):

main/waeup.kofa/trunk/src/waeup/kofa/students/tests/test_browser.py

@@ -257 +257 @@
         self.assertEqual(self.browser.headers['Status'], '200 Ok')
         self.assertEqual(self.browser.url, self.container_path)
-        self.browser.getLink("Manage student section").click()
+        self.browser.getLink("Manage students section").click()
         self.assertEqual(self.browser.headers['Status'], '200 Ok')
         self.assertEqual(self.browser.url, self.manage_container_path)

main/waeup.kofa/trunk/src/waeup/kofa/students/utils.py

@@ -16 +16 @@
 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 ##
-"""General helper functions and utilities for the student section.
+"""General helper functions and utilities for the students section.
 """
 import grok

main/waeup.kofa/trunk/src/waeup/kofa/students/viewlets.py

@@ -139 +139 @@
     grok.view(StudentsContainerPage)
     grok.require('waeup.manageStudent')
-    text = _('Manage student section')
+    text = _('Manage students section')
 
 class StudentsContainerAddActionButton(AddActionButton):

main/waeup.kofa/trunk/src/waeup/kofa/students/vocabularies.py

@@ -16 +16 @@
 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 ##
-"""Vocabularies and sources for the student section.
+"""Vocabularies and sources for the students section.
 """
 from zope.component import getUtility, queryUtility

main/waeup.kofa/trunk/src/waeup/kofa/university/catalog.py

@@ -57 +57 @@
 class CertificateCoursesIndexes(grok.Indexes):
     """This catalog is needed for automatic removal of certificate courses
-    and later for selection of course tickets in the student section.
+    and later for selection of course tickets in the students section.
     """
     grok.site(IUniversity)