aboutsummaryrefslogtreecommitdiff
path: root/src/hydrilla/proxy/self_doc/url_patterns.html.jinja
diff options
context:
space:
mode:
Diffstat (limited to 'src/hydrilla/proxy/self_doc/url_patterns.html.jinja')
-rw-r--r--src/hydrilla/proxy/self_doc/url_patterns.html.jinja308
1 files changed, 308 insertions, 0 deletions
diff --git a/src/hydrilla/proxy/self_doc/url_patterns.html.jinja b/src/hydrilla/proxy/self_doc/url_patterns.html.jinja
new file mode 100644
index 0000000..45a0db3
--- /dev/null
+++ b/src/hydrilla/proxy/self_doc/url_patterns.html.jinja
@@ -0,0 +1,308 @@
+{#
+SPDX-License-Identifier: GPL-3.0-or-later OR CC-BY-SA-4.0
+
+Documentation page describing URL patterns understood by Haketilo.
+
+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 %}URL patterns{% endblock %}
+
+{% block main %}
+ {{ big_heading('URL patterns') }}
+
+ {% call section() %}
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.html.intro')|safe }}
+ {% endcall %}
+ {% endcall %}
+
+ {% call section() %}
+ {{ medium_heading(_('doc.url_patterns.heading.employed_solution')) }}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.html.wildcards_intro')|safe }}
+ {% endcall %}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.html.wildcards_types_introduced')|safe }}
+ {% endcall %}
+ {% endcall %}
+
+ {% call section() %}
+ {{ small_heading(_('doc.url_patterns.label.domain_wildcards')) }}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.html.domain_wildcards_intro')|safe }}
+ {% endcall %}
+
+ {% call unordered_list() %}
+ {% call list_entry() %}
+ {{ _('doc.url_patterns.html.domain_no_asterisks_example')|safe }}
+ {% endcall %}
+ {% call list_entry() %}
+ {{ _('doc.url_patterns.html.domain_one_asterisk_example')|safe }}
+ {% endcall %}
+ {% call list_entry() %}
+ {{ _('doc.url_patterns.html.domain_two_asterisks_example')|safe }}
+ {% endcall %}
+ {% call list_entry() %}
+ {{ _('doc.url_patterns.html.domain_three_asterisks_example')|safe }}
+ {% endcall %}
+ {% endcall %}
+ {% endcall %}
+
+ {% call section() %}
+ {{ small_heading(_('doc.url_patterns.label.path_wildcards')) }}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.html.path_wildcards_intro')|safe }}
+ {% endcall %}
+
+ {% call unordered_list() %}
+ {% call list_entry() %}
+ {{ _('doc.url_patterns.html.path_no_asterisks_example')|safe }}
+ {% endcall %}
+ {% call list_entry() %}
+ {{ _('doc.url_patterns.html.path_one_asterisk_example')|safe }}
+ {% endcall %}
+ {% call list_entry() %}
+ {{ _('doc.url_patterns.html.path_two_asterisks_example')|safe }}
+ {% endcall %}
+ {% call list_entry() %}
+ {{ _('doc.url_patterns.html.path_three_asterisks_example')|safe }}
+ {% endcall %}
+ {% endcall %}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.html.path_trailing_slash')|safe }}
+ {% endcall %}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.html.path_trailing_slash_priority')|safe }}
+ {% endcall %}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.html.path_literal_trailing_asterisks')|safe }}
+ {% endcall %}
+ {% endcall %}
+
+ {% call section() %}
+ {{ small_heading(_('doc.url_patterns.label.protocol_wildcards')) }}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.html.protocol_wildcards')|safe }}
+ {% endcall %}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.html.protocol_wildcards_are_aliases')|safe }}
+ {% endcall %}
+ {% endcall %}
+
+ {% call section() %}
+ {{ small_heading(_('doc.url_patterns.label.wildcard_priorities')) }}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.priorities_intro') }}
+ {% endcall %}
+
+ {% call unordered_list() %}
+ {% call list_entry() %}
+ {{ _('doc.url_patterns.priorities_rule_path_ending')|safe }}
+ {% endcall %}
+ {% call list_entry() %}
+ {{ _('doc.url_patterns.priorities_rule_path_length')|safe }}
+ {% endcall %}
+ {% call list_entry() %}
+ {{ _('doc.url_patterns.priorities_rule_domain_beginning')|safe }}
+ {% endcall %}
+ {% call list_entry() %}
+ {{ _('doc.url_patterns.priorities_rule_domain_length')|safe }}
+ {% endcall %}
+ {% endcall %}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.html.priorities_example1_intro')|safe }}
+ {% endcall %}
+
+ {% call verbatim() %}
+http://settings.query.example.com/google/tries/destroy/adblockers/
+http://settings.query.example.com/google/tries/destroy/adblockers
+http://settings.query.example.com/google/tries/destroy/adblockers/***/
+http://settings.query.example.com/google/tries/destroy/adblockers/***
+http://settings.query.example.com/google/tries/destroy/*/
+http://settings.query.example.com/google/tries/destroy/*
+http://settings.query.example.com/google/tries/destroy/***/
+http://settings.query.example.com/google/tries/destroy/***
+http://settings.query.example.com/google/tries/**/
+http://settings.query.example.com/google/tries/**
+http://settings.query.example.com/google/tries/***/
+http://settings.query.example.com/google/tries/***
+http://settings.query.example.com/google/**/
+http://settings.query.example.com/google/**
+http://settings.query.example.com/google/***/
+http://settings.query.example.com/google/***
+http://settings.query.example.com/**/
+http://settings.query.example.com/**
+http://settings.query.example.com/***/
+http://settings.query.example.com/***
+http://***.settings.query.example.com/google/tries/destroy/adblockers/
+http://***.settings.query.example.com/google/tries/destroy/adblockers
+http://***.settings.query.example.com/google/tries/destroy/adblockers/***/
+http://***.settings.query.example.com/google/tries/destroy/adblockers/***
+http://***.settings.query.example.com/google/tries/destroy/*/
+http://***.settings.query.example.com/google/tries/destroy/*
+http://***.settings.query.example.com/google/tries/destroy/***/
+http://***.settings.query.example.com/google/tries/destroy/***
+http://***.settings.query.example.com/google/tries/**/
+http://***.settings.query.example.com/google/tries/**
+http://***.settings.query.example.com/google/tries/***/
+http://***.settings.query.example.com/google/tries/***
+http://***.settings.query.example.com/google/**/
+http://***.settings.query.example.com/google/**
+http://***.settings.query.example.com/google/***/
+http://***.settings.query.example.com/google/***
+http://***.settings.query.example.com/**/
+http://***.settings.query.example.com/**
+http://***.settings.query.example.com/***/
+http://***.settings.query.example.com/***
+http://*.query.example.com/google/tries/destroy/adblockers/
+http://*.query.example.com/google/tries/destroy/adblockers
+http://*.query.example.com/google/tries/destroy/adblockers/***/
+http://*.query.example.com/google/tries/destroy/adblockers/***
+http://*.query.example.com/google/tries/destroy/*/
+http://*.query.example.com/google/tries/destroy/*
+http://*.query.example.com/google/tries/destroy/***/
+http://*.query.example.com/google/tries/destroy/***
+http://*.query.example.com/google/tries/**/
+http://*.query.example.com/google/tries/**
+http://*.query.example.com/google/tries/***/
+http://*.query.example.com/google/tries/***
+http://*.query.example.com/google/**/
+http://*.query.example.com/google/**
+http://*.query.example.com/google/***/
+http://*.query.example.com/google/***
+http://*.query.example.com/**/
+http://*.query.example.com/**
+http://*.query.example.com/***/
+http://*.query.example.com/***
+http://***.query.example.com/google/tries/destroy/adblockers/
+http://***.query.example.com/google/tries/destroy/adblockers
+http://***.query.example.com/google/tries/destroy/adblockers/***/
+http://***.query.example.com/google/tries/destroy/adblockers/***
+http://***.query.example.com/google/tries/destroy/*/
+http://***.query.example.com/google/tries/destroy/*
+http://***.query.example.com/google/tries/destroy/***/
+http://***.query.example.com/google/tries/destroy/***
+http://***.query.example.com/google/tries/**/
+http://***.query.example.com/google/tries/**
+http://***.query.example.com/google/tries/***/
+http://***.query.example.com/google/tries/***
+http://***.query.example.com/google/**/
+http://***.query.example.com/google/**
+http://***.query.example.com/google/***/
+http://***.query.example.com/google/***
+http://***.query.example.com/**/
+http://***.query.example.com/**
+http://***.query.example.com/***/
+http://***.query.example.com/***
+http://**.example.com/google/tries/destroy/adblockers/
+http://**.example.com/google/tries/destroy/adblockers
+http://**.example.com/google/tries/destroy/adblockers/***/
+http://**.example.com/google/tries/destroy/adblockers/***
+http://**.example.com/google/tries/destroy/*/
+http://**.example.com/google/tries/destroy/*
+http://**.example.com/google/tries/destroy/***/
+http://**.example.com/google/tries/destroy/***
+http://**.example.com/google/tries/**/
+http://**.example.com/google/tries/**
+http://**.example.com/google/tries/***/
+http://**.example.com/google/tries/***
+http://**.example.com/google/**/
+http://**.example.com/google/**
+http://**.example.com/google/***/
+http://**.example.com/google/***
+http://**.example.com/**/
+http://**.example.com/**
+http://**.example.com/***/
+http://**.example.com/***
+http://***.example.com/google/tries/destroy/adblockers/
+http://***.example.com/google/tries/destroy/adblockers
+http://***.example.com/google/tries/destroy/adblockers/***/
+http://***.example.com/google/tries/destroy/adblockers/***
+http://***.example.com/google/tries/destroy/*/
+http://***.example.com/google/tries/destroy/*
+http://***.example.com/google/tries/destroy/***/
+http://***.example.com/google/tries/destroy/***
+http://***.example.com/google/tries/**/
+http://***.example.com/google/tries/**
+http://***.example.com/google/tries/***/
+http://***.example.com/google/tries/***
+http://***.example.com/google/**/
+http://***.example.com/google/**
+http://***.example.com/google/***/
+http://***.example.com/google/***
+http://***.example.com/**/
+http://***.example.com/**
+http://***.example.com/***/
+http://***.example.com/***
+ {% endcall %}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.html.priorities_example1_note')|safe }}
+ {% endcall %}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.html.priorities_example2_intro')|safe }}
+ {% endcall %}
+
+ {% call verbatim() %}
+https://example.com
+https://example.com/***
+https://***.example.com
+https://***.example.com/***
+ {% endcall %}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.html.priorities_example2_note')|safe }}
+ {% endcall %}
+ {% endcall %}
+
+ {% call section() %}
+ {{ small_heading(_('doc.url_patterns.label.limits')) }}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.limits')|safe }}
+ {% endcall %}
+ {% endcall %}
+
+ {% call section() %}
+ {{ medium_heading(_('doc.url_patterns.heading.alt_solution')) }}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.url_pattern_drawbacks') }}
+ {% endcall %}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.server_behavior_mimicking_idea') }}
+ {% endcall %}
+
+ {% call paragraph() %}
+ {{ _('doc.url_patterns.approach_may_be_considered') }}
+ {% endcall %}
+ {% endcall %}
+{% endblock main %}