[proxy] document policy selection

1 files changed, 87 insertions, 0 deletions

diff --git a/src/hydrilla/proxy/self_doc/policy_selection.html.jinja b/src/hydrilla/proxy/self_doc/policy_selection.html.jinja
new file mode 100644
index 0000000..6519e42
--- /dev/null
+++ b/src/hydrilla/proxy/self_doc/policy_selection.html.jinja
@@ -0,0 +1,87 @@
+{#
+SPDX-License-Identifier: GPL-3.0-or-later OR CC-BY-SA-4.0
+
+Documentation page describing how Haketilo selects policy to apply to a page.
+
+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.policy_selection.title') }}{% endblock %}
+
+{% block main %}
+  {{ big_heading(_('doc.policy_selection.h_big')) }}
+
+  {% call section() %}
+    {% call paragraph() %}
+      {{ _('doc.policy_selection.intro') }}
+      {% call unordered_list() %}
+        {% call list_entry() %}
+          {{ _('doc.policy_selection.enabled_payload_case') }}
+        {% endcall %}
+        {% call list_entry() %}
+          {{ _('doc.policy_selection.auto_payload_case') }}
+        {% endcall %}
+        {% call list_entry() %}
+          {{ _('doc.policy_selection.ask_payload_case') }}
+        {% endcall %}
+        {% call list_entry() %}
+          {{ _('doc.policy_selection.block_js_case') }}
+        {% endcall %}
+        {% call list_entry() %}
+          {{ _('doc.policy_selection.allow_js_case') }}
+        {% endcall %}
+      {% endcall %}
+    {% endcall %}
+  {% endcall %}
+
+  {% call section() %}
+    {{ medium_heading(_('doc.policy_selection.h_medium.precedence')) }}
+
+    {% call paragraph() %}
+      {% set fmt = _('doc.policy_selection.html.precedence_general_{patterns_link}') %}
+      {% set link_text = _('doc.policy_selection.precedence_general.patterns_link_text') %}
+      {% set link = doc_page_link(link_text|e, 'url_patterns') %}
+      {{ fmt.format(patterns_link=link)|safe }}
+    {% endcall %}
+
+    {% call paragraph() %}
+      {% set fmt = _('doc.policy_selection.html.precedence_nonenabled_{settings_link}') %}
+      {% set link_text = _('doc.policy_selection.precedence_nonenabled.settings_link_text') %}
+      {% set link = hkt_link(link_text|e, 'home.home') %}
+      {{ fmt.format(settings_link=link)|safe }}
+    {% endcall %}
+
+    {% call paragraph() %}
+      {% set fmt = _('doc.policy_selection.html.precedence_fallback_{settings_link}') %}
+      {% set link_text = _('doc.policy_selection.precedence_fallback.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.policy_selection.special_cases.h_medium')) }}
+
+    {% call paragraph() %}
+      {{ _('doc.policy_selection.special_cases.html.exepmt_and_error')|safe }}
+    {% endcall %}
+
+    {% call paragraph() %}
+      {{ _('doc.policy_selection.special_cases.internal_policies') }}
+    {% endcall %}
+  {% endcall %}
+{% endblock main %}