Changeset 14548 for main

Timestamp:

14 Feb 2017, 18:04:35 (8 years ago)

Author:

Henrik Bettermann

Message:

Update documentation.

File:

• main/waeup.kofa/trunk/docs/source/userdocs/academics.rst (modified) (3 diffs)

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

@@ -48 +48 @@
 
 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:
+`code`, a `title` a `title_prefix` and two officer name attributes:
+`officer_1` and `officer_2`. Officer names are not made use of in
+the base package. They can be used in custom packages to 'sign' pdf
+slips and reports. Usually, `officer_1` is reserved for the Dean of
+Faculty. 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:
 
   `longtitle` = `title_prefix` + `title` (`code`)
@@ -68 +72 @@
 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
+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
@@ -75 +79 @@
 However, it doesn't matter if we store a subobject 'in' or 'at' a
 parent object. The result is exactly the same: :ref:`a hierarchical,
-treelike storage of objects <object_database>` (see also diagram above).
+treelike storage of objects <object_database>` (see also diagram
+above).
+
+Department objects have four officer name attributes. Needless to say,
+`officer_1` should contain the name of the Head of Department. The
+title of the name fields can be localized in custom packages.
 
 The following :ref:`local roles <local_roles>` can be assigned at