Intuitive text editing for the Django Admin.
Project description
:warning: This project is in early development and has bugs, contribution is welcome.
# django-text
Intuitive text editing for the Django Admin.
## Installation
Install the package with pip.
```shell
$ pip install django-text
```
Add `text` to your installed packages.
```python
# settings.py
INSTALLED_APPS = (
# ...
'text',
)
```
Add `text.middleware.TextMiddleware` to your middleware.
```python
# settings.py
MIDDLEWARE = (
# ...
'text.middleware.TextMiddleware',
)
```
Run `migrate`.
```shell
$ python manage.py migrate
```
## Usage
### The `editable` tag
Add `editable` tags to your templates.
```html
<h1>{% editable "header" "My Header" %}</h1>
<div class="content">
{% editable "text_body" %}
</div>
```
The `editable` tag takes a default text as the second argument.
If no default text is passed, the name of the text node (i.e. the first argument)
will be used if there is no corresponding text node in the database.
### The `blockeditable` tag
You can also use the `blockeditable` tag that let's you wrap content to use
as the default text.
```html
<div class="content">
<h1>
{% blockeditable "header" %}
Read My Awesome Text
{% endblockeditable %}
</h1>
{% blockeditable "content" %}
Put your default text here!
{% endblockeditable %}
</div>
```
The `blockeditable` tags works with translation tags inside of it. So if you already
have a translated site, you can wrap your content with this tag and only
add text nodes for some of the languages that you support.
### Content editing
Now add text nodes with the corresponding names in the Django Admin. Currently raw text and [markdown](http://daringfireball.net/projects/markdown/) is supported.
Missing text nodes will be added to the database automatically when their
template tags are rendered. Blocktags will be added with their default
text and inline tags will be added with the name of the node as the text content.
To disable automatic updating of missing text nodes add the following to your settings.
```python
AUTOPOPULATE_TEXT = False
```
## License
Copyright (c) 2015 Anton Agestam. django-text is released under the MIT license.
See the LICENSE file for more information and licenses for bundled code.
# django-text
Intuitive text editing for the Django Admin.
## Installation
Install the package with pip.
```shell
$ pip install django-text
```
Add `text` to your installed packages.
```python
# settings.py
INSTALLED_APPS = (
# ...
'text',
)
```
Add `text.middleware.TextMiddleware` to your middleware.
```python
# settings.py
MIDDLEWARE = (
# ...
'text.middleware.TextMiddleware',
)
```
Run `migrate`.
```shell
$ python manage.py migrate
```
## Usage
### The `editable` tag
Add `editable` tags to your templates.
```html
<h1>{% editable "header" "My Header" %}</h1>
<div class="content">
{% editable "text_body" %}
</div>
```
The `editable` tag takes a default text as the second argument.
If no default text is passed, the name of the text node (i.e. the first argument)
will be used if there is no corresponding text node in the database.
### The `blockeditable` tag
You can also use the `blockeditable` tag that let's you wrap content to use
as the default text.
```html
<div class="content">
<h1>
{% blockeditable "header" %}
Read My Awesome Text
{% endblockeditable %}
</h1>
{% blockeditable "content" %}
Put your default text here!
{% endblockeditable %}
</div>
```
The `blockeditable` tags works with translation tags inside of it. So if you already
have a translated site, you can wrap your content with this tag and only
add text nodes for some of the languages that you support.
### Content editing
Now add text nodes with the corresponding names in the Django Admin. Currently raw text and [markdown](http://daringfireball.net/projects/markdown/) is supported.
Missing text nodes will be added to the database automatically when their
template tags are rendered. Blocktags will be added with their default
text and inline tags will be added with the name of the node as the text content.
To disable automatic updating of missing text nodes add the following to your settings.
```python
AUTOPOPULATE_TEXT = False
```
## License
Copyright (c) 2015 Anton Agestam. django-text is released under the MIT license.
See the LICENSE file for more information and licenses for bundled code.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django-text-1.3.0.tar.gz
(86.8 kB
view hashes)
