Merge pull request #252 from RSE-Sheffield/feat/video-instructions

Add documentation/help page with recorded video.

Author: Joe-Heffer-Shef

home/templates/help.html

@@ -0,0 +1,14 @@
+{% extends "base_manager.html" %}
+{% block content %}
+    <div class="container mx-auto px-4 py-8">
+        <h1>How to use the SORT online tool</h1>
+        <p>See the video below for instructions on how to use the SORT online tool.</p>
+
+        <iframe id="kaltura_player" style="width: 80%; aspect-ratio: 16 / 9; margin: auto"
+                src='https://cdnapisec.kaltura.com/p/2103181/embedPlaykitJs/uiconf_id/53345422?iframeembed=true&amp;entry_id=1_e1eky7pw&amp;config%5Bprovider%5D=%7B%22widgetId%22%3A%221_t5fs1o53%22%7D&amp;config%5Bplayback%5D=%7B%22startTime%22%3A0%7D'
+                style="width: 400px;height: 285px;border: 0;" allowfullscreen webkitallowfullscreen mozAllowFullScreen
+                allow="autoplay *; fullscreen *; encrypted-media *"
+                sandbox="allow-downloads allow-forms allow-same-origin allow-scripts allow-top-navigation allow-pointer-lock allow-popups allow-modals allow-orientation-lock allow-popups-to-escape-sandbox allow-presentation allow-top-navigation-by-user-activation"
+                title="SORT Application Introduction"></iframe>
+    </div>
+{% endblock %}

home/urls.py

@@ -54,4 +54,9 @@
         views.ProjectDeleteView.as_view(),
         name="project_delete",
     ),
+    path(
+        "help/",
+        views.HelpView.as_view(),
+        name="help",
+    )
 ]

home/views.py

@@ -14,7 +14,7 @@
 from django.shortcuts import get_object_or_404, redirect, render
 from django.urls import reverse, reverse_lazy
 from django.views import View
-from django.views.generic import ListView
+from django.views.generic import ListView, TemplateView
 from django.views.generic.edit import CreateView, DeleteView, UpdateView
 
 from survey.models import Survey
@@ -360,3 +360,6 @@ def form_valid(self, form):
 
     def get_success_url(self):
         return reverse_lazy("myorganisation")
+
+class HelpView(LoginRequiredMixin, TemplateView):
+    template_name = "help.html"

static/templates/base_manager.html

@@ -35,6 +35,9 @@
                                 {% if '/invite' in request.path %}active{% endif %}"
                                 href="{% url 'myorganisation' %}"><i class="bx bxs-buildings"></i> My Organisation</a>
                         </li>
+                        <li class="nav-item">
+                            <a class="nav-link {% if '/help;' in request.path %}active{% endif %}" href="{% url 'help' %}"><i class='bx bxs-help-circle' ></i> Help</a>
+                        </li>
                     </ul>
                     <ul class="navbar-nav">
                         {% if user.is_authenticated %}