Front end editing for Django.
Project description
Django-Front-Edit
Description
A front end editing app for Django. This app allows one to edit dynamic data on the front end of a website when logged in as a staff member. The app allows the editing of dynamic content within any element (See Example below).
Installation
You must have setuptools installed.
From PyPI:
pip install django_front_edit
Or download a package from the PyPI or the BitBucket page:
pip install <package>
Or unpack the package and:
python setup.py install.
Dependencies
Django >= 1.4 and its dependencies.
beautifulsoup4 >= 4.3.2 located at: http://www.crummy.com/software/BeautifulSoup/ or https://pypi.python.org/pypi/beautifulsoup4/.
django-classy-tags >= 0.5.1 located at: https://github.com/ojii/django-classy-tags or https://pypi.python.org/pypi/django-classy-tags.
and either one of the following: (see FRONT_EDIT_HTML_PARSER setting below)
html5lib >= 0.999, != 0.9999, != 1.0b5, != 0.99999, != 1.0b6 located at: https://github.com/html5lib/html5lib-python or https://pypi.python.org/pypi/html5lib.
lxml located at: https://github.com/lxml/lxml or https://pypi.python.org/pypi/lxml
Integration
In your Django settings.py file insert the following in an appropriate place:
...
# for django >1.4 <1.8
TEMPLATE_CONTEXT_PROCESSORS = [
'django.contrib.auth.context_processors.auth',
...
'django.core.context_processors.request',
...
'front_edit.context_processors.defer_edit'
]
# or for django >1.8
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [],
'OPTIONS': {
'context_processors': [
'django.contrib.auth.context_processors.auth',
...
'django.template.context_processors.request',
...
'front_edit.context_processors.defer_edit'
]
}
}
]
...
INSTALLED_APPS = [
...
'django.contrib.contenttypes',
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.sessions',
...
'front_edit',
...
]
...
In your main urls.py file:
...
url(r'', include('front_edit.urls')),
...
There is nothing to syncdb or migrate.
Usage
This app uses template tags for all its functionality.
JavaScript
There is one command that you can call if you need to reposition the edit elements. You should call this if any JavaScript will change the offset of in-flow elements.
djangoFrontEdit.refresh();
Example
pagelet_text.html
{% load front_edit_tags %}
<div class="pagelet pagelet-text" {% edit_hint instance "title,content" "class_name" %}>
<div class="title">
{{ instance.title }}
</div>
<div class="richtext">
{{ instance.content|safe }}
</div>
</div>
pagelet_image.html
{% load front_edit_tags %}
<div class="pagelet pagelet-image" {% edit_hint instance "image,caption" "class_name" %}>
<div class="image">
<img src="{{ instance.image.url }}"/>
<div class="caption">
{{ instance.caption }}
</div>
</div>
</div>
somepage.html
{% load front_edit_tags pagelet_tags %}
<!DOCTYPE html>
<html>
<head></head>
<body>
<div>
<!-- In a list -->
<ul>
{% for object in objects %}
{% edit object.text_field object.char_field "class_name" %}
<li>
<span>{{ object.text_field }}</span>
<span>{{ object.char_field }}</span>
</li>
{% endedit %}
{% endfor %}
</ul>
<!-- In a table -->
<table>
<tbody>
<tr>
{% for object in objects %}
{% edit object.text_field object.char_field "class_name" %}
<td>
<span>{{ object.text_field }}</span>
<span>{{ object.char_field }}</span>
</td>
{% endedit %}
{% endfor %}
</tr>
</tbody>
</table>
</div>
<!-- in a pagelet system -->
<div>
{% edit_with_hints %}
{% render_pagelets object.pagelets %}
{% endedit_with_hints %}
</div>
<div>
<!-- On a span -->
{% edit object.text_field "class_name" %}
<span>{{ object.text_field }}</span>
{% endedit %{
</div>
{% edit_loader %}
</body>
</html>
Advanced
Settings
Settings can be set by using the individual settings or by specifying a dictionary as follows:
FRONT_EDIT_SETTINGS = {
'CUSTOM_FIELDS':['path.to.custom.field'],
...
'USE_HINTS':True,
}
FRONT_EDIT_CUSTOM_FIELDS
Default: []
A list of dot-separated paths to a custom model field such as a rich text field or file field that has a Media class on its widget.
FRONT_EDIT_DEFER_KEY
Default: ‘__front_edit_defer’
The context key used to defer display of the collective editable loader templates.
FRONT_EDIT_EDITABLE_TEMPLATE
Default: ‘front_edit/includes/editable.html’
This template is the editable. Which includes the form, edit button, and overlay.
FRONT_EDIT_HTML_PARSER
Default: ‘html5lib’
Change the html parser used by beautifulsoup. By default we use ‘html5lib’, but we also support ‘lxml’. You will have to install either of those libraries. We do not support the builtin ‘html.parser’ library due to incompatibilities.
FRONT_EDIT_INLINE_EDITING_ENABLED
Default: True
Option to disable inline editing.
FRONT_EDIT_JQUERY_BACKUP
Default: ‘front_edit/js/jquery.min.js’
The path to the static jquery backup library if the CDN is down. The value is passed through the static tag.
FRONT_EDIT_JQUERY_BUILTIN
Default: True
Whether or not to use the builtin jquery library or rely on the library already being present in the final document.
FRONT_EDIT_JQUERY_CDN
Default: ‘//ajax.googleapis.com/ajax/libs/jquery/’
The url to the CDN to use for jquery. The version and file name are appended. i.e. path/1.11.2/jquery.min.js
FRONT_EDIT_JQUERY_VERSION
Default: ‘1.11.2’
The default version of jquery to fetch from the CDN.
FRONT_EDIT_LOADER_TEMPLATE
Default: ‘front_edit/loader.html’
This template is the main boilerplate.
FRONT_EDIT_LOGOUT_URL_NAME
Default: ‘admin:logout’
Set the name of the logout url.
FRONT_EDIT_TOOLBAR_TEMPLATE
Default: ‘front_edit/includes/toolbar.html’
This template is the admin toolbar.
FRONT_EDIT_USE_HINTS
Default: False
Whether or not to activate the use of EditHint tags.
FRONT_EDIT_VIGENERE_KEY
Default: None
A vigenere key used to obfuscate edit hints. Optional.
Custom Media and JS variables
If the FRONT_EDIT_CUSTOM_FIELDS setting doesn’t satisfy your needs you will need to do the following.
Change FRONT_EDIT_LOADER_TEMPLATE to your own template, it should have a different name than ‘front_edit/loader.html’.
In your template extend ‘front_edit/loader.html’.
Use the block ‘ft_extra’ to set or run javascript code. No script tags are needed.
Use the block ‘ft_extra_media’ to define media such as CSS or JS files.
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
File details
Details for the file django-front-edit-1.2.1.tar.gz.
File metadata
- Download URL: django-front-edit-1.2.1.tar.gz
- Upload date:
- Size: 61.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6cd4d74c23b996847d2f91aeb6cb696664a23382bddf0175af10349b87e941ec |
|
| MD5 | 07740e5579fd66e55794355b1c515f45 |
|
| BLAKE2b-256 | 17486e03a38e91bb6a8ffe11499af7b521c24bdd7eca395c973ed83d3638c436 |
