Metadata-Version: 1.1
Name: django-sekh
Version: 0.4
Summary: Highlight the keywords of a page if a visitor is coming form a search engine.
Home-page: https://github.com/Fantomas42/django-sekh
Author: Fantomas42
Author-email: fantomas42@gmail.com
License: BSD License
Description: ===========
        Django-SEKH
        ===========
        
        |latest-version| |downloads|
        
        |travis-develop| |coverage-develop|
        
        Django Search Engine Keywords **Highlighter**,
        
        is a middleware for Django providing the capacities to highlight the user's
        search keywords if he is coming from a search engine like Google, Yahoo or
        a custom search form plugged in your Website.
        
        It retrieves the keywords of the search and decorate them with a ``span``
        markup containing the classes ``highlight term-X`` for CSS makuping.
        
        .. contents::
        
        Installation
        ============
        
        First of all you need to install `BeautifulSoup`_ >= 4.0.
        
        Then install the package in your ``PYTHON_PATH`` by getting the
        sources and run ``setup.py`` or use ``pip``. ::
        
          $ pip install -e git://github.com/Fantomas42/django-sekh.git#egg=django-sekh
        
        Usage
        =====
        
        In your settings file, simply add this middleware at the end of the list. ::
        
          MIDDLEWARE_CLASSES = (
            ...
            'sekh.middleware.KeywordsHighlightingMiddleware',
            )
        
        This is it !
        
        Search Engines
        ==============
        
        Currenty django-sekh supports these search engines :
        
        * Ask
        * Baidu
        * Bing
        * Google
        * Hotbot
        * Lycos
        * Yahoo
        
        And even if you have a custom search engine plugged on your website,
        ``sekh`` can highlight the searched keywords. Currently ``sekh`` will
        highlight all the terms contained in this list of GET variables :
        ::
        
            ['highlight', 'hl', 'q', 'query', 'pattern']
        
        You can change the supported values by defining a variable named
        ``HIGHLIGHT_GET_VARNAMES`` representing a list of supported variable names
        in your project's settings.
        
        Testing
        =======
        
        If you want to test the highlighter, you can pass keywords in the ``hl``
        parameter in GET.
        
          http://localhost:8000/admin?hl=django%20admin
        
        
        .. |travis-develop| image:: https://travis-ci.org/Fantomas42/django-sekh.png?branch=develop
           :alt: Build Status - develop branch
           :target: http://travis-ci.org/Fantomas42/django-sekh
        .. |coverage-develop| image:: https://coveralls.io/repos/Fantomas42/django-sekh/badge.png?branch=develop
           :alt: Coverage of the code
           :target: https://coveralls.io/r/Fantomas42/django-sekh
        .. |latest-version| image:: https://pypip.in/v/django-sekh/badge.png
           :alt: Latest version on Pypi
           :target: https://crate.io/packages/django-sekh/
        .. |downloads| image:: https://pypip.in/d/django-sekh/badge.png
           :alt: Downloads from Pypi
           :target: https://crate.io/packages/django-sekh/
        
        .. _`BeautifulSoup`: http://www.crummy.com/software/BeautifulSoup/
        
Keywords: django,search engine,keyword,highlight
Platform: UNKNOWN
Classifier: Framework :: Django
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: Software Development :: Libraries :: Python Modules
