Skip to content

Commit

Permalink
[16.0][IMP] Update configure for readme
Browse files Browse the repository at this point in the history
  • Loading branch information
quentinDupont committed Apr 18, 2024
1 parent 6fec216 commit dea4a03
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 26 deletions.
19 changes: 10 additions & 9 deletions base_name_search_improved/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Improved Name Search
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:88daa951eef68e162381052878cb525cb0c1e6b0a72cd2a1f9d138dca31bd6f4
!! source digest: sha256:5527c4c2ccf479b110e1932003e728cba146a25044782418a2bf015f00a548bd
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
Expand Down Expand Up @@ -41,12 +41,12 @@ 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
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/16.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
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/16.0/base_name_search_improved/images/image2.png

How it works:

Expand All @@ -72,14 +72,15 @@ hopefully presenting them in order of relevance.
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.
Go to Settings > Smart Searches
Remove default filter to see all Models
Choose the Modlel you want to configure and choose your options (Smart Search,
Smart Name Search, Domain, Smart Search fields)

Additional search fields can be configured at Settings > Technical > Database > Models,
using the "Name Search Fields" field.
In the example, we choose to activate improved search for Contacts (partners) and
Products. Furthermore user can search a contact typing their city name

.. figure:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image1.png
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/16.0/base_name_search_improved/images/image1.png
:alt: Name Search Fields
:width: 600 px

Expand Down
Binary file modified base_name_search_improved/images/image1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 7 additions & 6 deletions base_name_search_improved/readme/CONFIGURE.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
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.
Go to Settings > Smart Searches
Remove default filter to see all Models
Choose the Modlel you want to configure and choose your options (Smart Search,
Smart Name Search, Domain, Smart Search fields)

Additional search fields can be configured at Settings > Technical > Database > Models,
using the "Name Search Fields" field.
In the example, we choose to activate improved search for Contacts (partners) and
Products. Furthermore user can search a contact typing their city name

.. figure:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image1.png
.. figure:: ../images/image1.png
:alt: Name Search Fields
:width: 600 px
4 changes: 2 additions & 2 deletions base_name_search_improved/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ 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
.. figure:: ../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
.. figure:: ../images/image2.png

How it works:

Expand Down
19 changes: 10 additions & 9 deletions base_name_search_improved/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ <h1 class="title">Improved Name Search</h1>
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:88daa951eef68e162381052878cb525cb0c1e6b0a72cd2a1f9d138dca31bd6f4
!! source digest: sha256:5527c4c2ccf479b110e1932003e728cba146a25044782418a2bf015f00a548bd
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-tools/tree/16.0/base_name_search_improved"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-base_name_search_improved"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-tools&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>Extends the name search feature to use additional, more relaxed
Expand All @@ -381,12 +381,12 @@ <h1 class="title">Improved Name Search</h1>
It also tolerates words in a different order, so searching
for “brown john” also works.</p>
<div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image0.png" src="https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image0.png" />
<img alt="https://raw.githubusercontent.com/OCA/server-tools/16.0/base_name_search_improved/images/image0.png" src="https://raw.githubusercontent.com/OCA/server-tools/16.0/base_name_search_improved/images/image0.png" />
</div>
<p>Additionally, an Administrator can configure other fields to also lookup into.
For example, Customers could be additionally searched by City or Phone number.</p>
<div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image2.png" src="https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image2.png" />
<img alt="https://raw.githubusercontent.com/OCA/server-tools/16.0/base_name_search_improved/images/image2.png" src="https://raw.githubusercontent.com/OCA/server-tools/16.0/base_name_search_improved/images/image2.png" />
</div>
<p>How it works:</p>
<p>Regular name search is performed, and the additional search logic is only
Expand Down Expand Up @@ -419,13 +419,14 @@ <h1 class="title">Improved Name Search</h1>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
<p>The fuzzy search is automatically enabled on all Models.
Note that this only affects typing in related fields.
The regular <tt class="docutils literal">search()</tt>, used in the top right search box, is not affected.</p>
<p>Additional search fields can be configured at Settings &gt; Technical &gt; Database &gt; Models,
using the “Name Search Fields” field.</p>
<p>Go to Settings &gt; Smart Searches
Remove default filter to see all Models
Choose the Modlel you want to configure and choose your options (Smart Search,
Smart Name Search, Domain, Smart Search fields)</p>
<p>In the example, we choose to activate improved search for Contacts (partners) and
Products. Furthermore user can search a contact typing their city name</p>
<div class="figure">
<img alt="Name Search Fields" src="https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image1.png" style="width: 600px;" />
<img alt="Name Search Fields" src="https://raw.githubusercontent.com/OCA/server-tools/16.0/base_name_search_improved/images/image1.png" style="width: 600px;" />
</div>
</div>
<div class="section" id="usage">
Expand Down

0 comments on commit dea4a03

Please sign in to comment.