You are here

Home » API reference » Search API Exclude Entity 8

README.txt in Search API Exclude Entity 8 

CONTENTS OF THIS FILE
---------------------
 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Troubleshooting
 * Sponsors
 * Maintainers

INTRODUCTION
------------
This module is the Drupal 8 / Search API successor to Apache Solr Node Exclude.
It makes it possible to exclude entities from being indexed in a Search API 
index.

Compared to the Drupal 7 / Apache Solr version is the new Drupal 8 version
using a custom field type, widget and formatter for controlling the exclude
status on entities. This gives some advantages:

* The field position, field label and description is configurable per entity /
bundle.
* It is possible to use multiple exclude fields on the same entity bundle, if
multiple search systems or indexes is being used in the site.
* Views integration out of the box without custom plugins.

The processing in Search API is handled using a custom configurable processing
plugin.

REQUIREMENTS
------------
* Search API (https://www.drupal.org/project/search_api)

INSTALLATION
------------
* Install the module and required modules.

CONFIGURATION
-------------
* Add a "Search API Exclude Entity" field to the entity types / bundles that is
going to use the exclude functionality.
* Add your search server and index in Search API.
* Enable the "Search API Exclude Entity" processor.
* In the processor settings enable the fields that should be used for
controlling the entity exclude status in the active index. It is possible to
have multiple entity types and fields enabled per index.

TROUBLESHOOTING
---------------
-

SPONSORS
--------
* FFW - https://ffwagency.com

MAINTAINERS
-----------
Current maintainers:
* Jens Beltofte (beltofte) - https://drupal.org/u/beltofte

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3.  * Introduction

  4.  * Requirements

  5.  * Installation

  6.  * Configuration

  7.  * Troubleshooting

  8.  * Sponsors

  9.  * Maintainers

  10. 

  11. INTRODUCTION

  12. ------------

  13. This module is the Drupal 8 / Search API successor to Apache Solr Node Exclude.

  14. It makes it possible to exclude entities from being indexed in a Search API 

  15. index.

  16. 

  17. Compared to the Drupal 7 / Apache Solr version is the new Drupal 8 version

  18. using a custom field type, widget and formatter for controlling the exclude

  19. status on entities. This gives some advantages:

  20. 

  21. * The field position, field label and description is configurable per entity /

  22. bundle.

  23. * It is possible to use multiple exclude fields on the same entity bundle, if

  24. multiple search systems or indexes is being used in the site.

  25. * Views integration out of the box without custom plugins.

  26. 

  27. The processing in Search API is handled using a custom configurable processing

  28. plugin.

  29. 

  30. REQUIREMENTS

  31. ------------

  32. * Search API (https://www.drupal.org/project/search_api)

  33. 

  34. INSTALLATION

  35. ------------

  36. * Install the module and required modules.

  37. 

  38. CONFIGURATION

  39. -------------

  40. * Add a "Search API Exclude Entity" field to the entity types / bundles that is

  41. going to use the exclude functionality.

  42. * Add your search server and index in Search API.

  43. * Enable the "Search API Exclude Entity" processor.

  44. * In the processor settings enable the fields that should be used for

  45. controlling the entity exclude status in the active index. It is possible to

  46. have multiple entity types and fields enabled per index.

  47. 

  48. TROUBLESHOOTING

  49. ---------------

  50. -

  51. 

  52. SPONSORS

  53. --------

  54. * FFW - https://ffwagency.com

  55. 

  56. MAINTAINERS

  57. -----------

  58. Current maintainers:

  59. * Jens Beltofte (beltofte) - https://drupal.org/u/beltofte