Changeset 13174 for main


Ignore:
Timestamp:
16 Jul 2015, 09:31:46 (9 years ago)
Author:
Henrik Bettermann
Message:

Extend intro.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • main/waeup.kofa/trunk/README.txt

    r12968 r13174  
    22********************
    33
    4 Kofa, which means 'entrance' or 'portal' in Hausa language,
    5 is a multifunctional Student Management System and a
    6 Web Portal to provide transparent and comprehensive information about
    7 study progress. The system controls all kinds of application and student
    8 registration processes at large schools and universities in Nigeria.
     4Kofa, which means 'entrance' or 'portal' in Hausa language, is a
     5multifunctional, open source, web based student management system to
     6provide transparent and comprehensive information about application
     7and study progress. Kofa is the flagship of the West African
     8eUniversity Project (WAeUP). See http://www.waeup.org to learn more
     9about WAeUP. The system controls all kinds of application and
     10student registration processes at large schools and universities in
     11Nigeria. It is a generic system which can be deployed by and is
     12useful to most universities, colleges or schools wordlwide.
    913
    10 Kofa is the flagship of the West African eUniversity Project (WAeUP).
    11 See http://www.waeup.org to learn more about WAeUP.
     14Kofa is really an allrounder. The best way to briefly describe Kofa,
     15is to explain what Kofa can *not* do for you, rather than trying to
     16describe all the features in just a few words. Kofa is primarily not
     17an e-learning system, although, it has some basic content management
     18features which can be used by lecturers to disseminate course
     19material. Kofa is also not a scheduler which generates lesson plans
     20or timetables for lecturers or students. Although students register
     21their courses with Kofa and can see or print course lists for each
     22academic session, so far, courses do not contain information, when
     23or where they take place. However, due to the modular design of Kofa,
     24a scheduler or room planner could be easily added.
    1225
    13 Installation instructions can be found in the User Handbook (docs
    14 folder in the file system).
     26Kofa is divided into sections. To each section belongs a folder in
     27Kofa's :ref:`object database <object_database>`. When starting Kofa
     28in debug mode::
     29
     30  $ ./bin/kofactl debug
     31
     32we can use simple Python expression to view the first two levels of
     33the database structure::
     34
     35  >>> list(root.keys())
     36  [u'app']
     37  >>> list(root['app'].keys())
     38  [u'accesscodes', u'applicants', u'configuration', u'datacenter',
     39   u'documents', u'faculties', u'hostels', u'mandates', u'reports',
     40   u'students', u'users']
     41
     42
     43Each of these subfolders in the root folder of the database belongs
     44to such a section. The section structure can be figured as follows::
     45
     46  root (Database Root)
     47  |
     48  +---> app (University)
     49        |
     50        +---> faculties (Academic Section)
     51        |
     52        +---> students (Students Section)
     53        |
     54        +---> applicants (Aplicants Section)
     55        |
     56        +---> documents (Documents Section)
     57        |
     58        +---> hostels (Accommodation Section)
     59        |
     60        +---> accesscodes (Access Codes Section)
     61        |
     62        +---> configuration (Configuration Section)
     63        |
     64        +---> users (Officers)
     65        |
     66        +---> datacenter (Data Center)
     67        |
     68        +---> mandates (Mandates)
     69        |
     70        +---> reports (Reports)
     71
     72The user handbook follows this organizational structure and adds
     73further chapters where needed. Also installation instructions and
     74basic information about customization can be found there.
Note: See TracChangeset for help on using the changeset viewer.