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

Timestamp:

16 Jun 2015, 08:22:27 (9 years ago)

Author:

Henrik Bettermann

Message:

Describe more precisely views, pages and form pages.

File:

• main/waeup.kofa/trunk/docs/source/userdocs/students/browser.rst (modified) (7 diffs)

main/waeup.kofa/trunk/docs/source/userdocs/students/browser.rst

@@ -25 +25 @@
 users, students and applicants do see a single-column theme with
 only a static top navigation bar. Students can navigate to the
-various display pages of their record by pulling down the 'My Data'
+various display form pages of their record by pulling down the 'My Data'
 in the navigation bar.
 
@@ -35 +35 @@
 'Officers', 'Data Center', 'Reports' and 'Access Codes'. A second
 box shows up in the left column when the officer accesses a student
-record. This box gives direct access to the display pages of a
+record. This box gives direct access to the pages of a
 student record.
 
@@ -41 +41 @@
 .. _manage_edit_pages:
 
-Manage and Edit Pages
-=====================
-
-Pages, or more precisely web pages, are browser views which render
-(produce) HTML or PDF code to be displayed in a web browser or a pdf
-reader respectively. Views are dealing with request and response
-objects. In Kofa most pages are form pages which means they are
-views on data. These pages are either used to display, edit or add
-persistant data. Thus we can further distinguish display, edit and
-add form pages. Kofa is using the `Zope Formlib`_ package to
-auto-generate these forms.
+Views, Pages and Form Pages
+===========================
+
+Views are dealing with request and response objects. Usually a view
+renders (produces) HTML or PDF code to be displayed in a web browser
+or a pdf reader respectively. Very often a view only redirects to
+another view or page and does not render code by itself.
+Views, which render pdf code, are called pdf slips in Kofa.
+
+Kofa pages are 'layout-aware' browser views, which means they know
+about the global page layout and render content inside it.
+
+In Kofa most pages are form pages which means they are layout-aware
+views on data. These pages are either used to submit data (simple form
+page), or to display, edit or add persistant data. The latter three
+are called display, edit or add form pages respectively. Kofa is
+using the `Zope Formlib`_ package to auto-generate these forms.
+
 
 .. note::
@@ -138 +145 @@
 always be reconstructed.
 
-Finally, the method redirects to the ContactStudentForm and prefills
+Finally, the method redirects to the `ContactStudentFormPage` and prefills
 the HTML form with the comment previously saved. The clearance
 officer can leave the comment as it is, or can modify the text to
@@ -189 +196 @@
 
 The old study course container(s) can still be accessed via links on
-the current study course display page. But, they can neither be
+the current study course display form page. But, they can neither be
 edited, removed, exported or reimported.
 
@@ -354 +361 @@
 they can validate or reject it by pressing the same-named link
 buttons. After pressing the 'Reject courses' button, Kofa redirects
-to the ContactStudentForm which can be used to inform the student
+to the `ContactStudentFormPage` which can be used to inform the student
 about the reason of rejection. In contrast to clearance rejection,
 the message, which is being sent to the student by email, is neither
@@ -441 +448 @@
 
 Officers with `ManageHostels` permission do see a 'Relocate student'
-link button which calls the `BedTicketRelocationPage`. This view
+link button which calls the `BedTicketRelocationView`. This view
 relocates the student if student parameters or the bed type of the
 bed have changed. The `update` method of this view checks first, if