Rich 项目技术文档

1. 安装指南

Rich 是一个基于 CKEditor 的 Rails 插件，适用于 Rails 3.2 及以上版本。它提供了一个简化的工具栏、对话框以及自定义文件管理器。文件管理器也可以独立于 CKEditor 使用。

1.1 安装步骤

1. 在 Gemfile 中添加 Rich 的依赖：

   gem 'rich'
   

   如果你想使用 Paperclip 进行文件上传，还需要添加：

   gem 'paperclip'
   

   如果你想使用 CarrierWave，添加：

   gem 'carrierwave'
   

2. 更新你的 bundle：

   bundle install
   

3. 运行 Rich 的安装生成器：

   rails generate rich:install
   

   该命令会生成路由、初始化配置文件、添加 JavaScript 和 CSS 文件，并创建一个数据库迁移文件。

4. 运行数据库迁移：

   rake db:migrate
   

5. 在 config/initializers/rich.rb 中设置文件管理器的认证方法。例如，如果你使用 Devise 并有一个 AdminUser 模型：

   config.authentication_method = :authenticate_admin_user!
   

2. 项目的使用说明

2.1 在 Formtastic 中使用 Rich

确保 Rich 的 JavaScript 文件已加载。默认情况下，Rails 会自动加载所有 JavaScript 文件。如果你移除了 require_tree .，则需要手动加载 Rich：

//= require rich

在 Formtastic 表单中使用 :as => :rich 来插入 Rich 编辑器：

<%= semantic_form_for @post do |f| %>
  <%= f.inputs do %>
    <%= f.input :name %>
    <%= f.input :title %>
    <%= f.input :featured_image, :as => :rich_picker %>
    <%= f.input :body, :as => :rich, :config => { :default_style => "myCrazyPaperclipStyle" } %>
  <% end %>
  <%= f.buttons do %>
    <%= f.commit_button %>
  <% end %>
<% end %>

2.2 在 Active Admin 中使用 Rich

Active Admin 使用 Formtastic，因此可以直接使用 Rich。确保在 app/assets/javascripts/active_admin.js 中加载 Rich：

//= require rich

在模型配置文件中设置表单：

form do |f|
  f.inputs "Basic info" do
    f.input :title
    f.input :featured_image, :as => :rich_picker, :config => { :style => 'width: 400px !important;' }
    f.input :body, :as => :rich, :config => { :width => '76%', :height => '400px' }
  end
  f.buttons
end

2.3 在 Rails Admin 中使用 Rich

从 Rails Admin 1.4.7 开始，用户需要手动创建 assets/javascripts/rails_admin/custom/ui.js 并加载 Rich：

//= require rich/base

在初始化文件中配置 Rich：

config.model Post do
  edit do
    field :title
    field :body, :rich_editor do
      config({
        :insert_many => true
      })
    end
  end
end

3. 项目 API 使用文档

3.1 文件管理器配置

文件管理器可以通过 rich_picker 使用。以下是一些常用的配置选项：

• :hidden_input => true：隐藏文本字段，适用于创建关联时。
• :preview_size => '100px'：指定图片预览的尺寸。
• :placeholder_image => image_path('placeholder.png')：显示占位符图片。

3.2 非图片文件上传

在 config/initializers/rich.rb 中启用非图片文件上传：

config.allow_document_uploads = true
config.allowed_document_types = ['application/pdf']

3.3 媒体嵌入

启用媒体嵌入功能：

config.allow_embeds = true

4. 项目安装方式

Rich 提供了多种安装方式，具体如下：

4.1 通过 Gem 安装

在 Gemfile 中添加 Rich 的依赖，并运行 bundle install 进行安装。

4.2 通过 Git 安装

如果你想使用最新的开发版本，可以通过 Git 安装：

gem 'rich', :git => 'https://github.com/kreativgebiet/rich.git'

4.3 手动安装

如果你不想使用 Gem，可以手动下载 Rich 的源代码，并将其放入你的 Rails 项目中。然后按照上述步骤进行配置。

5. 配置与覆盖

Rich 提供了丰富的配置选项，你可以在 config/initializers/rich.rb 中进行自定义。例如，你可以配置 CKEditor 的工具栏、图片处理选项等。

5.1 本地化

Rich 会自动使用当前设置的 locale (I18n.locale) 来本地化编辑器和文件浏览器。

5.2 图片配置与重新处理

你可以在初始化文件中定义图片样式。如果更改了样式，需要重新处理已上传的文件：

rake rich:refresh_assets

6. 生产模式

Rich 在生产模式下也能正常工作。在预编译资源时，Rich 会自动处理 CKEditor 的源文件：

rake assets:precompile

清理资源时，Rich 也会清理 CKEditor 的文件：

rake assets:clean

7. 总结

Rich 是一个功能强大且易于定制的 CKEditor 实现，适用于 Rails 项目。通过简单的配置，你可以轻松地将 Rich 集成到你的应用中，并享受其提供的丰富功能。