Add documentation

This commit is contained in:
Iacopo Spalletti 2014-05-17 16:17:12 +02:00
parent 3a9a98e66a
commit 3e41c226a3
1 changed files with 72 additions and 15 deletions

View File

@ -85,10 +85,78 @@ You can override the setting ``CKEDITOR_SETTINGS`` in your settings.py::
'skin': 'moono',
}
This is the default dict that holds all **CKEditor** settings. If you want to
use the CKEditor in your own models, then use the ``HTMLField`` from
``djangocms_text_ckeditor.fields`` and replace ``'toolbar': 'CMS'`` with
``'toolbar': 'HTMLField'`` in the above settings, in order to add an
This is the default dict that holds all **CKEditor** settings.
Customizing plugin editor
#########################
To customize the plugin editor, use `toolbar_CMS` attribute, as in::
CKEDITOR_SETTINGS = {
'language': '{{ language }}',
'toolbar_CMS': [
['Undo', 'Redo'],
['cmsplugins', '-', 'ShowBlocks'],
['Format', 'Styles'],
]
'skin': 'moono',
}
Customizing HTMLField editor
############################
If you use ``HTMLField`` from ``djangocms_text_ckeditor.fields`` in your own
models, use `toolbar_HTMLField` attribute::
CKEDITOR_SETTINGS = {
'language': '{{ language }}',
'toolbar_HTMLField': [
['Undo', 'Redo'],
['ShowBlocks'],
['Format', 'Styles'],
]
'skin': 'moono',
}
You can further customize each `HTMLField` field by using different
configuration parameter in your settings::
models.py
class Model1(models.Model):
text = HTMLField(configuration='CKEDITOR_SETTINGS_MODEL1')
class Model2(models.Model):
text = HTMLField(configuration='CKEDITOR_SETTINGS_MODEL2')
settings.py
CKEDITOR_SETTINGS_MODEL1 = {
'toolbar_HTMLField': [
['Undo', 'Redo'],
['ShowBlocks'],
['Format', 'Styles'],
['Bold', 'Italic', 'Underline', '-', 'Subscript', 'Superscript', '-', 'RemoveFormat'],
]
}
CKEDITOR_SETTINGS_MODEL2 = {
'toolbar_HTMLField': [
['Undo', 'Redo'],
['Bold', 'Italic', 'Underline', '-', 'Subscript', 'Superscript', '-', 'RemoveFormat'],
]
}
#. Add `configuration='MYSETTING'` to the `HTMLField` usage(s) you want to
customize;
#. Define a setting parameter named as the string used in the `configuration`
argument of the `HTMLField` instance with the desidered configuration;
Values not specified in your custom configuration will be taken from the global
``CKEDITOR_SETTINGS``.
For an overview of all the available settings have a look here:
@ -134,17 +202,6 @@ And use it in your models, just like a ``TextField``::
class MyModel(models.Model):
myfield = HTMLField(blank=True)
Configurable settings
*********************
When using ``HTMLField``, you can customize the ckeditor configuration for each
field::
class MyModel(models.Model):
myfield = HTMLField(blank=True, configuration='CKEDITOR_SETTINGS_MYMODEL')
and define a ``CKEDITOR_SETTINGS_MYMODEL`` parameter in project settings; values
not specified in your custom configuration will be taken from the global ``CKEDITOR_SETTINGS``.
Extending the plugin
--------------------