belug23 / django-epiced

EpicEditor implementation for django

warning DEPRECATION WARNING
This repository is no longer actively maintained.
======
EpicEd

EpicEd is a markdown field with the default widjet using EpicEditor.js http://epiceditor.com/

This plugin is made to keep a much as possible the possibilities to overide EpicEditor.js configurations the only settings you'll not be able to edit are 'container' and 'textarea' since they are rewriten by the wideget and are needed to save the data to the database.

Warning

Since Version 0.3.0 the html escaping of in markdown is now at true by default. If you want to add HTML tags in your content add 'safe_mode=False' in the field options. PLEASE becareful with that, do not disable html escaping in public fields.

Quick start

1. Install django-epiced :

   pip install django-epiced

2. Add it to your installed apps :

   INSTALLED_APPS = (
       ...
       'epiced',
   )

3. Use it in your model :

   from epiced.models import EpicEditorField
   
   class Post(models.Model):
       article = EpicEditorField()

4. Sync your database :

   python manage.py syncdb

5. Create an admin page or a form template.
6. Now you should have the EpicEditor in your admin and/or template.

7. To display the html version of the text in your template use :

   {{ post.article_html|safe }}

8. Enjoy a markdown editor that won't break your html!

Form more read the documentation at : http://django-epiced.readthedocs.org

Thanks

I'd like to thank John Gruber and Aaron Swartz.for the markdown language http://daringfireball.net/projects/markdown/

Thanks to Oscar Godson and John Donahue for EpicEditor : http://epiceditor.com/

Thanks to carljm creator of this snippet : http://djangosnippets.org/snippets/882/ used to complete the EpicEditorField

and Shaun Sephton for creating the django-ckeditor that inspired the widget associated with the field https://github.com/shaunsephton/django-ckeditor

History

0.4.3 :

- Updated support to Django 1.11

0.4.2 :

- Fixed issue #10 A leftover debugging print

0.4.1 :

- Fixed issue #9 that would prevent the settings config to override the default config

0.4.0 :

- Added support for Django 1.7
- Added support for Django 1.7 Migrations (Ugly patch)
- Added support for Python 3

0.3.1 :

- Updated to Epic Editor 0.2.2

0.3.0 :

*Warning, since it's so easy to use this pluggin I've changed the default
escaping of the HTML, Please refer to the documentation.*
- Security update : now html is escaped by default
- Added the automatic install of Markdown (Thanks daikeren for the patch)
- Added formsets support (Thanks szuliq for the bug repport)
- Added small test_site for debugging
- Updated documentation for the security update

0.2.1 :

Typo correction in the documentation

0.2.0 :

bug fixes: Double slashes in images url
Typos

0.1.0 :

First Release

django-epiced's Issues

Add buttons

I wish to add the buttons, but the creator of EpicEditor want's them too, so I'll check to add them to his repo insted.

__init__() got an unexpected keyword argument 'max_length'

File "/home/vagrant/.virtualenvs/gazex/local/lib/python2.7/site-packages/epiced/fields.py", line 59, in __init__
    super(EpicEditorFormField, self).__init__(*args, **kwargs)
TypeError: Error when calling the metaclass bases
    __init__() got an unexpected keyword argument 'max_length'

Version on Pypi is not 0.4.2

Fresh install from PyPi, getting the print issue supposedly resolved in 0.4.2

Add help section

Add an help section, a reminder of markdown markup.

Better doc for the field

There is some information about the field that is still not explain..

Adding the Field section to de Doc in configuration should Fix that.

JS variable names blow up

JS variable names blow up if EpicEdField is used in the formset. The field_id is not a safety JS variable name then.

See the comment for reference.

Makemigrations always displaying field info

When I am running makemigrations Django always displays

content django.db.models.TextField [] {}

Is it my error, or something to do with django-epiced?

Tables do not render correctly outside the editor

Tables are output in the original markdown output. when using {{ post.field_html|safe }}

|Provider|Account Name| |---|---| |Santander|123 Current Account| |Aldermore|1 Year Fixed Rate Bond (Issue 19)|

Automatic detection of the field to use?

I ask my self if it's possible to know if the value requested is for a field or for display in a template?

This could remove the use of "field_html" in the template.

DEFAULT_EPICEDITOR_CONFIG and EPICEDITOR_CONFIG ommited by epiceditor

I can't change default variables in config.py. DEFAULT_EPICEDITOR_CONFIG and EPICEDITOR_CONFIG are ommited and not used.