src/pyams_skin/help.py
changeset 0 bb4aabe07487
equal deleted inserted replaced
-1:000000000000 0:bb4aabe07487
       
     1 #
       
     2 # Copyright (c) 2008-2015 Thierry Florac <tflorac AT ulthar.net>
       
     3 # All Rights Reserved.
       
     4 #
       
     5 # This software is subject to the provisions of the Zope Public License,
       
     6 # Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
       
     7 # THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
       
     8 # WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
       
     9 # WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
       
    10 # FOR A PARTICULAR PURPOSE.
       
    11 #
       
    12 
       
    13 __docformat__ = 'restructuredtext'
       
    14 
       
    15 
       
    16 # import standard library
       
    17 
       
    18 # import interfaces
       
    19 from pyams_skin.interfaces import IContentHelp
       
    20 from pyams_skin.layer import IPyAMSLayer
       
    21 from pyams_utils.interfaces.text import IHTMLRenderer
       
    22 
       
    23 # import packages
       
    24 from pyams_template.template import template_config
       
    25 from pyams_utils.adapter import ContextRequestViewAdapter, adapter_config
       
    26 from pyams_utils.text import text_to_html
       
    27 from pyams_viewlet.viewlet import contentprovider_config
       
    28 from zope.interface import implementer, Interface
       
    29 from zope.schema.fieldproperty import FieldProperty
       
    30 
       
    31 
       
    32 @contentprovider_config(name='content_help', view=Interface, layer=IPyAMSLayer)
       
    33 @template_config(template='templates/help.pt', layer=IPyAMSLayer)
       
    34 class HelpContentProvider(object):
       
    35     """Help content provider"""
       
    36 
       
    37     help = None
       
    38 
       
    39     def update(self):
       
    40         registry = self.request.registry
       
    41         self.help = registry.queryMultiAdapter((self.context, self.request, self.view), IContentHelp)
       
    42 
       
    43 
       
    44 @implementer(IContentHelp)
       
    45 class ContentHelp(ContextRequestViewAdapter):
       
    46     """Content help"""
       
    47 
       
    48     outer_margin = FieldProperty(IContentHelp['outer_margin'])
       
    49     status = FieldProperty(IContentHelp['status'])
       
    50     header = FieldProperty(IContentHelp['header'])
       
    51     message = FieldProperty(IContentHelp['message'])
       
    52     message_format = FieldProperty(IContentHelp['message_format'])
       
    53 
       
    54 
       
    55 @adapter_config(context=(IContentHelp, IPyAMSLayer, Interface), provides=IHTMLRenderer)
       
    56 class HelpRenderer(ContextRequestViewAdapter):
       
    57     """Help renderer"""
       
    58 
       
    59     def render(self, **kwargs):
       
    60         message = self.request.localizer.translate(self.context.message)
       
    61         return text_to_html(message, self.context.message_format)