Metadata-Version: 1.0
Name: collective.amberjack.core
Version: 0.9
Summary: Collective Amberjack core functionality
Home-page: http://pypi.python.org/pypi/collective.amberjack.core
Author: Massimo Azzolini and contributors
Author-email: collective.amberjack.support@lists.coactivate.org
License: GPL
Description: collective.amberjack.core
        -------------------------
        
        This package provides core functionality for collective.amberjack package.
        
        Be aware that series 0.9.x is compatible with Plone3, series 1.x is compatible
        with Plone4.
        
        Useful links
        ============
        
        - project wiki, info: http://www.coactivate.org/projects/collectiveamberjack
        - pypi: http://pypi.python.org/pypi/collective.amberjack.core
        - Plone: http://plone.org/products/collective.amberjack.core
        - issue tracker: https://bugs.launchpad.net/collective.amberjack
        - svn repository: http://svn.plone.org/svn/collective/collective.amberjack.core
        
        
        How to create new tour
        ======================
        
        First of all you need to define the tour.
        
        A tour looks like that::
        
        {'tourId': u'example_tour',
        'title': _(u"Example tour"),
        'steps': <steps>}
        
        a <steps> looks like that::
        
        ({'url': u'/',
        'xpath': u'',
        'xcontent': u'',
        'title': _(u"Some title"),
        'text': _(u"Some text"),
        'steps': ({'description': _(u"Some description"),
        'idStep': u'',
        'selector': u'',
        'text': u''},
        ...
        )
        },)
        
        
        Steps parameters:
        
        * the description for the user (use [] to <span class="ajHighlight">highlight</span> parts),
        * the step id, [see ajStandardSteps section below]
        * an optional selector
        * an optional text used by the step
        
        An example::
        
        >>> add_folder = {
        >>>			   'url': u'/',
        >>>            'xpath': u'',
        >>>            'xcontent': u'',
        >>>            'title': _(u"Create a new folder"),
        >>>            'text': _(u"Folders are ..."),
        >>>            'steps': ({'description': _(u"Click the [Add new...] drop-down menu."),
        >>>                       'idStep': u'menu_add-new',
        >>>                       'selector': u'',
        >>>                       'text': u''},
        >>>                      {'description': _(u"Select [Folder] from the menu."),
        >>>                       'idStep': u'new_folder',
        >>>                       'selector': u'',
        >>>                       'text': u''})}
        >>>
        >>> ajTour = {'tourId': u'basic01_add_a_folder',
        >>>           'title': _(u'Add a Folder'),
        >>>           'steps': (add_folder,
        >>>                    )}
        
        
        Then you have to register it in zcml::
        
        <configure
        xmlns:collective.amberjack="http://namespaces.plone.org/collective.amberjack.core">
        <collective.amberjack:tour
        tourdescriptor=".example_tour.ajTour"
        />
        </configure>
        
        
        
        Changelog
        =========
        
        0.9 (2010-04-30)
        ----------------
        
        - Change version to 0.9 (plone3 release series)
        [amleczko]
        
        - Renamed validation to validators, now a list of validators.
        Renamed isVisible to validate.
        Now show a warning box for each error message.
        [vincentfretin]
        
        - Internationalize the "of" separator, but the javascript is cached once it's generated so the translation is the first language seen on the portal after a restart.
        [vincentfretin]
        
        - Internationalize the expected text of a step.
        [vincentfretin]
        
        - Don't disable button, input, textarea, select. The user needs to fill out
        the "remaining fields" and upload an image for example.
        [vincentfretin]
        
        - Rename IManageTourUtility to ITourManager.
        [vincentfretin]
        
        - Add url to next tour at the end of a tour.
        [vincentfretin]
        
        - Add basic step validations: isAnonymous and isAuthenticated.
        [amleczko]
        
        - Refactor tour and step: add proper Interface schema for Tour and Step.
        Add validation checkings, write some coverage tests for that.
        [fdelia, amleczko]
        
        - Add doctests for meta registration.
        [fdelia, amleczko]
        
        - Add unittests for tour_manager.
        [fdelia, amleczko]
        
        
        0.1 (released)
        --------------
        
        - Initial release
        
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Zope2
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
