django-sekh 0.2

Installation

First of all you need to install BeautifulSoup >= 3.2.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 :

• AltaVista

• Ask

• Google

• Live

• Lycos

• MSN

• 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