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

Timestamp:

2 Jul 2015, 10:06:52 (9 years ago)

Author:

Henrik Bettermann

Message:

More docs.

File:

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

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

@@ -109 +109 @@
 The central `KofaUtils` utility contains not only most dictionaries
 used for sources (see :py:class:`API
-<waeup.kofa.utils.utils.KofaUtils>`) but also configuration
-attributes like
+<waeup.kofa.utils.utils.KofaUtils>`) but also **configuration
+attributes** like
 
 .. autoattribute:: waeup.kofa.utils.utils.KofaUtils.PORTAL_LANGUAGE
@@ -121 +121 @@
    :noindex:
 
-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
---------------
-
-`StudentsUtils` contains the following configuration attributes:
+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 Utilities
+------------------
+
+`StudentsUtils` contains the following **configuration attributes**:
 
 .. autoattribute:: waeup.kofa.students.utils.StudentsUtils.STUDENT_ID_PREFIX
@@ -161 +161 @@
    :noindex:
 
-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
-----------------
-
-
+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 Utililties
+---------------------
+
+`ApplicantsUtils` contains the following **configuration attributes**:
+
+.. autoattribute:: waeup.kofa.applicants.utils.ApplicantsUtils.APP_TYPES_DICT
+   :noindex:
+
+.. autoattribute:: waeup.kofa.applicants.utils.ApplicantsUtils.SEPARATORS_DICT
+   :noindex:
+
+Customizable **utility methods** are:
+
+.. automethod:: waeup.kofa.applicants.utils.ApplicantsUtils.setPaymentDetails
+   :noindex:
+
+.. automethod:: waeup.kofa.applicants.utils.ApplicantsUtils.getApplicantsStatistics
+   :noindex:
+
+.. automethod:: waeup.kofa.applicants.utils.ApplicantsUtils.sortCertificates
+   :noindex:
+
+.. automethod:: waeup.kofa.applicants.utils.ApplicantsUtils.getCertTitle
+   :noindex: