Skip to content
Static pages for Haystack
Python
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
haystack_static_pages
AUTHORS
LICENSE
MANIFEST.in
README.rst
RELEASES
setup.py

README.rst

haystack_static_pages

Haystack Static Pages is an extension library for Haystack. Currently, it adds the ability to index static pages through the use of a settings.py variable and command extension.

Basic Usage:

  1. Setup and install Haystack.

  2. Add haystack_static_pages to your INSTALLED_APPS in settings.py

  3. Add HAYSTACK_STATIC_PAGES to your settings.py.

    eg.

    HAYSTACK\_STATIC\_PAGES = (
        'static-about_us',                        # A named url
        'static-help',                            # Another named url
        'http://www.example.com/some_page.html',  # An fully qualified url
    )
    
  4. ./manage.py syncdb to create the necessary tables.

  5. ./manage.py crawl_static_pages to populate the database with the static page content. This is needed for Haystack to properly map the urls to the content. Output should indicate which pages were crawled and where, as well as the total number of pages found. Crawled pages must be accessible through an http connection. ie., they must be viewable in a browser.

  6. ./manage.py rebuild_index to create the search indexes used by Haystack. You should see a note about how many static pages were indexed. The number of static pages indexed should match the number of static pages created in the step above.

Advanced Usage:

There are currently two command line options that can be used with the crawl_static_pages command:

-l LANG, --language=LANG
 This allows the user to specify the desired language for indexing content. Each page will include a language attribute that will correspond to the page's language as detected in the html lang attribute or 'en' if unable to be determined.
-p PORT, --port=PORT
 This allows the user to include the port number to crawl, if required.
Something went wrong with that request. Please try again.