Metadata-Version: 1.1
Name: experimental.nodtml
Version: 1.1
Summary: Patch DocumentTemplate to not return any content.
Home-page: https://pypi.python.org/pypi/experimental.nodtml
Author: Maurits van Rees
Author-email: maurits@vanrees.org
License: GPL version 2
Description: .. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.
           If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html
           This text does not appear on pypi or github. It is a comment.
        
        ==============================================================================
        experimental.nodtml
        ==============================================================================
        
        Patch DocumentTemplate to not return any content.
        
        
        Features
        --------
        
        DTML documents have been deprecated for several years, at least within
        the Plone community.  So you should not use them.  But still Plone
        ships with DTML documents.  And these may contain security issues,
        especially for Cross Site Scripting (CSS).  So this package patches
        the Document Templates to not return any content.
        
        
        Options
        -------
        
        The package looks for a few environment variables.
        
        ``SHOW_ORIGINAL_DTML``
            When this is set to a true value, the original DTML value is printed in the zope instance log.
            The arguments and keyword arguments are also shown, so you can know where this is coming from.
            Default: false.
        
        ``DEBUG_DTML_VALUE``
            When this is set, the given value is return as content of the DTML.
            Default: empty string.
        
        ``EXPERIMENTAL_NODTML_ONLY_WARN``
            When this is set to a true value, instead of replacing the dtml value, a warning is logged.
            When true, the ``SHOW_ORIGINAL_DTML`` and ``DEBUG_DTML_VALUE`` settings are ignored.
            Default: false.
        
        Accepted True values are: ``true``, ``t``, ``1``, ``yes``, ``y``.
        
        
        Installation
        ------------
        
        Install experimental.nodtml by adding it to your buildout::
        
            [buildout]
            ...
            eggs =
                experimental.nodtml
        
        and then running ``bin/buildout``
        
        No zcml is needed.
        
        
        Contribute
        ----------
        
        - Issue Tracker: https://github.com/plone/experimental.nodtml/issues
        - Source Code: https://github.com/plone/experimental.nodtml
        
        
        License
        -------
        
        The project is licensed under the GPLv2.
        
        
        Contributors
        ============
        
        - Maurits van Rees, maurits@vanrees.org
        
        
        Changelog
        =========
        
        
        1.1 (2016-09-28)
        ----------------
        
        New features:
        
        - Added ``EXPERIMENTAL_NODTML_ONLY_WARN`` option.  [maurits]
        
        Bug fixes:
        
        - Interpret value of ``SHOW_ORIGINAL_DTML`` as true value.
          Accepted True values are: ``true``, ``t``, ``1``, ``yes``, ``y``.
          [maurits]
        
        - Show arguments and keyword arguments when ``SHOW_ORIGINAL_DTML`` is true.
          [maurits]
        
        - Return empty string instead of empty unicode by default.  Otherwise
          you get exceptions when loading dtml files in for example the css
          registry on Plone 4.3.  [maurits]
        
        
        1.0.2 (2016-09-24)
        ------------------
        
        Bug fixes:
        
        - Fixed showing ``String .__str__``.  [maurits]
        
        
        1.0.1 (2016-09-24)
        ------------------
        
        Bug fixes:
        
        - Added z3c.autoinclude entry point, so our code gets loaded on startup.  [maurits]
        
        
        1.0 (2016-09-24)
        ----------------
        
        - Initial release.
          [mauritsvanrees]
        
Keywords: Python Plone
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: 4.3
Classifier: Framework :: Plone :: 5.0
Classifier: Framework :: Plone :: 5.1
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
