Changeset 12909 for main/waeup.kofa/trunk/docs/source
- Timestamp:
- 6 May 2015, 17:10:36 (10 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
main/waeup.kofa/trunk/docs/source/userdocs/academics.rst
r12908 r12909 4 4 **************** 5 5 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. 6 Academic bodies of universities are hierarchically structured. A 7 university contains faculties which again host departments. The 8 latter offer courses (course units) and study programmes (courses of 9 study). A course is series of classes or lessons on a particular 10 subject. This can be a lecture, tutorial, seminar, practical work 11 offered by a lecturer of the department over a period of an academic 12 term. A course can also be only an exam at the end of an academic 13 term. A study programme is defined by a set of course units to be 14 taken at various programme levels and by an academic degree 15 certificate, which is issued at the end of the programme. 16 Information about universities, their study programmes, lecturers 17 and courses can be found in the university prospectus. 7 18 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>`. 19 Kofa's academic section takes on the task of the university 20 prospectus. It is build to disseminate information about faculties, 21 departments, courses, study programmes and the sets of courses to be 22 taken. The academic section reflects exactly the universities' 23 hierarchical structure as described above. Technically speaking, the 24 academic section is a container of type `FacultiesContainer` with id 25 ``academics`` which contains faculty sub-containers. They again 26 contain department sub-objects, nothing else. This leads to a 27 :ref:`treelike storage of objects <object_database>`. 9 28 10 29 Faculties 11 30 ========= 12 31 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: 32 Faculties are container objects of type `Faculty`. They have a 33 `code`, a `title` and a `title_prefix` attribute. Furthermore, 34 faculties and departments have a `longtitle` property which 35 :py:func:`composes <waeup.kofa.university.faculty.longtitle>` and 36 returns the full title as it appears in tables, in breadcrumbs and 37 in many other places: 14 38 15 39 `longtitle` = `title_prefix` + `title` (`code`) 16 40 17 The following :ref:`local roles <local_roles>` can be assigned at faculty tree level: 41 The following :ref:`local roles <local_roles>` can be assigned at 42 faculty tree level: 18 43 19 44 .. autoattribute:: waeup.kofa.university.faculty.Faculty.local_roles … … 22 47 =========== 23 48 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>`. 49 Additionally, each department object has the attributes 50 `certificates` and `courses`. These attributes again are containers 51 which hold certificate and course objects respectively. A 52 :py:meth:`traverse 53 <waeup.kofa.university.department.Department.traverse>` method leads 54 the user to believe that `certificates` and `courses` are the ids of 55 objects stored inside a department container. De facto they are not. 56 However, it doesn't matter if we store a sub-object 'in' or 'at' a 57 parent object. The result is exactly the same: :ref:`a hierarchical, 58 treelike storage of objects <object_database>`. 25 59 26 The following :ref:`local roles <local_roles>` can be assigned at department tree level: 60 The following :ref:`local roles <local_roles>` can be assigned at 61 department tree level: 27 62 28 63 .. autoattribute:: waeup.kofa.university.department.Department.local_roles … … 31 66 ======= 32 67 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. 68 The `Course` class inherits from `grok.Model` which means it is 69 designed as a pure model and not a container. Courses are tips of 70 the database tree branches. Course objects contain information as 71 they are offered by the department. In the base package these are: 72 `code`, `title`, `credits`, `passmark`, `semester` and the boolean 73 attribute `former_course`. Like all objects in the academic section, 74 they also have a `longtitle` property. A former course is an 75 archived course which had been offered in the past and is no longer 76 part of any curriculum. 34 77 35 78 .. note:: 36 79 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. 38 91 39 The following :ref:`local roles <local_roles>` can be assigned at course tree level: 92 The following :ref:`local roles <local_roles>` can be assigned at 93 course tree level: 40 94 41 95 .. autoattribute:: waeup.kofa.university.course.Course.local_roles … … 45 99 ============ 46 100 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. 101 In Kofa, the terms 'certificate' and 'study programme' are used 102 synonymously. A certificate object holds information about the study 103 programme. Important data for further processing in Kofa are: the 104 various school fees to be paid at certain levels, programme start 105 and end level, the study mode and, last but not least, the 106 application category to which the programme belongs. 48 107 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. 108 Certificates are containers which contain `CertificateCourse` 109 objects. thatt means a certificate defines the curriculum, i.e. the 110 list of course units which have to or can be taken within the 111 programme. 50 112 51 The following :ref:`local roles <local_roles>` can be assigned at certificate tree level: 113 The following :ref:`local roles <local_roles>` can be assigned at 114 certificate tree level: 52 115 53 116 .. autoattribute:: waeup.kofa.university.certificate.Certificate.local_roles … … 57 120 =================== 58 121 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 123 they have a `course` attribute which is one of the course objects 124 stored in the portal. If the course is removed, an event handler 125 takes care of deleting also all referring certificate courses. The 126 same happens if a course is beeing marked as former course (see 127 above). A former course cannot be part of a curriculum. 60 128 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. 129 Certificate courses have to more attributes: `level` (integer) and 130 `mandatory` (boolean). Simply put, certificate courses carry the 131 information at which level a certain course can or has to be taken 132 to meet the current curriculum. 62 133 63 134 No local role can be assigned at certificate course tree level.
Note: See TracChangeset for help on using the changeset viewer.
