Metadata-Version: 2.0
Name: django-template-shortcodes
Version: 0.0.3
Summary: Limited WordPress shortcode support for Django
Home-page: https://github.com/emilbjorklund/django-template-shortcodes
Author: Emil Björklund
Author-email: bjorklund.emil@gmail.com
License: MIT
Download-URL: https://github.com/emilbjorklund/django-template-shortcodes/archive/0.0.3.tar.gz
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: beautifulsoup4 (>=4.0.0)

# django-template-shortcodes

THIS IS EXPERIMENTAL STUFF. Don't use it. Probably.

This package provides some [WordPress
shortcode](http://en.support.wordpress.com/shortcodes/) support for Django
templates. It is heavily based on [AGoodId's version of django-shortcodes](https://github.com/AGoodId/django-shortcodes) (in turn based on https://code.google.com/p/django-shortcodes/), as well as [WP Export Parser](https://github.com/RealGeeks/wp_export_parser) for the regex parts, lifted from WordPress.

## Supported shortcodes (sort of): 

* `[caption caption="Foo bar"]<img src="" alt="" />[/caption]`
* `[caption]<img src="" alt="" /> Foo bar[/caption]`
* `[youtube=https://www.youtube.com/watch?v=dQw4w9WgXcQ]`
* `[youtube url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"]`
* `[gmaps url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"]`
* `[vimeo url="https://www.vimeo.com/watch?v=dQw4w9WgXcQ"]`
* `[iframe url="https://www.vimeo.com/watch?v=dQw4w9WgXcQ"]`

## Installation

Install via pip: `pip install django-template-shortcodes`
Or clone the [Git repository](https://github.com/emilbjorklund/django-shortcodes).

## Usage

Parse shortcodes:

    {% load shortcodes_filters %}
    {{ text|shortcodes|safe }}

Remove shortcodes (completely, including contents inside):

    {% load shortcodes_filters %}
    {{ text|removeshortcodes|safe }}



