diff options
author | Wojtek Kosior <koszko@koszko.org> | 2022-10-26 14:30:28 +0200 |
---|---|---|
committer | Wojtek Kosior <koszko@koszko.org> | 2022-10-26 14:31:42 +0200 |
commit | 01834fe901117809490fbf59b104833bdd88ea20 (patch) | |
tree | 1b3c2d7e2099cab404275fb774f9ad6f631c5bc0 /src/hydrilla/proxy/self_doc | |
parent | 9efa3c0fcc55d0998b648c69d1918f1779c4c6e9 (diff) | |
download | haketilo-hydrilla-01834fe901117809490fbf59b104833bdd88ea20.tar.gz haketilo-hydrilla-01834fe901117809490fbf59b104833bdd88ea20.zip |
[proxy] add documentation page describing URL patterns in Haketilo
Diffstat (limited to 'src/hydrilla/proxy/self_doc')
-rw-r--r-- | src/hydrilla/proxy/self_doc/doc_base.html.jinja | 65 | ||||
-rw-r--r-- | src/hydrilla/proxy/self_doc/url_patterns.html.jinja | 308 |
2 files changed, 373 insertions, 0 deletions
diff --git a/src/hydrilla/proxy/self_doc/doc_base.html.jinja b/src/hydrilla/proxy/self_doc/doc_base.html.jinja new file mode 100644 index 0000000..cef1abb --- /dev/null +++ b/src/hydrilla/proxy/self_doc/doc_base.html.jinja @@ -0,0 +1,65 @@ +{# +SPDX-License-Identifier: GPL-3.0-or-later OR CC-BY-SA-4.0 + +Base template for documentation pages when outputting HTML. + +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. +#} +{% if doc_output == 'html_hkt_mitm_it' %} + {% set doc_base_filename = 'hkt_mitm_it_base.html.jinja' %} +{% else %} + {% set doc_base_filename = 'base.html.jinja' %} +{% endif %} +{% extends doc_base_filename %} + +{% set sections = namespace(count=0) %} + +{% macro section() %} + {% if sections.count > 0 %} + <div class="horizontal-separator"></div> + {% endif %} + {% set sections.count = sections.count + 1 %} + + {{ caller()|safe }} +{% endmacro %} + +{% macro link(where, text) -%} + <a href="{{ where }}">{{ text }}</a> +{%- endmacro %} + +{% macro paragraph() %} + <p class="has-colored-links"> + {{ caller()|safe }} + </p> +{% endmacro %} + +{% macro big_heading(text) %} + <h3> + {{ text }} + </h3> +{% endmacro %} + +{% macro medium_heading(text) %} + <h4> + {{ text }} + </h4> +{% endmacro %} + +{% macro small_heading(text) %} + <label class="section-label"> + {{ text }} + </label> +{% endmacro %} 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 %} |