Products.PloneHelpCenter 1.5rc2

A simple help-desk style documentation product for Plone.

Overview

Plone Help Center is an application designed to aid the documentation of Plone, and is used on plone.org to categorize and keep documentation up to date. It should be usable for documenting other open source products (such as Plone Product add-ons) or even for other documentation projects.

Usage

Plone Help Center has inline documentation, just add a help center.

Requirements

PloneHelpCenter requires:

• Plone 2.5 or later

Installation

See the Installing an Add-on Product tutorial for more detailed product installation instructions.

Optional

AddRemoveWidget – PLEASE NOTE: if AddRemoveWidget is installed as a Zope product, you must also install it in Plone. If it is present without being installed, errors will occur.

Installing with buildout

If you are using buildout to manage your instance installing Ploneboard is very simple. You can install it by adding it to the eggs line for your instance:

[instance]
eggs = Products.PloneHelpCenter

If another egg package depends on Products.Ploneboard you do not need to specify anything in the buildout configuration: buildout will detect this automatically.

After updating the configuration you need to run the ‘’bin/buildout’’, which will take care of updating your system.

Installing without buildout

Move (or symlink) the PloneHelpCenter folder of this project (Products.PloneHelpCenter/Products/PloneHelpCenter) into the Products directory of the Zope instance it has to be installed for, and restart the server.

You may also download a traditional tarball that you unpack into Products from http://plone.org/products/PloneHelpCenter .

Credits

Project Architecture, Development, Content Types, Archetypes, Workflow: Joel Burton

Development, User Interface, Project Architecture, Quality Assurance: Alexander Limi

Development, persistence and all-round brilliance: Martin “optilude” Aspeli

Development, Assistance: Christian “Tiran” Heimes

Original FAQ code: Tim Terlegard, Edward Muller - further enhancements by Jean-Paul Ladage and Ahmad Hadi from Zest Software

Fixing various stuff, documentation: The Sprinters: Christian Heimes, Dorneles Tremea, Daniel Nouri, Nate Aune

Added optional “see also” references to other Archetypes based types: Jens “jensens” Klein

i18n improvements: And general fixes in some templates and brazilian translations by Jean Ferri

Bugfixes and occasional Quality Assurance: Geir Baekholt

Topic, start-here, and 1.0 search options: The 2007 documentation sprint participants, particularly aclark, joelburton, magnon and stevem. Plone.Org view skin by vedawms.

Numerous 1.0 presentation fixes: Servilio Afre Puentes.