Plone Help Center 1.0.1

For additional information about this project, please visit the project page.

Available downloads

Product Package

For all platforms (267.8 kB)

Release Notes

This release is the culmination of a large amount of clean-up work, feature enhancements and real-world testing on plone.org. It should be robust under Plone 2.1 and 2.5. It is not Plone 3.0 compatible.

PloneHelpCenter unfortunately experienced well over a year of uneven maintenance and feature creep between version 0.8 and 1.0. While this release has some quirks due to lack of developer coordination, and has inadequate unit and functional tests, it is certainly usable, and the Plone Documentation Team wanted to get out 1.0 release before beginning a refactoring.

This version adds to previous versions:

• Support for presenting your help center content by section rather than  document type. To use this facility, set top-level sections by editing the help center object, then select one of the "topic" views. 
  

• Support for global sections. If you set sections in the top-level PHC  object, they'll be used automatically for any phc folder that does not have  its own section specification.
• Support for "start here" documents. PHC documentation objects that are  marked "start here" will be presented at the top of help listings, and  will be starred.
• Expanded searching. PHC searches normally only cover content inside the PHC. You may now make searches global via a setting in the top-level PHC object.
• A new "Search by topic, version, audience…" option.

Track changes to this release in svn: http://svn.plone.org/svn/collective/PloneHelpCenter/branches/1.0

Change log

    - Fixed: the print style sheet was loading for all media, hiding many
      visual features. [stevem]
     
    - Fixed: All content on one page" feature fails in manuals outside PHC
      due to absence of addImagePath. [stevem]   

    - Hide several visual artifacts that aid navigation on printed
      media.
      [servilio]

    - Using the stylesheet registry to include the custom styles,
      instead of including them directly from the templates.
      [servilio]

    - Searching the documentation area of a PSCDocumentation area (which uses
      the PHC template), would cause an attribute error on getPHCPath. [stevem]

    - Fix issue #64: Topic area listings should be restricted to the HelpCenter
      [stevem].
     
    - Make import of CMFCorePermissions compatible with later versions of CMF
      [mj]

    - PHC tracker cleanup [stevem]:
      Fix issue #59: Images don't show in highest level nonpaginated view
       for a PloneHelpCenter manual.
      Fix for issues #44 and 52. Make view actions Plone 2.5 friendly.
      Fix issue #55 by adding contributed spanish .po files
      Fix issue #54: German Umlaute by updating .po files
      Fix issue #54: German Umlaute by updating .po file
      Fix issue #31: Token 'ATOM' required, 'Not' found in searches.
      Fix issue #62: Duplicated listings on content-type folders
      Fix issue #35, Contents fail to display if no section value assigned
 
    - Rephrase all-content-in-one-page view's note for reference
      manuals and tutorials to make it simple/shorter and avoid the
      ambiguity-prone "page" term (simple users might think it refers
      to print media, and might be surprised :O when it doesn't
      actually fit in one page).
      [Kathryn Hryb, servilio]

    - Added full contents view option to TOC drop-down for section
      views of reference manual and tutorial.
      [servilio]

    - Fixed some templates that weren't honouring the setting of
      site_properties.allowAnonymousViewAbout
      [servilio]

    - Fixed document actions placement for some templates that have
      them after the title.
      [servilio]

    - Make getRelatedItems return an empty list when no relatedItems
      property is present.
      [servilio]

    - Added search template for searches by topic, audience, version.
      [stevem]

    - Added option to make PHC searches be global rather than local-only.
      This will support including product-area documentation in searches
      on plone.org.
      [stevem]

    - Added HelpCenter templates to support browsing by section (topic).
      Added some support for using the section field for a
      "topic : subtopic" taxonomy. Added portlets to support these
      pages.
      [stevem, templates by vedawms, joelburton, and limi]

    - Added default sections at HelpCenter folder level. These may be
      overridden in folders.
      [stevem]

    - Added 'Start Here' flag for key documentation
      [aclark and stevem]