Changeset 13084 for main


Ignore:
Timestamp:
21 Jun 2015, 06:29:05 (10 years ago)
Author:
Henrik Bettermann
Message:

Add browsing chapter and restructure documentation.

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  
    4343                            +-----> CertificateCourse
    4444
    45 .. note::
    46 
    47   In the user handbook we do not describe how to browse the
    48   academic section. The menu navigation should be
    49   self-explanatory and it's quite easy to follow the menu
    50   prompts. However, in the beginning of the development of
    51   Kofa, we used extensive doc tests which describe the
    52   navigation very well. Thus navigating through the academic
    53   section and other parts of Kofa with a test browser is
    54   perfectly described in :ref:`pages.txt <pages_txt>`.
    5545
    5646Faculty
    … …  
    180170
    181171No local role can be assigned at certificate course tree level.
     172
     173Browser Pages
     174=============
     175
     176In the user handbook we do not describe how to browse the academic
     177section. The menu navigation is self-explanatory and it's
     178quite easy to follow the menu prompts. However, in the beginning of
     179the development of Kofa, we used extensive doc tests which describe
     180the navigation very well. Thus navigating through the academic
     181section and other parts of Kofa with a test browser is perfectly
     182described in :ref:`pages.txt <pages_txt>`.

  • main/waeup.kofa/trunk/docs/source/userdocs/index.rst

    r13075 r13084  
    66
    77   install
     8   browsing
    89   academics
    910   students

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

    r13078 r13084  
    1 .. _students_browser:
    2 
    3 Browsing the Students Section
    4 =============================
    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 use
    8 Kofa? We are always tempted to answer: The menu navigation should be
    9 self-explanatory and it's quite easy to follow the menu prompts or
    10 flash messages which appear above page titles in a green, yellow or
    11 red box. For the students section this answer seems a bit over the
    12 top. We must indeed describe some browser pages and what their
    13 clickable actions are doing with the data. The reason is, that a lot
    14 of Kofa's functionality is embedded in view and utility methods and
    15 not only provided by the functionality of content components as
    16 described above.
    17 
    18 .. _navigation_bar:
    19 
    20 Navigation Bar
    21 ==============
    22 
    23 
    24 
    25 
    26 
    27 .. _page_layout:
    28 
    29 Page Layout
    30 ===========
    31 
    32 Kofa makes use of two different `Bootstrap`_ layouts. Anonymous
    33 users, students and applicants do see a single-column theme with
    34 only a static top navigation bar. Students can navigate to the
    35 various display form pages of their record by pulling down the 'My
    36 Data' tab in the navigation bar.
    37 
    38 Officers see a double-column theme after logging in. The left column
    39 contains a box which contains links to the user's preferences (My
    40 Preferences) and roles (My Roles). It also contains links to the
    41 various sections of Kofa depending on the permissions the officer
    42 has has obtained. Possible sections are: 'Portal Configuration',
    43 'Officers', 'Data Center', 'Reports' and 'Access Codes'. A second
    44 box shows up in the left column when the officer accesses a student
    45 record. This box gives direct access to the pages of a
    46 student record.
    47 
    48 
    49 .. _manage_edit_pages:
    50 
    51 Views, Pages and Form Pages
    52 ===========================
    53 
    54 Views are dealing with request and response objects. Usually a view
    55 renders (produces) HTML or PDF code to be displayed in a web browser
    56 or a pdf reader respectively. Very often a view only redirects to
    57 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 know
    61 about the global page layout and render content inside it.
    62 
    63 In Kofa most pages are form pages which means they are layout-aware
    64 views on data. These pages are either used to submit data (simple form
    65 page), or to display, edit or add persistant data. The latter three
    66 are called display, edit or add form pages respectively. Kofa is
    67 using the `Zope Formlib`_ package to auto-generate these forms.
    68 
    69 .. note::
    70 
    71   Briefly, Zope Formlib is wedded to `Zope Schema`_, it provides
    72   display and input widgets (= views) for the fields defined in the
    73   Zope Schema package. Auto-generation is done with `grok.AutoFields`
    74   which takes the fields, declared in an interface, and renders
    75   display or input widgets, according to the schema declaration, for
    76   display or edit forms respectively.
    77 
    78 Whereas display and add form pages are usually shared by officers
    79 and students, edit form pages are not. Students are not allowed to
    80 edit all of their data all the time. Edit access is restricted by
    81 workflow states or other conditions. Officers' access is much less
    82 restricted, and we therefore speak of 'managing' instead of 'editing'
    83 data. In most cases, Kofa uses two different form pages which
    84 require different permissions: An `EditFormPage` requires the
    85 :py:class:`HandleStudent<waeup.kofa.students.permissions.HandleStudent>`
    86 permission and a `ManageFormPage` requires the
    87 :py:class:`ManageStudent<waeup.kofa.students.permissions.ManageStudent>`
    88 permission.
    89 
    90 
    91 .. _action_buttons:
    92 
    93 Action Buttons
    94 ==============
    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 page
    99    title and are decorated with an icon. These
    100    :py:class:`action
    101    buttons<waeup.kofa.browser.viewlets.ActionButton>` have a
    102    link target which means they usually refer to another Kofa
    103    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 a
    107    POST request back to the form page. A form page method is
    108    called and processes the data or simply redirects to
    109    another Kofa page.
    110 
    111 
    1121.. _logging_in_as_student:
    1132
    114 Logging in as Student
    115 =====================
     3Impersonate Students
     4====================
    1165
    1176Officers with
    … …  
    13524
    13625
     26.. _personal_data:
     27
     28Personal Data
     29=============
     30
     31
     32.. _starting_clearance:
     33
     34Starting Clearance
     35==================
     36
     37
    13738.. _rejecting_clearance:
    13839
    … …  
    472373
    473374  :ref:`Bed Space Booking Doctests <test_handle_accommodation>`
    474 
    475 
    476 .. _bootstrap: http://getbootstrap.com/
    477 
    478 .. _zope schema: http://docs.zope.org/zope.schema
    479 
    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.