=================
django-shortcodes
=================

This package provides `WordPress shortcode
<http://en.support.wordpress.com/shortcodes/>`_ support for Django
templates. It is based on code by `Mark Steadman <http://marksteadman.com/>`_.

Support for different shortcodes are generated by parsers. The package
currently includes a parser for YouTube videos. Additional parsers can be
submitted for inclusion at the package's `issue
tracker <https://github.com/martey/django-shortcodes/issues>`_.

Installation
============

Use ``pip install django-shortcodes`` or clone the `Git
repository <https://github.com/martey/django-shortcodes>`_.

Usage
=====

::

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

Settings
========

- ``SHORTCODES_YOUTUBE_JQUERY``: Boolean whether the
  `jquery.flash plugin <http://jquery-flash.stephenbelanger.com/>`_ is
  available.
- ``SHORTCODES_YOUTUBE_HEIGHT``: Default height for YouTube videos.
- ``SHORTCODES_YOUTUBE_WIDTH``: Default width for YouTube videos.
