From 803a35cfa3bf06305ba45fea578eb320f3ce3288 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Fri, 30 Apr 2021 18:19:14 +0000 Subject: [PATCH] [UPD] README.rst --- base_name_search_improved/README.rst | 144 ++++++ .../static/description/index.html | 487 ++++++++++++++++++ 2 files changed, 631 insertions(+) create mode 100644 base_name_search_improved/README.rst create mode 100644 base_name_search_improved/static/description/index.html diff --git a/base_name_search_improved/README.rst b/base_name_search_improved/README.rst new file mode 100644 index 000000000..8d2261112 --- /dev/null +++ b/base_name_search_improved/README.rst @@ -0,0 +1,144 @@ +==================== +Improved Name Search +==================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github + :target: https://github.com/OCA/server-tools/tree/14.0/base_name_search_improved + :alt: OCA/server-tools +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-tools-14-0/server-tools-14-0-base_name_search_improved + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/149/14.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +Extends the name search feature to use additional, more relaxed +matching methods, and to allow searching into configurable additional +record fields. + +The name search is the lookup feature to select a related record. +For example, selecting a Customer on a new Sales order. + +For example, typing "john brown" doesn't match "John M. Brown". +The relaxed search also looks up for records containing all the words, +so "John M. Brown" would be a match. +It also tolerates words in a different order, so searching +for "brown john" also works. + +.. figure:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image0.png + +Additionally, an Administrator can configure other fields to also lookup into. +For example, Customers could be additionally searched by City or Phone number. + +.. figure:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image2.png + +How it works: + +Regular name search is performed, and the additional search logic is only +triggered if not enough results are found. +This way, no overhead is added on searches that would normally yield results. + +But if not enough results are found, then additional search methods are tried. +The specific methods used are: + +- Try regular search on each of the additional fields +- Try ordered word search on each of the search fields +- Try unordered word search on each of the search fields + +All results found are presented in that order, +hopefully presenting them in order of relevance. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +The fuzzy search is automatically enabled on all Models. +Note that this only affects typing in related fields. +The regular ``search()``, used in the top right search box, is not affected. + +Additional search fields can be configured at Settings > Technical > Database > Models, +using the "Name Search Fields" field. + +.. figure:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image1.png + :alt: Name Search Fields + :width: 600 px + +Usage +===== + +Just type into any related field, such as Customer on a Sale Order. + +Known issues / Roadmap +====================== + +* Also use fuzzy search, such as the Levenshtein distance: + https://www.postgresql.org/docs/9.5/static/fuzzystrmatch.html +* The list of additional fields to search could benefit from caching, for efficiency. +* This feature could also be implemented for regular ``search`` on the ``name`` field. +* While adding m2o or other related field that also have an improved name search, that improved name search is not used (while if name_search is customizend on a module and you add a field of that model on another model it works ok). Esto por ejemplo es en productos si agregamos campo "categoría pública" y a categoría pública le ponemos "parent_id". Entonces vamos a ver que si buscamos por una categoría padre no busca nada, en vez si hacemos esa lógica en name_search de modulo si funciona + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Daniel Reis +* ADHOC SA + +Contributors +~~~~~~~~~~~~ + +* Daniel Reis +* Kitti U. (migrate to v14) + +Other credits +~~~~~~~~~~~~~ + +The development of this module has been financially supported by: + +* Odoo Community Association + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/server-tools `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/base_name_search_improved/static/description/index.html b/base_name_search_improved/static/description/index.html new file mode 100644 index 000000000..a9c4cc2dc --- /dev/null +++ b/base_name_search_improved/static/description/index.html @@ -0,0 +1,487 @@ + + + + + + +Improved Name Search + + + + + +