Changeset 13084 for main/waeup.kofa/trunk/docs
- Timestamp:
- 21 Jun 2015, 06:29:05 (10 years ago)
- Location:
- main/waeup.kofa/trunk/docs/source/userdocs
- Files:
-
- 1 added
- 3 edited
Legend:
- Unmodified
- Added
- Removed
-
main/waeup.kofa/trunk/docs/source/userdocs/academics.rst
r13082 r13084 43 43 +-----> CertificateCourse 44 44 45 .. note::46 47 In the user handbook we do not describe how to browse the48 academic section. The menu navigation should be49 self-explanatory and it's quite easy to follow the menu50 prompts. However, in the beginning of the development of51 Kofa, we used extensive doc tests which describe the52 navigation very well. Thus navigating through the academic53 section and other parts of Kofa with a test browser is54 perfectly described in :ref:`pages.txt <pages_txt>`.55 45 56 46 Faculty … … 180 170 181 171 No local role can be assigned at certificate course tree level. 172 173 Browser Pages 174 ============= 175 176 In the user handbook we do not describe how to browse the academic 177 section. The menu navigation is self-explanatory and it's 178 quite easy to follow the menu prompts. However, in the beginning of 179 the development of Kofa, we used extensive doc tests which describe 180 the navigation very well. Thus navigating through the academic 181 section and other parts of Kofa with a test browser is perfectly 182 described in :ref:`pages.txt <pages_txt>`. -
main/waeup.kofa/trunk/docs/source/userdocs/index.rst
r13075 r13084 6 6 7 7 install 8 browsing 8 9 academics 9 10 students -
main/waeup.kofa/trunk/docs/source/userdocs/students/browser.rst
r13078 r13084 1 .. _students_browser:2 3 Browsing the Students Section4 =============================5 6 The reader may ask: How do officers and students browse the portal?7 Where are the step-by-step operating instructions on how to use8 Kofa? We are always tempted to answer: The menu navigation should be9 self-explanatory and it's quite easy to follow the menu prompts or10 flash messages which appear above page titles in a green, yellow or11 red box. For the students section this answer seems a bit over the12 top. We must indeed describe some browser pages and what their13 clickable actions are doing with the data. The reason is, that a lot14 of Kofa's functionality is embedded in view and utility methods and15 not only provided by the functionality of content components as16 described above.17 18 .. _navigation_bar:19 20 Navigation Bar21 ==============22 23 24 25 26 27 .. _page_layout:28 29 Page Layout30 ===========31 32 Kofa makes use of two different `Bootstrap`_ layouts. Anonymous33 users, students and applicants do see a single-column theme with34 only a static top navigation bar. Students can navigate to the35 various display form pages of their record by pulling down the 'My36 Data' tab in the navigation bar.37 38 Officers see a double-column theme after logging in. The left column39 contains a box which contains links to the user's preferences (My40 Preferences) and roles (My Roles). It also contains links to the41 various sections of Kofa depending on the permissions the officer42 has has obtained. Possible sections are: 'Portal Configuration',43 'Officers', 'Data Center', 'Reports' and 'Access Codes'. A second44 box shows up in the left column when the officer accesses a student45 record. This box gives direct access to the pages of a46 student record.47 48 49 .. _manage_edit_pages:50 51 Views, Pages and Form Pages52 ===========================53 54 Views are dealing with request and response objects. Usually a view55 renders (produces) HTML or PDF code to be displayed in a web browser56 or a pdf reader respectively. Very often a view only redirects to57 another view or page and does not render code by itself.58 Views, which render pdf code, are called pdf slips in Kofa.59 60 Kofa pages are 'layout-aware' browser views, which means they know61 about the global page layout and render content inside it.62 63 In Kofa most pages are form pages which means they are layout-aware64 views on data. These pages are either used to submit data (simple form65 page), or to display, edit or add persistant data. The latter three66 are called display, edit or add form pages respectively. Kofa is67 using the `Zope Formlib`_ package to auto-generate these forms.68 69 .. note::70 71 Briefly, Zope Formlib is wedded to `Zope Schema`_, it provides72 display and input widgets (= views) for the fields defined in the73 Zope Schema package. Auto-generation is done with `grok.AutoFields`74 which takes the fields, declared in an interface, and renders75 display or input widgets, according to the schema declaration, for76 display or edit forms respectively.77 78 Whereas display and add form pages are usually shared by officers79 and students, edit form pages are not. Students are not allowed to80 edit all of their data all the time. Edit access is restricted by81 workflow states or other conditions. Officers' access is much less82 restricted, and we therefore speak of 'managing' instead of 'editing'83 data. In most cases, Kofa uses two different form pages which84 require different permissions: An `EditFormPage` requires the85 :py:class:`HandleStudent<waeup.kofa.students.permissions.HandleStudent>`86 permission and a `ManageFormPage` requires the87 :py:class:`ManageStudent<waeup.kofa.students.permissions.ManageStudent>`88 permission.89 90 91 .. _action_buttons:92 93 Action Buttons94 ==============95 96 There are two kinds of action buttons which appear on pages:97 98 - **Link Buttons** appear on top of the page above the page99 title and are decorated with an icon. These100 :py:class:`action101 buttons<waeup.kofa.browser.viewlets.ActionButton>` have a102 link target which means they usually refer to another Kofa103 page and are sending GET requests to open the page.104 105 - **Form Buttons** are submit buttons which appear below a form.106 They are HTML form actions which submit data by sending a107 POST request back to the form page. A form page method is108 called and processes the data or simply redirects to109 another Kofa page.110 111 112 1 .. _logging_in_as_student: 113 2 114 Logging in as Student 115 ==================== =3 Impersonate Students 4 ==================== 116 5 117 6 Officers with … … 135 24 136 25 26 .. _personal_data: 27 28 Personal Data 29 ============= 30 31 32 .. _starting_clearance: 33 34 Starting Clearance 35 ================== 36 37 137 38 .. _rejecting_clearance: 138 39 … … 472 373 473 374 :ref:`Bed Space Booking Doctests <test_handle_accommodation>` 474 475 476 .. _bootstrap: http://getbootstrap.com/477 478 .. _zope schema: http://docs.zope.org/zope.schema479 480 .. _zope formlib: http://bluebream.zope.org/doc/1.0/manual/schema.html#auto-generated-forms-using-the-forms-package
Note: See TracChangeset for help on using the changeset viewer.