From 57d82aabe1c12672e1c2ce37922e9b9112f53d6f Mon Sep 17 00:00:00 2001
From: csae8092 <peter.andorfer@oeaw.ac.at>
Date: Sun, 21 Apr 2024 07:58:41 +0200
Subject: [PATCH] adding info modal to fulltext search #43

---
 .../templates/archiv/partials/info_modal.html | 23 +++++++++++++++++++
 .../archiv/partials/search_form.html          |  9 ++++----
 webpage/templates/webpage/index.html          |  1 +
 3 files changed, 29 insertions(+), 4 deletions(-)
 create mode 100644 archiv/templates/archiv/partials/info_modal.html

diff --git a/archiv/templates/archiv/partials/info_modal.html b/archiv/templates/archiv/partials/info_modal.html
new file mode 100644
index 0000000..78d1c7d
--- /dev/null
+++ b/archiv/templates/archiv/partials/info_modal.html
@@ -0,0 +1,23 @@
+<div class="modal" id="searchInfoModal" tabindex="-1" aria-labelledby="searchInfoModalLabel" aria-hidden="true">
+    <div class="modal-dialog">
+      <div class="modal-content">
+        <div class="modal-header">
+          <h5 class="modal-title">Search information</h5>
+          <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
+        </div>
+        <div class="modal-body">
+          <p>With this search, the fields "Short Description", "Facts", "Decision", "Commentary", "Additional Information" and "Parties" of a decision can be searched together. In order to keep the search efficient, the corresponding fields have been indexed. For this index, the individual texts are normalised back to their original forms. This also applies to the search term entered. Such a search index also allows more complex search queries such as:
+            <ul>
+                <li><strong>Phrase search</strong>: Terms in inverted commas are searched for together: "medical records".</li>
+                <li><strong>medical records</strong> finds all documents in which either <em>medical</em> or <em>recods</em> appears</li>
+                <li>A <strong>*</strong> at the end of a search term serves as a wildcard. <em>share*</em> also finds entries with <em>shareholder</em>, for example.</li>
+            </ul>
+          </p>
+          <p>For information: Displaying many hits as so called <em>Keywords in context (KWIC)</em> like e.g. <span class="text-nowrap bg-warning border-warning rounded border-5">example</span> can take some time. It is therefore advisable to narrow down the search results using additional filter options. </p>
+        </div>
+        <div class="modal-footer">
+          <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
+        </div>
+      </div>
+    </div>
+  </div>
\ No newline at end of file
diff --git a/archiv/templates/archiv/partials/search_form.html b/archiv/templates/archiv/partials/search_form.html
index f374160..4da032a 100644
--- a/archiv/templates/archiv/partials/search_form.html
+++ b/archiv/templates/archiv/partials/search_form.html
@@ -1,11 +1,12 @@
 <div class="container">
   <form method="get" action="{% url 'archiv:courtdecission_browse' %}">
     <div class="input-group mt-5">
-      <input type="text" class="form-control" placeholder="start typing your search term, e.g. 'Liability'" aria-label="start typing your search term, e.g. 'Liability'" aria-describedby="basic-addon2" {% if query_string %} value="{{ query_string }}" {% endif %} required name="ft_search">
+      <span class="input-group-text" title="Click for information about the search" data-bs-toggle="modal" data-bs-target="#searchInfoModal"><i class="bi bi-info-circle" role="button"></i></span>
+
+      <input type="text" class="form-control" placeholder="start typing your search term, e.g. 'Liability'"
+        aria-label="start typing your search term, e.g. 'Liability'" aria-describedby="basic-addon2" {% if query_string %} value="{{ query_string }}" {% endif %} required name="ft_search">
       <button class="btn btn-block btn-lg btn-primary" type="submit" id="basic-addon2">Search</span>
     </div>
+    
   </form>
 </div>
-
-
-
diff --git a/webpage/templates/webpage/index.html b/webpage/templates/webpage/index.html
index f8296d3..27136d2 100644
--- a/webpage/templates/webpage/index.html
+++ b/webpage/templates/webpage/index.html
@@ -8,5 +8,6 @@
     <h1 class="text-center">{% projects_metadata 'title' %}</h1>
     <h2 class="text-center">{% lorem 10 w %}</h2>
     {% include "archiv/partials/search_form.html" %}
+    {% include 'archiv/partials/info_modal.html' %}
 
 {% endblock %}
\ No newline at end of file