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

Timestamp:

19 Apr 2015, 05:32:19 (10 years ago)

Author:

Henrik Bettermann

Message:

Finalize exporter documentation.

File:

• main/waeup.kofa/trunk/docs/source/userdocs/datacenter.rst (modified) (2 diffs)

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

@@ -32 +32 @@
 .. note::
 
-  The list of exported columns usually underlies heavy customizations. In the Kofa base package only very fiew columns are being exported. In some Kofa custom packages tons of data are being gathered from applicants and students and the number of columns increase accordingly.
+  The list of exported columns usually underlies heavy customizations. In the Kofa base package only very few columns are being exported. In some Kofa custom packages tons of data are being gathered from applicants and students and the number of columns increase accordingly.
 
 The `title` attribute unveils the name of the exporter under which this exporter will be displayed in the user interface. The `mangle_value()` method shows how some of fields are being dynamically computed.
@@ -159 +159 @@
   .. automethod:: waeup.kofa.students.export.CourseTicketExporter.mangle_value()
 
+.. autoclass:: waeup.kofa.students.export.StudentPaymentsExporter()
+  :noindex:
+
+  .. autoattribute:: waeup.kofa.students.export.StudentPaymentsExporter.fields
+  .. autoattribute:: waeup.kofa.students.export.StudentPaymentsExporter.title
+  .. automethod:: waeup.kofa.students.export.StudentPaymentsExporter.mangle_value()
+
+.. autoclass:: waeup.kofa.students.export.BedTicketsExporter()
+  :noindex:
+
+  .. autoattribute:: waeup.kofa.students.export.BedTicketsExporter.fields
+  .. autoattribute:: waeup.kofa.students.export.BedTicketsExporter.title
+  .. automethod:: waeup.kofa.students.export.BedTicketsExporter.mangle_value()
+
+The above exporters refer to a specific content type (object class). They export all attributes of these objects and a few additional parameters derived from the parent objects. These exporters can be used for reimport, or more precisely for backing up and restoring data. The following 'special' exporters are made on request of some universities to collect and compose student data for analysis and postprocessing by the university.
+
+.. autoclass:: waeup.kofa.students.export.DataForBursaryExporter()
+  :noindex:
+
+  .. autoattribute:: waeup.kofa.students.export.DataForBursaryExporter.fields
+  .. autoattribute:: waeup.kofa.students.export.DataForBursaryExporter.title
+  .. automethod:: waeup.kofa.students.export.DataForBursaryExporter.mangle_value()
+
+.. autoclass:: waeup.kofa.students.export.StudentPaymentsOverviewExporter()
+  :noindex:
+
+  .. autoattribute:: waeup.kofa.students.export.StudentPaymentsOverviewExporter.fields
+  .. autoattribute:: waeup.kofa.students.export.StudentPaymentsOverviewExporter.title
+  .. autoattribute:: waeup.kofa.students.export.StudentPaymentsOverviewExporter.curr_year
+  .. automethod:: waeup.kofa.students.export.StudentPaymentsOverviewExporter.mangle_value()
+
+.. autoclass:: waeup.kofa.students.export.StudentStudyLevelsOverviewExporter()
+  :noindex:
+
+  .. autoattribute:: waeup.kofa.students.export.StudentStudyLevelsOverviewExporter.fields
+  .. autoattribute:: waeup.kofa.students.export.StudentStudyLevelsOverviewExporter.title
+  .. automethod:: waeup.kofa.students.export.StudentStudyLevelsOverviewExporter.mangle_value()
+
+.. autoclass:: waeup.kofa.students.export.ComboCardDataExporter()
+  :noindex:
+
+  .. autoattribute:: waeup.kofa.students.export.ComboCardDataExporter.fields
+  .. autoattribute:: waeup.kofa.students.export.ComboCardDataExporter.title
+  .. automethod:: waeup.kofa.students.export.ComboCardDataExporter.mangle_value()
+
 Data Import
 ===========