README

Yeeki是一个灵活的wiki引擎，既可以作为独立应用程序使用，也可以作为Yii框架模块。

默认情况下，它使用markdown语法，并增加了wiki链接。

实现的功能

• Unicode支持
• 命名空间
• 页面索引
• 修订历史
• 查看特定修订的能力
• 在修订历史页面中输入更改摘要的能力
• 修订差异
• 支持多种标记方言（仅提供markdown）
• 使用[[wiki-links]]进行交叉链接
• 主题支持
• i18n支持

要求

目前，为了使用Yeeki，您需要启用InnoDB引擎的MySQL。将来计划允许使用MyISAM和PostgreSQL。

此外，服务器应能够运行Yii框架。

将Yeeki作为应用程序使用

目前，您需要执行以下步骤。在未来的版本中，所有这些都将由自动化安装程序处理。

1. 解压缩发行版存档的内容。
2. 将您的Web服务器docroot指向www。
3. 确保Web服务器对www/assets和app/runtime有写权限。
4. 创建具有utf8编码和utf8_general_ci校对的数据库。
5. 在app/config/db.php中提供适当的数据库凭据。
6. 从Web浏览器运行install.php。

将Yeeki作为模块使用

• 将app/modules/wiki复制到您的应用程序目录。
• 使用yiic应用以下命令的迁移

yiic migrate --migrationPath=application.modules.wiki.migrations --migrationTable=wiki_migration

• 将wiki模块添加到您的Web应用程序配置中（通常为protected/config/main.php）

return array(
	'basePath'=>dirname(__FILE__).DIRECTORY_SEPARATOR.'..',
	'name'=>'My cool application',

	// add the following:
	'modules' => array(
		'wiki' => array(

		),
	),

	// …

• 将cache组件添加到您的应用程序配置中

return array(
  // ...
  'components' => array(
    'cache' => array(
       'class' => 'CFileCache',
    ),
  ),
);

实现数据接口和配置模块

为了在您的应用程序中使用wiki，您应该实现一些简单的接口，并配置指向实现的模块。如果您使用标准的Yii::app()->user和标准的RBAC，则唯一必须实现的接口是IWikiUser。您可以在app/components/WikiUser.php中找到示例实现。实现后，您需要配置模块

'modules' => array(
	'wiki' => array(
		'userAdapter' => array(
			'class' => 'WikiUser',
		),
	),
),

另请参阅IWikiAuth、IWikiSearch。

主题化Yeeki

您可以使用标准的Yii主题功能来主题化Yeeki。有关详细信息，请参阅 definitive guide。

许可证

Yeeki采用新BSD许可证。这允许专有使用，并将软件纳入专有产品中。基于该材料的作品可以以专有许可证或作为闭源软件发布。可以将某些东西与BSD许可证一起分发，并适用其他许可证。

致谢

• 初始代码和想法：Alexander Makarov，@samdark。
• 功能贡献：Mark Bryk，@mbryk。

感谢

• CleverTech对支持此开源项目的支持。