Metadata-Version: 2.1
Name: django-textblocks
Version: 0.8.3
Summary: Simple app for managing small blocks of text/html.
Home-page: http://github.com/fabiangermann/django-textblocks/
Author: Fabian Germann
Author-email: fg@feinheit.ch
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
License-File: LICENSE
License-File: AUTHORS

==========
Textblocks
==========

.. image:: https://travis-ci.org/fabiangermann/django-textblocks.svg?branch=master
    :target: https://travis-ci.org/fabiangermann/django-textblocks


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

1. Add ``textblocks`` and optionally ``modeltranslation`` to
   ``INSTALLED_APPS``
2. Add an entry for ``textblocks`` to your ``MIGRATION_MODULES``
   (textblocks cannot ship its own migrations because the exact schema
   depends on your ``LANGUAGES`` setting) and create an empty Python
   module (folder with an empty ``__init__.py`` file).
3. Run ``./manage.py makemigrations textblocks`` and ``./manage.py migrate``


Usage
=====

1. Load templatetags ``{% load textblock_tags %}``
2. Add ``textblock`` tags with unique identifiers::

      {% textblock "introduction" %}

Text blocks with identifiers that do not exist in the database yet will
automatically be created.

You can optionally provide the following keyword arguments:

============== ============================================================================================= =================================== ================
   Argument                                             Description                                                  Possible Values                 Default
============== ============================================================================================= =================================== ================
 ``type``       Sets the content type.                                                                        ``text/plain``, ``text/html``       ``text/plain``
 ``show_key``   If set to true, the template will render the textblock key for textblocks without a value.    ``False``, ``0``, ``True``, ``1``   ``False``
============== ============================================================================================= =================================== ================

The default value for the ``show_key``-option can be overriden with the
``TEXTBLOCKS_SHOWKEY = True``-setting.


