jQuery recurrenceinput 插件技术文档

1. 安装指南

环境要求

• jQuery
• jQuery Tools datetime widget 和 overlay 支持
• 支持的 jQuery 版本：1.4 和 1.7（jQuery 1.5 可能兼容，但未测试；jQuery 1.6.4 不兼容）
• 支持的浏览器：Chromium 20 (Linux)、Firefox 16 (Linux)、IE 8 和 IE 9 (Windows)

安装步骤

1. 下载或克隆项目代码。
2. 将 src/jquery.recurrenceinput.js 文件引入到你的项目中。
3. 确保你的项目中已经引入了 jQuery 和 jQuery Tools。

2. 项目的使用说明

基本使用

1. 在你的 HTML 文件中引入 jQuery、jQuery Tools 和 jquery.recurrenceinput.js：

   <script src="path/to/jquery.js"></script>
   <script src="path/to/jquery.tools.js"></script>
   <script src="path/to/jquery.recurrenceinput.js"></script>
   

2. 在你的表单中添加一个输入框，并初始化 recurrenceinput 插件：

   <input type="text" id="recurrence-input" />
   <script>
     $(document).ready(function() {
       $('#recurrence-input').recurrenceinput();
     });
   </script>
   

国际化支持

该插件支持国际化，可以通过设置语言模板来实现不同语言的支持。

预定义规则（模板）

插件支持预定义的重复规则模板，用户可以选择这些模板来快速设置重复规则。

3. 项目API使用文档

初始化

$('#recurrence-input').recurrenceinput(options);

• options：可选参数，用于自定义插件的行为。

方法

• destroy()：销毁插件实例，恢复输入框的默认状态。

  $('#recurrence-input').recurrenceinput('destroy');
  

事件

• change：当重复规则发生变化时触发。

  $('#recurrence-input').on('change', function() {
    console.log('Recurrence rule changed');
  });
  

4. 项目安装方式

通过 GitHub 安装

1. 克隆项目仓库：

   git clone https://github.com/collective/jquery.recurrenceinput.js.git
   

2. 进入项目目录：

   cd jquery.recurrenceinput.js
   

3. 安装依赖：
   • 对于 Debian/Ubuntu 系统：

     sudo apt-get install python-dateutil
     

   • 对于非系统 Python 2 环境：

     <pathtopython>/easy_install python-dateutil
     

本地测试

1. 启动本地测试服务器：

   python ./test_server.py
   

2. 打开浏览器访问以下地址进行测试：
   • 演示页面：http://localhost:8000/demo/input.html
   • 国际化演示页面：http://localhost:8000/demo/localized.html
   • 测试页面：http://localhost:8000/tests/tests.html

代码覆盖率测试

1. 安装 jscoverage：

   sudo apt-get install jscoverage
   

2. 更新覆盖率代码：

   jscoverage src/ coverage/
   

3. 运行覆盖率测试：

   http://localhost:8000/coverage/jscoverage.html?/tests/coveragetest.html
   

5. 开发者信息

代码风格检查

• 使用 jslint 进行代码风格检查：

  js tests/jslint.js src/jquery.recurrenceinput.js
  

贡献者

• 项目最初由 Rok Garbas 发起。
• 主要贡献者：Lennart Regebro、Rok Garbas、Vilmos Somogyi、Johannes Raggam、Mike Rhodes、Kai Lautaportti

感谢 Hexagon IT 公司资助了该项目的主要开发工作。