RailsTinyMCE 使用与技术文档

本文档将详细介绍如何安装、使用以及配置 RailsTinyMCE，这是一个适用于 Rails 应用的富文本编辑器。

1. 安装指南

1.1 Gemfile 中添加依赖

首先，在您的 Rails 应用的 Gemfile 中添加以下代码：

gem 'rails_tinymce'

然后执行以下命令来安装依赖：

$ bundle

或者您也可以手动安装：

$ gem install rails_tinymce

1.2 迁移数据库

接下来，运行以下迁移命令：

rails g tiny_migration
rake db:migrate

1.3 安装依赖的 Gem

确保以下 Gem 已安装：

• paperclip
• respond_to_parent
• will_paginate

2. 项目使用说明

2.1 布局中添加 JavaScript

在您的布局文件中，添加以下代码：

<%= javascript_include_tag :defaults %>
<%= javascript_include_tiny_mce_if_used %>
<%= tiny_mce if using_tiny_mce? %>

2.2 控制器配置

在您的控制器类顶部，添加以下代码：

uses_tiny_mce(options: AppConfig.default_mce_options, only: [:new, :edit])

AppConfig.default_mce_options 配置位于 config/initializers/tiny_mce_plus_config.rb 文件中，您可以在该文件中修改设置。

2.3 视图中设置文本域

在您的视图中，为文本域添加 mceEditor 类：

<%= f.text_area :description, :class => :mceEditor %>

2.4 安装文件列表

运行以下命令来安装文件列表：

rake rails_tiny_mce:install

这将在以下目录创建文件：

app
  |-- controller
    |-- attachments_controller.rb
  |-- helpers
    |-- remote_link_renderer.rb
  |-- models
    |-- print.rb
    |-- video.rb
  |-- views
    |-- attachments
       |-- _show_attachment_list.html.erb
config
  |-- initializers
    |-- tiny_mce_plus_config.rb
public
  |-- images
    |-- tiny_mce
  |-- javascripts
    |-- tiny_mce

您可以在 tiny_mce_plus_config.rb 中自定义配置。

3. 项目API使用文档

请参考项目 GitHub 仓库的 Wiki 部分，以获取详细的 API 使用文档。

4. 项目安装方式

请遵循以下步骤来安装 RailsTinyMCE：

1. 在 Gemfile 中添加 rails_tinymce 依赖。
2. 运行 bundle 命令安装依赖。
3. 执行数据库迁移。
4. 根据上述说明配置布局、控制器和视图。
5. 安装文件列表。

通过以上步骤，您将能够在您的 Rails 应用中成功集成并使用 RailsTinyMCE 富文本编辑器。