Ignore:
Timestamp:
13 Jul 2015, 08:37:27 (9 years ago)
Author:
Henrik Bettermann
Message:

More docs.

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

Legend:

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

    r13084 r13167  
    164164above). A former course cannot be part of a curriculum.
    165165
    166 Certificate courses have to more attributes: `level` (integer) and
     166Certificate courses have two more attributes: `level` (integer) and
    167167`mandatory` (boolean). Simply put, certificate courses carry the
    168168information at which level a certain course can or has to be taken
  • main/waeup.kofa/trunk/docs/source/userdocs/customization.rst

    r13133 r13167  
    110110used for sources (see :py:class:`API
    111111<waeup.kofa.utils.utils.KofaUtils>`) but also **configuration
    112 attributes** like
     112attributes** like:
    113113
    114114.. autoattribute:: waeup.kofa.utils.utils.KofaUtils.PORTAL_LANGUAGE
  • main/waeup.kofa/trunk/docs/source/userdocs/documents.rst

    r13156 r13167  
    11.. _documents:
    22
    3 Public Documents
    4 ****************
     3Documents Section
     4*****************
    55
    66The documents section of Kofa is a tiny built-in content management
     
    1010and registration procedures.
    1111
    12 Technically speaking, the documents section is a container of type
    13 `DocumentsContainer` with id ``documents``, which is located in the
    14 `IUniversity` instance and which contains documents. There are three
    15 types of public documents::
     12Technically speaking, the documents section is a container of type `DocumentsContainer` with id ``documents``, which is located in the `IUniversity` instance and which contains public documents. There are three types of public documents::
    1613
    17   Public Documents (DocumentsContainer)
     14  Documents Section (DocumentsContainer)
    1815  |
    1916  +---> PDFDocument
  • main/waeup.kofa/trunk/docs/source/userdocs/hostels.rst

    r12908 r13167  
    33Accommodation Section :sup:`in progress`
    44****************************************
     5
     6The accommodation sections is a built-in hostel management system. African universities usually run their own student hostels which are built on their huge university campuses. They combine the booking of beds with the registration process. There are two major use cases. Students either have to book a bed space before they can continue with the registration, or they are only allowed to book, if they have reached a certain registration state. In the first case, the university requires students to stay on campus. They usually have enough beds for all of their students and need to fill up the hostels. In the second case, bed space is limited. Since accommodation is usually very reasonable and much safer on campus than on the free market outside, students prefer accommodation on campus. If bed allocation e.g. requires the payment of school fees, students are forced to pay in order to get the highly coveted hostel bed.
     7
     8Technically speaking, the accommodation section is a container of type `HostelsContainer` with id ``hostels``, which is located in the `IUniversity` instance. It contains hostels (instances of `IHostel`) which again contain the beds (instances of `IBed`).
     9
     10The :ref:`treelike storage of objects <object_database>` in the
     11accommodation section can be figured as follows::
     12
     13
     14  Accommodation Section (HostelsContainer)
     15  |
     16  +---> Hostel
     17        |
     18        +---> Bed
     19
     20Interfaces
     21==========
     22
     23
     24.. literalinclude:: ../../../src/waeup/kofa/hostels/interfaces.py
     25   :pyobject: IHostelsContainer
     26
     27.. literalinclude:: ../../../src/waeup/kofa/hostels/interfaces.py
     28   :pyobject: IHostel
     29
     30.. literalinclude:: ../../../src/waeup/kofa/hostels/interfaces.py
     31   :pyobject: IBed
Note: See TracChangeset for help on using the changeset viewer.