updated synonyms to 1.5

sites/all/modules/contrib/taxonomy/synonyms/README.txt

@@ -1,69 +1,84 @@
 
 -- SUMMARY --
 
-The Synonyms module extends the Drupal core Taxonomy features. Currently
-the module provides this additional functionality:
+The Synonyms module enriches Entities with the notion of synonyms. Currently the
+module provides the following functionality:
 * support of synonyms through Field API. Any field, for which synonyms behavior
-   exists, can be enabled as source of synonyms.
-* synonyms-friendly autocomplete and select widgets for taxonomy_term_reference
-   fields
+  implementation exists, can be enabled as source of synonyms.
+* support of synonyms through Entity properties. Entity properties stored in
+  database (as opposed to being calculated on-the-fly) can be enabled as source
+  of synonyms.
+* synonyms-friendly autocomplete and select widgets for taxonomy_term_reference,
+  entityreference, and commerce_product_reference (through Synonyms Commerce
+  submodule) fields.
 * integration with Drupal search functionality through Synonyms Search
-   submodule. It enables searching content by synonyms of the terms that the
-   content references. Synonyms Search submodule also integrates with Term
-   Search contributed module in a fashion that allows your terms to be found by
-   their synonyms.
-* integration with Search API. If you include synonyms of a term into your
-   Search API search index, your clients will be able to find content with
-   search keywords that contain synonyms and not actual names of terms.
+  submodule. It enables searching content by synonyms of the terms that the
+  content references. Synonyms Search submodule also integrates with Term Search
+  contributed module in a fashion that allows your terms to be found by their
+  synonyms.
+* integration with Search API. If you include entity synonyms into your Search
+  API search index, your clients will be able to find content with search
+  keywords that contain synonyms and not actual names of entities.
+* integration with Views. Synonyms module provides a few filters and contextual
+  filters that allow filtering not only by entity name but also by one of its
+  synonyms. Synonyms module also provides a Views field for all eligible
+  entities that contains a list of synonyms associated with the entity in
+  question.
 
 -- REQUIREMENTS --
 
 The Synonyms module requires the following modules:
-* Taxonomy module
-* CTools module
+* Entity API module
 
--- SYNONYMS BEHAVIOR, SUPPORTED FIELD TYPES --
-
-Module ships with ability to use the following field types as synonyms:
-* Text
-* Taxonomy Term Reference
+The Synonyms module integrates with (but does not require) the following
+modules:
+* Taxonomy
+* Search
+* Term Search
 * Entity Reference
-* Number
-* Float
-* Decimal
+* Views
+* Commerce
+* Features
+* Term Merge
 
-If you want to implement your own synonyms behavior that would enable support
-for any other field type, refer to synonyms.api.php file for instructions on how
-to do it, or file an issue against Synonyms module. We will try to implement
-support for your field type too. If you have written your synonyms behavior
-implementation, please share by opening an issue, and it will be included into
-this module.
+-- SUPPORTED SYNONYMS PROVIDERS --
+
+Module ships with ability to provide synonyms from the following locations:
+* "Text" field type
+* "Taxonomy Term Reference" field type
+* "Entity Reference" field type
+* "Commerce Product Reference" field type
+* "Number" field type
+* "Float" field type
+* "Decimal" field type
+* Entity properties stored in database
+
+Worth mentioning here: this list is easily extended further by implementing new
+synonyms providers in your code. Refer to Synonyms advanced help for more
+details on how to accomplish it.
 
 -- GRANULATION WITHIN SYNONYMS BEHAVIOR --
 
 In order to achieve greater flexibility, this module introduced additional
-granularity into what "synonyms" mean. Then you can enable different synonyms
-behaviors for different fields. For example, field "Typos" can be part of
-autocomplete behavior, while field "Other spellings" can be part of search
-integration behavior. Currently the following synonym behaviors are recognized
-(other modules actually can extend this list):
-* General synonym - normally we suggest to enable this behavior for all fields
-   that have enabled at least one another behavior. In technical words, this
-   behavior is responsible for including content of the field into term synonyms
-   and also enables ability to add entities as synonym into this field.
-* Autocomplete - whether content of this field should participate in
-   autocomplete suggestions. This module ships an autocomplete synonyms friendly
-   widget and its autocomplete suggestions will be filled in with the content of
-   the fields that have enabled this behavior.
-* Select - whether content of this field should be included in the synonyms
-   friendly select widget.
+granularity into what "synonyms" mean. This granularity is expressed via
+"synonyms behavior" idea whatsoever. Then you can enable different synonyms
+behaviors for different synonyms providers. For example, field "Typos" can be
+part of autocomplete behavior, while field "Other spellings" can be part of
+search integration behavior. Currently the following synonym behaviors are
+recognized (other modules actually can extend this list):
+* Autocomplete - whether synonyms from this provider should participate in
+  autocomplete suggestions. This module ships with autocomplete synonyms
+  friendly widgets and their autocomplete suggestions will be filled in with the
+  synonyms of providers that have this behavior enabled.
+* Select - whether synonyms from this provider should be included in the
+  synonyms friendly select widgets.
 * Search integration (requires Synonyms Search enabled) - allows your content to
-   be found by synonyms of the terms it references. Your nodes  will be found by
-   all synonyms that have this behavior enabled.
+  be found by synonyms of the terms it references. Your nodes will be found by
+  all synonyms that have this behavior enabled.
 
-Therefore, on the vocabulary edit page you will see a table, where rows are
-fields that can become synonyms and columns are these "synonym behaviors" and
-you decide what synonym behaviors to activate on what fields.
+Therefore, on the Synonyms configuration page you will see a table, where rows
+are synonym providers and columns are these "synonym behaviors" and you decide
+what synonym behaviors to activate on what synonym providers.
 
 -- INSTALLATION --
 
@@ -71,15 +86,11 @@ you decide what synonym behaviors to activate on what fields.
 
 -- CONFIGURATION --
 
-* The module itself does not provide any configuration as of the moment.
-Although during editing of a Taxonomy vocabulary you will be specify for that
-particular vocabulary the additional functionality this module provides, you
-will find additional fieldset at the bottom of the vocabulary edit page.
+* You can configure synonyms of all eligible entity types by going to Admin ->
+  Structure -> Synonyms (admin/structure/synonyms)
 
 -- FUTURE DEVELOPMENT --
 
-* If you are interested into converting this module from synonyms for Taxonomy
-terms into synonyms for any entity type, please go to this issue
-http://drupal.org/node/1194802 and leave a comment. Once we see some demand for
-this great feature and the Synonyms module gets a little more mature, we will
-try to make it happen.
+* No good directions for future development are known at the moment. If you
+  would like to suggest one, report an issue (future request) against Synonyms
+  issue queue on Drupal.org.