From 876283debfbc4c9f5e029b157e6c344ce0e1e076 Mon Sep 17 00:00:00 2001 From: Jeffrey Hearn Date: Sat, 10 May 2014 01:35:52 -0400 Subject: [PATCH] omg search --- docs/wagtail_search.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/wagtail_search.rst b/docs/wagtail_search.rst index 4c6ce62f28..c43a537375 100644 --- a/docs/wagtail_search.rst +++ b/docs/wagtail_search.rst @@ -54,13 +54,13 @@ The search view returns a context with a few useful variables. The terms (string) used to make the search. ``search_results`` - A collection of Page objects matching the query. + A collection of Page objects matching the query. The ``specific`` property of ``Page`` will give the most-specific subclassed model object for the Wagtail page. For instance, if an ``Event`` model derived from the basic Wagtail ``Page`` were included in the search results, you could use ``specific`` to access the custom properties of the ``Event`` model (``result.specific.date_of_event``). ``is_ajax`` Boolean. This returns Django's ``request.is_ajax()``. ``query`` - The Query object matching the terms. The query model provides several class methods for viewing the statistics of all queries, but exposes only one property for single queries, ``query.hits``, which tracks the number of time the search string has been used. + A Wagtail Query object matching the terms. The query model provides several class methods for viewing the statistics of all queries, but exposes only one property for single objects, ``query.hits``, which tracks the number of time the search string has been used over the lifetime of the site.