Changeset 12993

Timestamp:

22 May 2015, 10:39:19 (10 years ago)

Author:

Henrik Bettermann

Message:

First adjustments for the upcoming Ikoba User Handbook.

Location:

main/waeup.ikoba/trunk/src/waeup/ikoba/doctests

Files:

• app.txt (modified) (2 diffs)
• authentication.txt (modified) (3 diffs)
• batchprocessing.txt (modified) (1 diff)
• batchprocessing_browser.txt (modified) (1 diff)
• catalog.txt (modified) (5 diffs)
• datacenter.txt (modified) (1 diff)
• helpers.txt (modified) (1 diff)
• pages.txt (modified) (1 diff)
• permissions.txt (modified) (2 diffs)
• userscontainer.txt (modified) (1 diff)

main/waeup.ikoba/trunk/src/waeup/ikoba/doctests/app.txt

@@ -1 @@
-:mod:`waeup.ikoba.app` -- central components for Ikoba
-******************************************************
+Central Components
+******************
 
 .. :doctest:
@@ -6 +6 @@
 
 .. module:: waeup.ikoba.app
-
-.. class:: Company
-
-  The main Ikoba application object is given with
-  :class:`Company`. It provides the main containers as faculties,
-  hostels, etc.
-
-  .. attribute:: name
-
-     A string. The name of a company.
-
-  .. attribute:: faculties
-
-     An arbitrary object containing "faculties". In the case of
-     `Company` it is a container of type
-     `waeup.ikoba.interfaces.IFacultiesContainer`.
 
 

main/waeup.ikoba/trunk/src/waeup/ikoba/doctests/authentication.txt

@@ -1 @@
-Ikoba authentication
-*******************
+Authentication
+**************
 
 We need to protect most pieces of our portals from unauthenticated
@@ -24 +24 @@
   >>> browser.handleErrors = False
 
-Creating users (principals)
-===========================
+Creating officers
+=================
 
 Before we can login, we have to provide a user (``principal`` in Zope
@@ -42 +42 @@
 See ``userscontainer.txt`` for details about the UsersContainer we use here.
 
-Users and local roles
-=====================
+Officers and local roles
+========================
 
 Accounts also hold infos about local roles assigned to a user. In the

main/waeup.ikoba/trunk/src/waeup/ikoba/doctests/batchprocessing.txt

@@ -1 @@
-:mod:`waeup.ikoba.utils.batching` -- Batch processing
-****************************************************
+Batch Processing
+****************
 
 Batch processing is much more than pure data import.

main/waeup.ikoba/trunk/src/waeup/ikoba/doctests/batchprocessing_browser.txt

@@ -1 @@
-Batch processing via browser
+Batch Processing via Browser
 ****************************
 

main/waeup.ikoba/trunk/src/waeup/ikoba/doctests/catalog.txt

@@ -1 @@
-:mod:`waeup.ikoba.catalog` -- Cataloging support Ikoba
-****************************************************
+Cataloging Support
+******************
 
 .. module:: waeup.ikoba.catalog
@@ -18 +18 @@
 ------------------
 
-.. class:: IkobaQuery()
-
-   .. attribute:: grok.implements(hurry.query.interfaces.IQuery)
-
-   A `hurry.query.query.Query` compatible query that also supports
-   retrival of plain ``Bree`` result sets as used inside a catalog.
-
-   Like `hurry.query.query.Query` objects, `IkobaQuery` is some kind
-   of a meta query or 'compound query' that can give the cataloged
-   objects (or their int ids) matching one or more 'subqueries'.
-
-   This way you can search for objects (or their int ids) that match
-   several criteria at the same time. See ``examples`` section below.
-
-   A singleton instance of this class is also available as global
-   utility.
-
-   .. method:: searchResults(query)
-
-     Get the cataloged objects determined by ``query``.
-
-   .. method:: apply(query)
-
-     Get the list of int ids (a `BTree` result set) for objects
-     determined by ``query``.
-
-     The list of int ids is less expensive to compute than the
-     complete search results and sufficient, for instance, when you
-     only need the number of objects that match a query and not the
-     objects themselves.
-
-Examples
-========
-
 Getting a general query object
-------------------------------
+==============================
 
 We can get a IkobaQuery object by asking for an unnamed global utility
@@ -69 +35 @@
 
 Setting up a catalog and feeding it
------------------------------------
+===================================
 
     >>> from zope.catalog.interfaces import ICatalog
@@ -148 +114 @@
 
 Searching for result sets
--------------------------
+=========================
 
 Finally we can perform queries:
@@ -198 +164 @@
 
 Searching for objects
----------------------
+=====================
 
 Very often we don't want to know the catalog-internal 'ids' of

main/waeup.ikoba/trunk/src/waeup/ikoba/doctests/datacenter.txt

@@ -1 @@
-Ikoba Data Center
-****************
+Data Center
+***********
 
 The Ikoba data center cares for managing CSV files and importing then.

main/waeup.ikoba/trunk/src/waeup/ikoba/doctests/helpers.txt

@@ -1 @@
-:mod:`waeup.ikoba.utils.helpers` -- Helpers for Ikoba
-***************************************************
+Helpers for Ikoba
+*****************
 
 .. module:: waeup.ikoba.utils.helpers

main/waeup.ikoba/trunk/src/waeup/ikoba/doctests/pages.txt

@@ -5 +5 @@
 
 Company
-==========
+=======
 
 We can watch universities in the browser.

main/waeup.ikoba/trunk/src/waeup/ikoba/doctests/permissions.txt

@@ -1 @@
-Ikoba permissions and roles
-**************************
+Permissions and Roles
+*********************
 
 Permissions and roles used in a Ikoba portal.
@@ -7 +7 @@
 .. :layer: waeup.ikoba.testing.IkobaUnitTestLayer
 
-Convenience functions
+Convenience Functions
 =====================
 

main/waeup.ikoba/trunk/src/waeup/ikoba/doctests/userscontainer.txt

@@ -1 @@
-User container for the Ikoba
-****************************
+Users Container
+***************
 
 .. :doctest: