Relevanssi Extras plugin for WordPress

Table of Contents

• Relevanssi Extras plugin for WordPress
• Table of Contents
• Basic Overview
• Requirements
• Download Relevanssi Extras
• Installation
• Usage
• Updating
• Uninstallation
• Language Support
• FAQ
  • Frequently Asked Questions
    • Are there any security considerations?
  • Other questions
• Contributing
  • Contributors
  • Pending Features
• Motivation for this plugin
• Further Information
• License

Basic Overview

Relevanssi Extras for WordPress:

• Enables ignoring of hyphens;
• Adds the ability to limit the number of search results per page;
• Enable you to exclude specific pages from results.

IMPORTANT: Although we expect everything to work, this ALPHA release has not been fully tested in every situation. If you find a problem, please help by reporting it in the Bug Tracker.

(Back to top)

Requirements

This plugin requires WordPress 4.1+ from https://wordpress.org/

(Back to top)

Download Relevanssi Extras

The most recent DEVELOPMENT release can be found at: https://github.com/michael-milette/wordpress-relevanssi_extras

(Back to top)

Installation

Install the plugin, like any other plugin, to the following folder:

/wp-content/plugins/wordpress-relevanssi_extras

(Back to top)

Usage

Once installed and activated, Pages (not Posts) will have a new checkbox setting in the sidebar called "DO NOT INCLUDE this page in search results". It will be in a section called "Exclude Relevanssi Page Search".

When enabled, the page will not be included i Relevanssi search results. This is useful if you do not want a particular page to appear in search results such as a thank you, payment or other page on your site.

There are no other configurable settings for this plugin at this time.

(Back to top)

Updating

There are no special considerations required for updating the plugin.

The first public ALPHA version was released on 2017-11-01.

For more information on latest releases, see the CHANGELOG.md file on GitHub.

(Back to top)

Uninstallation

Uninstalling the plugin by going into the following:

Dashboard > Plugins > Installed Plugins > Relevanssi Extras

...and click Deactivate, and then Delete. You may also need to manually delete the following folder:

/wp-content/plugins/wordpress-relevanssi_extras

(Back to top)

Language Support

This plugin only supports the English language. However, this will not prevent it from working in other languages.

This plugin has not been tested for right-to-left (RTL) language support. If you want to use this plugin with a RTL language and it doesn't work as-is, feel free to prepare a pull request and submit it to the project page at:

https://github.com/michael-milette/wordpress-relevanssi_extras

(Back to top)

FAQ

Frequently Asked Questions

IMPORTANT: Although we expect everything to work, this ALPHA release has not been fully tested in every situation. If you find a problem, please help by reporting it in the Bug Tracker.

Are there any security considerations?

There are no known security considerations at this time.

Other questions

Got a burning question that is not covered here? If you can't find your answer, open a new issue on Github

(Back to top)

Contributing

If you are interested in helping, please take a look at our contributing guidelines for details on our code of conduct and the process for submitting pull requests to us.

Contributors

Michael Milette - Author and Lead Developer

Pending Features

Some of the features we are considering for future releases include:

• Adding configurable option to specify the number of results per page (current hard coded).
• Add support for language translations for plugin strings.

If you could use any of these features, or have other requirements, consider contributing or hiring us to accelerate development.

(Back to top)

Motivation for this plugin

The development of this plugin was motivated through our own experience in WordPress development and topics discussed in the various WordPress forums. The project is sponsored and supported by TNG Consulting Inc.

(Back to top)

Further Information

For further information regarding the Relevanssi Extras plugin for WordPress, support or to report a bug, please visit the project page.

(Back to top)

License

Copyright © 2017-2024 TNG Consulting Inc. - https://www.tngconsulting.ca/

This file is part of Relevanssi Extras for WordPress.

Relevanssi Extras is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Relevanssi Extras is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Relevanssi Extras. If not, see https://www.gnu.org/licenses/.

(Back to top)