CMSPlugin-Filer 技术文档

本文档旨在帮助用户了解并使用 CMSPlugin-Filer 项目。以下是项目安装、使用说明以及 API 使用文档。

1. 安装指南

在开始使用 CMSPlugin-Filer 之前，请确保满足以下依赖条件：

• django-filer >= 1.2
• Django >= 1.8
• django-cms >= 3.1
• django-sekizai >= 0.4.2
• easy_thumbnails >= 1.0
• django-appconf
• djangocms-attributes-field

安装步骤如下：

1. 使用 pip 安装 CMSPlugin-Filer：

   $ pip install cmsplugin-filer
   

2. 根据 django-filer 文档 配置 django-filer。

3. 将以下插件添加到 INSTALLED_APPS：

   INSTALLED_APPS = (
       ...
       'cmsplugin_filer_file',
       'cmsplugin_filer_folder',
       'cmsplugin_filer_link',
       'cmsplugin_filer_image',
       'cmsplugin_filer_teaser',
       'cmsplugin_filer_video',
       ...
   )
   

4. 运行迁移命令 migrate。

您还可以在 settings.py 中设置 FILER_IMAGE_USE_ICON，以配置 cmsplugin_filer_image 插件使用 32x32 图标表示插件实例。

2. 项目的使用说明

CMSPlugin-Filer 提供了一组用于替换 django-cms 默认插件的插件，这些插件使用 django-filer 的文件字段。

升级到版本 1.1 时，需要注意以下向后不兼容的更改：

迁移布局

迁移文件已移回到标准位置。cmsplugin_filer 1.1 中必须删除与 cmsplugin_filer 相关的 MIGRATION_MODULE 设置项。

删除 ThumbnailOption 模型

ThumbnailOption 已移动到 filer（自 filer 1.2 版本起）。您必须更新引用 ThumbnailOption 的模型和迁移。

model.py

添加以下内容：

try:
    from filer.models import ThumbnailOption
    thumbnail_model = 'filer.ThumbnailOption'
except ImportError:
    from cmsplugin_filer_image.models import ThumbnailOption
    thumbnail_model = 'cmsplugin_filer_image.ThumbnailOption'

Django 1.7+ 迁移

对于每个引用 ThumbnailOption 的迁移文件，添加以下导入：

from myapp.models import thumbnail_model

并将所有 'cmsplugin_filer_image.ThumbnailOption' 替换为 thumbnail_model。

South 迁移

在每个迁移文件中添加以下导入：

from myapp.models import thumbnail_model

并将所有 'cmsplugin_filer_image.ThumbnailOption' 替换为 thumbnail_model，以及将 u"orm['cmsplugin_filer_image.ThumbnailOption']" 替换为 u"orm['%s']" % thumbnail_model。

3. 项目 API 使用文档

本项目未提供详细的 API 文档。建议直接查看项目代码和源文件以获取 API 使用信息。

4. 项目安装方式

如前所述，项目的安装方式是通过 pip 安装：

$ pip install cmsplugin-filer

请按照上述指南操作以确保项目正确安装。

---

本文档基于项目 README 和 GitHub 项目 Wiki 编写，以帮助用户更好地了解和使用 CMSPlugin-Filer 项目。