Irwi 技术文档

本文档将详细介绍如何安装、使用及配置 Irwi 插件，该插件为 Ruby on Rails 4 应用程序提供维基功能。

1. 安装指南

在您的 Gemfile 文件中添加以下内容：

gem 'irwi', :git => 'git://github.com/alno/irwi.git'

然后在您的应用程序目录中执行以下命令：

rails g irwi_wiki

此命令将生成以下文件：

• WikiPageController：用于服务维基页面
• WikiPage：表示页面的模型
• 数据库迁移文件

同时，它将在您的 routes.rb 文件中添加类似以下内容：

wiki_root '/wiki'

2. 项目使用说明

维基语法

您可以通过以下方式在文本中链接其他页面：

[[某个页面标题]]

如果链接的页面存在，它将被替换为指向该页面的链接；如果不存在，它将被替换为指向新页面的链接。

模板定义

您可以创建自己的控制器动作模板（show、edit 和 history），如果不自定义，将使用内置的默认模板。

辅助方法定义

以下辅助方法默认被定义，您可以用自己的方法替换它们：

• wiki_user：根据给定的用户对象渲染用户名或链接。默认情况下，对于 nil，它渲染 <Unknown>，对于其他用户，渲染 "User#{user.id}"。

配置

配置选项可以通过 Irwi.config 对象访问。目前支持的选项有：

• user_class_name：用户模型类的名称。默认为 'User'。

• formatter：在输出之前处理维基内容的格式化器实例（见下文）。

• paginator：显示分页控制的分页器实例（见下文）。

• comparator：构建并渲染两个文本之间的更改集合的比较器实例。默认使用 Irwi::Comparators::DiffLcs。

格式化器

Irwi 支持自定义格式化器，可以通过设置 Irwi.config.formatter 为相应的实例来配置。每个格式化器都应该有一个 format 方法，它接收一个字符串并返回格式化后的字符串。

以下是一些基于不同宝石的支持的格式化器（您应该将它们添加到应用程序的 Gemfile 中）：

• Irwi::Formatters::RedCloth：基于 RedCloth 宝石的 Markdown 格式化器。
• Irwi::Formatters::RedCarpet：基于 redcarpet 宝石的 Markdown 格式化。
• Irwi::Formatters::BlueCloth：基于 BlueCloth 宝石的 Textile 格式化。
• Irwi::Formatters::WikiCloth：基于 wiki_cloth 宝石的格式化器。
• Irwi::Formatters::SimpleHtml：不做任何处理的格式化器。

默认情况下，Irwi 会选择应用程序 Gemfile 中存在的第一个格式化器。您也可以通过指定 Irwi.config.formatter 值来显式选择格式化器，例如：

Irwi.config.formatter = Irwi::Formatters::BlueCloth.new

分页器

Irwi 支持自定义分页器，可以通过设置 Irwi.config.paginator 为相应的实例来配置。以下是一些支持的分页器（您应该将它们添加到应用程序的 Gemfile 中）：

• Irwi::Paginators::WillPaginate：基于 will_paginate 宝石。
• Irwi::Paginators::Kaminari：基于 kaminari 宝石。
• Irwi::Paginators::None：不执行任何操作的格式化器。

默认情况下，Irwi 会选择应用程序 Gemfile 中存在的第一个分页器。您也可以通过指定 Irwi.config.paginator 值来显式选择分页器，例如：

Irwi.config.paginator = Irwi::Paginators::WillPaginate.new

3. 项目API使用文档

Irwi 提供了一些方法和配置选项，您可以在您的应用程序中使用它们。

• Irwi.config：访问配置选项。

• wiki_user：辅助方法，用于渲染用户名或链接。

• irwi_wiki：生成器方法，用于创建维基相关的模型和控制器。

• irwi_wiki_attachments：生成器方法，用于添加附件功能。

4. 项目安装方式

请参考“安装指南”部分，其中包括将 Irwi 添加到 Gemfile 和执行相关命令的步骤。

通过上述步骤，您可以轻松地在您的 Ruby on Rails 4 应用程序中集成 Irwi 插件，并开始使用维基功能。