Changeset 12909


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

Wrap lines.

File:
1 edited

Legend:

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

    r12908 r12909  
    44****************
    55
    6 Academic bodies of universities are hierarchically structured. A university contains faculties which again host departments. The latter offer course (course units) and study programmes (courses of study). A course is series of classes or lessons on a particular subject. This can be a lecture, tutorial, seminar, practical work offered by a lecturer of the department over a period of an academic term. A course can also be only an exam at the end of an academic term. A study programme is defined by a set of course units to be taken at various programme levels and by an academic degree certificate, which is issued at the end of the programme. Information about universities, their study programmes, lecturers and courses can be found in the university prospectus.
     6Academic bodies of universities are hierarchically structured. A
     7university contains faculties which again host departments. The
     8latter offer courses (course units) and study programmes (courses of
     9study). A course is series of classes or lessons on a particular
     10subject. This can be a lecture, tutorial, seminar, practical work
     11offered by a lecturer of the department over a period of an academic
     12term. A course can also be only an exam at the end of an academic
     13term. A study programme is defined by a set of course units to be
     14taken at various programme levels and by an academic degree
     15certificate, which is issued at the end of the programme.
     16Information about universities, their study programmes, lecturers
     17and courses can be found in the university prospectus.
    718
    8 Kofa's academic section takes on the task of the university prospectus. It is build to disseminate information about faculties, departments, courses, study programmes and the sets of courses to be taken. The academic section reflects exactly the universities' hierarchical structure as described above. Technically speaking, the academic section is a container of type `FacultiesContainer` with id ``academics`` which contains faculty sub-containers. They again contain department sub-objects, nothing else. This leads to a  :ref:`treelike storage of objects <object_database>`.
     19Kofa's academic section takes on the task of the university
     20prospectus. It is build to disseminate information about faculties,
     21departments, courses, study programmes and the sets of courses to be
     22taken. The academic section reflects exactly the universities'
     23hierarchical structure as described above. Technically speaking, the
     24academic section is a container of type `FacultiesContainer` with id
     25``academics`` which contains faculty sub-containers. They again
     26contain department sub-objects, nothing else. This leads to a
     27:ref:`treelike storage of objects <object_database>`.
    928
    1029Faculties
    1130=========
    1231
    13 Faculties are container objects of type `Faculty`. They have a `code`, a `title` and a `title_prefix` attribute.  Furthermore, faculties and departments have a `longtitle` property which :py:func:`composes <waeup.kofa.university.faculty.longtitle>` and returns the full title as it appears in tables, in breadcrumbs and in many other places:
     32Faculties are container objects of type `Faculty`. They have a
     33`code`, a `title` and a `title_prefix` attribute. Furthermore,
     34faculties and departments have a `longtitle` property which
     35:py:func:`composes <waeup.kofa.university.faculty.longtitle>` and
     36returns the full title as it appears in tables, in breadcrumbs and
     37in many other places:
    1438
    1539  `longtitle` = `title_prefix` + `title` (`code`)
    1640
    17 The following :ref:`local roles <local_roles>` can be assigned at faculty tree level:
     41The following :ref:`local roles <local_roles>` can be assigned at
     42faculty tree level:
    1843
    1944  .. autoattribute:: waeup.kofa.university.faculty.Faculty.local_roles
     
    2247===========
    2348
    24 Additionally, 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>`.
     49Additionally, each department object has the attributes
     50`certificates` and `courses`. These attributes again are containers
     51which hold certificate and course objects respectively. A
     52:py:meth:`traverse
     53<waeup.kofa.university.department.Department.traverse>` method leads
     54the user to believe that `certificates` and `courses` are the ids of
     55objects stored inside a department container. De facto they are not.
     56However, it doesn't matter if we store a sub-object 'in' or 'at' a
     57parent object. The result is exactly the same: :ref:`a hierarchical,
     58treelike storage of objects <object_database>`.
    2559
    26 The following :ref:`local roles <local_roles>` can be assigned at department tree level:
     60The following :ref:`local roles <local_roles>` can be assigned at
     61department tree level:
    2762
    2863  .. autoattribute:: waeup.kofa.university.department.Department.local_roles
     
    3166=======
    3267
    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`. 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.
     68The `Course` class inherits from `grok.Model` which means it is
     69designed as a pure model and not a container. Courses are tips of
     70the database tree branches. Course objects contain information as
     71they are offered by the department. In the base package these are:
     72`code`, `title`, `credits`, `passmark`, `semester` and the boolean
     73attribute `former_course`. Like all objects in the academic section,
     74they also have a `longtitle` property. A former course is an
     75archived course which had been offered in the past and is no longer
     76part of any curriculum.
    3477
    3578.. note::
    3679
    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.
     80  Only the department, which offers the course, decides how many
     81  credits can be earned, which pass mark must be achieved and in which
     82  semester the course can be taken. The manager of the department
     83  cannot decide whether a course is mandatory or not, or at which
     84  study level the course has to be taken when studying a certain
     85  programme. This information is stored in `CertificateCourse` objects,
     86  see below. Therefore it does not make sense to speak e.g. of a 300
     87  level course. Also course codes like ``AEE311``, which tell the
     88  student that the course is primarily intended for 300 level students,
     89  is somehow misleading. There might be other study programmes which
     90  recommend to take this course earlier or later.
    3891
    39 The following :ref:`local roles <local_roles>` can be assigned at course tree level:
     92The following :ref:`local roles <local_roles>` can be assigned at
     93course tree level:
    4094
    4195  .. autoattribute:: waeup.kofa.university.course.Course.local_roles
     
    4599============
    46100
    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 end level, the study mode and, last but not least, the application category to which the programme belongs.
     101In Kofa, the terms 'certificate' and 'study programme' are used
     102synonymously. A certificate object holds information about the study
     103programme. Important data for further processing in Kofa are: the
     104various school fees to be paid at certain levels, programme start
     105and end level, the study mode and, last but not least, the
     106application category to which the programme belongs.
    48107
    49 Certificates 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.
     108Certificates are containers which contain `CertificateCourse`
     109objects. thatt means a certificate defines the curriculum, i.e. the
     110list of course units which have to or can be taken within the
     111programme.
    50112
    51 The following :ref:`local roles <local_roles>` can be assigned at certificate tree level:
     113The following :ref:`local roles <local_roles>` can be assigned at
     114certificate tree level:
    52115
    53116  .. autoattribute:: waeup.kofa.university.certificate.Certificate.local_roles
     
    57120===================
    58121
    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.
     122`CertificateCourse` objects point to `Course` objects which means
     123they have a `course` attribute which is one of the course objects
     124stored in the portal. If the course is removed, an event handler
     125takes care of deleting also all referring certificate courses. The
     126same happens if a course is beeing marked as former course (see
     127above). A former course cannot be part of a curriculum.
    60128
    61 Certificate 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.
     129Certificate courses have to more attributes: `level` (integer) and
     130`mandatory` (boolean). Simply put, certificate courses carry the
     131information at which level a certain course can or has to be taken
     132to meet the current curriculum.
    62133
    63134No local role can be assigned at certificate course tree level.
Note: See TracChangeset for help on using the changeset viewer.