2022-10-10 09:25:46 +00:00
|
|
|
__filename__ = "webapp_about.py"
|
|
|
|
|
__author__ = "Bob Mottram"
|
|
|
|
|
__license__ = "AGPL3+"
|
2024-01-21 19:01:20 +00:00
|
|
|
__version__ = "1.5.0"
|
2022-10-10 09:25:46 +00:00
|
|
|
__maintainer__ = "Bob Mottram"
|
|
|
|
|
__email__ = "bob@libreserver.org"
|
|
|
|
|
__status__ = "Production"
|
|
|
|
|
__module_group__ = "Web Interface"
|
|
|
|
|
|
|
|
|
|
import os
|
|
|
|
|
from shutil import copyfile
|
|
|
|
|
from utils import get_config_param
|
|
|
|
|
from webapp_utils import html_header_with_website_markup
|
|
|
|
|
from webapp_utils import html_footer
|
|
|
|
|
from markdown import markdown_example_numbers
|
|
|
|
|
from markdown import markdown_to_html
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def html_manual(base_dir: str, http_prefix: str,
|
|
|
|
|
domain_full: str, onion_domain: str, translate: {},
|
|
|
|
|
system_language: str) -> str:
|
|
|
|
|
"""Show the user manual screen
|
|
|
|
|
"""
|
|
|
|
|
manual_filename = base_dir + '/manual/manual.md'
|
|
|
|
|
admin_nickname = get_config_param(base_dir, 'admin')
|
|
|
|
|
if os.path.isfile(base_dir + '/accounts/manual.md'):
|
|
|
|
|
manual_filename = base_dir + '/accounts/manual.md'
|
|
|
|
|
|
|
|
|
|
if os.path.isfile(base_dir + '/accounts/login-background-custom.jpg'):
|
|
|
|
|
if not os.path.isfile(base_dir + '/accounts/login-background.jpg'):
|
|
|
|
|
copyfile(base_dir + '/accounts/login-background-custom.jpg',
|
|
|
|
|
base_dir + '/accounts/login-background.jpg')
|
|
|
|
|
|
|
|
|
|
manual_text = 'User Manual.'
|
|
|
|
|
if os.path.isfile(manual_filename):
|
|
|
|
|
with open(manual_filename, 'r',
|
|
|
|
|
encoding='utf-8') as fp_manual:
|
|
|
|
|
md_text = markdown_example_numbers(fp_manual.read())
|
|
|
|
|
manual_text = markdown_to_html(md_text)
|
|
|
|
|
|
|
|
|
|
manual_form = ''
|
|
|
|
|
css_filename = base_dir + '/epicyon-profile.css'
|
|
|
|
|
if os.path.isfile(base_dir + '/epicyon.css'):
|
|
|
|
|
css_filename = base_dir + '/epicyon.css'
|
|
|
|
|
|
|
|
|
|
instance_title = \
|
|
|
|
|
get_config_param(base_dir, 'instanceTitle')
|
|
|
|
|
manual_form = \
|
|
|
|
|
html_header_with_website_markup(css_filename, instance_title,
|
|
|
|
|
http_prefix, domain_full,
|
|
|
|
|
system_language)
|
|
|
|
|
manual_form += \
|
|
|
|
|
'<div class="container">' + manual_text + '</div>'
|
|
|
|
|
if onion_domain:
|
|
|
|
|
manual_form += \
|
|
|
|
|
'<div class="container"><center>\n' + \
|
|
|
|
|
'<p class="administeredby">' + \
|
|
|
|
|
'http://' + onion_domain + '</p>\n</center></div>\n'
|
|
|
|
|
if admin_nickname:
|
|
|
|
|
admin_actor = '/users/' + admin_nickname
|
|
|
|
|
manual_form += \
|
|
|
|
|
'<div class="container"><center>\n' + \
|
|
|
|
|
'<p class="administeredby">' + \
|
|
|
|
|
translate['Administered by'] + ' <a href="' + \
|
|
|
|
|
admin_actor + '">' + admin_nickname + '</a>. ' + \
|
|
|
|
|
translate['Version'] + ' ' + __version__ + \
|
|
|
|
|
'</p>\n</center></div>\n'
|
|
|
|
|
manual_form += html_footer()
|
|
|
|
|
return manual_form
|
