django-ckeditor-updated 4.4.4

Django CKEditor
===============
* riklaunim / django-ckeditor 在PyPi上作为 https://pypi.python.org/pypi/django-ckeditor-updated - 最新代码，与最新Django版本兼容
* shaunsephton / django-ckeditor 在PyPi上作为 https://pypi.python.org/pypi/django-ckeditor - 仍然是旧版本，与较新版本的Django不兼容


**这个分支，django-ckeditor-updated，与旧的django ckeditor的配置不同。我所有的更改最近都已合并到shaunsephton存储库
但它们尚未作为包发布。在django-ckeditor不会获得新的和持续的发布之前，我将维护这个分支。***


**Django admin CKEditor集成。**
提供利用CKEditor的`RichTextField`和`CKEditorWidget`，包含图像上传和浏览支持。

* 这个版本还包括
#. 支持django-storages（与S3兼容）
#. 将ckeditor更新到版本4.4
#. 包含所有ckeditor语言文件，让每个人都满意！

.. 目录 :: 目录
:depth: 5

安装
------------

要求
~~~~~~~~
#. 安装或添加django-ckeditor-updated到您的python路径。注意：您可能无法同时安装原始django-ckeditor和django-ckeditor-updated。

#. 将`ckeditor`添加到您的`INSTALLED_APPS`设置。

#. 将CKEDITOR_UPLOAD_PATH设置添加到项目的`settings.py`文件。此设置指定了CKEditor媒体上传目录的相对路径。CKEditor使用Django存储API。默认情况下，Django使用文件系统存储后端（它将使用您的MEDIA_ROOT和MEDIA_URL），如果您不使用不同的后端，您必须在MEDIA_ROOT中具有CKEDITOR_UPLOAD_PATH路径的写入权限，即：


CKEDITOR_UPLOAD_PATH = "uploads/"

对于默认文件系统存储，图像将上传到您的MEDIA_ROOT中的“uploads”文件夹，并且URL将针对MEDIA_URL（/media/uploads/image.jpg）创建。

CKEditor已经与django FileSystemStorage和S3BotoStorage进行了测试。
使用django-storages中的S3Storage存在问题。

#. 运行``collectstatic``管理命令：``$ /manage.py collectstatic``。这将复制静态CKEditor所需的媒体资源到由``STATIC_ROOT``设置指定的目录。有关更多信息，请参阅`Django管理静态文件文档 <https://docs.django.ac.cn/en/dev/howto/static-files>`_。

#. 将CKEditor URL包含到项目的``urls.py``文件中：

(r'^ckeditor/', include('ckeditor.urls')),

#. 将``CKEDITOR_IMAGE_BACKEND``设置为支持的任何后端以启用ckeditor画廊中的缩略图。默认情况下不会创建缩略图，而是使用完整大小的图像作为预览。支持的后端

- ``pillow``：使用PIL或Pillow

#. django-ckeditor在ckeditor-init.js文件中使用jQuery。您必须设置``CKEDITOR_JQUERY_URL``为将用于加载库的jQuery URL。如果您已从不同来源加载jQuery，则只需不要设置此变量，django-ckeditor将不会尝试加载其自己的jQuery。示例：

CKEDITOR_JQUERY_URL = '//ajax.googleapis.ac.cn/ajax/libs/jquery/2.1.1/jquery.min.js'


可选
~~~~~~~~
#. 默认情况下，所有上传的文件都会被slugify，要禁用此功能，请将``CKEDITOR_UPLOAD_SLUGIFY_FILENAME``设置为``False``

#. 在项目的``settings.py``文件中将``CKEDITOR_RESTRICT_BY_USER``设置为``True``（默认为``False``）。这将限制对上传图像的访问，仅允许上传用户（例如，每个用户只能查看和上传自己的图像）。超级用户仍可以查看所有图像。**注意**：此限制仅在CKEditor媒体浏览器内强制执行。

#. 将CKEDITOR_CONFIGS设置添加到项目的``settings.py``文件中。这指定了传递给CKEditor的CKEditor设置集（请参阅CKEditor的`设置配置 <http://docs.cksource.com/CKEditor_3.x/Developers_Guide/Setting_Configurations>`_），例如：

CKEDITOR_CONFIGS = {
'awesome_ckeditor': {
'toolbar': 'Basic',
},
}

当实例化RichTextField时可以引用设置名称：

content = RichTextField(config_name='awesome_ckeditor')

当实例化CKEditorWidget时可以引用设置名称：

widget = CKEditorWidget(config_name='awesome_ckeditor')

通过指定名为``default``的集合并将其应用于所有未显式定义``config_name``的RichTextField和CKEditorWidget对象：

CKEDITOR_CONFIGS = {
'default': {
'toolbar': 'Full',
'height': 300,
'width': 300,
},
}


用法
-----

字段
~~~~~
为模型添加富文本编辑功能的最快方法是使用包含的``RichTextField``模型字段类型。CKEditor小部件作为表单字段渲染，但在所有其他方面，字段的行为与标准Django ``TextField``相同。例如：

from django.db import models
from ckeditor.fields import RichTextField

class Post(models.Model)
content = RichTextField()


小部件
~~~~~~
作为替代，您可以使用包含的``CKEditorWidget``作为表单字段的控件。例如：

from django import forms
from django.contrib import admin
from ckeditor.widgets import CKEditorWidget

from post.models import Post

class PostAdminForm(forms.ModelForm)
content = forms.CharField(widget=CKEditorWidget())
class Meta
model = Post

class PostAdmin(admin.ModelAdmin)
form = PostAdminForm

admin.site.register(Post, PostAdmin)

管理命令
~~~~~~~~~~~~~~~~~~
包含一个管理命令来为包含在``CKEDITOR_UPLOAD_PATH``中的图像创建缩略图。这对于在使用django-ckeditor时创建现有图像的缩略图非常有用。按以下方式发出命令：

$ ./manage.py generateckeditorthumbnails

**注意**：如果您使用自定义视图，请记住在表单的媒体中包含ckeditor.js，无论是通过``{{ form.media }}``还是通过``<script>``标签。管理员会自动为您这样做。有关更多信息，请参阅`Django表单媒体文档 <https://docs.django.ac.cn/en/dev/topics/forms/media/>`_。

使用S3
~~~~~~~~
请参阅http://django-storages.readthedocs.org/en/latest/


如果您想使用allowedContent
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
要使allowedContent工作，请禁用**stylesheetparser**插件。
请在 settings.py 中包含以下内容。

CKEDITOR_CONFIGS = {
"default": {
"removePlugins": "stylesheetparser",
}
}


示例 / 测试应用
~~~~~~~~~~~~~~~~~~~~~~~
如果您克隆了仓库，您将能够运行 ``ckeditor_demo`` 应用程序。

#. ``pip install -r ckeditor_demo_requirements.txt``

#. 运行 ``python.manage.py syncdb``

#. 如果您想测试管理面板中的小部件，请创建超级用户

#. 启动开发服务器。

主页（/）上有一个 forms.Form，管理中有一个使用该小部件的模型。
数据库设置为 sqlite3，STATIC/MEDIA_ROOT 设置为临时目录中的文件夹。


运行 selenium 测试
~~~~~~~~~~~~~~~~~~~~~

您可以使用 ``python manage.py test ckeditor_demo``（仅用于仓库检出）或使用 ``tox`` 运行测试，它已配置为与 Python 2.7 和 3.3 一起运行。
（您可能需要在 selenium webdriver for Python 3.3 中修复一些导入）。
作者
=======


此分支
----------
#. `riklaunim <https://github.com/riklaunim>`_


创建者
----------
#. `shaunsephton <http://github.com/shaunsephton>`_


贡献者
------------
#. `3point2 <https://github.com/3point2>`_
#. `buchuki <http://github.com/buchuki>`_
#. `chr15m <http://github.com/chr15m>`_
#. `hedleyroos <https://github.com/hedleyroos>`_
#. `jeffh <https://github.com/jeffh>`_
#. `lihan <https://github.com/lihan>`_
#. `loop0 <http://github.com/loop0>`_
#. `mwcz <https://github.com/mwcz>`_
#. `tomwys <https://github.com/tomwys>`_
#. `snbuback <https://github.com/snbuback>`_
#. 以及其他人 `<https://github.com/**/django-ckeditor/graphs/contributors>`_
变更日志
=========

4.4.4
-----
#. 将 CKEditor 更新到 4.4.4 全套包 - 包含您可能需要的所有插件和静态文件
#. 内联编辑器的修复
#. 编辑器初始化使用 jQuery。您需要指定 CKEDITOR_JQUERY_URL 才能使其正常工作。您可以使用：

CKEDITOR_JQUERY_URL = '//ajax.googleapis.ac.cn/ajax/libs/jquery/2.1.1/jquery.min.js'


4.4.0
-----
#. 将 CKEditor 更新到 4.4.1
#. Django 1.7 兼容性修复

4.2.8
-----
#. 将 CKEditor 更新到 4.3.3

4.2.7
-----
#. 如果文件名中只提供了无效字符，则修复了将文件名转换为缩写名到空文件名的错误。使用随机字符串作为后备。
#. 在 ckeditor 文件浏览器中不要使用非图像文件的 IMG 标签。
#. 从破坏 collectstatic 的 CSS 文件中删除不存在的图像引用。
#. 其他修复

4.2.5 / 4.2.6
-------------
#. 修复了静态文件安装 - 从 distutils 切换到 setuptools

4.2.4
-----
#. 添加了新的带有 selenium 集成测试的示例应用程序
#. 为 Python 3.3 和 2.7 测试设置 tox
#. 将图像处理提取到后端。PIL/Pillow 现在是可选的。可以添加其他后端。
#. 修复了缩略图生成中的错误

4.2.3
-----
#. Python 3.3 兼容性
#. 默认将所有上传的文件转换为缩写名（新设置 CKEDITOR_SLUGIFY_FILENAME）
#. 现在编辑链接（<a href>）时上传文件可以正常工作

4.2.2
-----
#. widgets.py 中的 Python 3.3 兼容性

4.2.1
-----
#. 包含 CKEditor 版本 4.2.1。
#. 支持 Django 1.6

4.0.2
-----
#. 包含 CKEditor 版本 4.0.2。

3.6.2.1
-------
#. 从发行版中删除不想要的静态文件。
#. 使用 Pillow 而不是 PIL，因为它可以在所有系统上构建。

3.6.2
-----
#. 包含 CKEditor 版本 3.6.2。
#. 开始 Django 对齐主题的初步工作。
#. 修复了在生成媒体 URL 时移除斜杠的方案问题。感谢 `mwcz <https://github.com/mwcz>`_
#. 添加了对 South 的兼容性。感谢 `3point2 <https://github.com/3point2>`_
#. 防止设置在小部件实例之间泄露。感谢 `3point2 <https://github.com/3point2>`_
#. 修复了使用 verbose_name 作为字段第一个位置参数时的 config_name 冲突。感谢 `3point2 <https://github.com/3point2>`_
#. 重构了视图以允许使用本地路径的文件遍历。感谢 `3point2 <https://github.com/3point2>`_
#. 添加了生成缩略图的命令。感谢 `3point2 <https://github.com/3point2>`_
#. 从使用媒体迁移到静态文件管理。

0.0.9
-----

#. 增加通过 CKEDITOR_CONFIGS 设置配置 CKeditor 的功能。感谢 `jeffh <https://github.com/jeffh>`_ 提供的反馈。

0.0.8
-----

#. 移除了有问题的 URL 包含检查。

0.0.7
-----
#. 修正 Egg 包以排除测试 admin.py 和 models.py。

0.0.6
-----
#. 强制正确的配置。
#. 改变上传行为，根据上传日期将文件分开到目录中。感谢 `loop0 <http://github.com/loop0>`_ 。
#. 增加限制用户访问上传内容的权限功能（参见 CKEDITOR_RESTRICT_BY_USER 设置）。感谢 `chr15m <http://github.com/chr15m>`_ 提供的反馈。
#. 添加了必需的初始测试集。
#. 通用清理，轻微重构。

0.0.5
-----
#. csrf_exempt 向后兼容。感谢 `chr15m <http://github.com/chr15m>`_ 。

0.0.4
-----
#. 包含资源，对此表示歉意。

0.0.3
-----
#. 更健壮的 PIL 导入。感谢 `buchuki <http://github.com/buchuki>`_ 。
#. 更好的 CKEDITOR_MEDIA_PREFIX 设置错误。

0.0.2
-----
#. 在清单中包含 README.rst。

0.0.1
-----
#. 添加 CKEDITOR_UPLOAD_PREFIX 设置。感谢 `chr15m <http://github.com/chr15m>`_ 提供的反馈。