#------------------------------------------------------------------------------
#
# Copyright (c) 2005, Enthought, Inc.
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in enthought/LICENSE.txt and may be redistributed only
# under the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
#
# Author: David C. Morrill
# Date: 10/25/2004
#
#------------------------------------------------------------------------------
""" Defines the HTML help templates used for formatting Traits UI help pages.
"""
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
from __future__ import absolute_import
from traits.api import HasStrictTraits, Str
#-------------------------------------------------------------------------------
# Constants:
#-------------------------------------------------------------------------------
# Default HTML for a single Item's help window
ItemHTML = """
"""
# Default HTML for a complete Group's help window
GroupHTML = """
%s
"""
# Default HTML for a single Item within a Group
ItemHelp = """
| %s: |
%s |
"""
# Default HTML for formatting a Group's 'help' trait
GroupHelp = """
"""
#-------------------------------------------------------------------------------
# 'HelpTemplate' class:
#-------------------------------------------------------------------------------
class HelpTemplate ( HasStrictTraits ):
""" Contains HTML templates for displaying help.
"""
item_html = Str( ItemHTML ) # Item popup help window HTML document
group_html = Str( GroupHTML ) # Group help window HTML document
item_help = Str( ItemHelp ) # Single group item HTML
group_help = Str( GroupHelp ) # Group level help HTML
no_group_help = Str( '' ) # Missing group level help HTML
#-------------------------------------------------------------------------------
# Gets/Sets the current HelpTemplate in use:
#-------------------------------------------------------------------------------
_help_template = HelpTemplate()
def help_template ( template = None ):
""" Gets or sets the current HelpTemplate in use.
"""
global _help_template
if template is not None:
_help_template = template
return _help_template