Changeset 11954 for main/waeup.kofa/branches/henrik-regista/src/waeup/ikoba/browser/breadcrumbs.txt

Timestamp:

13 Nov 2014, 16:54:17 (10 years ago)

Author:

Henrik Bettermann

Message:

Remove tools.

rename institution company.

Remove some apis from docs.

File:

• main/waeup.kofa/branches/henrik-regista/src/waeup/ikoba/browser/breadcrumbs.txt (modified) (11 diffs)

main/waeup.kofa/branches/henrik-regista/src/waeup/ikoba/browser/breadcrumbs.txt

@@ -9 +9 @@
 ===============================
 
-We create a institution to check the breadcrumb functionality.
-
-    >>> from waeup.ikoba.app import Institution
+We create a company to check the breadcrumb functionality.
+
+    >>> from waeup.ikoba.app import Company
     >>> root = getRootFolder()
-    >>> root['app'] = Institution()
+    >>> root['app'] = Company()
     >>> app = root['app']
 
@@ -25 +25 @@
     >>> blist1 = getBreadcrumbList(app, 'index')
     >>> blist1
-    [<waeup.ikoba.browser.breadcrumbs.InstitutionBreadcrumb object at 0x...>]
+    [<waeup.ikoba.browser.breadcrumbs.CompanyBreadcrumb object at 0x...>]
 
 A slightly more extensive list for the datacenter:
@@ -32 +32 @@
     >>> from pprint import pprint
     >>> pprint(blist2)
-    [<waeup.ikoba.browser.breadcrumbs.InstitutionBreadcrumb object at 0x...>,
+    [<waeup.ikoba.browser.breadcrumbs.CompanyBreadcrumb object at 0x...>,
      <waeup.ikoba.browser.breadcrumbs.AdministrationBreadcrumb object at 0x...>,
      <waeup.ikoba.browser.breadcrumbs.DataCenterBreadcrumb object at 0x...>]
 
-We get a breadcrumb for institution, administration area and data
+We get a breadcrumb for company, administration area and data
 center in that order.
 
@@ -47 +47 @@
 
      >>> pprint([(x.context, x.viewname) for x in blist2])
-     [(<waeup.ikoba.app.Institution object at 0x...>, 'index'),
-      (<waeup.ikoba.app.Institution object at 0x...>, 'administration'),
+     [(<waeup.ikoba.app.Company object at 0x...>, 'index'),
+      (<waeup.ikoba.app.Company object at 0x...>, 'administration'),
       (<waeup.ikoba.datacenter.DataCenter object at 0x...>, 'index')]
 
 The administration area breadcrumb might be a surprise, as there is no
 equivalent object in the ZODB. In fact the administration area is only
-a certain view (the 'administration' view) on the institution object.
+a certain view (the 'administration' view) on the company object.
 
 We will show below, how you can define breadcrumbs this way.
@@ -62 +62 @@
 
 This way we can make sure, that there are different breadcrumb lists
-generated for instance for the administration view of Institution
+generated for instance for the administration view of Company
 instances and the index view. While the first should look something
 like::
@@ -118 +118 @@
 
     >>> pprint(mybccontainer.getList())
-    [<...breadcrumbs.InstitutionBreadcrumb object at 0x...>,
+    [<...breadcrumbs.CompanyBreadcrumb object at 0x...>,
      <...breadcrumbs.AdministrationBreadcrumb object at 0x...>,
      <...breadcrumbs.UsersContainerBreadcrumb object at 0x...>]
@@ -128 +128 @@
 
 Now we can get breadcrumbs for contexts and view names. For example a
-breadcrumb for the 'index' view of our Institution object:
+breadcrumb for the 'index' view of our Company object:
 
     >>> from zope.component import getAdapter
@@ -134 +134 @@
     >>> b1 = getAdapter(app, IBreadcrumb, 'index')
     >>> b1
-    <waeup.ikoba.browser.breadcrumbs.InstitutionBreadcrumb object at 0x...>
+    <waeup.ikoba.browser.breadcrumbs.CompanyBreadcrumb object at 0x...>
 
 Breadcrumb objects provide a title:
@@ -168 +168 @@
 
     >>> b2.parent
-    (<waeup.ikoba.app.Institution object at 0x...>, 'administration')
-
-This result denotes a new context object (the Institution instance we
+    (<waeup.ikoba.app.Company object at 0x...>, 'administration')
+
+This result denotes a new context object (the Company instance we
 created above) and a view name ('administration').
 
@@ -188 +188 @@
 As you can see, we get an AdministrationBreadcrumb, although the
 context object, for which the breadcrumb was created is also the
-Institution instance as above:
+Company instance as above:
 
     >>> b3.context is b1.context
@@ -197 +197 @@
     >>> context, viewname = b3.parent
     >>> context, viewname
-    (<waeup.ikoba.app.Institution object at 0x...>, 'index')
+    (<waeup.ikoba.app.Company object at 0x...>, 'index')
 
 We create last breadcrumb: