From fddbbf96bf447bfb630e4a0fd67f6ba7c8c0e141 Mon Sep 17 00:00:00 2001
From: Wojtek Kosior <koszko@koszko.org>
Date: Thu, 27 Oct 2022 19:48:54 +0200
Subject: [proxy] document popup

---
 .../info_pages_templates/info_base.html.jinja      |   1 +
 src/hydrilla/proxy/self_doc/popup.html.jinja       | 130 +++++++++++++++++++++
 .../proxy/web_ui/templates/index.html.jinja        |   4 +-
 3 files changed, 134 insertions(+), 1 deletion(-)
 create mode 100644 src/hydrilla/proxy/self_doc/popup.html.jinja

(limited to 'src/hydrilla/proxy')

diff --git a/src/hydrilla/proxy/policies/info_pages_templates/info_base.html.jinja b/src/hydrilla/proxy/policies/info_pages_templates/info_base.html.jinja
index ccdc7c8..9268c92 100644
--- a/src/hydrilla/proxy/policies/info_pages_templates/info_base.html.jinja
+++ b/src/hydrilla/proxy/policies/info_pages_templates/info_base.html.jinja
@@ -42,6 +42,7 @@ code in a proprietary work, I am not going to enforce this in court.
 {% block main %}
   <h3>
     {{ _('info.base.heading.page_info') }}
+    {{ hkt_doc_link('popup') }}
   </h3>
 
   {{ label(_('info.base.page_url_label')) }}
diff --git a/src/hydrilla/proxy/self_doc/popup.html.jinja b/src/hydrilla/proxy/self_doc/popup.html.jinja
new file mode 100644
index 0000000..f1a31e9
--- /dev/null
+++ b/src/hydrilla/proxy/self_doc/popup.html.jinja
@@ -0,0 +1,130 @@
+{#
+SPDX-License-Identifier: GPL-3.0-or-later OR CC-BY-SA-4.0
+
+Documentation page describing Haketilo popup.
+
+This file is part of Hydrilla&Haketilo.
+
+Copyright (C) 2022 Wojtek Kosior
+
+Dual licensed under
+* GNU General Public License v3.0 or later and
+* Creative Commons Attribution Share Alike 4.0 International.
+
+You can choose to use either of these licenses or both.
+
+
+I, Wojtek Kosior, thereby promise not to sue for violation of this
+file's licenses. Although I request that you do not make use of this
+code in a proprietary work, I am not going to enforce this in court.
+#}
+{% extends "doc_base.html.jinja" %}
+
+{% block title %}{{ _('doc.popup.title') }}{% endblock %}
+
+{% block main %}
+  {{ big_heading(_('doc.popup.h_big')) }}
+
+  {% call section() %}
+    {% call paragraph() %}
+      {{ _('doc.popup.intro') }}
+    {% endcall %}
+  {% endcall %}
+
+  {% call section() %}
+    {{ medium_heading(_('doc.popup.h_medium.operating')) }}
+
+    {% call paragraph() %}
+      {% set fmt = _('doc.popup.operating.html.opening_{blocking_link}_{packages_link}') %}
+      {% set blocking_link_text = _('doc.popup.operating.opening.blocking_link_text') %}
+      {% set blocking_link = doc_page_link(blocking_link_text|e, 'script_blocking') %}
+      {% set packages_link_text = _('doc.popup.operating.opening.packages_link_text') %}
+      {% set packages_link = doc_page_link(packages_link_text|e, 'packages') %}
+      {{
+        fmt.format(
+            blocking_link = blocking_link,
+            packages_link = packages_link
+        )|safe
+      }}
+    {% endcall %}
+
+    {% call paragraph() %}
+      {{ _('doc.popup.operating.html.closing')|safe }}
+    {% endcall %}
+  {% endcall %}
+
+  {% call section() %}
+    {{ medium_heading(_('doc.popup.h_medium.enabling')) }}
+
+    {% call paragraph() %}
+      {{ _('doc.popup.enabling.html.intro')|safe }}
+    {% endcall %}
+
+    {% call unordered_list() %}
+      {% call list_entry() %}
+        {{ _('doc.popup.enabling.js_allowed_case') }}
+      {% endcall %}
+      {% call list_entry() %}
+        {{ _('doc.popup.enabling.js_blocked_case') }}
+      {% endcall %}
+      {% call list_entry() %}
+        {{ _('doc.popup.enabling.payload_case') }}
+      {% endcall %}
+    {% endcall %}
+
+    {% call paragraph() %}
+      {% set fmt = _('doc.popup.enabling.html.rest_{settings_link}') %}
+      {% set link_text = _('doc.popup.enabling.html.rest.settings_link_text') %}
+      {% set link = hkt_link(link_text|e, 'home.home') %}
+      {{ fmt.format(settings_link=link)|safe }}
+    {% endcall %}
+  {% endcall %}
+
+  {% call section() %}
+    {{ medium_heading(_('doc.popup.h_medium.fingerprinting')) }}
+
+    {% call paragraph() %}
+      {{ _('doc.popup.fingerprinting_intro') }}
+    {% endcall %}
+
+    {% call paragraph() %}
+      {{ _('doc.popup.fingerprinting_more') }}
+    {% endcall %}
+
+    {% call paragraph() %}
+      {{ _('doc.popup.fingerprinting_more_more') }}
+    {% endcall %}
+  {% endcall %}
+
+  {% call section() %}
+    {{ medium_heading(_('doc.popup.h_medium.other_caveats')) }}
+
+    {% call paragraph() %}
+      {{ _('doc.popup.other_caveats.intro') }}
+    {% endcall %}
+  {% endcall %}
+
+  {% call section() %}
+    {{ small_heading(_('doc.popup.h_small.site_interference')) }}
+
+    {% call paragraph() %}
+      {{ _('doc.popup.site_interference.text') }}
+    {% endcall %}
+  {% endcall %}
+
+  {% call section() %}
+    {{ small_heading(_('doc.popup.h_small.content_blockers_interference')) }}
+
+    {% call paragraph() %}
+      {{ _('doc.popup.content_blockers_interference.text') }}
+    {% endcall %}
+  {% endcall %}
+
+  {% call section() %}
+    {{ small_heading(_('doc.popup.h_small.url_mismatch')) }}
+
+    {% call paragraph() %}
+      {{ _('doc.popup.url_mismatch.text')|safe }}
+    {% endcall %}
+  {% endcall %}
+{% endblock main %}
diff --git a/src/hydrilla/proxy/web_ui/templates/index.html.jinja b/src/hydrilla/proxy/web_ui/templates/index.html.jinja
index ff74369..36d9941 100644
--- a/src/hydrilla/proxy/web_ui/templates/index.html.jinja
+++ b/src/hydrilla/proxy/web_ui/templates/index.html.jinja
@@ -193,7 +193,9 @@ code in a proprietary work, I am not going to enforce this in court.
 
   <div class="horizontal-separator"></div>
 
-  {{ label(_('web_ui.home.popup_settings_label')) }}
+  {% call label(_('web_ui.home.popup_settings_label')) %}
+    {{ hkt_doc_link('popup') }}
+  {% endcall %}
 
   {%
     macro render_popup_settings(
-- 
cgit v1.2.3