From 8cd18af3f264afd1203c60e4933efe4dd3f425fe Mon Sep 17 00:00:00 2001 From: Peter Farrell Date: Wed, 30 Jul 2014 12:20:59 -0500 Subject: [PATCH] DOCO: Added information about usage of HTMLField Spent quite a bit of time trying to figure out why additional plugins were showing up inside the text editor when using HTMLField. Found out it isn't supported when using this field in this issue: https://github.com/divio/djangocms-text-ckeditor/issues/72 Decided that I'm not the first person to run into this question, so I'm documenting it for future reference. --- README.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.rst b/README.rst index b38d60d..bd5836b 100644 --- a/README.rst +++ b/README.rst @@ -202,6 +202,14 @@ And use it in your models, just like a ``TextField``:: class MyModel(models.Model): myfield = HTMLField(blank=True) +This field does not allow you to embed any other CMS plugins within the text editor. Plugins can only be embedded +within ``Placeholder`` fields. + +If you need to allow additional plugins to be embedded in a HTML field, convert the ``HTMLField`` to a ``Placeholderfield`` +and configure the placeholder to only accept TextPlugin. For more information on using placeholders outside of the CMS see: + +http://django-cms.readthedocs.org/en/latest/extending_cms/placeholders.html + Extending the plugin --------------------