skip to navigation
skip to content

Not Logged In

django-markwhat 1.1

A collection of template filters that implement common markup languages.

travis-cli tests status for django-markwhat

A collection of template filters that implement common markup languages.

provides template filters that implement the following markup languages:

In each case, the filter expects formatted markup as a string and returns a string representing the marked-up text. For example, the textile filter converts text that is marked-up in Textile format to HTML.

Installation

django-markwhat is available on pypi:

http://pypi.python.org/pypi/django-markwhat

So easily install it by pip:

pip install django-markwhat

Or by easy_install

$ easy_install django-markwhat

Another way is by cloning django-markwhat's git repo ::

git clone git://github.com/Alir3z4/django-markwhat.git

Then install it by running:

$ python setup.py install

Configuration

To activate these filters, add 'django_markwhat' to your INSTALLED_APPS setting. Once you've done that, use {% load markup %} in a template, and you'll have access to these filters.

Warning

The output of markup filters is marked "safe" and will not be escaped when rendered in a template. Always be careful to sanitize your inputs and make sure you are not leaving yourself vulnerable to cross-site scripting or other types of attacks.

reStructured Text

When using the restructuredtext markup filter you can define a RESTRUCTUREDTEXT_FILTER_SETTINGS in your django settings to override the default writer settings. See the restructuredtext writer settings for details on what these settings are.

Warning

reStructured Text has features that allow raw HTML to be included, and that allow arbitrary files to be included. These can lead to XSS vulnerabilities and leaking of private information. It is your responsibility to check the features of this library and configure appropriately to avoid this. See the Deploying Docutils Securely documentation.

Markdown

The Python Markdown library supports options named "safe_mode" and "enable_attributes". Both relate to the security of the output. To enable both options in tandem, the markdown filter supports the "safe" argument.

{ markdown_content_var|markdown:"safe" }}

Warning

Versions of the Python-Markdown library prior to 2.1 do not support the optional disabling of attributes and by default

 
File Type Py Version Uploaded on Size
django-markwhat-1.1.tar.gz (md5) Source 2014-01-19 5KB
  • Downloads (All Versions):
  • 54 downloads in the last day
  • 155 downloads in the last week
  • 508 downloads in the last month
  • Author: Alireza Savand
  • Home Page: http://pypi.python.org/pypi/django-markwhat
  • Keywords: django,markdown,markup,textile,rst,reStructuredText,docutils,web
  • License:
    Copyright (c) 2005-2013 Django Contributors, Alireza Savand
    All rights reserved.
    
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
        * Redistributions of source code must retain the above copyright
          notice, this list of conditions and the following disclaimer.
        * Redistributions in binary form must reproduce the above copyright
          notice, this list of conditions and the following disclaimer in the
          documentation and/or other materials provided with the distribution.
        * Neither the name of the authors nor the
          names of its contributors may be used to endorse or promote products
          derived from this software without specific prior written permission.
    
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
    ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • Platform: OS Independent
  • Categories
  • Package Index Owner: Alir3z4
  • DOAP record: django-markwhat-1.1.xml