mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-28 08:03:36 +00:00
Currently menu items are shown in alphabetical order in applications and no clear order in system configuration. This is done using static weights for menu items based on English names that does not work for other locales. Sorting can't be done at the time of adding menu items as users of multiple locales may use the interface at the same time. Implement a sorting mechanism based on existing order as well as labels of menu item. This allows the flexiblity of grouping menu items in future as it may be need for system configuration. In case of help menu Remove sort order for all modules except for help menu as here we want that specific order.
74 lines
2.4 KiB
Python
74 lines
2.4 KiB
Python
#
|
|
# This file is part of Plinth.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
"""
|
|
Help module for Plinth.
|
|
"""
|
|
|
|
import os
|
|
from django.http import Http404
|
|
from django.template.response import TemplateResponse
|
|
from django.utils.translation import ugettext as _, ugettext_lazy
|
|
from stronghold.decorators import public
|
|
|
|
from plinth import cfg, __version__
|
|
|
|
|
|
def init():
|
|
"""Initialize the Help module"""
|
|
menu = cfg.main_menu.add_urlname(ugettext_lazy('Documentation'),
|
|
'glyphicon-book', 'help:index')
|
|
menu.add_urlname(ugettext_lazy('Where to Get Help'), 'glyphicon-search',
|
|
'help:index_explicit', 5)
|
|
menu.add_urlname(ugettext_lazy('Manual'), 'glyphicon-info-sign',
|
|
'help:manual', 10)
|
|
menu.add_urlname(ugettext_lazy('About'), 'glyphicon-star', 'help:about',
|
|
100)
|
|
|
|
|
|
@public
|
|
def index(request):
|
|
"""Serve the index page"""
|
|
return TemplateResponse(request, 'help_index.html',
|
|
{'title': _('Documentation and FAQ')})
|
|
|
|
|
|
@public
|
|
def about(request):
|
|
"""Serve the about page"""
|
|
context = {
|
|
'title': _('About {box_name}').format(box_name=_(cfg.box_name)),
|
|
'version': __version__
|
|
}
|
|
return TemplateResponse(request, 'help_about.html', context)
|
|
|
|
|
|
@public
|
|
def manual(request):
|
|
"""Serve the manual page from the 'doc' directory"""
|
|
try:
|
|
with open(os.path.join(cfg.doc_dir, 'freedombox-manual.part.html'),
|
|
'r', encoding='utf-8') as input_file:
|
|
content = input_file.read()
|
|
except IOError:
|
|
raise Http404
|
|
|
|
return TemplateResponse(
|
|
request, 'help_manual.html',
|
|
{'title': _('{box_name} Manual').format(box_name=_(cfg.box_name)),
|
|
'content': content})
|