✨ display inline help for searches - 💄 new syle for help

1 files changed, 34 insertions, 1 deletions

diff --git a/ishtar_common/templates/widgets/search_input.html b/ishtar_common/templates/widgets/search_input.html
index b26cd07f0..9cbae011e 100644
--- a/ishtar_common/templates/widgets/search_input.html
+++ b/ishtar_common/templates/widgets/search_input.html
@@ -40,6 +40,12 @@
             <i class="fa fa-bookmark" aria-hidden="true"></i>
         </span>
         <div class="dropdown-menu" id="bookmark-list"></div>
+        <a class="input-group-text" data-toggle="collapse"
+           href="#{{field.auto_id}}_help"
+           aria-expanded="false" aria-controls="{{field.auto_id}}_help">
+           <i class="fa fa-question-circle" aria-hidden="true"></i>
+        </a>
+        {% comment %}
         <a class="input-group-text input-link async-link disabled"
            id="generate-qrcode"
            data-target="#modal-dynamic-form"
@@ -48,10 +54,37 @@
            href="{% url 'search-qrcode' %}">
             <i class="fa fa-qrcode" aria-hidden="true"></i>
         </a>
-
+        {% endcomment %}
     </span>
 </div>
 
+<div class="collapse help-text-parent" id="{{field.auto_id}}_help">
+    <div class="card card-body help-text">
+        <h3>{% trans "Free search" %}</h3>
+        <p>{% trans "Each item in the database is indexed to ensure consistent results for free-entry searches." %}</p>
+        <p><em>{% blocktrans %}Example: "071234" in an operation search will return the operation with the corresponding operation code in the Operation search field, and finds linked to the same operation in the Find search field.{% endblocktrans %}</em></p>
+
+        <h3>{% trans "Criteria search" %}</h3>
+        <p>{% blocktrans %}Clicking on the <i class="fa fa-cog" aria-hidden="true"></i> icon takes you to a form that allows you to simply construct your search by criteria. Once this search query has been built up, the query can be adjusted.{% endblocktrans %}</p>
+
+        <h4>{% trans "Open search" %}</h4>
+        <p>{% blocktrans %}In the criterion search, the engine searches exactly for the value entered. If you want an open search such as "contains the value", add an asterisk * to the value.{% endblocktrans %}</p>
+
+        <p><em>{% blocktrans %}Example: "denomination='éclat'" will return only those elements whose denomination is exactly "éclat", while "denomination='éclat*'" will return all elements whose denomination contains the word "éclat", e.g. batches of "éclats", "éclat retouché", etc.{% endblocktrans %}}</em></p>
+
+        <h4>{% trans "Exclude" %}</h4>
+        <p>{% blocktrans %}To exclude items from the search, add the criterion from the form, then prefix the criterion with "-".{% endblocktrans %}</p>
+        <p><em>{% blocktrans %}Example: the search "-material='metal'" will exclude all metal finds from the search.{% endblocktrans %}</em></p>
+
+        <h4>{% trans "Greater than, lower than, before, after" %}</h4>
+        <p>{% blocktrans %}For searches such as larger, smaller (for numeric fields), before, after (for date fields), add the criterion from the form, then change the "=" sign to "=>" or "=<", depending on the desired result.{% endblocktrans %}</p>
+        <p><em>{% blocktrans %}Example: the search 'year=>"2019"' will return all items from 2019 and onwards.{% endblocktrans %}</em></p>
+
+        <p class="text-center"><em><a href="https://ishtar.readthedocs.io/fr/{{widget.ISHTAR_DOCUMENT_VERSION}}/interface-utilisateur.html#recherche-textuelle-et-par-criteres" target="_blank">{% trans "Full documentation for searches." %}</a></em></p>
+
+    </div>
+</div>
+
 <script type="text/javascript">{% localize off %}
 var bookmark_url = "{% url 'bookmark-list' app_name pin_model %}";