[Zope3-checkins] CVS: Zope3/src/zope/app/onlinehelp/browser - __init__.py:1.1 configure.zcml:1.1 helptopic.pt:1.1

[Philipp von Weitershausen]

Update of /cvs-repository/Zope3/src/zope/app/onlinehelp/browser
In directory cvs.zope.org:/tmp/cvs-serv16018/onlinehelp/browser

Added Files:
	__init__.py configure.zcml helptopic.pt 
Log Message:
Centralized the onlinehelp facility, its browser views/skins and its
interfaces in zope.app.onlinehelp.


=== Added File Zope3/src/zope/app/onlinehelp/browser/__init__.py ===
##############################################################################
#
# Copyright (c) 2002, 2003 Zope Corporation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL).  A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""OnlineHelp views

$Id: __init__.py,v 1.1 2004/02/27 16:15:25 philikon Exp $
"""
from zope.interface import providedBy

from zope.component import getService, getView
from zope.app.publisher.browser import BrowserView
from zope.app.traversing import getRoot
from zope.app.traversing import getParents, getName

class OnlineHelpTopicView(BrowserView):
    """View for one particular help topic."""

    def _makeSubTree(self, topic):
        html = '<ul>\n'
        for entry in topic.items():
            html += '  <li><a href="%s">%s</a></li>\n' %(
                getView(entry, 'absolute_url', self.request)(),
                entry.getTitle())
            html += self._makeSubTree(entry)
        html += '</ul>\n'
        return html

    def getTopicTree(self):
        onlinehelp = getRoot(self.context)
        return self._makeSubTree(onlinehelp)

# XXX The view below is highly qeustionable on many levels.
# - It uses the global view service (now refactored to presentation service
# - It's very expensive.
# Perhaps we'll resurrect this later when we have time to do it bit better.

## class FindRelevantHelpTopics(BrowserView):
##     """This object is used as a view on a view, so that we can get all the
##     required information."""

##     def __call__(self):

##         class FindResult:
##             def __init__(self, url, topic):
##                 self.url = url
##                 self.topic = topic

##         view_class = self.context.__class__
##         obj = self.context.context
##         help = getService(obj, 'OnlineHelp')
##         ifaces = providedBy(obj).flattened()
##         topics = []
##         for iface in ifaces:
##             specs = viewService.getRegisteredMatching((iface,),
##                                                       IBrowserRequest)
##             for spec in specs:
##                 if spec[2][0] is not view_class:
##                     continue
##                 for topic in help.getTopicsForInterfaceAndView(iface, spec[4]):
##                     parents = getParents(topic)
##                     path = map(getName, [topic]+parents[:-1]) 
##                     path.reverse()
##                     url = getView(obj, 'absolute_url', self.request)()
##                     url += '/++help++/++skin++Onlinehelp/'+'/'.join(path)
##                     topics.append(FindResult(url, topic))
        
##         return topics


=== Added File Zope3/src/zope/app/onlinehelp/browser/configure.zcml ===
<zope:configure 
  xmlns:zope="http://namespaces.zope.org/zope"
  xmlns="http://namespaces.zope.org/browser"
  i18n_domain="zope"
  >

  <menu
      id="help_actions"
      title="Menu for displaying help actions to be performed with popup"
      usage="activitydialog"
      />

<!--
  <page
      name="find_help_topics"
      for="*"
      class=".FindRelevantHelpTopics"
      permission="zope.Public"
      allowed_attributes="__call__" />

-->

  <pages
      for="zope.app.onlinehelp.interfaces.IOnlineHelpTopic"
      permission="zope.Public"
      class=".OnlineHelpTopicView"
      >

      <page name="index.html" template="helptopic.pt" />
      <page name="getTopicTree" attribute="getTopicTree" />

  </pages>

  <menuItem
      for="*"
      filter="python:request.getURL().find('++help++')==-1"
      menu="help_actions"
      title="Help"
      action="++help++/@@index.html"
      />
 
</zope:configure>


=== Added File Zope3/src/zope/app/onlinehelp/browser/helptopic.pt ===
<html metal:use-macro="views/standard_macros/page">
<head>
  <title metal:fill-slot="title" tal:content="context/getTitle"
      i18n:translate="">Title</title>
</head>
<body>
<div metal:fill-slot="body">

  <h1 tal:content="context/getTitle"
      i18n:translate="">Title of Help Topic</h1>

  <p tal:content="structure context/getContent"
      i18n:translate="">Content of Online Help.</p>

</div>

</body>
</html>