Changeset 13124 for main/waeup.kofa/trunk/docs

Timestamp:

1 Jul 2015, 16:24:58 (9 years ago)

Author:

Henrik Bettermann

Message:

More docs.

Location:

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

Files:

• browsing.rst (modified) (1 diff)
• customization.rst (modified) (2 diffs)

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

@@ -57 +57 @@
 
 
-.. _manage_edit_pages:
+.. _views_pages:
 
 Views, Pages and Form Pages

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

@@ -49 +49 @@
 localization. Translation is done via ``po`` text files which are
 located in the ``locales`` folder of a package. Each language has
-its own subfolder. Localized English Kofa terms, for intance, can be
+its own subfolder. Localized English Kofa terms, for instance, can be
 found in ``locales/en/LC_MESSAGES/waeup.kofa.po``. A single
 entry/message consists of two lines.
@@ -71 +71 @@
 ===============
 
+Adding further schema field attributes to content components can be
+done by inheriting Zope interfaces from the base package and adding
+new schema fields to these custom interfaces, see :ref:`note
+<kofa_interfaces>`. This sounds simple, but it isn't. There are many
+things to think about, when customizing interfaces:
+
+1. A customized interface alone doesn't have any effect, beause the
+   content classes still implement the original interfaces. Thus, also
+   all content classes, which are supposed to implement the extended
+   interfaces, must be customized, and must be registered instead of
+   the orginal classes which they inherit from. Drawback is, that this
+   must be done before the first start-up of the portal. Otherwise,
+   instances of the original content classes might have been created
+   which cannot be changed afterwards.
+
+2. Also the forms which are being auto-generated by
+   `grok.AutoFields` (see :ref:`views_pages`), must be customized and
+   use the new and extended interfaces. Otherwise added fields won't
+   appear on form pages.
+
+3. The same holds for exporters and importers. They also consider
+   the fields from interfaces when processing the data. If we forget to
+   customize exporter or batch processor classes, only the fields from
+   the original interfaces will be exported or reimported.
+
+
 Zope Utilities
 ==============
 
-Zope utilities are dedicated to customization by overriding their methods in custom packages.
+Kofa's global utilities are perfectly suited for customization.
+Their attributes and methods can be easily overridden in custom
+packages.
 
 Kofa Utils
 ----------
 
+The central `KofaUtils` utility contains not only most dictionaries
+used for sources (see
+:py:class:`API <waeup.kofa.utils.utils.KofaUtils>`) but also attributes 
+like `PORTAL_LANGUAGE` and `tzinfo`. The first defines the default
+language, which is used for pdf slips. The second defines the time
+zone where the institution is located.
+
+Customizable utility methods are:
+
+.. automethod:: waeup.kofa.utils.utils.KofaUtils.sendContactForm()
+   :noindex:
+
+.. automethod:: waeup.kofa.utils.utils.KofaUtils.fullname()
+   :noindex:
+
+.. automethod:: waeup.kofa.utils.utils.KofaUtils.genPassword()
+   :noindex:
+
+.. automethod:: waeup.kofa.utils.utils.KofaUtils.sendCredentials()
+   :noindex:
+
+.. automethod:: waeup.kofa.utils.utils.KofaUtils.getPaymentItem()
+   :noindex:
+
 Students Utils
 --------------
+
+Customizable utility methods are:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.getReturningData()
+   :noindex:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.setReturningData()
+   :noindex:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.setPaymentDetails()
+   :noindex:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.setBalanceDetails()
+   :noindex:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.increaseMatricInteger()
+   :noindex:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.constructMatricNumber()
+   :noindex:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.setMatricNumber()
+   :noindex:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.getAccommodationDetails()
+   :noindex:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.selectBed()
+   :noindex:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.renderPDFAdmissionLetter()
+   :noindex:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.getPDFCreator()
+   :noindex:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.renderPDF()
+   :noindex:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.renderPDFTranscript()
+   :noindex:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.maxCredits()
+   :noindex:
+
+.. automethod:: waeup.kofa.students.utils.StudentsUtils.getBedCoordinates()
+   :noindex:
+
+
+
 
 Applicants Utils