source: main/waeup.kofa/trunk/docs/source/userdocs/configuration.rst @ 13118

Last change on this file since 13118 was 13118, checked in by Henrik Bettermann, 9 years ago

More docs.

File size: 1.6 KB
Line 
1Configuration and Customization
2*******************************
3
4.. _configuration:
5
6Portal Configuration
7====================
8
9There are many places in Kofa where portal parameters can be set or
10page descriptions can be added. These parameters are attributes of
11either dedicated configuration objects or of containers in the
12academics and applicants section. The latter have been described
13elsewehere. Here we explain the interfaces of the configuration
14section.
15
16Technically speaking, the portal configuration section is a
17container of type `ConfigurationContainer` with id ``configuration``
18which contains session configuration subcontainers::
19
20
21  Portal Configuration (ConfigurationContainer)
22  |
23  +--->SessionConfiguration
24
25Much like ``academics``, ``students``, ``applicants``, ``hostels``
26and ``documents``, also ``configuration`` is a unique container
27which is located in the `IUniversity` instance.
28
29Site Settings
30-------------
31
32The site setting parameters are the attributes of the configuration
33container to be set via the `ConfigurationContainerManageFormPage`.
34The page opens, if an officer with
35:py:class:`ManagePortalConfiguration<waeup.kofa.permissions.ManagePortalConfiguration>`
36permission clicks the 'Portal Configuration' link in the side box.
37
38.. literalinclude:: ../../../src/waeup/kofa/interfaces.py
39   :pyobject: IConfigurationContainer
40
41The page alows furthermore to add or access the containing session
42configuration objects.
43
44Session Settings
45----------------
46
47
48
49.. literalinclude:: ../../../src/waeup/kofa/interfaces.py
50   :pyobject: ISessionConfiguration
51
52
53
54
55.. _customization:
56
57Portal Customization
58====================
Note: See TracBrowser for help on using the repository browser.