From b1912607ae9783d6ccf648bd7706a64eca5bedb9 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Sat, 12 Mar 2022 10:18:08 +0100
Subject: [mod] replace /help by /info pages and include pages in project docs

This patch implements a bolierplate to share content from info-pages of the
SearXNG instance (URL /info) with the project documentation (path /docs/user).

The info pages are using Markdown (CommonMark), to include them in the project
documentation (reST) the myst-parser [1] is used in the Sphinx-doc build chain.

If base_url is known (defined in settings.yml) links to the instance are also
inserted into the project documentation::

    searxng_extra/docs_prebuild

[1] https://www.sphinx-doc.org/en/master/usage/markdown.html

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 searx/templates/oscar/help.html   | 12 ------------
 searx/templates/oscar/info.html   | 12 ++++++++++++
 searx/templates/oscar/navbar.html |  2 +-
 searx/templates/simple/base.html  |  2 +-
 searx/templates/simple/help.html  | 12 ------------
 searx/templates/simple/info.html  | 14 ++++++++++++++
 6 files changed, 28 insertions(+), 26 deletions(-)
 delete mode 100644 searx/templates/oscar/help.html
 create mode 100644 searx/templates/oscar/info.html
 delete mode 100644 searx/templates/simple/help.html
 create mode 100644 searx/templates/simple/info.html

(limited to 'searx/templates')

diff --git a/searx/templates/oscar/help.html b/searx/templates/oscar/help.html
deleted file mode 100644
index bf311fb4a..000000000
--- a/searx/templates/oscar/help.html
+++ /dev/null
@@ -1,12 +0,0 @@
-{% extends "oscar/base.html" %}
-{% block title %}{{ page.title }} - {% endblock %}
-{% block content %}
-<ul class="nav nav-tabs">
-{% for name, page in all_pages %}
-  <li {% if name == page_filename %}class="active"{% endif %}>
-    <a href="{{name}}">{{page.title}}</a>
-  </li>
-{% endfor %}
-</ul>
-{{ page.content | safe }}
-{% endblock %}
diff --git a/searx/templates/oscar/info.html b/searx/templates/oscar/info.html
new file mode 100644
index 000000000..3a696da50
--- /dev/null
+++ b/searx/templates/oscar/info.html
@@ -0,0 +1,12 @@
+{% extends "oscar/base.html" %}
+{% block title %}{{ active_page.title }} - {% endblock %}
+{% block content %}
+<ul class="nav nav-tabs">
+{% for pagename, page in all_pages('en') %}
+  <li {% if pagename == active_pagename %}class="active"{% endif %}>
+    <a href="{{pagename}}">{{page.title}}</a>
+  </li>
+{% endfor %}
+</ul>
+{{ active_page.html | safe }}
+{% endblock %}
diff --git a/searx/templates/oscar/navbar.html b/searx/templates/oscar/navbar.html
index b1d344c11..4c0ec0068 100644
--- a/searx/templates/oscar/navbar.html
+++ b/searx/templates/oscar/navbar.html
@@ -3,7 +3,7 @@
         <a href="{{ url_for('index') }}">{{ instance_name }}</a>{{- "" -}}
     </span>{{- "" -}}
     <span class="{% if rtl %}pull-left{% else %}pull-right{% endif %}">{{- "" -}}
-        <a href="{{ url_for('help_page', pagename='about') }}">{{ _('about') }}</a>{{- "" -}}
+        <a href="{{ url_for('info', pagename='about', locale=current_locale) }}">{{ _('about') }}</a>{{- "" -}}
         <a href="{{ url_for('preferences') }}">{{ _('preferences') }}</a>{{- "" -}}
     </span>{{- "" -}}
 </div>
diff --git a/searx/templates/simple/base.html b/searx/templates/simple/base.html
index 644c6df9a..135a95669 100644
--- a/searx/templates/simple/base.html
+++ b/searx/templates/simple/base.html
@@ -58,7 +58,7 @@
   </main>
   <footer>
     <p>
-    {{ _('Powered by') }} <a href="{{ url_for('help_page', pagename='about') }}">searxng</a> - {{ searx_version }} — {{ _('a privacy-respecting, hackable metasearch engine') }}<br/>
+    {{ _('Powered by') }} <a href="{{ url_for('info', pagename='about', locale=current_locale) }}">searxng</a> - {{ searx_version }} — {{ _('a privacy-respecting, hackable metasearch engine') }}<br/>
         <a href="{{ searx_git_url }}">{{ _('Source code') }}</a> |
         <a href="{{ get_setting('brand.issue_url') }}">{{ _('Issue tracker') }}</a> |
         <a href="{{ url_for('stats') }}">{{ _('Engine stats') }}</a> |
diff --git a/searx/templates/simple/help.html b/searx/templates/simple/help.html
deleted file mode 100644
index 5f571ae01..000000000
--- a/searx/templates/simple/help.html
+++ /dev/null
@@ -1,12 +0,0 @@
-{% extends 'simple/page_with_header.html' %}
-{% block title %}{{ page.title }} - {% endblock %}
-{% block content %}
-<ul class="tabs">
-{% for name, page in all_pages %}
-  <li>
-    <a href="{{name}}" {% if name == page_filename %}class="active"{% endif %}>{{page.title}}</a>
-  </li>
-{% endfor %}
-</ul>
-{{ page.content | safe }}
-{% endblock %}
diff --git a/searx/templates/simple/info.html b/searx/templates/simple/info.html
new file mode 100644
index 000000000..ef6b343ad
--- /dev/null
+++ b/searx/templates/simple/info.html
@@ -0,0 +1,14 @@
+{% extends 'simple/page_with_header.html' %}
+{% block title %}{{ active_page.title }} - {% endblock %}
+{% block content %}
+<ul class="tabs">
+{% for pagename, page in all_pages('en') %}
+  <li>
+    <a href="{{pagename}}" {% if pagename == active_pagename %}class="active"{% endif %}>{{page.title}}</a>
+  </li>
+{% endfor %}
+</ul>
+<div class="info-page {{pagename}}">
+  {{- active_page.html | safe -}}
+</div>
+{% endblock %}
-- 
cgit v1.2.3