Metadata-Version: 1.0
Name: htmlfilter
Version: 0.2
Summary: White list HTML filter
Home-page: http://github.com/samueladam/htmlfilter
Author: Samuel Adam
Author-email: samuel.adam@gmail.com
License: BSD
Description: About
        -----
        
        Very simple white list HTML filter.
        
        Use it with a WYSIWYG editor on the client side.
        
        
        Usage
        -----
        
        ::
        from htmlfilter import HTMLFilter
        hf = HTMLFilter()
        cleaned_html = hf.filter(dirty_html)
        
        
        Rules file
        ----------
        
        The filter is instanciated with a predefined set of rules.
        http://github.com/samueladam/htmlfilter/blob/master/htmlfilter/rules.py
        
        You can create your own rules file::
        
        # file: my_rules.py
        TAGS = {
        'a': ('href', 'name',),
        'p': ('class',),
        }
        
        # define filters on attributes data (tag_attr)
        def p_class(data):
        if data not in ('class1', 'class2',):
        data = ''
        return data
        
        
        And use them this way::
        
        from htmlfilter import HTMLFilter
        import my_rules
        
        hf = HTMLFilter(rules=my_rules)
        cleaned_html = hf.filter(dirty_html)
        
        
Keywords: html,filter,white list,parser,clean,tags
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Text Processing :: Filters
Classifier: Topic :: Text Processing :: Markup :: HTML
