HTML: Add description to meta

Author: 3j14

gcampus/auth/views/course.py

@@ -62,6 +62,10 @@
 logger = logging.getLogger("gcampus.auth.views.course")
 
 _TITLE = _("Course administration")
+_DESCRIPTION = _(
+    "Administer your GewässerCampus course. Edit your details, "
+    "manage and create access keys, and download your course documents."
+)
 _COURSE_TABS = TabNavigation(
     course=Tab(_("Course data"), url=reverse_lazy("gcampusauth:course-update")),
     access_keys=Tab(
@@ -77,6 +81,7 @@ class CourseUpdateView(TitleMixin, TabsMixin, UpdateView):
     template_name_suffix = "_edit_form"
     success_url = reverse_lazy("gcampusauth:course-update")
     title = _TITLE
+    description = _DESCRIPTION
     tabs = _COURSE_TABS
     current_tab_name = "course"
 
@@ -117,6 +122,7 @@ class AccessKeyCreateView(
     model = AccessKey
     success_url = reverse_lazy("gcampusauth:course-access-keys")
     title = _TITLE
+    description = _DESCRIPTION
     tabs = _COURSE_TABS
     current_tab_name = "access_keys"
 

gcampus/auth/views/register.py

@@ -36,6 +36,16 @@ class RegisterFormView(TitleMixin, CreateView):
     model = Course
     template_name_suffix = "_create_form"
     title = gettext_lazy("Register a new course")
+    description = gettext_lazy(
+        "Register your class or course and generate a list"
+        "of access keys for your students. "
+        "These keys can be used to create and later edit "
+        "measurements on GewässerCampus. "
+        "Alongside the generated access keys, you will also "
+        "receive a course token that should be kept "
+        "private. With this key you can view and edit all "
+        "your student's measurements."
+    )
     success_url = reverse_lazy("gcampuscore:mapview")
     object: Course
 

gcampus/auth/views/token.py

@@ -53,6 +53,14 @@ class LoginFormView(FormView, TitleMixin, ABC):
     template_name = "gcampusauth/login_form.html"
     success_url = reverse_lazy("gcampuscore:mapview")
     title = gettext_lazy("Login")
+    description = gettext_lazy(
+        "Login as a student using you access key"
+        "to create new measurements and edit your "
+        "existing ones. "
+        "Teachers can login using a course token "
+        "to administer the course, edit measurements and "
+        "create new access keys."
+    )
     # Has to be set by child classes
     token_type: Optional[TokenType]
 

gcampus/core/templates/gcampuscore/base.html

@@ -10,7 +10,13 @@
     <meta charset="utf-8"/>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
     <title>{% block title %}{% if page_title %}{{ page_title }} - GewässerCampus{% else %}GewässerCampus{% endif %}{% endblock %}</title>
-    <meta name="description" content="{% block description %}{% endblock %}"/>
+    {% blocktrans asvar default_description trimmed %}
+        The web application GewässerCampus enables students, teachers,
+        and Citizen Scientists to publish their measurements and
+        analyze the data from all measurements to understand and explore
+        the quality of waters.
+    {% endblocktrans %}
+    <meta name="description" content="{% block description %}{% firstof page_description default_description %}{% endblock %}"/>
     <meta name="viewport" content="width=device-width, initial-scale=1"/>
     <meta name="theme-color" content="#2760A4">
     {% settings "ENVIRONMENT" as deploy_env %}

gcampus/core/views/base.py

@@ -21,14 +21,19 @@
 
 
 class TitleMixin(ContextMixin):
-    title: Optional[str] = None
+    title: str | None = None
+    description: str | None = None
 
     def get_title(self) -> str:
         return self.title
 
+    def get_description(self) -> str:
+        return self.description
+
     def get_context_data(self, **kwargs):
-        """Insert the page title into the context dict."""
+        """Insert the page title and description into the context."""
         kwargs.setdefault("page_title", self.get_title())
+        kwargs.setdefault("page_description", self.get_description())
         return super().get_context_data(**kwargs)
 
 

gcampus/core/views/details/measurement.py

@@ -12,6 +12,7 @@
 #
 #  You should have received a copy of the GNU Affero General Public License
 #  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 import datetime
 import logging
 from inspect import cleandoc
@@ -20,7 +21,7 @@
 from django.core.mail import mail_managers
 from django.urls import reverse
 from django.utils.decorators import method_decorator
-from django.utils.translation import gettext
+from django.utils.translation import gettext, gettext_lazy
 from django.views.generic import DetailView
 from django.views.generic.edit import FormMixin
 
@@ -41,6 +42,11 @@ class MeasurementDetailView(FormMixin, TitleMixin, DetailView):
         "parameters"
     )
     template_name = "gcampuscore/sites/detail/measurement_detail.html"
+    description = gettext_lazy(
+        "Learn more about the measurement, explore nearby and similar "
+        "measurements, and download a PDF summary of this measurement "
+        "to discuss the results with others."
+    )
     form_class = ReportForm
     object: Measurement
 

gcampus/core/views/details/water.py

@@ -15,6 +15,7 @@
 
 __all__ = ["WaterDetailView"]
 
+from django.utils.translation import gettext
 from django.views.generic import DetailView
 
 from gcampus.core.models import Water
@@ -31,8 +32,15 @@ class WaterDetailView(TitleMixin, DetailView):
     )
     template_name = "gcampuscore/sites/detail/water_detail.html"
 
+    def get_description(self) -> str:
+        if not self.object:
+            raise RuntimeError("'self.object' is not set")
+        return gettext(
+            "Learn more about the water '{water}' and explore all measurements "
+            "that have been recorded at this water on GewässerCampus."
+        ).format(water=self.object.display_name)
+
     def get_title(self) -> str:
-        if self.object:
-            return str(self.object)
-        else:
+        if not self.object:
             raise RuntimeError("'self.object' is not set")
+        return str(self.object)

gcampus/core/views/lists/measurement.py

@@ -43,6 +43,9 @@ class MeasurementListView(TitleMixin, ListView):
         .all()
     )
     title = gettext_lazy("All measurements")
+    description = gettext_lazy(
+        "List of all the measurements recorded on GewässerCampus."
+    )
     context_object_name = "measurement_list"
     filter: MeasurementFilterSet
     paginate_by = 10

gcampus/core/views/lists/water.py

@@ -37,6 +37,11 @@ class WaterListView(TitleMixin, ListView):
         .order_by("-measurement_count", "name")
     )
     title = gettext_lazy("All waters")
+    description = gettext_lazy(
+        "List of all the waters recorded on GewässerCampus. You can "
+        "browse the waters and view all measurements for a specific "
+        "water."
+    )
     context_object_name = "water_list"
     paginate_by = 10
     filter: WaterFilterSet

gcampus/tools/views.py

@@ -34,17 +34,33 @@
 class ToolsOverView(TitleMixin, TemplateView):
     title = gettext_lazy("Tools")
     template_name = "gcampustools/tools.html"
+    description = gettext_lazy(
+        "GewässerCampus provides tools that help you to easily "
+        "perform and analyze measurements. Calculate chemical "
+        "parameters from optical densities or view documents and "
+        "support material for a successful measurement."
+    )
+
+
+_DESCRIPTION = gettext_lazy(
+    "This tool helps you to convert the optical density you measured "
+    "with the photometer into the value of the specific parameter. "
+    "It uses a standard calibration which has been prepared by the "
+    "GewässerCampus team."
+)
 
 
 class MeasurementKitOverView(TitleMixin, ListView):
     title = gettext_lazy("Measurement Kits")
+    description = _DESCRIPTION
     template_name = "gcampustools/measurement_kit_overview.html"
     model = MeasurementKit
     queryset = MeasurementKit.objects.filter(calibrations__isnull=False).distinct()
 
 
 class ODConverterOverView(TitleMixin, ListView):
     title = gettext_lazy("Optical Density Converter")
+    description = _DESCRIPTION
     template_name = "gcampustools/od_converter_overview.html"
     model = ParameterType
     kit: MeasurementKit
@@ -69,6 +85,7 @@ def get_context_data(self, **kwargs):
 
 class ODConverterDetailView(TitleMixin, DetailView):
     title = gettext_lazy("Optical Density Converter")
+    description = _DESCRIPTION
     template_name = "gcampustools/od_converter_detail.html"
     model = ParameterType
     context_object_name = "parameter"