Skip to main content

Framework for Context-Sensitive Help Pages

Project description

Documentation Status Build Status Code Coverage

This package provides a framework for creating help pages for Zope 3 applications. ZCML directives are used to minimize the overhead of creating new help pages.

Documentation is hosted at https://zopeapponlinehelp.readthedocs.io

CHANGES

4.1.0 (2017-07-12)

  • The help namespace no longer modifies the global help object on traversal. Instead it returns a new proxy object. This makes it thread-safe. See issue 4.
  • getTopicFor now really returns the first found topic in the event that the object implements multiple interfaces that have registered topics for the given view. Previously it would return the topic for the least-specific interface.

4.0.1 (2017-05-21)

  • Drop test dependency on zope.app.securitypolicy. It wasn’t used, and it isn’t yet fully ported to Python 3.

4.0.0 (2017-05-17)

  • Add support for Python 3.4, 3.5, 3.6 and PyPy.
  • Change ZODB dependency to persistent.
  • Drop test dependency on zope.app.testing, zope.app.zcmlifiles and zope.app.apidoc, among others.

3.5.2 (2010-01-08)

  • Fix tests using a newer zope.publisher that requires zope.login.

3.5.1 (2009-03-21)

  • Use zope.site instead of zope.app.folder.

3.5.0 (2009-02-01)

  • Removed OnlineHelpTopicFactory, simple and SimpleViewClass. All of them where using old deprecated and removed Zope3 imports. None of them where used and tested.
  • Use zope.container instead of zope.app.container.
  • Removed use of zope.app.zapi.

3.4.1 (2007-10-25)

  • Package meta-data update.

3.4.0 (2007-10-23)

  • Initial release independent of the main Zope tree.

Older

Make the onlinehelp utility more component oriented.

  • Use registred page/view instead of ViewPageTemplate for rendering topic tree This way we can use/register own templates for tree layout.
  • Add page template based topic for rendering topics which has to call other zope3 resources like javascripts and css styles sheets etc. This resources can be rendered in the header area of the onlinehelp_macros.
  • Enhance the API of topics and simplyfie the view part.
  • Implemented getSubTopics() method on topics. This way we can sublist topics.
  • Remove unused onlinehelp code in rotterdam template.pt
  • Add type to directive, this supports registration of README.txt as ‘rest’ topics

Release history Release notifications

This version
History Node

4.1.0

History Node

4.0.1

History Node

4.0.0

History Node

3.5.2

History Node

3.5.1

History Node

3.5.0

History Node

3.4.1

History Node

3.4.0

History Node

3.4.0b1

History Node

3.4.0a1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
zope.app.onlinehelp-4.1.0-py2.py3-none-any.whl (91.3 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jul 12, 2017
zope.app.onlinehelp-4.1.0.tar.gz (82.1 kB) Copy SHA256 hash SHA256 Source None Jul 12, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page