django-machina Logo
1.1.6
  • Getting started
  • Example project
  • Settings
  • Glossary
  • Forum permissions
  • Customization
  • Machina’s apps reference
    • Forum
    • Forum conversation
    • Forum feeds
    • Forum member
    • Forum moderation
    • Forum permission
    • Forum search
      • Search indexes
        • Forum search indexes
      • Views
        • Forum search views
    • Forum tracking
  • Contributing to django-machina
  • Release notes
django-machina
  • »
  • Machina’s apps reference »
  • Forum search
  • Edit on GitHub

Forum search¶

The forum_search application allows to search within forums.

Search indexes¶

Forum search indexes¶

This module defines search indexes allowing to perform searches among forum topics and posts.

class machina.apps.forum_search.search_indexes.PostIndex¶

Bases: haystack.indexes.SearchIndex, haystack.constants.Indexable

Defines the data stored in the Post indexes.

get_model()¶

Should return the Model class (not an instance) that the rest of the SearchIndex should use.

This method is required & you must override it to return the correct class.

index_queryset(using=None)¶

Get the default QuerySet to index when doing a full update.

Subclasses can override this method to avoid indexing certain objects.

read_queryset(using=None)¶

Get the default QuerySet for read actions.

Subclasses can override this method to work with other managers. Useful when working with default managers that filter some objects.

Views¶

Forum search views¶

This module defines views provided by the forum_search application.

class machina.apps.forum_search.views.FacetedSearchView(*args, **kwargs)¶

Bases: haystack.views.FacetedSearchView

Allows to search within forums.

build_form()¶

Instantiates the form the class should use to process the search query.

Next Previous

© Copyright 2013-2018, Morgan Aubert. Revision 7f387c41.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: 1.1.6
Versions
latest
stable
1.1.6
1.0.2
0.7.1
0.7.0
0.6.0
0.5.6
0.5.5
0.5.4
0.5.3
0.5.2
0.5.1
0.5.0
0.4.0
0.3.0
0.2.1
0.2.0
0.1.1
0.1.0
Downloads
html
On Read the Docs
Project Home
Builds