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.
This commit is contained in:
Peter Farrell 2014-07-30 12:20:59 -05:00
parent a61a5b48e1
commit 8cd18af3f2
1 changed files with 8 additions and 0 deletions

View File

@ -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
--------------------