********************
Embedded Web
********************

Overview
====================

This driver is an example of one of the ways to implement templated
HTML with Python in a presentation.  This approach is documented at
http://www.digi.com/wiki/developer/index.php/Python_inside_HTML. 

This shipping implementation provides an AJAX style hierarchical view
of the channel database.  

.. note:: Currently, this presentation is intended to provide a
          development example and is more suitable for usage by a
          developer interested in expanding on the approach, rather
          than as a canned solution.  For a more complete traditional
          HTML server implementation check out the :ref:`Web
          presentation <Web_Presentation>`.

Configuration
====================

A typical embedded_web configuration block looks like this::

  - name: eweb
    driver: presentations.embedded_web.web:Web
      settings:
        page: data
        exclude: ['template_transforms.count_by_two']

Settings
--------------------

page (optional, default: /data)
    The URL path component that this driver will recognize and present
    as the page encoded in index_page.py initially.  Further calls may
    request additional templated components.  See the Wiki page and
    implementation for details.

exclude (optional, default: [])
    A list of strings.  Channels whose name matches one in this list
    will not be processed as part of the channel list provided to the
    HTML template processing.

