Wagtail Wagtail Documentation
  • Getting started
    • Your first Wagtail site
    • Demo site
    • Integrating Wagtail into a Django project
    • The Zen of Wagtail
  • Usage guide
    • Page models
    • Writing templates
    • How to use images in templates
    • Search
      • Indexing
      • Searching
      • Backends
    • Snippets
    • How to use StreamField for mixed content
    • Permissions
  • Advanced topics
    • Images
      • Generating renditions in Python
      • Animated GIF support
      • Image file formats
      • Custom image models
      • Changing rich text representation
      • Feature Detection
      • Dynamic image serve view
      • Focal points
      • Title generation on upload
    • Documents
      • Custom document model
      • Title generation on upload
    • Embedded content
    • How to add Wagtail into an existing Django project
    • Deploying Wagtail
    • Performance
    • Internationalisation
    • Private pages
    • Customising Wagtail
      • Customising the editing interface
      • Customising admin templates
      • Custom user models
      • How to build custom StreamField blocks
    • Third-party tutorials
    • Testing your Wagtail site
    • Wagtail API
      • Wagtail API v2 Configuration Guide
      • Wagtail API v2 Usage Guide
    • How to build a site with AMP support
    • Accessibility considerations
    • About StreamField BoundBlocks and values
    • Multi-site, multi-instance and multi-tenancy
    • How to use a redirect with Form builder to prevent double submission
  • Extending Wagtail
    • Creating admin views
    • Template components
    • Adding reports
    • Adding new Task types
    • Audit log
    • Customising the user account settings form
    • Customising group edit/create views
    • Rich text internals
    • Extending the Draftail Editor
    • Extending the Hallo Editor
    • Adding custom bulk actions
  • Reference
    • Pages
      • Theory
      • Recipes
      • Panel types
      • Model Reference
      • Page QuerySet reference
    • StreamField reference
      • StreamField block reference
      • Form widget client-side API
    • Contrib modules
      • Site settings
      • Form builder
        • Form builder customisation
      • Sitemap generator
      • Frontend cache invalidator
      • RoutablePageMixin
      • ModelAdmin
        • modeladmin customisation primer
        • Customising the menu item
        • Customising IndexView - the listing view
        • Customising CreateView, EditView and DeleteView
        • Enabling & customising InspectView
        • Customising ChooseParentView
        • Additional tips and tricks
          • Reversing ModelAdmin URLs
      • PostgreSQL search engine
      • Promoted search results
      • Simple translation
      • TableBlock
      • Typed table block
      • Redirects
      • Legacy richtext
    • Management commands
    • Hooks
    • Signals
    • Settings
    • The project template
    • Jinja2 template support
  • Support
  • Using Wagtail: an Editor’s guide
    • Introduction
    • Getting started
    • Finding your way around
      • The Dashboard
      • The Explorer menu
      • Using search
      • The Explorer page
    • Creating new pages
      • Selecting a page type
      • Creating page body content
      • Inserting images in a page
      • Inserting links in a page
      • Inserting videos into body content
      • Inserting links to documents into body text
      • Adding multiple items
      • Required fields
      • Edit Page tabs
      • Previewing and submitting pages for moderation
    • Editing existing pages
    • Copying and creating aliases to existing pages
    • Managing documents, images, snippets and collections
      • Documents
      • Images
      • Snippets
      • Collections
    • Managing Redirects
    • Administrator tasks
      • Managing users and roles
      • Managing Workflows
      • Promoted search results
    • Browser issues
  • Contributing to Wagtail
    • Issue tracking
    • Development
    • Committing code
    • UI Styleguide
    • General coding guidelines
    • Python coding guidelines
    • HTML coding guidelines
    • CSS coding guidelines
    • JavaScript coding guidelines
    • Documentation guidelines
    • Writing documentation
    • Reporting security issues
    • Wagtail’s release process
  • Release notes
    • Upgrading Wagtail
    • Wagtail 2.16.1 release notes
    • Wagtail 2.16 release notes
    • Wagtail 2.15.4 release notes
    • Wagtail 2.15.3 release notes
    • Wagtail 2.15.2 release notes
    • Wagtail 2.15.1 release notes
    • Wagtail 2.15 release notes
    • Wagtail 2.14.2 release notes
    • Wagtail 2.14.1 release notes
    • Wagtail 2.14 release notes
    • Wagtail 2.13.5 release notes
    • Wagtail 2.13.4 release notes
    • Wagtail 2.13.3 release notes
    • Wagtail 2.13.2 release notes
    • Wagtail 2.13.1 release notes
    • Wagtail 2.13 release notes
    • Wagtail 2.12.6 release notes
    • Wagtail 2.12.5 release notes
    • Wagtail 2.12.4 release notes
    • Wagtail 2.12.3 release notes
    • Wagtail 2.12.2 release notes
    • Wagtail 2.12.1 release notes
    • Wagtail 2.12 release notes
    • Wagtail 2.11.9 release notes
    • Wagtail 2.11.8 release notes
    • Wagtail 2.11.7 release notes
    • Wagtail 2.11.6 release notes
    • Wagtail 2.11.5 release notes
    • Wagtail 2.11.4 release notes
    • Wagtail 2.11.3 release notes
    • Wagtail 2.11.2 release notes
    • Wagtail 2.11.1 release notes
    • Wagtail 2.11 release notes
    • Wagtail 2.10.2 release notes
    • Wagtail 2.10.1 release notes
    • Wagtail 2.10 release notes
    • Wagtail 2.9.3 release notes
    • Wagtail 2.9.2 release notes
    • Wagtail 2.9.1 release notes
    • Wagtail 2.9 release notes
    • Wagtail 2.8.2 release notes
    • Wagtail 2.8.1 release notes
    • Wagtail 2.8 release notes
    • Wagtail 2.7.4 release notes
    • Wagtail 2.7.3 release notes
    • Wagtail 2.7.2 release notes
    • Wagtail 2.7.1 release notes
    • Wagtail 2.7 release notes
    • Wagtail 2.6.3 release notes
    • Wagtail 2.6.2 release notes
    • Wagtail 2.6.1 release notes
    • Wagtail 2.6 release notes
    • Wagtail 2.5.2 release notes
    • Wagtail 2.5.1 release notes
    • Wagtail 2.5 release notes
    • Wagtail 2.4 release notes
    • Wagtail 2.3 release notes
    • Wagtail 2.2.2 release notes
    • Wagtail 2.2.1 release notes
    • Wagtail 2.2 release notes
    • Wagtail 2.1.3 release notes
    • Wagtail 2.1.2 release notes
    • Wagtail 2.1.1 release notes
    • Wagtail 2.1 release notes
    • Wagtail 2.0.2 release notes
    • Wagtail 2.0.1 release notes
    • Wagtail 2.0 release notes
    • Wagtail 1.13.4 release notes
    • Wagtail 1.13.3 release notes
    • Wagtail 1.13.2 release notes
    • Wagtail 1.13.1 release notes
    • Wagtail 1.13 release notes
    • Wagtail 1.12.6 release notes
    • Wagtail 1.12.5 release notes
    • Wagtail 1.12.4 release notes
    • Wagtail 1.12.3 release notes
    • Wagtail 1.12.2 release notes
    • Wagtail 1.12.1 release notes
    • Wagtail 1.12 release notes
    • Wagtail 1.11.1 release notes
    • Wagtail 1.11 release notes
    • Wagtail 1.10.1 release notes
    • Wagtail 1.10 release notes
    • Wagtail 1.9.1 release notes
    • Wagtail 1.9 release notes
    • Wagtail 1.8.2 release notes
    • Wagtail 1.8.1 release notes
    • Wagtail 1.8 release notes
    • Wagtail 1.7 release notes
    • Wagtail 1.6.3 release notes
    • Wagtail 1.6.2 release notes
    • Wagtail 1.6.1 release notes
    • Wagtail 1.6 release notes
    • Wagtail 1.5.3 release notes
    • Wagtail 1.5.2 release notes
    • Wagtail 1.5.1 release notes
    • Wagtail 1.5 release notes
    • Wagtail 1.4.6 release notes
    • Wagtail 1.4.5 release notes
    • Wagtail 1.4.4 release notes
    • Wagtail 1.4.3 release notes
    • Wagtail 1.4.2 release notes
    • Wagtail 1.4.1 release notes
    • Wagtail 1.4 release notes
    • Wagtail 1.3.1 release notes
    • Wagtail 1.3 release notes
    • Wagtail 1.2 release notes
    • Wagtail 1.1 release notes
    • Wagtail 1.0 release notes
    • Wagtail 0.8.10 release notes
    • Wagtail 0.8.8 release notes
    • Wagtail 0.8.7 release notes
    • Wagtail 0.8.6 release notes
    • Wagtail 0.8.5 release notes
    • Wagtail 0.8.4 release notes
    • Wagtail 0.8.3 release notes
    • Wagtail 0.8.1 release notes
    • Wagtail 0.8 release notes
    • Wagtail 0.7 release notes
    • Wagtail 0.6 release notes
    • Wagtail 0.5 release notes
    • Wagtail 0.4.1 release notes
    • Wagtail 0.4 release notes
  1. Docs
  2. Using Wagtail: an Editor’s guide
  3. Administrator tasks
  4. Promoted search results
Edit on GitHub View source

Promoted search results¶

Note

Promoted search results are an optional Wagtail feature. For details of how to enable them on a Wagtail installation, see search_promotions

Wagtail allows you to promote certain search results dependent on the keyword or phrase entered by the user when searching. This can be particularly useful when users commonly refer to parts of your organisation via an acronym that isn’t in official use, or if you want to direct users to a page when they enter a certain term related to the page but not included in the text of the page itself.

As a concrete example, one of our clients wanted to direct people who searched for ‘finances’ to their ‘Annual budget review’ page. The word ‘finances’ is not mentioned in either the title or the body of the target page, so they created a promoted search result for the word ‘finances’ that pushed the budget page to the very top of the results.

Note

The promoted result will only work if the user types exactly the phrase that you have set it up for. If you have variations of a phrase that you want to take into account, then you must create additional promoted results.

To set up the promoted search results, click on the ‘Promoted search results’ menu item in the ‘Settings’ menu.

../../_images/screen37_promoted_menu_item.png

Add a new promoted result from the button in the top right of the resulting screen, or edit an existing promoted result by clicking on it.

../../_images/screen38_promoted_results_listing.png

When adding a new promoted result, Wagtail provides you with a ‘Choose from popular search terms’ option. This will show you the most popular terms entered by users into your internal search. You can match this list against your existing promoted results to ensure that users are able to find what they are looking for.

../../_images/screen38.5_popular_search_results.png

You then add a the result itself by clicking ‘Add recommended page’. You can add multiple results, but be careful about adding too many, as you may end up hiding all of your organic results with promoted results, which may not be helpful for users who aren’t really sure what they are looking for.

../../_images/screen39_add_promoted_result.png
  • Previous Managing Workflows
  • Next Browser issues
  • Features
  • About Wagtail
  • Services
  • Blog
  • Packages
  • Developers

Wagtail Sphinx Theme 5.0.4