Changeset 12908


Ignore:
Timestamp:
6 May 2015, 16:59:16 (10 years ago)
Author:
Henrik Bettermann
Message:

More docs.

Location:
main/waeup.kofa/trunk/docs/source/userdocs
Files:
9 edited

Legend:

Unmodified
Added
Removed
  • main/waeup.kofa/trunk/docs/source/userdocs/academics.rst

    r12906 r12908  
    11.. _academic_section:
    22
    3 Academic Section
     3Academic Section 
    44****************
    55
     
    1515  `longtitle` = `title_prefix` + `title` (`code`)
    1616
    17 The following :ref:`local roles <local_roles>` can be assigned at faculty level:
     17The following :ref:`local roles <local_roles>` can be assigned at faculty tree level:
    1818
    1919  .. autoattribute:: waeup.kofa.university.faculty.Faculty.local_roles
     
    2424Additionally, each department object has the attributes `certificates` and `courses`. These attributes again are containers which hold certificate and course objects respectively. A :py:meth:`traverse <waeup.kofa.university.department.Department.traverse>` method leads the user to believe that `certificates` and `courses` are the ids of objects stored inside a department container. De facto they are not. However, it doesn't matter if we store a sub-object 'in' or 'at' a parent object. The result is exactly the same: :ref:`a hierarchical, treelike storage of objects <object_database>`.
    2525
    26 The following :ref:`local roles <local_roles>` can be assigned at department level:
     26The following :ref:`local roles <local_roles>` can be assigned at department tree level:
    2727
    2828  .. autoattribute:: waeup.kofa.university.department.Department.local_roles
     
    3131=======
    3232
    33 The `Course` class inherits from `grok.Model` which means it is designed as a pure model and not a container. Courses are tips of the database tree branches. Course objects contain information as they are offered by the department. In the base package these are: `code`, `title`, `credits`, `passmark`, `semester` and the boolean attribute `former_course`. They also have a `longtitle` property. A former course is an archived course which had been offered in the past.
     33The `Course` class inherits from `grok.Model` which means it is designed as a pure model and not a container. Courses are tips of the database tree branches. Course objects contain information as they are offered by the department. In the base package these are: `code`, `title`, `credits`, `passmark`, `semester` and the boolean attribute `former_course`. Like all objects in the academic section, they also have a `longtitle` property. A former course is an archived course which had been offered in the past and is no longer part of any curriculum.
    3434
    3535.. note::
    3636
    37   Only the department, which offers the course, decides how many credits can be earned, which pass mark must be achieved and in which semester the course can be taken. The manager of the department cannot decide whether a course is mandatory or not, or at which study level the course has to be taken when studying a certain programme. This information is stored in `CertificateCourse` objects, see below. Therefore it does not make sense to speak e.g. of a 300 level course. Also course codes like ``AEE311``, which tell the student that the course is primarily intended for 300 level students, is somehow misleading. There might be other study programmes which recommend to take this course already at level 200.
     37  Only the department, which offers the course, decides how many credits can be earned, which pass mark must be achieved and in which semester the course can be taken. The manager of the department cannot decide whether a course is mandatory or not, or at which study level the course has to be taken when studying a certain programme. This information is stored in `CertificateCourse` objects, see below. Therefore it does not make sense to speak e.g. of a 300 level course. Also course codes like ``AEE311``, which tell the student that the course is primarily intended for 300 level students, is somehow misleading. There might be other study programmes which recommend to take this course earlier or later.
    3838
    39 The following :ref:`local roles <local_roles>` can be assigned at course level:
     39The following :ref:`local roles <local_roles>` can be assigned at course tree level:
    4040
    4141  .. autoattribute:: waeup.kofa.university.course.Course.local_roles
     
    4545============
    4646
    47 In Kofa, the terms 'certificate' and 'study programme' are used synonymously. A certificate object holds information about the study programme. Important data for further processing in Kofa are: the various school fees to be paid at certain levels, programme start and programme end level, the mode of the study course and, last but not least, the application category to which the programme belongs.
     47In Kofa, the terms 'certificate' and 'study programme' are used synonymously. A certificate object holds information about the study programme. Important data for further processing in Kofa are: the various school fees to be paid at certain levels, programme start and end level, the study mode and, last but not least, the application category to which the programme belongs.
    4848
    49 Certificates are also containers which contain `CertificateCourse` objects. That means a certificate defines the list of course units which have to or can be taken within the programme.
     49Certificates are containers which contain `CertificateCourse` objects. That means a certificate defines the curriculum, i.e. the list of course units which have to or can be taken within the programme.
    5050
    51 The following :ref:`local roles <local_roles>` can be assigned at certificate level:
     51The following :ref:`local roles <local_roles>` can be assigned at certificate tree level:
    5252
    5353  .. autoattribute:: waeup.kofa.university.certificate.Certificate.local_roles
     
    5757===================
    5858
     59`CertificateCourse` objects point to `Course` objects which means they have a `course` attribute which is one of the course objects stored in the portal. If the course is removed, an event handler takes care of deleting also all referring certificate courses. The same happens if a course is beeing marked as former course (see above). A former course cannot be part of a curriculum.
     60
     61Certificate courses have to more attributes: `level` (integer) and `mandatory` (boolean). Simply put, certificate courses carry the information at which level a certain course can or has to be taken to meet the current curriculum.
     62
     63No local role can be assigned at certificate course tree level.
    5964
    6065
  • main/waeup.kofa/trunk/docs/source/userdocs/accesscodes.rst

    r12829 r12908  
    11.. _accesscodes:
    22
    3 Access Codes
    4 ************
     3Access Codes :sup:`in progress`
     4*******************************
  • main/waeup.kofa/trunk/docs/source/userdocs/applicants.rst

    r12829 r12908  
    11.. _application_section:
    22
    3 Application Section
    4 *******************
     3Application Section :sup:`in progress`
     4**************************************
  • main/waeup.kofa/trunk/docs/source/userdocs/configuration.rst

    r12829 r12908  
    11.. _configuration:
    22
    3 Portal Configuration
    4 ********************
     3Portal Configuration :sup:`in progress`
     4***************************************
  • main/waeup.kofa/trunk/docs/source/userdocs/documents.rst

    r12829 r12908  
    11.. _documents:
    22
    3 Public Documents
    4 ****************
     3Public Documents :sup:`in progress`
     4***********************************
  • main/waeup.kofa/trunk/docs/source/userdocs/hostels.rst

    r12829 r12908  
    11.. _accommodation_section:
    22
    3 Accommodation Section
    4 *********************
     3Accommodation Section :sup:`in progress`
     4****************************************
  • main/waeup.kofa/trunk/docs/source/userdocs/reports.rst

    r12829 r12908  
    11.. _reports:
    22
    3 Reports
    4 *******
     3Reports :sup:`in progress`
     4**************************
  • main/waeup.kofa/trunk/docs/source/userdocs/students.rst

    r12829 r12908  
    11.. _student_section:
    22
    3 Student Section
    4 ***************
     3Student Section :sup:`in progress`
     4**********************************
  • main/waeup.kofa/trunk/docs/source/userdocs/users.rst

    r12829 r12908  
    11.. _users:
    22
    3 Portal Officers
    4 ***************
     3Portal Officers :sup:`in progress`
     4**********************************
Note: See TracChangeset for help on using the changeset viewer.