Improved templates to make easier to customize them for integration w…

[nad2000]

Fix for #477:

• added block.super to reuse base block;
• following admin convention added block "extrastyle" to facilitate customization;

[nad2000]

@marksweb it's done so that customization can be done in one place - the explorer/base.html. Otherwise, you would have to override all 4 templates: query_list.html, query.html, play.html and qyertlog_list.html.

Well here is my explorer/base.html that works with the proposed changes:

{% extends "explorer/base.html" %}

{% block extrastyle %}
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.13.0/css/all.min.css">
{% endblock %}

{% block sql_explorer_navlinks %}
  <li class="nav-item" id="admin:index">
    <a id="admin-link"
       class="nav-link"
       href="{% url 'admin:index' %}"
       data-toggle="tooltip"
       title="Research Funding Data Administration"
       >
       <i class="fas fa-radiation"></i> RFDA Admin</a>
  </li>
{% endblock %}


{% block sql_explorer_scripts %}
  <script>
    $(document).ready(function() {
      $('[data-toggle="tooltip"]').tooltip()
    });
  </script>
{% endblock %}

and this is how it gets rendered:

Without them, I would have to override almost the entire base.html.

[nad2000]

Actually, it was possible to refactor and dry a bit the templates and move the sql_explorer_navlinks block to the base.html.

Assuming that "django.template.context_processors.request" isn't used I populate the context in the mixin with the current view name.

[marksweb]

@nad2000 Ok now I get what you're doing so that makes sense 👍

I'll have a proper look at this over the weekend hopefully 🤞

[ernstki]

I'm overriding explorer/base.html in our application, just as @nad2000 prescribed above, but getting double the nav <li>s in the site's rendered output.

A possible workaround is to just copy-paste all the existing nav bar links, and add my two to the end, but it seems like Django's {{ block.super }} is supposed to take care of that.

I frankly didn't follow the context processor part of the conversation (beyond a vague understanding of what a context processor is), but could that have something to do with this? Or have I just done something boneheaded?

There is only this single file in ourapp/templates/explorer:

{# ourapp/templates/explorer/base.html #}
{% block sql_explorer_navlinks %}
{{ block.super }}
<li><a href="{{ DEFAULT_URL }}/explorer/schema/readonly">Schema</a></li>
<li><a href="#">|</a></li>                                              
<li><a href="{{ DEFAULT_URL }}/admin/">Back to {{ SITE_TITLE }}</a></li>
{% endblock %}

I'm currently using django-sql-explorer==3.2.1, the latest release as of this writing, and Django 3.2.latest. I get that this could actually be a Django bug, perhaps already fixed in some later version, and I am looking into that now.

Update: had nothing at all to do with this PR—my bad!

We did this, and the fix was this:

diff --git a/ourapp/settings.py b/ourapp/settings.py
index 15e8803..df73912 100644
--- a/ourapp/settings.py
+++ b/ourapp/settings.py
@@ -65,7 +65,9 @@ ROOT_URLCONF = "ourapp.urls"
 TEMPLATES = [
     {
         "BACKEND": "django.template.backends.django.DjangoTemplates",
-        "DIRS": [os.path.join(BASE_DIR, "ourapp/templates")],
+        # no need to specify additional 'DIRS': [] here; see
+        # https://docs.djangoproject.com/en/3.2/topics/templates/#configuration
+        # and https://stackoverflow.com/a/75021565/785213
         "APP_DIRS": True,
         "OPTIONS": {
             "context_processors": [