CalendarHelper 项目技术文档

1. 安装指南

环境要求

• Ruby 版本：2.0 或更高
• Rails 版本：3.0 或更高（如果使用 Rails）
• Sinatra 或其他 Web 框架（如果使用 Sinatra）

安装步骤

1. 将 calendar_helper 添加到你的 Gemfile 中：

   gem 'calendar_helper'
   

2. 运行 bundle install 安装依赖。
3. 如果使用 Rails，生成 CSS 文件：

   ./script/generate calendar_styles
   

   生成的 CSS 文件将位于 public/stylesheets/calendar 目录下。

2. 项目的使用说明

基本使用

CalendarHelper 提供了一个简单的 calendar 方法，可以在 Rails 视图模板或其他 Web 应用中使用。以下是一些基本用法示例：

简单日历

calendar(:year => 2005, :month => 6)

设置表格类

calendar({:year => 2005, :month => 6, :table_class => "calendar_helper"})

高级功能

calendar(:year => 2005, :month => 5) do |d|
  if listOfSpecialDays.include?(d)
    [d.mday, {:class => "specialDay"}]
  else
    [d.mday, {:class => "normalDay"}]
  end
end

ERb 使用示例

<%= calendar(:year => @year, :month => @month, :first_day_of_week => 1) do |d|
      render_calendar_cell(d)
    end
%>

Haml 使用示例

= calendar(:year => @year, :month => @month, :first_day_of_week => 1) do |d|
  - render_calendar_cell(d)

Sinatra 使用示例

在 Sinatra 中，需要将 CalendarHelper 模块包含在 helpers 中：

helpers do
  include CalendarHelper
end

3. 项目 API 使用文档

calendar 方法

• 参数:
  • :year (Integer): 年份
  • :month (Integer): 月份
  • :table_class (String): 表格的 CSS 类名
  • :first_day_of_week (Integer): 一周的第一天（默认为 0，即星期天）
• 块:
  • 块参数 d 表示当前日期。
  • 块返回值为一个数组，第一个元素是日期，第二个元素是一个包含 CSS 类名的哈希。

示例

calendar(:year => 2005, :month => 5) do |d|
  if listOfSpecialDays.include?(d)
    [d.mday, {:class => "specialDay"}]
  else
    [d.mday, {:class => "normalDay"}]
  end
end

4. 项目安装方式

通过 Gem 安装

1. 在 Gemfile 中添加：

   gem 'calendar_helper'
   

2. 运行 bundle install。

手动安装

1. 下载项目源码。
2. 将 calendar_helper 目录复制到你的项目中。
3. 在需要使用的地方引入 calendar_helper。

CSS 文件安装

1. 运行生成器：

   ./script/generate calendar_styles
   

2. 生成的 CSS 文件将位于 public/stylesheets/calendar 目录下。

通过以上步骤，你可以顺利安装并使用 CalendarHelper 项目，生成美观且功能丰富的日历。