Refactor tap examples and use defer="defer" to be xhtml complient

django-daiquiri · Nov 7, 2024 · 0e651db · 0e651db
1 parent 6203824
commit 0e651db
Show file tree

Hide file tree

Showing 11 changed files with 38 additions and 59 deletions.
diff --git a/daiquiri/auth/templates/auth/users.html b/daiquiri/auth/templates/auth/users.html
@@ -3,7 +3,7 @@
 
 {% block js %}
     <script src="{% url 'javascript-catalog' %}"></script>
-    <script src="{% static 'auth/js/users.js' %}" defer></script>
+    <script src="{% static 'auth/js/users.js' %}" defer="defer"></script>
 {% endblock %}
 
 {% block wide %}

diff --git a/daiquiri/contact/templates/contact/messages.html b/daiquiri/contact/templates/contact/messages.html
@@ -3,7 +3,7 @@
 
 {% block js %}
 <script src="{% url 'javascript-catalog' %}"></script>
-<script src="{% static 'contact/js/messages.js' %}" defer></script>
+<script src="{% static 'contact/js/messages.js' %}" defer="defer"></script>
 {% endblock %}
 
 {% block wide %}

diff --git a/daiquiri/core/templates/core/base.html b/daiquiri/core/templates/core/base.html
@@ -12,7 +12,7 @@
 {% endblock %}
 
 {% block js %}
-<script src="{% static 'core/js/bootstrap.js' %}" defer></script>
+<script src="{% static 'core/js/bootstrap.js' %}" defer="defer"></script>
 {% endblock %}
 
 </head>

diff --git a/daiquiri/metadata/templates/metadata/management.html b/daiquiri/metadata/templates/metadata/management.html
@@ -10,7 +10,7 @@
 
 {% block js %}
 <script src="{% url 'javascript-catalog' %}"></script>
-<script src="{% static 'metadata/js/management.js' %}" defer></script>
+<script src="{% static 'metadata/js/management.js' %}" defer="defer"></script>
 {% endblock %}
 
 {% block wide %}

diff --git a/daiquiri/query/models.py b/daiquiri/query/models.py
@@ -44,7 +44,7 @@
     run_database_ingest_task,
     run_database_query_task,
 )
-from .utils import get_format_config, get_job_columns
+from .utils import get_format_config, get_job_columns, get_query_language_label
 
 logger = logging.getLogger(__name__)
 query_logger = logging.getLogger('query')
@@ -84,11 +84,7 @@ def phase_label(self):
 
     @property
     def query_language_label(self):
-        return next(iter(
-            query_language['label']
-            for query_language in settings.QUERY_LANGUAGES
-            if '{key}-{version}'.format(**query_language) == self.query_language
-        ), None)
+        return get_query_language_label(self.query_language)
 
     @property
     def creation_time_label(self):
@@ -658,3 +654,7 @@ class Meta:
 
     def __str__(self):
         return self.name
+
+    @property
+    def query_language_label(self):
+        return get_query_language_label(self.query_language)
diff --git a/daiquiri/query/templates/query/query.html b/daiquiri/query/templates/query/query.html
@@ -10,7 +10,7 @@
 
 {% block js %}
 <script src="{% url 'javascript-catalog' %}"></script>
-<script src="{% static 'query/js/query.js' %}" defer></script>
+<script src="{% static 'query/js/query.js' %}" defer="defer"></script>
 {% endblock %}
 
 {% block wide %}

diff --git a/daiquiri/query/utils.py b/daiquiri/query/utils.py
@@ -368,6 +368,14 @@ def get_query_language_choices():
     ]
 
 
+def get_query_language_label(query_language):
+    return next(iter(
+        ql['label']
+        for ql in settings.QUERY_LANGUAGES
+        if '{key}-{version}'.format(**ql) == query_language
+    ), None)
+
+
 def get_queue_choices():
     return [
         (queue['key'], queue['label']) for queue in settings.QUERY_QUEUES

diff --git a/daiquiri/serve/templates/serve/table.html b/daiquiri/serve/templates/serve/table.html
@@ -3,7 +3,7 @@
 
 {% block js %}
 <script src="{% url 'javascript-catalog' %}"></script>
-<script src="{% static 'serve/js/table.js' %}" defer></script>
+<script src="{% static 'serve/js/table.js' %}" defer="defer"></script>
 {% endblock %}
 
 {% block wide %}

diff --git a/daiquiri/tap/templates/tap/examples.html b/daiquiri/tap/templates/tap/examples.html
@@ -10,12 +10,23 @@
 
     <h1>{% trans 'Examples' %}</h1>
 
-    {% for example in examples %}
-    <div id="example-{{ example.id }}" resource="#example-{{ example.id }}" typeof="example" class="daiquiri-tap-example">
-        <h2 property="name">{{ example.name }}</h2>
-        <p property="description">{{ example.description }}</p>
-        <pre property="query">{{ example.query_string }}</pre>
+    <div vocab="http://www.ivoa.net/rdf/examples#">
+        {% for example in examples %}
+        <div id="example-{{ example.id }}" resource="#example-{{ example.id }}" typeof="example" class="card mb-3">
+            <div class="card-header d-flex align-items-center">
+                <span property="name">{{ example.name }}</span>
+                {% if example.query_language_label %}
+                <span class="badge text-bg-secondary ms-auto">{{ example.query_language_label }}</span>
+                {% endif %}
+            </div>
+            <div class="card-body">
+                {% if example.description %}
+                <p property="description" class="card-text">{{ example.description }}</p>
+                {% endif %}
+                <pre class="mb-0"><code property="query">{{ example.query_string }}</code></pre>
+            </div>
+        </div>
+        {% endfor %}
     </div>
-    {% endfor %}
 
 {% endblock %}
diff --git a/daiquiri/tap/templates/tap/examples.xhtml b/daiquiri/tap/templates/tap/examples.xhtml
diff --git a/daiquiri/tap/views.py b/daiquiri/tap/views.py
@@ -25,10 +25,6 @@ def tables(request):
 
 
 def examples(request):
-    template = 'tap/examples.html'
-    user_agent = request.headers.get("User-Agent", "").lower()
-    if "topcat" in user_agent or "curl" in user_agent:
-        template = 'tap/examples.xhtml'
-    return render(request, template, {
+    return render(request, 'tap/examples.html', {
         'examples': Example.objects.filter_by_access_level(request.user)
     })