mirror of
https://github.com/wagtail/wagtail.git
synced 2024-12-01 11:41:20 +01:00
bc6b5a8a6c
All `.. code::` instances have been changed to use `.. code-block::`, and have been properly formatted. The syntax names have been normalised, so all django templates use the `html+django` syntax, shell commands use `sh`, and plain text uses `text`.
64 lines
2.0 KiB
ReStructuredText
64 lines
2.0 KiB
ReStructuredText
.. _editors-picks:
|
|
|
|
=======================
|
|
Promoted search results
|
|
=======================
|
|
|
|
.. module:: wagtail.contrib.wagtailsearchpromotions
|
|
|
|
.. versionchanged:: 1.1
|
|
|
|
Before Wagtail 1.1, promoted search results were implemented in the :mod:`wagtail.wagtailsearch` core module and called "editors picks".
|
|
|
|
The ``searchpromotions`` module provides the models and user interface for managing "Promoted search results" and displaying them in a search results page.
|
|
|
|
"Promoted search results" allow editors to explicitly link relevant content to search terms, so results pages can contain curated content in addition to results from the search engine.
|
|
|
|
|
|
Installation
|
|
============
|
|
|
|
The ``searchpromotions`` module is not enabled by default. To install it, add ``wagtail.contrib.wagtailsearchpromotions`` to ``INSTALLED_APPS`` in your project's Django settings file.
|
|
|
|
|
|
.. code-block:: python
|
|
|
|
INSTALLED_APPS = [
|
|
...
|
|
|
|
'wagtail.contrib.wagtailsearchpromotions',
|
|
]
|
|
|
|
This app contains migrations so make sure you run the ``migrate`` django-admin command after installing.
|
|
|
|
|
|
Usage
|
|
=====
|
|
|
|
Once installed, a new menu item called "Promoted search results" should appear in the "Settings" menu. This is where you can assign pages to popular search terms.
|
|
|
|
|
|
Displaying on a search results page
|
|
-----------------------------------
|
|
|
|
To retrieve a list of promoted search results for a particular search query, you can use the ``{% get_search_promotions %}`` template tag from the ``wagtailsearchpromotions_tags`` templatetag library:
|
|
|
|
.. code-block:: html+django
|
|
|
|
{% load wagtailcore_tags wagtailsearchpromotions_tags %}
|
|
|
|
...
|
|
|
|
{% get_search_promotions search_query as search_promotions %}
|
|
|
|
<ul>
|
|
{% for search_promotion in search_promotions %}
|
|
<li>
|
|
<a href="{% pageurl search_promotion.page %}">
|
|
<h2>{{ search_promotion.page.title }}</h2>
|
|
<p>{{ search_promotion.description }}</p>
|
|
</a>
|
|
</li>
|
|
{% endfor %}
|
|
</ul>
|