Metadata-Version: 1.1
Name: ftw.contacts
Version: 1.0.0
Summary: Provides a contact-contenttype
Home-page: https://github.com/4teamwork/ftw.contacts
Author: Mathias Leimgruber
Author-email: mailto:info@4teamwork.ch
License: GPL2
Description: Introduction
        ============
        
        This package provides a contact contenttype.
        
        .. contents:: Table of Contents
        
        
        Installation
        ------------
        
        Add the package as dependency to your setup.py:
        
        .. code:: python
        
          setup(...
                install_requires=[
                  'ftw.contacts',
                ])
        
        or to your buildout configuration:
        
        .. code:: ini
        
          [instance]
          eggs += ftw.contacts
        
        and rerun buildout.
        
        Install the Generic Setup profile.
        
        
        Quick overview of the functions
        -------------------------------
        
        - Contactdirectory with ajax search functionality
        - Contact
        - KML-Representation of Contact
        - vCard-Representation of Contact
        - `ftw.zipexport`_ integration if you install the [zipexport]-extra
        - `ftw.simplelayout`_ integration if you install the [simplelayout]-extra
        
        How it looks
        ------------
        
        The ``ftw.contacts`` package provides a nice contactdirectory.
        
        .. image:: https://raw.github.com/4teamwork/ftw.contacts/master/docs/images/contactdirectory.png
        
        with a contact-view.
        
        .. image:: https://raw.github.com/4teamwork/ftw.contacts/master/docs/images/contact.png
        
        How it works
        ------------
        
        Contactfolder
        ~~~~~~~~~~~~~
        
        This is a dexterity contenttype and acts as a container for contacts to be listed.
        
        After installing the ``ftw.contacts`` package you can add a ``Contactfolder`` to your plonesite.
        
        The ``Contactfolder`` provides a nice overview of all available contacts.
        By default, the first 20 contacts will be shown and you can load more contacts by clicking on the
        ``Load more`` button at the end of the list.
        
        The alphabetical filter allows the user to quickly find a contact. Furthermore contacts can be found by using the search field.
        
        All the requests are asynchron and works also with a big amount of contacts
        
        Contact
        ~~~~~~~
        
        This is a dexterity contenttype addable in a ``Contactfolder``.
        
        A ``Contact`` lists all available attributes on the contact.
        
        You have also the possiblity to show the contacts location on a map.
        
        In addition you can download the kml-representation or the vCard-representation of the contact.
        
        ftw.simplelayout integration
        ----------------------------
        
        Add the simplelayout extra to your egg:
        
        .. code:: ini
        
          [instance]
          eggs += ftw.contacts [simplelayout]
        
        Run buildout and install the ``ftw.contacts.simplelayout:default`` profile
        
        You'll get a new contenttype ``MemberBlock`` which is available in a contentpage.
        
        If you don't know `ftw.simplelayout`_, please read https://github.com/4teamwork/ftw.simplelayout
        
        MemberBlock
        ~~~~~~~~~~~
        
        The memberblock connects the a Contact with a simplelayout page.
        You just have do define the Contact attributes once an you can reuse them trough
        the memberblock
        
        
        ftw.geo integration
        -------------------
        
        Add the geo extra to your egg:
        
        .. code:: ini
        
          [instance]
          eggs += ftw.contacts [geo]
        
        Run buildout and install the ``ftw.contacts.geo:default`` profile
        
        After installing the geo-extra, you'll see a maplayer on each contact-type
        if you entered a valid address.
        
        If you don't know `ftw.geo`_, please read https://github.com/4teamwork/ftw.geo
        
        Compatibility
        -------------
        
        Plone 4.3
        
        .. image:: https://jenkins.4teamwork.ch/job/ftw.contacts-master-test-plone-4.3.x.cfg/badge/icon
           :target: https://jenkins.4teamwork.ch/job/ftw.contacts-master-test-plone-4.3.x.cfg
        
        
        Links
        -----
        
        - Github: https://github.com/4teamwork/ftw.contacts
        - Issues: https://github.com/4teamwork/ftw.contacts/issues
        - Pypi: http://pypi.python.org/pypi/ftw.contacts
        - Continuous integration: https://jenkins.4teamwork.ch/search?q=ftw.contacts
        
        
        Copyright
        ----------
        
        This package is copyright by `4teamwork <http://www.4teamwork.ch/>`_.
        
        ``ftw.contacts`` is licensed under GNU General Public License, version 2.
        
        .. _ftw.zipexport: https://github.com/4teamwork/ftw.zipexport
        .. _ftw.simplelayout: https://github.com/4teamwork/ftw.simplelayout
        .. _ftw.geo: https://github.com/4teamwork/ftw.geo
        Changelog
        =========
        
        
        1.0.0 (2015-12-04)
        ------------------
        
        - Nothing changed yet
Keywords: ftw plone contacts
Platform: UNKNOWN
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: 4.2
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
