aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWojtek Kosior <koszko@koszko.org>2022-10-28 16:14:46 +0200
committerWojtek Kosior <koszko@koszko.org>2022-10-28 16:14:46 +0200
commitdb2845b3c0176a4d17fec770d58f8a5a7a19e77c (patch)
tree6376db1190adf24a6bb45e556d2ff34dad690516
parentbbfe6b3314c034dd03962c06cd957540cca8a95b (diff)
downloadhaketilo-hydrilla-db2845b3c0176a4d17fec770d58f8a5a7a19e77c.tar.gz
haketilo-hydrilla-db2845b3c0176a4d17fec770d58f8a5a7a19e77c.zip
[proxy] document advanced web UI features
-rw-r--r--src/hydrilla/proxy/self_doc/advanced_ui_features.html.jinja69
-rw-r--r--src/hydrilla/proxy/web_ui/templates/index.html.jinja4
2 files changed, 72 insertions, 1 deletions
diff --git a/src/hydrilla/proxy/self_doc/advanced_ui_features.html.jinja b/src/hydrilla/proxy/self_doc/advanced_ui_features.html.jinja
new file mode 100644
index 0000000..e702b7f
--- /dev/null
+++ b/src/hydrilla/proxy/self_doc/advanced_ui_features.html.jinja
@@ -0,0 +1,69 @@
+{#
+SPDX-License-Identifier: GPL-3.0-or-later OR CC-BY-SA-4.0
+
+Documentation page explaining what Haketilo's advanced UI features are.
+
+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 %} Advanced UI features {% endblock %}
+
+{% block main %}
+ {{ big_heading('Haketilo user interface features for advanced users') }}
+
+ {% call section() %}
+ {% call paragraph() %}
+ Certain options that may cause a lot of unnecessary confusion to casual
+ Haketilo users have been hidden by default. They can be accessed after
+ enabling advanced UI features on the
+ {{ hkt_link('settings page', 'home.home') }}.
+ {% endcall %}
+ {% endcall %}
+
+ {% call section() %}
+ {{ medium_heading('Concept of libraries') }}
+
+ {% call paragraph() %}
+ Haketilo has a concept of 2 types of entities -
+ <span class="bold">packages</span> and
+ <span class="bold">libraries</span>.
+ As explained on the {{ doc_page_link('packages', 'packages') }} page, it's
+ ultimately a package that provides concrete functionality and a casual
+ user does not need to be aware of the existence of libraries.
+ Consequently, with advanced features off the UI does not contain any
+ notion of libraries and even the
+ {{ hkt_link('libraries listing page', 'items.libraries') }} link is
+ removed from the navigation bar.
+ {% endcall %}
+ {% endcall %}
+
+ {% call section() %}
+ {{ medium_heading('Selective installation/uninstallation of packages') }}
+
+ {% call paragraph() %}
+ A packages is automatically installed together with all its dependencies
+ when the user enables it.
+ Additionally, whenever some installed Haketilo packages or libraries are
+ found not to be needed anymore, they can be pruned from the
+ {{ hkt_link('settings page', 'home.home') }}.
+ This functionality was deemed sufficient for most users' needs.
+ With advanced features enabled the UI also allows any single package or
+ library not in use to be uninstalled manually and any package or library
+ available from a repository to be installed without prior enabling.
+ {% 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 93b834a..25649ff 100644
--- a/src/hydrilla/proxy/web_ui/templates/index.html.jinja
+++ b/src/hydrilla/proxy/web_ui/templates/index.html.jinja
@@ -134,7 +134,9 @@ code in a proprietary work, I am not going to enforce this in court.
<div class="horizontal-separator"></div>
- {{ label(_('web_ui.home.advanced_features_label')) }}
+ {% call label(_('web_ui.home.advanced_features_label')) %}
+ {{ hkt_doc_link('advanced_ui_features') }}
+ {% endcall %}
{% set advanced_user_but_classes = ['red-button'] %}
{% set simple_user_but_classes = ['blue-button'] %}