Make it easy to override the way sub organizations are displayed on an organization by calling a @@suborganizations view

CHANGES.rst

@@ -7,6 +7,9 @@ Changelog
 - On persons listed on the directory view, display held_positions when hovering
   person title (tooltip).
   [gbastien]
+- Make it easy to override the way sub organizations are displayed on an
+  organization by calling a @@suborganizations view.
+  [gbastien]
 
 1.20 (2018-07-20)
 -----------------

src/collective/contact/core/browser/configure.zcml

@@ -28,6 +28,14 @@
       permission="zope2.View"
       />
 
+  <browser:page
+      name="suborganizations"
+      for="collective.contact.core.content.organization.IOrganization"
+      class=".organization.SubOrganizations"
+      template="templates/suborganizations.pt"
+      permission="zope2.View"
+      />
+
   <browser:page
       name="view"
       for="..content.position.IPosition"

src/collective/contact/core/browser/organization.py

@@ -1,16 +1,16 @@
-from five import grok
+# -*- coding: utf-8 -*-
 
 from AccessControl import getSecurityManager
-
-from plone import api
-
-from collective.contact.core.browser.contactable import BaseView
-from collective.contact.core.interfaces import IContactable
 from collective.contact.core.behaviors import IContactDetails
-from collective.contact.core.content.organization import IOrganization
-from collective.contact.core.browser.utils import get_valid_url
+from collective.contact.core.browser.contactable import BaseView
 from collective.contact.core.browser.utils import date_to_DateTime
+from collective.contact.core.browser.utils import get_valid_url
+from collective.contact.core.content.organization import IOrganization
+from collective.contact.core.interfaces import IContactable
 from collective.contact.core.interfaces import IContactCoreParameters
+from five import grok
+from plone import api
+from Products.Five import BrowserView
 
 
 ADDNEW_OVERLAY = """
@@ -64,6 +64,18 @@ def display_date(self, date):
         return self.context.toLocalizedTime(date_to_DateTime(date))
 
 
+class SubOrganizations(BrowserView):
+
+    def __call__(self):
+        catalog = api.portal.get_tool('portal_catalog')
+        context_path = '/'.join(self.context.getPhysicalPath())
+        self.sub_organizations = catalog.searchResults(portal_type="organization",
+                                                       path={'query': context_path,
+                                                             'depth': 1},
+                                                       sort_on='getObjPositionInParent')
+        return self.index()
+
+
 class OtherContacts(grok.View):
     """Displays other contacts list"""
     grok.name('othercontacts')

src/collective/contact/core/browser/templates/organization.pt

@@ -33,17 +33,7 @@
 
     <metal:additional-fields use-macro="context/contact_core_macros/macros/additional-fields" />
 
-    <div id="sub_organizations" class="field" tal:condition="view/sub_organizations">
-        <label><tal:block i18n:translate="">Organizations in this organization</tal:block>:</label>
-        <ul>
-        <tal:block tal:repeat="sub_org view/sub_organizations">
-            <li><img tal:attributes="src string:${portal_url}/${sub_org/getIcon}" /> <a tal:attributes="href sub_org/getURL">
-                <span tal:replace="sub_org/Title"
-                      i18n:translate="" />
-            </a></li>
-        </tal:block>
-        </ul>
-    </div>
+    <div tal:replace="structure context/@@suborganizations" />
 
     <div id="positions" class="field" tal:condition="view/positions">
         <label><tal:block i18n:translate="">Positions in this organization</tal:block>:</label>

src/collective/contact/core/browser/templates/suborganizations.pt

@@ -0,0 +1,20 @@
+<div xmlns="http://www.w3.org/1999/xhtml"
+      lang="en"
+      xmlns:tal="http://xml.zope.org/namespaces/tal"
+      xmlns:metal="http://xml.zope.org/namespaces/metal"
+      xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+      i18n:domain="collective.contact.core"
+      tal:define="portal_url context/@@plone_portal_state/portal_url;">
+
+    <div id="sub_organizations" class="field" tal:condition="view/sub_organizations">
+        <label><tal:block i18n:translate="">Organizations in this organization</tal:block>:</label>
+        <ul>
+        <tal:block tal:repeat="sub_org view/sub_organizations">
+            <li><img tal:attributes="src string:${portal_url}/${sub_org/getIcon}" /> <a tal:attributes="href sub_org/getURL">
+                <span tal:replace="sub_org/Title"
+                      i18n:translate="" />
+            </a></li>
+        </tal:block>
+        </ul>
+    </div>
+</div>