-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathREADME.rst
45 lines (31 loc) · 1.45 KB
/
README.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
*****
WARNING: This code is entirely unsupported, 0.9.0 will be the last
release of django-tinycontent.
*****
django-tinycontent is a simple Django application for re-usable
content blocks, much like django-boxes.
Installation is simple::
pip install django-tinycontent
Add ``tinycontent`` to your ``INSTALLED_APPS``.
Usage in templates is simple::
{% load tinycontent_tags %}
{% tinycontent_simple 'content_name' %}
Or, to specify a value if a content block by the given name cannot be
found, use::
{% load tinycontent_tags %}
{% tinycontent 'content_name' %}
This will be shown if no matching object is found.
{% endtinycontent %}
The name of the content block can also be a context variable, using
both the simple and the complex variants.
Content blocks themselves can be added and edited using Django's admin
interface. If a block with the name given in the template tag cannot
be found, either nothing is rendered (if using
``tinycontent_simple``), or the text between ``tinycontent`` and
``endtinycontent`` is rendered (if using the more complex variant).
To apply custom filters to your content, set ``TINYCONTENT_FILTER`` to
a dotted path to a callable that takes the raw content and returns the
transformed content. You can also set ``TINYCONTENT_FILTER`` to be a
list of dotted paths to callables, to chain filters together.
django-tinycontent supports all versions of Django from 2.0 to
3.0. Python 3.6, 3.7 and 3.8 are supported.