adds help links

liiweb/templates/liiweb/legislation_list.html

@@ -38,6 +38,7 @@ <h1 class="my-4">{% trans 'Legislation' %}</h1>
           </li>
         </nav>
       {% endblock %}
+      {% include "peachjam/_help_popover.html" with link="https://example.com" btn_text=help_button_text content=legislation_help_text %}
       {% if view.variant == 'repealed' %}
         <div class="alert alert-danger">{% trans 'You are viewing repealed legislation which is no longer in force.' %}</div>
       {% endif %}

liiweb/views/legislation.py

@@ -1,6 +1,7 @@
 from collections import defaultdict
 
 from django.shortcuts import get_object_or_404
+from django.utils.translation import gettext_lazy as _
 from django.views.generic import TemplateView
 
 from peachjam.helpers import chunks, get_language
@@ -46,6 +47,13 @@ def get_context_data(self, **kwargs):
 
         context["legislation_table"] = LegislationSerializer(qs, many=True).data
 
+        context["help_button_text"] = _("Help")
+        context["legislation_help_text"] = _(
+            "This is is a list of legislation for this jurisdiction. Click on the "
+            "tabs to filter according to current, repealed and subsidiary "
+            "legislation."
+        )
+
         return context
 
     def add_children(self, queryset):

peachjam/js/components/FindDocuments/AdvancedSearch.vue

@@ -71,11 +71,24 @@
         </div>
       </div>
     </div>
-
-    <div class="text-end">
-      <button type="submit" class="btn btn-primary">
-        {{ $t('Search') }}
-      </button>
+    <div class="d-flex justify-content-between">
+      <div>
+        <a
+          href="#https://example.com"
+          class="btn btn-sm btn-outline-info"
+          data-bs-toggle="help-popover"
+          :data-bs-content="$t('This is Advanced Search. Enter keywords in the fields above for a more fine grained search of documents.')"
+          data-bs-trigger="click"
+        >
+          <i class="bi bi-question-circle" />
+          Help
+        </a>
+      </div>
+      <div>
+        <button type="submit" class="btn btn-primary">
+          {{ $t('Search') }}
+        </button>
+      </div>
     </div>
   </form>
 </template>

peachjam/js/components/FindDocuments/index.vue

@@ -76,6 +76,18 @@
               Filters <span v-if="selectedFacetsCount">({{ selectedFacetsCount }})</span>
             </button>
           </form>
+          <div class="my-2">
+            <a
+              href="#https://example.com"
+              class="btn btn-sm btn-outline-info"
+              data-bs-toggle="help-popover"
+              :data-bs-content="$t( 'You can search for documents by entering a keyword or phrase in the search box. You can also use the Advanced search to search for documents by more specific criteria.' )"
+              data-bs-trigger="click"
+            >
+              <i class="bi bi-question-circle" />
+              {{ $t("Help") }}
+            </a>
+          </div>
         </div>
         <div
           id="nav-advanced-search"
@@ -105,7 +117,6 @@
         {{ $t("No documents match your search.") }}
       </div>
     </div>
-
     <div ref="filters-results-container">
       <div class="row">
         <div class="col col-lg-3">

peachjam/js/locale/fr/translation.json

@@ -65,5 +65,8 @@
   "Try searching instead": "Essayez plutôt de faire une recherche",
   "What changed?": "Quels sont les changements ?",
   "Year": "Année",
-  "Years": "Années"
+  "Years": "Années",
+  "Help": "Aide",
+  "You can search for documents by entering a keyword or phrase in the search box. You can also use the Advanced search to search for documents by more specific criteria.": "Vous pouvez rechercher des documents en entrant un mot-clé ou une phrase dans la zone de recherche. Vous pouvez également utiliser la recherche avancée pour rechercher des documents selon des critères plus spécifiques.",
+  "This is Advanced Search. Enter keywords in the fields above for a more fine grained search of documents.": "Ceci est une recherche avancée. Entrez des mots-clés dans les champs ci-dessus pour une recherche plus fine des documents.",
 }

peachjam/js/locale/sw/translation.json

@@ -65,5 +65,8 @@
   "Try searching instead": "Jaribu kutafuta badala yake",
   "What changed?": "Nini kimebadilika?",
   "Year": "Mwaka",
-  "Years": "Miaka"
+  "Years": "Miaka",
+  "Help": "Msaada",
+  "You can search for documents by entering a keyword or phrase in the search box. You can also use the Advanced search to search for documents by more specific criteria.": "Unaweza kutafuta nyaraka kwa kuingiza neno au kifungu cha maneno katika sanduku la utafutaji.Unaweza pia kutumia utafutaji wa kina kutafuta nyaraka kwa vigezo zaidi maalum.",
+  "This is Advanced Search. Enter keywords in the fields above for a more fine grained search of documents.": "Hii ni utafutaji wa kina. Weka maneno katika uga ulio juu kwa utafutaji wa nyaraka kwa undani zaidi."
 }

peachjam/js/peachjam.ts

@@ -143,9 +143,10 @@ class PeachJam {
       // @ts-ignore
       new window.bootstrap.Popover(el, {
         html: true,
-        content:
-          (el.getAttribute('data-bs-content')
-          + "<div><a href='" + el.getAttribute('href') + "' target='_blank' rel='noopener noreferrer'>Learn more</a></div>"),
+        content: `
+        ${el.getAttribute('data-bs-content')}
+         <div><a href="${el.getAttribute('href')?.split('#')[1] || '#'}" target='_blank' rel='noopener noreferrer'>Learn more</a></div>
+        `,
         container: 'body'
       });
     });

peachjam/templates/peachjam/_citations.html

@@ -1,6 +1,7 @@
 {% load peachjam i18n %}
 <div class="container">
   <div class="row">
+    {% include 'peachjam/_help_popover.html' with link='#' btn_text=help_button_text content=citations_help_text %}
     <div class="col-sm">
       <h4 class="mb-3">
         {% translate 'Cited documents' %} <span class="badge bg-secondary">{{ cited_documents_count }}</span>

peachjam/templates/peachjam/_help_popover.html

@@ -0,0 +1,7 @@
+<div class="mb-3">
+  <a href="#{{ link }}"
+     class="btn btn-sm btn-outline-info"
+     data-bs-toggle="help-popover"
+     data-bs-content="{{ content }}"
+     data-bs-trigger="click"><i class="bi bi-question-circle"></i> {{ btn_text }}</a>
+</div>

peachjam/templates/peachjam/_related_documents.html

@@ -1,12 +1,6 @@
 {% load peachjam i18n %}
 <h4>{% trans "Related documents" %}</h4>
-<div class="mb-3">
-  <a href="#help"
-     class="btn btn-sm btn-outline-info"
-     data-bs-toggle="help-popover"
-     data-bs-content="Other documents related to this one."
-     data-bs-trigger="click"><i class="bi bi-question-circle"></i> Help</a>
-</div>
+{% include 'peachjam/_help_popover.html' with link='https://google.com' btn_text=help_button_text content=related_documents_help_text %}
 <div class="row">
   {% if relationships_as_subject %}
     <div class="col-md">

peachjam/views/generic_views.py

@@ -1,6 +1,7 @@
 import itertools
 
 from django.shortcuts import get_object_or_404
+from django.utils.translation import gettext_lazy as _
 from django.views.generic import DetailView, ListView
 from lxml import html
 
@@ -183,6 +184,14 @@ def get_context_data(self, **kwargs):
             + context["documents_citing_current_doc_count"]
         )
         context["labels"] = doc.labels.all()
+        context["help_button_text"] = _("Help")
+        context["citations_help_text"] = _(
+            "This is a list citations. On the left is a list of documents that this "
+            "document cites. On the right are documents that cite this one."
+        )
+        context["related_documents_help_text"] = _(
+            "This is a list of documents that are related to this one."
+        )
 
         return context